Commerce · Commerce

Get an order

Fetches an order. Works with Shopify and WooCommerce accounts.

GEThttps://api.pozy.ai/v1/commerce/orders/{orderId}

Shopify and WooCommercegetCommerceOrder

Guides: Orders, Commerce & blogs, Products and catalog

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the commerce resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`orderId`required	string

Query parameters

Name	Type	Notes
`accountId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/commerce/orders/6b0cd41b19d2de5d892171eb?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/commerce/orders/6b0cd41b19d2de5d892171eb?accountId=696e0b682d0a31188e7a2ba9", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/commerce/orders/6b0cd41b19d2de5d892171eb",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

orderobject
35 child fields
- idstring
- accountIdstring
- platformstring
  One of shopify, woocommerce.
- numberstring
- statusstring
  One of pending_payment, on_hold, awaiting_fulfillment, partially_fulfilled, in_transit, delivered, completed, cancelled.
- platformStatusstring
- paymentStatusstring
- platformPaymentStatusstring
  Can be null.
- currencystring
- taxesIncludedboolean
- createdAtstring (date-time)
- updatedAtstring (date-time)
- paidAtstring (date-time)
  Can be null.
- cancelledAtstring (date-time)
  Can be null.
- cancelReasonstring
  Can be null.
- subtotalobject
  2 child fields
  amountstringrequired
  currencystringrequired
- discountTotalobject
  2 child fields
  amountstringrequired
  currencystringrequired
- shippingTotalobject
  2 child fields
  amountstringrequired
  currencystringrequired
- taxTotalobject
  2 child fields
  amountstringrequired
  currencystringrequired
- totalobject
  2 child fields
  amountstringrequired
  currencystringrequired
- refundedTotalobject
  2 child fields
  amountstringrequired
  currencystringrequired
- discountCodesarray of string
- paymentMethodsarray of string
- customerobject
  Can be null.
  5 child fields
  idstring
  Can be null.
  emailstring
  Can be null.
  phonestring
  Can be null.
  firstNamestring
  Can be null.
  lastNamestring
  Can be null.
- billingAddressobject
  One of:
  Commerce Address (10 fields)
  firstNamestring
  Can be null.
  lastNamestring
  Can be null.
  companystring
  Can be null.
  phonestring
  Can be null.
  line1string
  Can be null.
  line2string
  Can be null.
  citystring
  Can be null.
  regionstring
  Can be null.
  postalCodestring
  Can be null.
  countryCodestring
  Can be null.
- shippingAddressobject
  One of:
  Commerce Address (10 fields)
  firstNamestring
  Can be null.
  lastNamestring
  Can be null.
  companystring
  Can be null.
  phonestring
  Can be null.
  line1string
  Can be null.
  line2string
  Can be null.
  citystring
  Can be null.
  regionstring
  Can be null.
  postalCodestring
  Can be null.
  countryCodestring
  Can be null.
- buyerNotestring
  Can be null.
- attributionobject
  4 child fields
  readyboolean
  firstVisitobject
  One of:
  Commerce Order Visit (6 fields)
  occurredAtstring (date-time)
  Can be null.
  landingUrlstring
  Can be null.
  referrerUrlstring
  Can be null.
  sourcestring
  Can be null.
  sourceTypestring
  Can be null.
  utmobject
  Can be null.
  5 child fields
  sourcestring
  Can be null.
  mediumstring
  Can be null.
  campaignstring
  Can be null.
  termstring
  Can be null.
  contentstring
  Can be null.
  lastVisitobject
  One of:
  Commerce Order Visit (6 fields)
  occurredAtstring (date-time)
  Can be null.
  landingUrlstring
  Can be null.
  referrerUrlstring
  Can be null.
  sourcestring
  Can be null.
  sourceTypestring
  Can be null.
  utmobject
  Can be null.
  5 child fields
  sourcestring
  Can be null.
  mediumstring
  Can be null.
  campaignstring
  Can be null.
  termstring
  Can be null.
  contentstring
  Can be null.
  customAttributesarray of object
  2 child fields
  keystring
  valuestring
- lineItemsarray of object
  12 child fields
  idstring
  productIdstring
  Can be null.
  variantIdstring
  Can be null.
  skustring
  Can be null.
  titlestring
  variantTitlestring
  Can be null.
  quantityinteger
  unitPriceobject
  2 child fields
  amountstringrequired
  currencystringrequired
  subtotalobject
  2 child fields
  amountstringrequired
  currencystringrequired
  discountTotalobject
  2 child fields
  amountstringrequired
  currencystringrequired
  totalobject
  2 child fields
  amountstringrequired
  currencystringrequired
  taxLinesarray of object
  3 child fields
  titlestring
  ratePercentnumber
  Can be null.
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
- shippingLinesarray of object
  5 child fields
  idstring
  titlestring
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
  discountTotalobject
  2 child fields
  amountstringrequired
  currencystringrequired
  taxLinesarray of object
  3 child fields
  titlestring
  ratePercentnumber
  Can be null.
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
- feeLinesarray of object
  5 child fields
  idstring
  titlestring
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
  discountTotalobject
  2 child fields
  amountstringrequired
  currencystringrequired
  taxLinesarray of object
  3 child fields
  titlestring
  ratePercentnumber
  Can be null.
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
- taxLinesarray of object
  3 child fields
  titlestring
  ratePercentnumber
  Can be null.
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
- refundsarray of object
  5 child fields
  idstring
  createdAtstring (date-time)
  Can be null.
  notestring
  Can be null.
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
  lineItemsarray of object
  3 child fields
  lineItemIdstring
  quantityinteger
  amountobject
  2 child fields
  amountstringrequired
  currencystringrequired
- fulfillmentsarray of object
  3 child fields
  carrierNamestring
  Can be null.
  trackingNumberstring
  Can be null.
  trackingUrlstring
  Can be null.
- platformDataobject
  Can be null.

200 response

{
  "order": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "platform": "shopify",
    "number": "string",
    "status": "pending_payment",
    "platformStatus": "instagram",
    "paymentStatus": "pending",
    "platformPaymentStatus": "instagram",
    "currency": "USD",
    "taxesIncluded": true,
    "createdAt": "2026-10-02T09:00:00.000Z",
    "updatedAt": "2026-10-02T09:00:00.000Z",
    "paidAt": "2026-10-02T09:00:00.000Z",
    "cancelledAt": "2026-10-02T09:00:00.000Z",
    "cancelReason": "string",
    "subtotal": {
      "amount": "string",
      "currency": "USD"
    },
    "discountTotal": {
      "amount": "string",
      "currency": "USD"
    },
    "shippingTotal": {
      "amount": "string",
      "currency": "USD"
    },
    "taxTotal": {
      "amount": "string",
      "currency": "USD"
    },
    "total": {
      "amount": "string",
      "currency": "USD"
    },
    "refundedTotal": {
      "amount": "string",
      "currency": "USD"
    },
    "discountCodes": [
      "string"
    ],
    "paymentMethods": [
      "string"
    ],
    "customer": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "email": "alex@example.com",
      "phone": "+14155550123",
      "firstName": "Acme",
      "lastName": "Acme"
    },
    "billingAddress": {
      "firstName": "Acme",
      "lastName": "Acme",
      "company": "string",
      "phone": "+14155550123",
      "line1": "string",
      "line2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "US"
    },
    "shippingAddress": {
      "firstName": "Acme",
      "lastName": "Acme",
      "company": "string",
      "phone": "+14155550123",
      "line1": "string",
      "line2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "US"
    },
    "buyerNote": "string",
    "attribution": {
      "ready": true,
      "firstVisit": {
        "occurredAt": "2026-10-02T09:00:00.000Z",
        "landingUrl": "https://pozy.ai/media/example-1.jpg",
        "referrerUrl": "https://pozy.ai/media/example-1.jpg",
        "source": "string",
        "sourceType": "string",
        "utm": {
          "source": "string",
          "medium": "string",
          "campaign": "string",
          "term": "string",
          "content": "Hello from Pozy"
        }
      },
      "lastVisit": {
        "occurredAt": "2026-10-02T09:00:00.000Z",
        "landingUrl": "https://pozy.ai/media/example-1.jpg",
        "referrerUrl": "https://pozy.ai/media/example-1.jpg",
        "source": "string",
        "sourceType": "string",
        "utm": {
          "source": "string",
          "medium": "string",
          "campaign": "string",
          "term": "string",
          "content": "Hello from Pozy"
        }
      },
      "customAttributes": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "lineItems": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "productId": "659773d34b353e6821202f21",
        "variantId": "64058b146247283881d19961",
        "sku": "string",
        "title": "Launch day",
        "variantTitle": "string",
        "quantity": 1,
        "unitPrice": {
          "amount": "string",
          "currency": "USD"
        },
        "subtotal": {
          "amount": "string",
          "currency": "USD"
        },
        "discountTotal": {
          "amount": "string",
          "currency": "USD"
        },
        "total": {
          "amount": "string",
          "currency": "USD"
        },
        "taxLines": [
          {
            "title": "Launch day",
            "ratePercent": 12.5,
            "amount": {
              "amount": "string",
              "currency": "USD"
            }
          }
        ]
      }
    ],
    "shippingLines": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "title": "Launch day",
        "amount": {
          "amount": "string",
          "currency": "USD"
        },
        "discountTotal": {
          "amount": "string",
          "currency": "USD"
        },
        "taxLines": [
          {
            "title": "Launch day",
            "ratePercent": 12.5,
            "amount": {
              "amount": "string",
              "currency": "USD"
            }
          }
        ]
      }
    ],
    "feeLines": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "title": "Launch day",
        "amount": {
          "amount": "string",
          "currency": "USD"
        },
        "discountTotal": {
          "amount": "string",
          "currency": "USD"
        },
        "taxLines": [
          {
            "title": "Launch day",
            "ratePercent": 12.5,
            "amount": {
              "amount": "string",
              "currency": "USD"
            }
          }
        ]
      }
    ],
    "taxLines": [
      {
        "title": "Launch day",
        "ratePercent": 12.5,
        "amount": {
          "amount": "string",
          "currency": "USD"
        }
      }
    ],
    "refunds": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "createdAt": "2026-10-02T09:00:00.000Z",
        "note": "string",
        "amount": {
          "amount": "string",
          "currency": "USD"
        },
        "lineItems": [
          {
            "lineItemId": "681b8812378e080e232ba5be",
            "quantity": 1,
            "amount": {
              "amount": "string",
              "currency": "USD"
            }
          }
        ]
      }
    ],
    "fulfillments": [
      {
        "carrierName": "Acme",
        "trackingNumber": "string",
        "trackingUrl": "https://pozy.ai/media/example-1.jpg"
      }
    ],
    "platformData": {}
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Commerce

GETGet a store GETList orders GETList products POSTCreate a product POSTActivate, deactivate, archive or delete products GETGet a product PATCHUpdate a product POSTUpdate variant prices GETList collections POSTCreate a collection GETGet a collection PATCHUpdate a collection DELDelete a collection POSTAdd or remove products in a collection POSTAdd variants DELDelete variants POSTAdd options DELDelete options POSTAdd images DELRemove images POSTReorder images POSTDuplicate a product GETList product metafields PUTSet product metafields DELDelete product metafields POSTPublish or unpublish a product GETList collection metafields PUTSet collection metafields DELDelete collection metafields POSTPublish or unpublish a collection POSTAdd or remove tags in bulk POSTReorder products in a collection GETList pages POSTCreate a page GETGet a page PATCHUpdate a page DELDelete a page GETList locations GETGet a product's stock POSTSet or adjust stock GETList sales channels GETList discounts POSTCreate a discount GETGet a discount PATCHUpdate a discount DELDelete a discount POSTActivate or deactivate a discount POSTAdd codes to a discount GETList URL redirects POSTCreate a URL redirect PATCHUpdate a URL redirect DELDelete a URL redirect GETList navigation menus POSTCreate a navigation menu GETGet a navigation menu PUTReplace a navigation menu DELDelete a navigation menu GETList metaobject definitions GETList metaobjects of a type POSTCreate a metaobject GETGet a metaobject PATCHUpdate a metaobject DELDelete a metaobject GETList markets GETList price lists PUTSet fixed prices DELRemove fixed prices PUTRecord a marketing activity DELDelete a marketing activity POSTReport daily engagement GETList catalog syncs POSTSync a store into a Meta catalog GETGet a catalog sync DELStop a catalog sync POSTRun a catalog sync now