API Reference Overview
Authentication
Consumers
Connections
Accounting
- Folders
- Book years
- Clients
- Suppliers
- Invoices
- Ledger accounts
- Journals
- Journal entries
- Employees
- Analytic plans
- Analytic accounts
- Miscellaneous operations
- Outstandings
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
Payment
- Payments
- Balances
- Transactions
- Refunds
Banking
- Financial institutions
- Banking accounts
- Transactions
Advanced
- Webhooks
- Syncs
- Issues
- Datastores
Get all orders
Returns a list of all the orders
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/commerce/orders \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"order_number": "<string>",
"customer": {
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"internal_notes": "<string>",
"email": "<string>",
"id": "<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",
"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,
"refunded_amount": 0,
"currency": "<string>",
"note": "<string>",
"tags": [],
"lines": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": []
},
"quantity": 123,
"current_quantity": 123,
"unit_price": 123,
"description": "<string>",
"tax_id": "<string>",
"tax_rate": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123,
"discounts": [],
"gift_card": false
}
],
"other_fees": [],
"payment_method_id": "<string>",
"transactions": [],
"payment_methods": [],
"detailed_refunds": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"total": 123,
"reason": "<string>",
"order_lines": [],
"other": 0,
"shipping_refunds": [],
"other_fees": [],
"transactions": []
}
],
"returns": []
}
],
"total": 1,
"page": 2,
"size": 2
}
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
x >= 1
1 <= x <= 100
An enumeration.
true
, false
An enumeration.
true
, false
An enumeration.
true
, false
Response
Technical id in Chift
An enumeration.
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).
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
Technical id of the product variant in Chift
Technical id of the tax rate in Chift
An enumeration.
main
, delivery
, invoice
Format: ISO 3166-1 codes.
An enumeration.
main
, delivery
, invoice
Format: ISO 3166-1 codes.
Technical id in Chift
An enumeration.
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
Technical id of the transaction in the eCommerce
An enumeration.
failed
, pending
, success
Technical id of the payment method in the eCommerce
Name of the payment method
Technical id in Chift
Technical id of the order line in Chift
Untaxed amount refunded (after discount).
Total taxes refunded (after discount).
Total refunded (after discount).
Technical id in Chift
Untaxed amount refunded (after discount).
Total taxes refunded (after discount).
Total refunded (after discount).
Technical id of the fee in Chift
An enumeration.
shipping
, other
Technical id of the transaction in the eCommerce
An enumeration.
failed
, pending
, success
Technical id of the payment method in the eCommerce
Name of the payment method
Technical id of the return in Chift
Technical id of the order line in Chift
Untaxed amount refunded (after discount).
Total taxes refunded (after discount).
Total refunded (after discount).
Technical id of the order line in Chift
Untaxed amount refunded (after discount).
Total taxes refunded (after discount).
Total refunded (after discount).
Technical id of the fee in Chift
An enumeration.
shipping
, other
x >= 0
x >= 1
x >= 1
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/commerce/orders \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"order_number": "<string>",
"customer": {
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"internal_notes": "<string>",
"email": "<string>",
"id": "<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",
"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,
"refunded_amount": 0,
"currency": "<string>",
"note": "<string>",
"tags": [],
"lines": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": []
},
"quantity": 123,
"current_quantity": 123,
"unit_price": 123,
"description": "<string>",
"tax_id": "<string>",
"tax_rate": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123,
"discounts": [],
"gift_card": false
}
],
"other_fees": [],
"payment_method_id": "<string>",
"transactions": [],
"payment_methods": [],
"detailed_refunds": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"total": 123,
"reason": "<string>",
"order_lines": [],
"other": 0,
"shipping_refunds": [],
"other_fees": [],
"transactions": []
}
],
"returns": []
}
],
"total": 1,
"page": 2,
"size": 2
}