Skip to main content

​
Overview

This endpoint can be used to create a checkout session for a list of shipments. Endpoint: /api/v1/checkout Method: GET
A maximum of 10 shipments can be included in a single checkout session.
It is critical that you verify the fulfillment and destination addresses for each shipment.Failure to verify the addresses may result in loss or delayed shipments.You may also be charged should address correction be necessary by the carrier.
Your organization requires a stored payment method in order to process a checkout session.

​
Request

​
shipments
array
required
An array of up to 10 shipment IDs to be included in the checkout session.

​
Response (200)

If the checkout session was successfully created, the API will return a 200 OK status code. The response will contain the following content:
​
shipments
array
required
An array of integers showing the price of each shipment included in the checkout session.Each shipment ID is mapped to its price. For example, 125: 4500 means that a shipment with ID 125 has a price of 4500.Prices are displayed in U.S. cents. For example, a price of 4500 is equal to 4500 cents ($45.00 U.S. dollars).
​
total
integer
required
The total price of all shipments included in the checkout session.The total is displayed in U.S. cents. For example, a total of 17500 is equal to 17500 cents ($175.00 U.S. dollars).

​
Response (500)

If the checkout session was not successfully created, the API will return a 500 Server Error status code. The response will contain the following content:
​
status
integer
required
A Checkout Session Status enum representing the status of the checkout session.
​
message
string
required
A human-readable message explaining the error.
{
    "shipments": [
        125,
        126,
        127
    ]
}

{
    "shipments": [
        125: 4500,
        126: 6000,
        127: 7000,
    ],
    "total": 17500
}