LettrLabs API
API ReferenceOrders

List orders

Returns the account's orders with their status, product, postage, and delivery progress. Supports the id, status, paid, product, postage, and showRecipients filters, plus pageNumber/pageSize pagination.

View this page as Markdown
GET
/v1/order

Returns the account's orders with their status, product, postage, and delivery progress. Supports the id, status, paid, product, postage, and showRecipients filters, plus pageNumber/pageSize pagination.

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

Tri-state filter on payment state: omit the parameter to return orders regardless of payment state, true for paid orders only, false for unpaid orders only. Any other value is rejected with a 400.

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"
{  "profile": {    "id": 0,    "aadId": "1cbad290-069a-4527-be23-a0c144b5302d",    "email": "string",    "firstName": "string",    "lastName": "string",    "company": "string",    "created": "2019-08-24T14:15:22Z",    "shouldProcessQrCodes": true  },  "payload": {    "orderId": 0,    "status": "Success",    "orders": [      {        "id": 0,        "status": "Draft",        "paidDate": "2019-08-24T14:15:22Z",        "mailedDate": "2019-08-24T14:15:22Z",        "holdUntilDate": "2019-08-24T14:15:22Z",        "postageType": "Standard",        "productType": "string",        "productionSpeed": "Normal",        "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": "Waiting on USPS Info",              "updatedDate": "2019-08-24T14:15:22Z"            }          }        ]      }    ]  },  "errorCode": "UNAUTHENTICATED",  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "errorDetails": [    null  ],  "metadata": {    "property1": null,    "property2": null  }}
{  "profile": {    "id": 0,    "aadId": "1cbad290-069a-4527-be23-a0c144b5302d",    "email": "string",    "firstName": "string",    "lastName": "string",    "company": "string",    "created": "2019-08-24T14:15:22Z",    "shouldProcessQrCodes": true  },  "payload": {    "orderId": 0,    "status": "Success",    "orders": [      {        "id": 0,        "status": "Draft",        "paidDate": "2019-08-24T14:15:22Z",        "mailedDate": "2019-08-24T14:15:22Z",        "holdUntilDate": "2019-08-24T14:15:22Z",        "postageType": "Standard",        "productType": "string",        "productionSpeed": "Normal",        "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": "Waiting on USPS Info",              "updatedDate": "2019-08-24T14:15:22Z"            }          }        ]      }    ]  },  "errorCode": "UNAUTHENTICATED",  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "errorDetails": [    null  ],  "metadata": {    "property1": null,    "property2": null  }}
{  "profile": {    "id": 0,    "aadId": "1cbad290-069a-4527-be23-a0c144b5302d",    "email": "string",    "firstName": "string",    "lastName": "string",    "company": "string",    "created": "2019-08-24T14:15:22Z",    "shouldProcessQrCodes": true  },  "payload": {    "orderId": 0,    "status": "Success",    "orders": [      {        "id": 0,        "status": "Draft",        "paidDate": "2019-08-24T14:15:22Z",        "mailedDate": "2019-08-24T14:15:22Z",        "holdUntilDate": "2019-08-24T14:15:22Z",        "postageType": "Standard",        "productType": "string",        "productionSpeed": "Normal",        "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": "Waiting on USPS Info",              "updatedDate": "2019-08-24T14:15:22Z"            }          }        ]      }    ]  },  "errorCode": "UNAUTHENTICATED",  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "errorDetails": [    null  ],  "metadata": {    "property1": null,    "property2": null  }}
Empty
{  "profile": {    "id": 0,    "aadId": "1cbad290-069a-4527-be23-a0c144b5302d",    "email": "string",    "firstName": "string",    "lastName": "string",    "company": "string",    "created": "2019-08-24T14:15:22Z",    "shouldProcessQrCodes": true  },  "payload": {    "orderId": 0,    "status": "Success",    "orders": [      {        "id": 0,        "status": "Draft",        "paidDate": "2019-08-24T14:15:22Z",        "mailedDate": "2019-08-24T14:15:22Z",        "holdUntilDate": "2019-08-24T14:15:22Z",        "postageType": "Standard",        "productType": "string",        "productionSpeed": "Normal",        "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": "Waiting on USPS Info",              "updatedDate": "2019-08-24T14:15:22Z"            }          }        ]      }    ]  },  "errorCode": "UNAUTHENTICATED",  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "errorDetails": [    null  ],  "metadata": {    "property1": null,    "property2": null  }}

Retrieve order analytics GET

Returns engagement statistics — including per-recipient QR code scans — for the orders named in the Id query parameter (a comma-separated list of order IDs). Orders that cannot be processed are reported per-order with an error status rather than failing the whole request.

Preview an order checkout GET

Calculates the line-item cost, production, and estimated delivery details for an order so they can be reviewed before checking out. This preview is side-effect-free: it does not modify the order and does not create a payment intent. Calling this endpoint is not required before executing a checkout. Pass `autoBill=false` to preview the checkout under the payment-method opt-out: if the available account balance does not cover the order in full the preview is rejected with HTTP 402 Payment Required and error code INSUFFICIENT_BALANCE — the exact rejection the checkout execute verb returns for the same order — so a preview and an execute agree on whether the order can proceed. The preview remains side-effect-free even when rejected.