API Reference Overview
Access & Connections
Accounting
Invoicing
POS
PMS
Payment
Banking
Other
curl --request POST \
--url https://api.chift.eu/consumers/{consumer_id}/commerce/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer": {
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"internal_notes": "<string>"
},
"billing_address": {
"first_name": "<string>",
"last_name": "<string>",
"street": "<string>",
"number": "<string>",
"city": "<string>",
"country": "<string>",
"box": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"email": "<string>"
},
"shipping_address": {
"first_name": "<string>",
"last_name": "<string>",
"street": "<string>",
"number": "<string>",
"city": "<string>",
"country": "<string>",
"box": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"email": "<string>"
},
"currency": "<string>",
"lines": [
{
"variant_id": "<string>",
"quantity": 123,
"tax_rate": 123,
"unit_price": 123
}
],
"note": "<string>",
"payment_method": "<string>"
}
'{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"status": "cancelled_unpaid",
"discount_amount": 123,
"untaxed_amount_without_fees": 123,
"tax_amount_without_fees": 123,
"total_without_fees": 123,
"current_untaxed_amount": 123,
"current_tax_amount": 123,
"current_total": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123,
"currency": "<string>",
"lines": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"quantity": 123,
"current_quantity": 123,
"unit_price": 123,
"description": "<string>",
"tax_rate": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123,
"created_on": "2023-11-07T05:31:56Z",
"variant": {
"id": "<string>",
"name": "<string>",
"sku": "<string>",
"categories": []
},
"tax_id": "<string>",
"discounts": [],
"gift_card": false,
"is_gift": false
}
],
"order_number": "<string>",
"customer": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"internal_notes": "<string>",
"email": "<string>"
},
"billing_address": {
"address_type": "main",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"street": "<string>",
"number": "<string>",
"box": "<string>",
"city": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>"
},
"shipping_address": {
"address_type": "main",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"street": "<string>",
"number": "<string>",
"box": "<string>",
"city": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"last_updated_on": "2023-11-07T05:31:56Z",
"confirmed_on": "2023-11-07T05:31:56Z",
"delivery_date": "2023-11-07T05:31:56Z",
"cancelled_on": "2023-11-07T05:31:56Z",
"refunded_amount": 0,
"note": "<string>",
"tags": [],
"other_fees": [],
"payment_method_id": "<string>",
"transactions": [],
"payment_methods": [],
"detailed_refunds": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"total": 123,
"created_on": "2023-11-07T05:31:56Z",
"reason": "<string>",
"order_lines": [],
"other": 0,
"shipping_refunds": [],
"other_fees": [],
"transactions": []
}
],
"returns": []
}Create an order
Create a new order
curl --request POST \
--url https://api.chift.eu/consumers/{consumer_id}/commerce/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer": {
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"internal_notes": "<string>"
},
"billing_address": {
"first_name": "<string>",
"last_name": "<string>",
"street": "<string>",
"number": "<string>",
"city": "<string>",
"country": "<string>",
"box": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"email": "<string>"
},
"shipping_address": {
"first_name": "<string>",
"last_name": "<string>",
"street": "<string>",
"number": "<string>",
"city": "<string>",
"country": "<string>",
"box": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"email": "<string>"
},
"currency": "<string>",
"lines": [
{
"variant_id": "<string>",
"quantity": 123,
"tax_rate": 123,
"unit_price": 123
}
],
"note": "<string>",
"payment_method": "<string>"
}
'{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"status": "cancelled_unpaid",
"discount_amount": 123,
"untaxed_amount_without_fees": 123,
"tax_amount_without_fees": 123,
"total_without_fees": 123,
"current_untaxed_amount": 123,
"current_tax_amount": 123,
"current_total": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123,
"currency": "<string>",
"lines": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"quantity": 123,
"current_quantity": 123,
"unit_price": 123,
"description": "<string>",
"tax_rate": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123,
"created_on": "2023-11-07T05:31:56Z",
"variant": {
"id": "<string>",
"name": "<string>",
"sku": "<string>",
"categories": []
},
"tax_id": "<string>",
"discounts": [],
"gift_card": false,
"is_gift": false
}
],
"order_number": "<string>",
"customer": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"internal_notes": "<string>",
"email": "<string>"
},
"billing_address": {
"address_type": "main",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"street": "<string>",
"number": "<string>",
"box": "<string>",
"city": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>"
},
"shipping_address": {
"address_type": "main",
"company_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"street": "<string>",
"number": "<string>",
"box": "<string>",
"city": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"email": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"last_updated_on": "2023-11-07T05:31:56Z",
"confirmed_on": "2023-11-07T05:31:56Z",
"delivery_date": "2023-11-07T05:31:56Z",
"cancelled_on": "2023-11-07T05:31:56Z",
"refunded_amount": 0,
"note": "<string>",
"tags": [],
"other_fees": [],
"payment_method_id": "<string>",
"transactions": [],
"payment_methods": [],
"detailed_refunds": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"total": 123,
"created_on": "2023-11-07T05:31:56Z",
"reason": "<string>",
"order_lines": [],
"other": 0,
"shipping_refunds": [],
"other_fees": [],
"transactions": []
}
],
"returns": []
}Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Body
Show child attributes
Show child attributes
Format: ISO 3166-1 codes.
Show child attributes
Show child attributes
Format: ISO 3166-1 codes.
Indicates the currency of the order (e.g. EUR).
1If filled in the order will be marked as paid and processed by this payment method.
Response
Successful Response
Technical id in Chift
cancelled_unpaid, cancelled, draft, confirmed, shipped, refunded Untaxed amount without fees (e.g. shipping) but with discout. Refunds and returns are not included.
Total taxes applied to the order without taxes linked to fees (e.g. shipping).
Total of the order without fees (e.g. shipping) but with discount. Refunds and returns are not included.
Untaxed amount with discout and any kind of fee (e.g. shipping). After returns, removes and returns.
Total taxes applied to the order. After returns, removes and returns.
Current total of the order with discount. After returns, removes and returns.
Untaxed amount with discout and any kind of fee (e.g. shipping). Refunds and returns are not included.
Total taxes applied to the order. Refunds and returns are not included.
Total of the order with discount. Refunds and returns are not included.
Indicates the currency of the order (e.g. EUR).
Show child attributes
Show child attributes
Technical id in Chift
Quantity without refunds and returns.
Unit price of the product without taxes.
Indicates the tax rate used for the line (e.g. 21.0).
Untaxed amount of the order line with discount.
Total taxes applied to the order line.
Total of the order line with discount.
Product variant
Show child attributes
Show child attributes
Technical id of the product variant in Chift
Technical id of the tax rate in Chift
Show child attributes
Show child attributes
main, delivery, invoice Format: ISO 3166-1 codes.
Show child attributes
Show child attributes
main, delivery, invoice Format: ISO 3166-1 codes.
Show child attributes
Show child attributes
Technical id in Chift
shipping, other Indicates if the fee has been removed from the order
Technical id of the tax rate in Chift
Technical id of the payment method in the eCommerce
Show child attributes
Show child attributes
Technical id of the transaction in the eCommerce
failed, pending, success Technical id of the payment method in the eCommerce
Name of the payment method
Show child attributes
Show child attributes
Technical id in Chift
Show child attributes
Show child attributes
Technical id of the order line in Chift
Untaxed amount refunded (after discount).
Total taxes refunded (after discount).
Total refunded (after discount).
Product variant
Show child attributes
Show child attributes
Technical id of the product variant in Chift
Show child attributes
Show child attributes
Technical id in Chift
Untaxed amount refunded (after discount).
Total taxes refunded (after discount).
Total refunded (after discount).
Show child attributes
Show child attributes
Technical id of the fee in Chift
shipping, other Show child attributes
Show child attributes
Technical id of the transaction in the eCommerce
failed, pending, success Technical id of the payment method in the eCommerce
Name of the payment method
Show child attributes
Show child attributes
Technical id of the return in Chift
Show child attributes
Show child attributes
Technical id of the order line in Chift
Untaxed amount refunded (after discount).
Total taxes refunded (after discount).
Total refunded (after discount).
Product variant
Show child attributes
Show child attributes
Technical id of the product variant in Chift
Show child attributes
Show child attributes
Technical id of the order line in Chift
Untaxed amount refunded (after discount).
Total taxes refunded (after discount).
Total refunded (after discount).
Product variant
Show child attributes
Show child attributes
Technical id of the product variant in Chift
Show child attributes
Show child attributes
Technical id of the fee in Chift
shipping, other