Create a customer order

post

https://api.mrpeasy.com/rest/v1/customer-orders

If the status is Confirmed (30) or greater, the software tries to book available products from stock immediately.

If the status is Shipped (70) or Delivered (80), and products are booked, the software creates a shipment document and picks products from the stock.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customer_id

integer

required

Database ID of the customer.

code

string

A unique number to identify the customer order.

If omitted, it is auto-generated.

reference

string

Reference of the customer order.

status

integer

enum

Status of customer order.

10 - quotation
20 - waiting for confirmation
30 - confirmed
40 - waiting for production
50 - in production
60 - ready for shipment
70 - shipped
80 - delivered
85 - archived
90 - cancelled

Optional.

If the status is Confirmed (30) or greater, the software tries to book available products from stock immediately.
If the status is Shipped (70) or Delivered (80), and products are booked, the software tries to create a shipment document and pick products from stock.

created

integer

Date and time when this customer order was created. Defaults to current date if omitted.

delivery_date

integer

Date and time when this customer order should be delivered.

delivery_terms

string | null

Delivery terms of the order.

notes

string

Internal notes, any additional information about the order.

discount_rate

number

Percentage of discount.

discount_percent

number

Alias of discount_rate

discount_sum_cur

number

Sum of discount in the order's currency.

currency

string

Currency of the customer order. Can only be set on create.

currency_rate

number

Currency rate of the customer order.

shipping_address_id

integer

ID of customer order shipping address if it is selected in customer order details.

site_id

integer

Optional site ID.

If provided, products are booked from this site.
Otherwise, products are booked from the customer order's site.

pricelist_id

integer

Database ID of the pricelist.

user_id

integer

Sales person who handles that customer order.

lot_id

Optional stock lot ID or array of stock lot IDs.

If provided, products are booked from these stock lots.
Otherwise, products are booked from any stock lots.

location_id

Optional storage location ID or array of storage location IDs.

If provided, products are booked from these storage locations.
Otherwise, products are booked from any storage location.

products

array of objects

required

Array of products that are sold.
To create a customer order, provide at least one product line.

products*

Responses

429

Rate limited - another request is running

201Customer order created

400Validation failed

401Authentication failed