O2M Logo
One to Many
List orders
Was this page helpful?

List orders

Get orders from every channel, with their lines and parcels.

Overview

Returns your orders from every channel, with their lines and parcels.

Request

GET/orders

Needs the permission orders:read

cURL
curl "https://api.o2m.in/api/v1/orders?status=placed&channel=mysite&limit=50" \
  -H "X-Access-Key: $O2M_ACCESS_KEY" \
  -H "X-Secret-Key: $O2M_SECRET_KEY"

Query parameters

ParameterTypeRequiredDescription
statusstringNoOne status, such as placed. See Status values.
channelstringNoOne channel, such as shopify or a name of your own.
updated_sincedate and timeNoOnly orders changed at or after this time, for example 2026-10-02T10:00:00Z.
limitnumberNoRows per page, from 1 to 500. The default is 50.
cursorstringNoThe next value of the page before. See Pagination.

Response

200 with orders and next, oldest order first.

Response
{
  "orders": [
    {
      "id": "4410",
      "order_id": "SO-1001",
      "channel": "mysite",
      "status": "placed",
      "channel_status": null,
      "ordered_at": "2026-10-02T10:00:00.000Z",
      "updated_at": "2026-10-02T10:00:02.000Z",
      "dispatch_by": null,
      "shipped_at": null,
      "delivered_at": null,
      "cancelled_at": null,
      "total": 200,
      "tax": 30.51,
      "customer": {
        "name": "Ravi",
        "email": "ravi@example.com"
      },
      "shipping_address": {
        "name": "Ravi",
        "phone": "9800000000",
        "address1": "12 MG Road",
        "address2": null,
        "city": "Pune",
        "state": "Maharashtra",
        "pincode": "411001",
        "country": "IN"
      },
      "client": null,
      "lines": [
        {
          "id": "9001",
          "sku": "MUG-BLUE",
          "title": "Blue mug",
          "quantity": 2,
          "unit_price": 100,
          "total": 200,
          "tax": 30.51,
          "reserved": 2,
          "backordered": 0,
          "dispatched": 0,
          "delivered": 0,
          "returned": 0
        }
      ],
      "shipments": []
    }
  ],
  "next": null
}
FieldTypeDescription
idstringO2M's ID for the order. Use it to retrieve or cancel the order.
order_idstringThe order number on its channel, or the number you sent.
channelstringWhere the order came from.
statusstringThe order status. See Status values.
channel_statusstring or nullThe status in the channel's own words, when there is one.
ordered_at, updated_atstringWhen the order was placed and last changed.
dispatch_bystring or nullWhen the order must leave the warehouse.
shipped_at, delivered_at, cancelled_atstring or nullWhen each of these happened.
total, taxnumber or nullThe order value and its tax, in rupees.
customerobjectname and email.
shipping_addressobject or nullname, phone, address1, address2, city, state, pincode and country.
clientstring or nullThe code of the 3PL client the order belongs to, or null.
linesarrayThe order lines. See the table below.
shipmentsarrayThe order's parcels, in the shape of List shipments. Cancelled parcels are left out.

Each line

FieldTypeDescription
idstringO2M's ID for the line.
sku, titlestringThe item on the line.
quantitynumberUnits ordered.
unit_price, total, taxnumber or nullThe price per unit, the line value and the line's tax, in rupees.
reservednumberUnits held for this line in a warehouse.
backorderednumberUnits no warehouse has yet.
dispatched, delivered, returnednumberUnits that reached each stage.

Errors

StatusCodeMessageWhat to do
422—updated_since must be a date and time, for example 2026-10-02T10:00:00ZCorrect the value.

Every endpoint can also return the common errors: a missing or invalid key, a missing permission, the rate limit, or a temporary failure.