Orders

List orders

Secret key. Permission orders:read. Newest first.

get/orders

Request

  • Base URL: https://sitesplaced.com/api/v1
  • URL: https://sitesplaced.com/api/v1/orders
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Query parameters

limitinteger

Page size, 1 to 100.

cursorstring

The next_cursor from the page before.

status'pending' | 'confirmed' | 'shipped' | 'out_for_delivery' | 'completed' | 'cancelled'

completed means delivered.

source'native' | 'woocommerce' | 'shopify' | 'api'

native is the SitesPlaced checkout.

external_idstring

The order's id on the other platform.

updated_sincestring date-time

ISO 8601, in UTC.

created_sincestring date-time

ISO 8601, in UTC.

include_archived'true'

Send true to also return archived orders.

Response

A page of orders.

has_moreboolean required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "external_status": "processing",
      "currency": "INR",
      "risk": {
        "flags": [
          {
            "code": "bad_phone"
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.