LettrLabs API
API ReferenceOrders

Checkout Summary

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.

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

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.

Authorization

ApiKey
X-API-KEY<token>

In: header

Path Parameters

id*integer

The Id of the order to calculate checkout details.

Query Parameters

postage?string

The type of postage for the order. Available values: Standard, FirstClass.

production?string

The speed of production for the order. Available values: Normal, ExpeditedFaster, ExpeditedFastest.

holdUntilDate?string

The date to hold order production until. This date must be further in the future than the normal estimated production completion date.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/order/0/checkout"
{  "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",    "lineItems": [      {        "tax": 0.1,        "name": "string",        "quantity": 0,        "rate": 0.1,        "total": 0.1,        "transactionType": "string",        "transactionSubType": "string",        "subItems": [          {            "tax": 0.1,            "name": "string",            "quantity": 0,            "rate": 0.1,            "total": 0.1,            "transactionType": "string",            "transactionSubType": "string",            "subItems": []          }        ]      }    ],    "credits": [      {        "tax": 0.1,        "name": "string",        "quantity": 0,        "rate": 0.1,        "total": 0.1,        "transactionType": "string",        "transactionSubType": "string",        "subItems": [          {            "tax": 0.1,            "name": "string",            "quantity": 0,            "rate": 0.1,            "total": 0.1,            "transactionType": "string",            "transactionSubType": "string",            "subItems": []          }        ]      }    ],    "totalCharges": 0.1,    "totalTax": 0.1,    "totalCredits": 0.1,    "balance": 0.1,    "productionSpeeds": {      "Normal": "2019-08-24T14:15:22Z",      "ExpeditedFaster": "2019-08-24T14:15:22Z",      "ExpeditedFastest": "2019-08-24T14:15:22Z",      "HailTrace": "2019-08-24T14:15:22Z"    },    "productionSpeedPrices": {      "property1": 0.1,      "property2": 0.1    },    "postageTypePrices": {      "property1": 0.1,      "property2": 0.1    },    "estimatedDeliveryDateMin": "2019-08-24T14:15:22Z",    "estimatedDeliveryDateMax": "2019-08-24T14:15:22Z"  },  "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",    "lineItems": [      {        "tax": 0.1,        "name": "string",        "quantity": 0,        "rate": 0.1,        "total": 0.1,        "transactionType": "string",        "transactionSubType": "string",        "subItems": [          {            "tax": 0.1,            "name": "string",            "quantity": 0,            "rate": 0.1,            "total": 0.1,            "transactionType": "string",            "transactionSubType": "string",            "subItems": []          }        ]      }    ],    "credits": [      {        "tax": 0.1,        "name": "string",        "quantity": 0,        "rate": 0.1,        "total": 0.1,        "transactionType": "string",        "transactionSubType": "string",        "subItems": [          {            "tax": 0.1,            "name": "string",            "quantity": 0,            "rate": 0.1,            "total": 0.1,            "transactionType": "string",            "transactionSubType": "string",            "subItems": []          }        ]      }    ],    "totalCharges": 0.1,    "totalTax": 0.1,    "totalCredits": 0.1,    "balance": 0.1,    "productionSpeeds": {      "Normal": "2019-08-24T14:15:22Z",      "ExpeditedFaster": "2019-08-24T14:15:22Z",      "ExpeditedFastest": "2019-08-24T14:15:22Z",      "HailTrace": "2019-08-24T14:15:22Z"    },    "productionSpeedPrices": {      "property1": 0.1,      "property2": 0.1    },    "postageTypePrices": {      "property1": 0.1,      "property2": 0.1    },    "estimatedDeliveryDateMin": "2019-08-24T14:15:22Z",    "estimatedDeliveryDateMax": "2019-08-24T14:15:22Z"  },  "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",    "lineItems": [      {        "tax": 0.1,        "name": "string",        "quantity": 0,        "rate": 0.1,        "total": 0.1,        "transactionType": "string",        "transactionSubType": "string",        "subItems": [          {            "tax": 0.1,            "name": "string",            "quantity": 0,            "rate": 0.1,            "total": 0.1,            "transactionType": "string",            "transactionSubType": "string",            "subItems": []          }        ]      }    ],    "credits": [      {        "tax": 0.1,        "name": "string",        "quantity": 0,        "rate": 0.1,        "total": 0.1,        "transactionType": "string",        "transactionSubType": "string",        "subItems": [          {            "tax": 0.1,            "name": "string",            "quantity": 0,            "rate": 0.1,            "total": 0.1,            "transactionType": "string",            "transactionSubType": "string",            "subItems": []          }        ]      }    ],    "totalCharges": 0.1,    "totalTax": 0.1,    "totalCredits": 0.1,    "balance": 0.1,    "productionSpeeds": {      "Normal": "2019-08-24T14:15:22Z",      "ExpeditedFaster": "2019-08-24T14:15:22Z",      "ExpeditedFastest": "2019-08-24T14:15:22Z",      "HailTrace": "2019-08-24T14:15:22Z"    },    "productionSpeedPrices": {      "property1": 0.1,      "property2": 0.1    },    "postageTypePrices": {      "property1": 0.1,      "property2": 0.1    },    "estimatedDeliveryDateMin": "2019-08-24T14:15:22Z",    "estimatedDeliveryDateMax": "2019-08-24T14:15:22Z"  },  "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",    "lineItems": [      {        "tax": 0.1,        "name": "string",        "quantity": 0,        "rate": 0.1,        "total": 0.1,        "transactionType": "string",        "transactionSubType": "string",        "subItems": [          {            "tax": 0.1,            "name": "string",            "quantity": 0,            "rate": 0.1,            "total": 0.1,            "transactionType": "string",            "transactionSubType": "string",            "subItems": []          }        ]      }    ],    "credits": [      {        "tax": 0.1,        "name": "string",        "quantity": 0,        "rate": 0.1,        "total": 0.1,        "transactionType": "string",        "transactionSubType": "string",        "subItems": [          {            "tax": 0.1,            "name": "string",            "quantity": 0,            "rate": 0.1,            "total": 0.1,            "transactionType": "string",            "transactionSubType": "string",            "subItems": []          }        ]      }    ],    "totalCharges": 0.1,    "totalTax": 0.1,    "totalCredits": 0.1,    "balance": 0.1,    "productionSpeeds": {      "Normal": "2019-08-24T14:15:22Z",      "ExpeditedFaster": "2019-08-24T14:15:22Z",      "ExpeditedFastest": "2019-08-24T14:15:22Z",      "HailTrace": "2019-08-24T14:15:22Z"    },    "productionSpeedPrices": {      "property1": 0.1,      "property2": 0.1    },    "postageTypePrices": {      "property1": 0.1,      "property2": 0.1    },    "estimatedDeliveryDateMin": "2019-08-24T14:15:22Z",    "estimatedDeliveryDateMax": "2019-08-24T14:15:22Z"  },  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "metadata": {    "property1": null,    "property2": null  }}

Retrieve all open API orders GET

Retrieve all open API orders

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

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