Get an order
The order with its buyer, line items and totals.
GET
The order with its buyer, line items and totals.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringFormat
uuidOK
application/json- response
id*stringFormat
uuidstoreId*stringFormat
uuidnumber*stringplacedAt*stringFormat
date-timefinancialStatus*stringValue in
"pending""authorized""partially_paid""paid""partially_refunded""refunded""voided"fulfillmentStatus*stringValue in
"unfulfilled""partially_fulfilled""fulfilled""restocked"cancelled*booleantotal*locale*string|nullstore*adminUrl*stringFormat
uricustomerAdminUrl*|Format
uribuyer*|nullsubtotal*totalDiscounts*totalShipping*totalTax*totalRefunded*sourceName*string|nullisTest*booleancancelledAt*|Format
date-timelineItems*array<>curl -X GET 'https://api.postforge.dev/v1/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c", "number": "string", "placedAt": "2019-08-24T14:15:22Z", "financialStatus": "pending", "fulfillmentStatus": "unfulfilled", "cancelled": true, "total": { "amount": 0, "currency": "str" }, "locale": "string", "store": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "platform": "string" }, "adminUrl": "http://example.com", "customerAdminUrl": "http://example.com", "buyer": { "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a", "name": "string", "email": "string" }, "subtotal": { "amount": 0, "currency": "str" }, "totalDiscounts": { "amount": 0, "currency": "str" }, "totalShipping": { "amount": 0, "currency": "str" }, "totalTax": { "amount": 0, "currency": "str" }, "totalRefunded": { "amount": 0, "currency": "str" }, "sourceName": "string", "isTest": true, "cancelledAt": "2019-08-24T14:15:22Z", "lineItems": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "variantTitle": "string", "sku": "string", "quantity": 0, "unitPrice": { "amount": 0, "currency": "str" }, "totalDiscount": { "amount": 0, "currency": "str" }, "isGiftCard": true } ]}