List orders
Orders of the workspace’s stores, newest first. A Shopify app session sees its own store only.
GET
Orders of the workspace’s stores, newest first. A Shopify app session sees its own store only.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
page?integerStarts at 1
Range
1 <= valueDefault
1pageSize?numberOne of 10, 25, 50, 100
Default
25q?stringSearch
Length
1 <= length <= 200store?stringComma-separated ids
payment?stringComma-separated, any of: pending, authorized, partially_paid, paid, partially_refunded, refunded, voided
fulfillment?stringComma-separated, any of: unfulfilled, partially_fulfilled, fulfilled, restocked
profile?stringOnly orders of this profile
Format
uuidproduct?stringOnly orders that include this product
Format
uuidplacedFrom?stringPlaced from (inclusive)
Format
date-timeplacedTo?stringPlaced until (exclusive)
Format
date-timesort?stringOne of placedAt, total; prefix with - for descending
Default
"-placedAt"Value in
"placedAt""-placedAt""total""-total"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integerall*integercurl -X GET 'https://api.postforge.dev/v1/orders'{ "items": [ { "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" } ], "total": 0, "page": 0, "pageSize": 0, "all": 0}