Skip to main content
POST
Create a new sales order

Authorizations

Authorization
string
header
required

Use a valid JWT token in the Authorization header with the format 'Bearer {token}'

Body

application/json
customerReference
string
required
code
null | string
name
null | string
notes
null | string
externalReference
null | string
codeForCustomer
null | string
orderedAt
null | string<date-time>
deliveryInstructions
null | string

Response

Created

id
string
required
externalReference
null | string
required
customerId
string
required
customer
object | null
required
Example:
code
string
required
name
string
required
notes
null | string
required
deliveryInstructions
null | string
required
codeForCustomer
null | string
required
status
enum<string>
required
Available options:
Cancelled,
Draft,
Pending,
PartiallyDelivered,
Delivered
stockStatus
any | null
required
Available options:
Pending,
PartiallyPlanned,
FullyPlanned,
Ready,
NotRequired,
null
cancelledAt
null | string<date-time>
required
orderedAt
string<date-time>
required
requestedDeliveryAt
null | string<date-time>
required
committedDeliveryAt
null | string<date-time>
required
targetDeliveryAt
null | string<date-time>
required
stockExpectedAt
null | string<date-time>
required
createdAt
string<date-time>
required
createdBy
string
required
lastModifiedAt
string<date-time>
required
lastModifiedBy
string
required