Create a Batch of Shipments

post

https://public-api.easyship.com/2024-09/batches/shipments

Create a batch of shipments and schedule it for processing.

Required authorization scopes: public.batch:write, public.shipment:write and public.label:write if a label(s) will be created during the batch processing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Batch Shipments Create

defaults

object

Default settings for each shipment (can be override on the individual shipment)

shipments

array of objects

length between 1 and 1000

shipments

Shipment

origin_address_id

uuid

sender_address_id

uuid

return_address_id

uuid

destination_address

object

required

metadata

object

Set of key-value pairs that you can attach to a shipment. This can be useful for storing additional information about the object in a structured format

set_as_residential

boolean

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

consignee_tax_id

string

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_reference

string

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

regulatory_identifiers

object

Seller's identifiers for various tax, import and export regulations.

buyer_regulatory_identifiers

object

Buyer's identifiers for various tax, import and export regulations.

incoterms

string | null

enum

Defaults to DDU

Terms of Sale DDP: Seller pays all import duties/taxes. DDU: Buyer pays all import duties/taxes. null: No incoterm specified; defaults to DDU.

Allowed:

insurance

object | null

Insurance

order_data

object

Free-form data related to the eCommerce platform

courier_settings

object

shipping_settings

object

parcels

array of objects

required

length ≥ 1

parcels*

Parcel

total_actual_weight

number

Total weight of the shipment, including the box weight. If you provide the total weight of the shipment, then the weight for items can be optional.

box

object | null

The box dimensions for the shipment. If the box dimensions are provided, then dimensions for items are optional.

items

array of objects

length between 1 and 200

Array of all shipment items

items

Shipment Item based on Product

product

object

required

description

string

≤ 200

Description of the item

hs_code

string

HS Code of the item. Required if category is not provided.

202batch successfully created

422invalid params