Request a shipment

post

https://api.usestable.com/v1/shipments

Requests one or more mail items to be shipped to the given address and recipient. Returns one entry per shipment created.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body required in the request

mailItemIds

array of strings

required

IDs of the mail items to ship. Repeated IDs are treated as a single item.

CreateShipmentsRequestBody.mailItemIds*

recipient

string

required

Name on the shipping label. Person or company name.

phone

string

required

Phone number the carrier can contact about the delivery. Include the
country code for numbers outside the US, such as +44 20 7946 0958; a
number without one is read as a US number.

address

object

required

Destination address for the supplied mail item IDs.

serviceCode

string

required

The shipping method for every shipment this call creates. It must appear
on each shipment's menu in the POST /v1/shipping-methods response for
the same mail items and destination. To use a different method for a
subset of the items, ship that subset in its own call.

Headers

x-api-key

string

required

Responses

200Success

400Bad Request

403Forbidden

404Not Found

409Conflict

500Internal Server Error