Skip to main content
Sendcloud’s Orders API offers an intuitive and flexible way of getting your orders ready for delivery. Are you willing to put your shipping processes on autopilot? Learn how to create your first order with Sendcloud’s Orders API. This guide covers the basics of creating, edited and retrieving orders via the API. Before you begin, make sure you’ve completed setting up your Sendcloud account and that you know how to authenticate with our API.

​
Creating an order

Use the Create/Update orders in batch endpoint to create one or more orders. Refer to the API reference for information on the data you can include, as well as try out requests in the API playground.
Example request method and URL
POST https://panel.sendcloud.sc/api/v2/orders
If the order was created successfully, you’ll receive a 201 Created response with the order details in the response body. 
{
  "data": [
    {
      "id": "123",
      "order_id": "123456",
      "order_number": "ABCDEFG-12"
    }
  ]
}
The response contains the minimum amount of information to locate it in Sendcloud’s system. The newly created order has an id of "123", which is the unique identifier you can use later for updating an order via the API.

​
Making changes to an order

There are a couple of ways to update an order via the API:
  • Use the Create/Update orders in batch endpoint to update one or more orders
    • To update an order, ensure you provide the order_id, and the integration id so that a new order is not created.
    • You will need to provide all the required fields again when updating an order via this endpoint.
  • Use the Update an order endpoint to update a single order
    • This endpoint allows you to update specific fields of an order without needing to provide all the required fields again.

​
Retrieving an order

You can get the details for an order, or for multiple orders, via these endpoints:
  • Retrieve a list of orders: get multiple orders and filter the results by integration, status, created/updated date, and other parameters
  • Retrieve an order: get the details for a specific order by providing its unique id