Skip to main content
GET
/
orders
Retrieve a list of orders
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/orders \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": "669",
      "order_id": "555413",
      "order_number": "OXSDFGHTD-12",
      "created_at": "2018-02-27T10:00:00.555Z",
      "modified_at": "2018-02-27T10:00:00.555Z",
      "order_details": {
        "integration": {
          "id": 739283
        },
        "status": {
          "code": "fulfilled",
          "message": "Fulfilled"
        },
        "order_created_at": "2018-02-27T10:00:00.555Z",
        "order_updated_at": "2018-02-27T10:00:00.555Z",
        "order_items": [
          {
            "name": "Cylinder candle",
            "measurement": {
              "weight": {
                "value": 1,
                "unit": "kg"
              }
            },
            "quantity": 1,
            "unit_price": {
              "value": 3.5,
              "currency": "EUR"
            },
            "total_price": {
              "value": 3.5,
              "currency": "EUR"
            },
            "delivery_dates": {
              "handover_at": "2022-02-27T10:00:00.555309+00:00",
              "deliver_at": "2022-03-02T11:50:00.555309+00:00"
            },
            "mid_code": "US1234567",
            "material_content": "100% Cotton",
            "intended_use": "Personal use"
          }
        ]
      },
      "payment_details": {
        "is_cash_on_delivery": false,
        "total_price": {
          "value": 7,
          "currency": "EUR"
        },
        "status": {
          "code": "paid",
          "message": "Order has been paid"
        },
        "discount_granted": {
          "value": "3.99",
          "currency": "EUR"
        },
        "insurance_costs": {
          "value": "9.99",
          "currency": "EUR"
        },
        "freight_costs": {
          "value": "5.99",
          "currency": "EUR"
        },
        "other_costs": {
          "value": "2.99",
          "currency": "EUR"
        }
      },
      "customs_details": {
        "commercial_invoice_number": "0124-03102022",
        "shipment_type": "commercial_goods",
        "export_type": "commercial_b2c",
        "tax_numbers": {
          "sender": [
            {
              "name": "VAT",
              "country_code": "NL",
              "value": "NL987654321B02"
            }
          ],
          "receiver": [
            {
              "name": "VAT",
              "country_code": "DE",
              "value": "DE123456789B03"
            }
          ],
          "importer_of_record": [
            {
              "name": "VAT",
              "country_code": "NL",
              "value": "NL975318642B01"
            }
          ]
        }
      },
      "shipping_address": {
        "name": "John Doe",
        "address_line_1": "Stadhuisplein",
        "house_number": "15",
        "postal_code": "5341TW",
        "city": "Oss",
        "country_code": "NL"
      },
      "shipping_details": {
        "is_local_pickup": false,
        "ship_with": {
          "type": "shipping_option_code",
          "properties": {
            "shipping_option_code": "postnl:standard",
            "contract_id": 517
          }
        }
      },
      "billing_address": {
        "name": "Jane Doe",
        "address_line_1": "Vioolstraat",
        "house_number": "118",
        "postal_code": "5391TW",
        "city": "Breda",
        "country_code": "NL"
      },
      "customer_details": {
        "name": "Jane Doe"
      }
    },
    {
      "id": "1337",
      "order_id": "555414",
      "created_at": "2018-03-21T10:00:00.555Z",
      "modified_at": "2018-03-22T10:00:00.555Z",
      "order_number": "OXSDFGHTD-13",
      "order_details": {
        "integration": {
          "id": 739283
        },
        "status": {
          "code": "fulfilled",
          "message": "Fulfilled"
        },
        "order_created_at": "2018-02-27T10:00:00.555Z",
        "order_updated_at": "2018-02-28T11:05:15.634Z",
        "order_items": [
          {
            "name": "Squared Candle",
            "measurement": {
              "weight": {
                "value": 0.8,
                "unit": "kg"
              }
            },
            "quantity": 3,
            "unit_price": {
              "value": 2,
              "currency": "EUR"
            },
            "total_price": {
              "value": 6,
              "currency": "EUR"
            },
            "delivery_dates": null,
            "mid_code": "US1234567",
            "material_content": "100% Cotton",
            "intended_use": "Personal use"
          },
          {
            "name": "Scented Candle",
            "quantity": 2,
            "unit_price": {
              "value": 5.5,
              "currency": "EUR"
            },
            "total_price": {
              "value": 11,
              "currency": "EUR"
            },
            "delivery_dates": null,
            "mid_code": "US1234567",
            "material_content": "100% Cotton",
            "intended_use": "Personal use"
          }
        ]
      },
      "payment_details": {
        "is_cash_on_delivery": false,
        "total_price": {
          "value": 7,
          "currency": "EUR"
        },
        "status": {
          "code": "paid",
          "message": "Order has been paid"
        },
        "discount_granted": {
          "value": "3.99",
          "currency": "EUR"
        },
        "insurance_costs": {
          "value": "9.99",
          "currency": "EUR"
        },
        "freight_costs": {
          "value": "5.99",
          "currency": "EUR"
        },
        "other_costs": {
          "value": "2.99",
          "currency": "EUR"
        }
      },
      "customs_details": {
        "commercial_invoice_number": "0124-03102022",
        "shipment_type": "commercial_goods",
        "export_type": "commercial_b2c",
        "tax_numbers": {
          "sender": [
            {
              "name": "VAT",
              "country_code": "NL",
              "value": "NL987654321B02"
            }
          ],
          "receiver": [
            {
              "name": "VAT",
              "country_code": "DE",
              "value": "DE123456789B03"
            }
          ],
          "importer_of_record": [
            {
              "name": "VAT",
              "country_code": "NL",
              "value": "NL975318642B01"
            }
          ]
        }
      },
      "shipping_address": {
        "name": "John Doe",
        "address_line_1": "Stadhuisplein",
        "house_number": "15",
        "postal_code": "5341AB",
        "city": "Oss",
        "country_code": "NL",
        "phone_number": "0612345678"
      },
      "shipping_details": {
        "is_local_pickup": false,
        "ship_with": {
          "type": "shipping_option_code",
          "properties": {
            "shipping_option_code": "postnl:standard",
            "contract_id": 517
          }
        }
      }
    }
  ]
}
This endpoint lets you get a list of orders from the API in the same way you can find it on the Incoming Orders overview in the Sendcloud panel. The endpoint is paginated. You can navigate through the results by using the URLs of the next and prev fields in the Link response header.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

