Sign in

v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
eCommerce
Orders

Create an order

Create a new order

post/consumers/{consumer_id}/commerce/orders

Path parameters

consumer_idstring uuid required

Request body

currencystring required

Indicates the currency of the order (e.g. EUR).

notestring nullable
payment_methodstring nullable

If filled in the order will be marked as paid and processed by this payment method.

Response

Successful Response

idstring required

Technical id in Chift

order_numberstring nullable
created_onstring date-time nullable
last_updated_onstring date-time nullable
confirmed_onstring date-time nullable
delivery_datestring date-time nullable
cancelled_onstring date-time nullable
status'cancelled_unpaid' | 'cancelled' | 'draft' | 'confirmed' | 'shipped' | 'refunded' required
discount_amountnumber required
untaxed_amount_without_feesnumber required

Untaxed amount without fees (e.g. shipping) but with discout. Refunds and returns are not included.

tax_amount_without_feesnumber required

Total taxes applied to the order without taxes linked to fees (e.g. shipping).

total_without_feesnumber required

Total of the order without fees (e.g. shipping) but with discount. Refunds and returns are not included.

current_untaxed_amountnumber required

Untaxed amount with discout and any kind of fee (e.g. shipping). After returns, removes and returns.

current_tax_amountnumber required

Total taxes applied to the order. After returns, removes and returns.

current_totalnumber required

Current total of the order with discount. After returns, removes and returns.

untaxed_amountnumber required

Untaxed amount with discout and any kind of fee (e.g. shipping). Refunds and returns are not included.

tax_amountnumber required

Total taxes applied to the order. Refunds and returns are not included.

totalnumber required

Total of the order with discount. Refunds and returns are not included.

refunded_amountnumber nullable
currencystring required

Indicates the currency of the order (e.g. EUR).

notestring nullable
tagsstring[] nullable
payment_method_idstring nullable

Technical id of the payment method in the eCommerce