Get Orders

Get Orders

get

Authorizations

Query parameters

order_numberany ofOptional

Order number to search for

stringOptional

or

nullOptional

customer_keyany ofOptional

Customer key to search for

stringOptional

or

nullOptional

carrier_keyany ofOptional

Carrier of the order to filter by. Choose from: "DHL_STD_NATIONAL", "HERMES_KLV", "HERMES_STD_NATIONAL", "DHL_AUT", "DHL_POST_AUT", "HERMES_POST_AUT", "POST_CH", "QUICK_CH", "POST_NL", "DHL_NL", "DHL_PL", "PPL", "ZASIL_CZ", "BPOST_BE", "DHL_BPOST_BEL", "COLI_FR", "UB_GLS_DK", "UB_CORR_ES", "DS_TB_ES", "UB_CTT_PT", "DS_TB_PT", "ECONT_BG", "ACS_CY", "UB_OMNIVA_EE", "UB_POST_FI", "UB_TAXY_GR", "ACS_GR", "POST_HR", "POST_HU", "GLS_HU", "UB_FAST_IE", "POST_IT", "DS_TB_IT", "UB_OMNIVA_LT", "BPOST_LU", "UB_OMNIVA_LV", "UB_POST_NO", "FAN_RO", "UB_DHL_SE", "POST_SI", "POST_SK", "ZASIL_SK".

string · enumOptionalPossible values:

or

nullOptional

shop_countryany ofOptional

Shop country to search for

stringOptional

or

nullOptional

order_statusany ofOptional

Status of the order to filter by. Choose from: "open", "shipped", "cancelled", "returned", "mixed".

string · enumOptionalPossible values:

or

nullOptional

order_item_statusany ofOptional

Status of the order item to filter by. Choose from: "open", "shipped", "cancelled", "returned".

string · enumOptionalPossible values:

or

nullOptional

orders_fromany ofOptional

Orders from date to filter by

string · date-timeOptional

or

nullOptional

orders_toany ofOptional

Orders to date to filter by

string · date-timeOptional

or

nullOptional

pageinteger · min: 1Optional

Page number to retrieve items from

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of items per page

Default: 20

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/orders/ HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "order_items": [
        {
          "return_tracking_key": "text",
          "shipment_tracking_key": "text",
          "sku": "text",
          "id": 1,
          "product_variant": 1,
          "vat": 19,
          "price_without_tax": 1,
          "price_with_tax": 1,
          "custom_data": {},
          "status": "open"
        }
      ],
      "order_number": "text",
      "delivery_document_url": "text",
      "created_at": "2025-06-09T05:45:44.994Z",
      "updated_at": "2025-06-09T05:45:44.994Z",
      "customer_key": "text",
      "custom_data": {},
      "shop": 1,
      "carrier_key": "text",
      "payment_method": "text",
      "billing_street": "text",
      "billing_zip_code": "text",
      "billing_city": "text",
      "billing_country_code": "text",
      "billing_recipient_gender": "text",
      "billing_recipient_first_name": "text",
      "billing_recipient_last_name": "text",
      "billing_additional": "text",
      "shipping_street": "text",
      "shipping_zip_code": "text",
      "shipping_city": "text",
      "shipping_country_code": "text",
      "shipping_additional": "text",
      "shipping_collection_point_key": "text",
      "shipping_collection_point_type": "text",
      "shipping_collection_point_customer_key": "text",
      "shipping_collection_point_description": "text",
      "shipping_recipient_gender": "text",
      "shipping_recipient_first_name": "text",
      "shipping_recipient_last_name": "text",
      "currency_code": "text",
      "cost_without_tax": 1,
      "cost_with_tax": 1,
      "shopify_order_id": "text",
      "status": "open",
      "fulfillment_type": "dropshipping"
    }
  ],
  "pagination": {
    "per_page": 1,
    "page": 1,
    "pages": 1,
    "total": 1,
    "next": "text",
    "prev": "text"
  }
}