​
integration
integer

Filter orders by one or more integration IDs. Use a comma separated list, e.g. integration=41,68,419.

You can get your integration IDs from the Retrieve a list of integrations endpoint.

Example:

17

​
order_number
string

Filter orders by a specific order number, e.g. order_number=ORDER_284565. The filtering is case insensitive.

Example:

"ORDER_284565"

​
order_id
string

Filter orders by a specific order id, e.g. order_id=1896e94b-c01b-4e73-a9e7-57f51c8a4c77. The filtering is case insensitive.

Example:

"1896e94b-c01b-4e73-a9e7-57f51c8a4c77"

​
status
string

Filter orders based on their status, e.g. status=unshipped. The filtering is case insensitive.

Example:

"unshipped"

​
order_created_at
string<date>

Find orders that were created on a specific date, e.g. order_created_at=2023-04-28.

Example:

"2023-04-28"

​
order_created_at_min
string<date>

Find orders that were created at or after a specific date, e.g. order_created_at_min=2023-04-28.

Example:

"2023-04-28"

​
order_created_at_max
string<date>

Find orders that were created at or before a specific date, e.g. order_created_at_max=2023-04-28.

Example:

"2023-04-28"

​
order_updated_at
string<date>

Find orders that were updated on a specific date, e.g. order_updated_at=2023-04-28.

Example:

"2023-04-28"

​
order_updated_at_min
string<date>

Find orders that were updated at or after a specific date, e.g. order_updated_at_min=2023-04-28.

Example:

"2023-04-28"

​
order_updated_at_max
string<date>

Find orders that were updated at or before a specific date, e.g. order_updated_at_max=2023-04-28.

Example:

"2023-04-28"

​
sort
string

Sort the orders in the response by using one or more of the following values:

  • integration: Sort by the integration ID of the retrieved orders; to sort in descending order, use -integration
  • order_number: Sort by the order number of the retrieved orders; to sort in descending order, use -order_number.
  • order_created_at: Sort by the date of an order creation of the retrieved orders; to sort in descending order, use -order_created_at
  • order_updated_at: Sort by the date of an order update of the retrieved orders; to sort in descending order, use -order_updated_at
  • pk: Sort by the ID (autogenerated internal ID) of the retrieved orders; to sort in descending order, use -pk

Additional information about this query:

  • Any valid combination of the above values is supported, e.g. sort=integration,-order_created_at.
  • In case of conflicting sort values, e.g. /?sort=integration,-integration, the conflicting value will be ignored.
  • If the sort query parameter is not set, the sorting of the retrieved orders will default to -pk.
  • If an unsupported sort value is provided, the results will be sorted by the default (-pk).
Example:

"-order_number"

​
page_size
number
default:100

The maximum number of results to be returned per page

Required range: 1 <= x <= 200
Example:

150

​
cursor
string

The cursor query string is used as the pivot value to filter results. If no value is provided, the first page of results will be returned. To get this value, you must encode the offset, reverse and position into a base64 string.

There are 3 possible parameters to encode:

  • o: Offset
  • r: Reverse
  • p: Position

For example, r=1&p=300 encoded as a base64 string would be cj0xJnA9MzAw. The query string would then be cursor=cj0xJnA9MzAw.

Example:

"cj0xJnA9MzAw"

Response

OK

​
data
Order Object · object[]