LettrLabs API
API ReferenceOrders

Initiates the checkout process for a specified order using its unique Order ID

Initiates the checkout process for a specified order using its unique Order ID

View this page as Markdown
POST
/v1/order/{id}/checkout

Initiates the checkout process for a specified order using its unique Order ID

Authorization

ApiKey
X-API-KEY<token>

In: header

Path Parameters

id*integer

The Id of the order to execute checkout and finalize the transaction.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

postageType*string
productionSpeed*string
holdUntilDate*|
autoBill*boolean

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/order/0/checkout" \  -H "Content-Type: application/json" \  -d '{    "postageType": "string",    "productionSpeed": "string",    "holdUntilDate": "2019-08-24T14:15:22Z",    "autoBill": true  }'
{  "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": "string"  },  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "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": "string"  },  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "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": "string"  },  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "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": "string"  },  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "metadata": {    "property1": null,    "property2": null  }}

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.

Deletes an order that is in draft or edits needs status DELETE

Deletes an order that is in draft or edits needs status