List ingested commerce orders (D2C entitlement required)

GET /commerce/orders

List ingested commerce orders (D2C entitlement required)

cURL

curl --request GET \
  --url https://api.pineyard.ai/commerce/orders \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "externalOrderId": "<string>",
      "orderNumber": "<string>",
      "currency": "<string>",
      "totalPrice": "<string>",
      "financialStatus": "<string>",
      "fulfillmentStatus": "<string>",
      "customerName": "<string>",
      "placedAt": "<string>",
      "attributedToPineyard": true,
      "attributedCampaignId": "<string>",
      "utmSource": "<string>",
      "utmCampaign": "<string>"
    }
  ],
  "total": 123
}

Required scope: sales.view

Requires commerce analytics enabled for your workspace. Otherwise the request is refused; see Errors.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Query Parameters

page · integer · default: 1

Required range: x >= 1

limit · integer · default: 50

Required range: 1 <= x <= 200

attributed · enum<string>

Available options: true, false

Response

200

application/json

OK

items · object[] · required

Show child attributes

total · number · required