Create Order

post

https://api.paqato.com/v3/orders

Create an Order

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

orderNumber

string

required

length between 1 and 255

^((?!/).)*$

Public/customer-facing order number

statuses

array of objects

Array of Order Statuses

statuses

shopToken

string

required

length between 1 and 16

language

string

required

length between 2 and 2

customerNumber

string

required

length between 1 and 255

Customer number. Must uniquely identify a specific customer. See https://docs.paqato.com/docs/kundennummer-vs-subkundennummer for detailed description.

subCustomerNumber

string

length between 1 and 255

Sub-customer number. See https://docs.paqato.com/docs/kundennummer-vs-subkundennummer for detailed description.

shippingAddress

object

required

orderNumberInternal

string

length between 1 and 255

Internal order number

fullyShipped

integer

enum

Order fully shipped. Will affect returns calculation.

0 = Unknown (default)
1 = not fully shipped
2 = fully shipped

Allowed:

orderDate

date-time

Order date. RFC3339 format without milliseconds.

totalPrice

number

Total cost in EUR/USD/CHF etc.

currency

string

length between 1 and 255

Total cost's currency

shippingCost

number

≥ 0

Shipping cost in EUR/USD/CHF etc.

shippingCostCurrency

string

length between 1 and 255

Shipment cost's currency

requestedDeliveryDateFrom

date-time

Delivery date requested by customer - start of range. RFC3339 format without milliseconds.

requestedDeliveryDateTo

date-time

Delivery date requested by customer - end of range. RFC3339 format without milliseconds.

confirmedDeliveryDateFrom

date-time

Delivery date confirmed to customer - start of range. RFC3339 format without milliseconds.

confirmedDeliveryDateTo

date-time

Delivery date confirmed to customer - end of range. RFC3339 format without milliseconds.

paymentType

string

length between 1 and 255

Order's payment type

customerGroup

string

length between 1 and 255

billingAddress

object

shipments

array of objects

List of shipments for this order

shipments

items

array of objects

List of items/articles for this order

items

notifications

array of objects

notifications

data

object

Additional data

commissionNumber

string | null

Order commission number

shopOrderNumbers

array of strings

List of shop order numbers

shopOrderNumbers

customerOrderNumbers

array of strings

List of customer order numbers

customerOrderNumbers

deliveryNotes

array of strings

List of delivery notes

deliveryNotes

Responses

202OK, Order queued for import

400Bad Request, Order not saved

404A required resource was not found, see body message for details

409Conflict with existing Order, Order not saved