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": 123,
"currency": "<string>",
"note": "<string>",
"tags": [
"<string>"
],
"lines": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"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": [
{
"name": "<string>",
"description": "<string>",
"amount": 123
}
],
"gift_card": true
}
],
"other_fees": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"type": "shipping",
"removed": true,
"tax_rate": 123,
"tax_id": "<string>",
"discounts": [
{
"name": "<string>",
"description": "<string>",
"amount": 123
}
],
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"payment_method_id": "<string>",
"transactions": [
{
"id": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"payment_method_id": "<string>",
"payment_method_name": "<string>",
"amount": 123,
"status": "failed"
}
],
"payment_methods": [
{
"id": "<string>",
"name": "<string>"
}
],
"detailed_refunds": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"total": 123,
"reason": "<string>",
"order_lines": [
{
"id": "<string>",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"quantity": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"other": 123,
"shipping_refunds": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"other_fees": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "shipping",
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"transactions": [
{
"id": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"payment_method_id": "<string>",
"payment_method_name": "<string>",
"amount": 123,
"status": "failed"
}
]
}
],
"returns": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"order_lines": [
{
"id": "<string>",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"quantity": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"new_lines": [
{
"id": "<string>",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"quantity": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"linked_fees": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "shipping",
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
]
}
]
}
],
"total": 1,
"page": 2,
"size": 2
}
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": 123,
"currency": "<string>",
"note": "<string>",
"tags": [
"<string>"
],
"lines": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"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": [
{
"name": "<string>",
"description": "<string>",
"amount": 123
}
],
"gift_card": true
}
],
"other_fees": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"type": "shipping",
"removed": true,
"tax_rate": 123,
"tax_id": "<string>",
"discounts": [
{
"name": "<string>",
"description": "<string>",
"amount": 123
}
],
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"payment_method_id": "<string>",
"transactions": [
{
"id": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"payment_method_id": "<string>",
"payment_method_name": "<string>",
"amount": 123,
"status": "failed"
}
],
"payment_methods": [
{
"id": "<string>",
"name": "<string>"
}
],
"detailed_refunds": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"total": 123,
"reason": "<string>",
"order_lines": [
{
"id": "<string>",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"quantity": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"other": 123,
"shipping_refunds": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"other_fees": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "shipping",
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"transactions": [
{
"id": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"payment_method_id": "<string>",
"payment_method_name": "<string>",
"amount": 123,
"status": "failed"
}
]
}
],
"returns": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"created_on": "2023-11-07T05:31:56Z",
"order_lines": [
{
"id": "<string>",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"quantity": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"new_lines": [
{
"id": "<string>",
"variant": {
"id": "<string>",
"sku": "<string>",
"name": "<string>",
"categories": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"quantity": 123,
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
],
"linked_fees": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "shipping",
"untaxed_amount": 123,
"tax_amount": 123,
"total": 123
}
]
}
]
}
],
"total": 1,
"page": 2,
"size": 2
}
This access token needs to be included in each of your request to the Chift API.
Page number
x >= 1
Page size
1 <= x <= 100
true
, false
true
, false
true
, false
Successful Response
The response is of type object
.