Shipments API

The Shipments API allows you to indicate that you have (partially) fulfilled an order that was created with the Orders API. This implicitly (partially) captures the authorized amount, which will then be settled to your balance.

The word “shipping” is used in the figurative sense here. It can also mean that a service was provided or digital content was delivered.

Refer to the Orders API guide for a step-by-step guide on implementing the Orders API and the Shipments API.

Endpoints

Create shipment

POST/v2/orders/*orderId*/shipments

Create a shipment for a specific order.

Get shipment

GET/v2/orders/*orderId*/shipments/*id*

Retrieve a specific shipment.

Update shipment

PATCH/v2/orders/*orderId*/shipments/*id*

Update a specific shipment.

List shipments

GET/v2/orders/*orderId*/shipments

Retrieve the list of shipments created for a specific order.