latestOpenAPI 3.0.32026-07-26170311887.2 KB

71d737a5fcbf

Shipments

Create a Shipment

Create a new shipment.

Required authorization scope: public.shipment:write and public.label:write if a label is requested during the request.

Select a courier

If you use our Rates API, you can define a courier ID to assign a courier to the shipment using courier_service_id. If you skip courier ID, we will return a list of all possible rates to your new shipment and assign the best value for money courier.

Calculate dimensions and total weight

You can calculate dimensions and total weight of your shipment in three ways:

  • Provide total_actual_weight and box objects for the shipment.
  • Specify actual_weight and dimensions for each item of the items object: in this case, total weight and box size will be calculated automatically.
  • Specify sku for each item of the items object: in this case, actual weight and dimensions for calculations will be taken as set for the product.
post/2024-09/shipments

Request body

origin_address_idstring uuid

ID of origin address. Required if the origin_address object is not provided. If provided, the origin address will be ignored.

sender_address_idstring uuid

ID of sender address. Required if the sender_address object is not provided.

return_address_idstring uuid

ID of return address. Required if the return_address object is not provided.

returnboolean

Set the shipment as a return shipment

metadataMetadata — unresolved $ref
set_as_residentialboolean

US addresses will be automatically validated when not specified. If specified, the validation will be bypassed.

consignee_tax_idstring

The consignee's tax identification number or EIN. This is required for customs clearance when shipping to certain countries, such as China and Brazil.

eei_referencestring

The Electronic Export Identifier (EEI). This is required when shipping goods over USD2500 in value (Applies to US-outbound shipments only).

regulatory_identifiersRegulatoryIdentifiers — unresolved $ref
buyer_regulatory_identifiersBuyerRegulatoryIdentifiers — unresolved $ref
incotermsIncoterms — unresolved $ref
insuranceInsurance — unresolved $ref
order_dataOrderData — unresolved $ref

Response

shipment successfully created