Skip to main content
GET
/
consumers
/
{consumer_id}
/
commerce
/
orders
Get all 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": "<any>",
                "sku": "<any>",
                "name": "<any>",
                "categories": "<any>"
              },
              "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": "<any>",
                "sku": "<any>",
                "name": "<any>",
                "categories": "<any>"
              },
              "quantity": 123,
              "untaxed_amount": 123,
              "tax_amount": 123,
              "total": 123
            }
          ],
          "new_lines": [
            {
              "id": "<string>",
              "variant": {
                "id": "<any>",
                "sku": "<any>",
                "name": "<any>",
                "categories": "<any>"
              },
              "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
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100
​
date_from
string<date> | null

Filter orders created at or after this date (e.g. 2023-01-31)

​
date_to
string<date> | null

Filter orders created at or before this date (e.g. 2023-01-31)

​
updated_after
string<date-time> | null

Filter orders last updated at or after this date (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.

​
include_detailed_refunds
enum<string> | null
default:false

Include detailed information concerning refunds

Available options:
true,
false
​
include_product_categories
enum<string> | null
default:false

Include detailed information about categories

Available options:
true,
false
​
include_customer_details
enum<string> | null
default:true

Include detailed information about customer

Available options:
true,
false

Response

Successful Response

​
items
OrderItemOut · object[]
required
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
total
integer | null
Required range: x >= 0