API ReferenceOrders
Retrieve all open API orders
Retrieve all open API orders
Retrieve all open API orders
Authorization
ApiKey X-API-KEY<token>
In: header
Query Parameters
id?string
Filter orders by a list of order IDs separated by comma.
status?string
Filter orders by status (e.g., 'Draft', 'Mailed').
paid?boolean
Filter orders by whether they are paid or not.
product?string
Filter orders by product type.
postage?string
Filter orders by postage type.
showRecipients?boolean
Filter whether to return recipient information.
pageNumber?integer
Used for pagination, the page number. Defaults to 0.
pageSize?integer
Used for pagination, the number of records to retrieve. Defaults to 100.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/order"{ "payload": { "orderId": 0, "status": "string", "orders": [ { "id": 0, "status": "string", "paidDate": "2019-08-24T14:15:22Z", "mailedDate": "2019-08-24T14:15:22Z", "holdUntilDate": "2019-08-24T14:15:22Z", "postageType": "string", "productType": "string", "productionSpeed": "string", "handwrittenFont": "string", "qrCodeUrl": "string", "deliveredStatus": { "mailed": 0, "inTransit": 0, "atLocalFacility": 0, "delivered": 0 }, "recipients": [ { "id": 0, "orderId": 0, "firstName": "string", "lastName": "string", "salutation": "string", "toOrganization": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "phoneNumber": "string", "email": "string", "country": "string", "custom1": "string", "custom2": "string", "custom3": "string", "custom4": "string", "custom5": "string", "custom6": "string", "image1": "string", "image2": "string", "image3": "string", "image4": "string", "image5": "string", "image6": "string", "delivery": { "status": "string", "updatedDate": "2019-08-24T14:15:22Z" } } ] } ] }, "errors": [ "string" ], "errorDetails": [ null ], "warnings": [ "string" ], "hasErrors": true, "hasWarnings": true}{ "payload": { "orderId": 0, "status": "string", "orders": [ { "id": 0, "status": "string", "paidDate": "2019-08-24T14:15:22Z", "mailedDate": "2019-08-24T14:15:22Z", "holdUntilDate": "2019-08-24T14:15:22Z", "postageType": "string", "productType": "string", "productionSpeed": "string", "handwrittenFont": "string", "qrCodeUrl": "string", "deliveredStatus": { "mailed": 0, "inTransit": 0, "atLocalFacility": 0, "delivered": 0 }, "recipients": [ { "id": 0, "orderId": 0, "firstName": "string", "lastName": "string", "salutation": "string", "toOrganization": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "phoneNumber": "string", "email": "string", "country": "string", "custom1": "string", "custom2": "string", "custom3": "string", "custom4": "string", "custom5": "string", "custom6": "string", "image1": "string", "image2": "string", "image3": "string", "image4": "string", "image5": "string", "image6": "string", "delivery": { "status": "string", "updatedDate": "2019-08-24T14:15:22Z" } } ] } ] }, "errors": [ "string" ], "errorDetails": [ null ], "warnings": [ "string" ], "hasErrors": true, "hasWarnings": true}{ "payload": { "orderId": 0, "status": "string", "orders": [ { "id": 0, "status": "string", "paidDate": "2019-08-24T14:15:22Z", "mailedDate": "2019-08-24T14:15:22Z", "holdUntilDate": "2019-08-24T14:15:22Z", "postageType": "string", "productType": "string", "productionSpeed": "string", "handwrittenFont": "string", "qrCodeUrl": "string", "deliveredStatus": { "mailed": 0, "inTransit": 0, "atLocalFacility": 0, "delivered": 0 }, "recipients": [ { "id": 0, "orderId": 0, "firstName": "string", "lastName": "string", "salutation": "string", "toOrganization": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "phoneNumber": "string", "email": "string", "country": "string", "custom1": "string", "custom2": "string", "custom3": "string", "custom4": "string", "custom5": "string", "custom6": "string", "image1": "string", "image2": "string", "image3": "string", "image4": "string", "image5": "string", "image6": "string", "delivery": { "status": "string", "updatedDate": "2019-08-24T14:15:22Z" } } ] } ] }, "errors": [ "string" ], "errorDetails": [ null ], "warnings": [ "string" ], "hasErrors": true, "hasWarnings": true}{ "payload": { "orderId": 0, "status": "string", "orders": [ { "id": 0, "status": "string", "paidDate": "2019-08-24T14:15:22Z", "mailedDate": "2019-08-24T14:15:22Z", "holdUntilDate": "2019-08-24T14:15:22Z", "postageType": "string", "productType": "string", "productionSpeed": "string", "handwrittenFont": "string", "qrCodeUrl": "string", "deliveredStatus": { "mailed": 0, "inTransit": 0, "atLocalFacility": 0, "delivered": 0 }, "recipients": [ { "id": 0, "orderId": 0, "firstName": "string", "lastName": "string", "salutation": "string", "toOrganization": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "phoneNumber": "string", "email": "string", "country": "string", "custom1": "string", "custom2": "string", "custom3": "string", "custom4": "string", "custom5": "string", "custom6": "string", "image1": "string", "image2": "string", "image3": "string", "image4": "string", "image5": "string", "image6": "string", "delivery": { "status": "string", "updatedDate": "2019-08-24T14:15:22Z" } } ] } ] }, "errors": [ "string" ], "errorDetails": [ null ], "warnings": [ "string" ], "hasErrors": true, "hasWarnings": true}Retrieve statistics from order ids GET
Retrieve statistics from order ids
Checkout Summary GET
Calculate and retrieves the line item cost, production and estimated delivery details for a specific order for review prior to executing the checkout. This is not required to be called before executing a checkout.