OrbisCommerce Developers

API reference

Create a shipment

Picks the best service for an order and creates its label.

POST/v1/shipments

Request body

Field Type Description
order_id string The order number on the marketplace
service string A service code, or cheapest
ship_to.country string ISO country code, e.g. DE
parcel.weight_kg number Parcel weight in kg
customs.incoterm string DDP or DDU

Example

curl https://api.orbiscommerce.com/v1/shipments \
  -H "Authorization: Bearer $ORBISCOMMERCE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "ETSY-3108842",
    "service": "cheapest",
    "ship_to": { "country": "DE", "postal_code": "10115" },
    "parcel": { "weight_kg": 0.8 },
    "customs": { "incoterm": "DDP", "hs_code": "6109.10" }
  }'

Response

201 Created
{
  "id": "shp_01J9...",
  "status": "label_created",
  "tracking_number": "...",
  "label_url": "https://..."
}
Edit this page on GitHub (opens in a new tab)