API ReferenceDocs
API Reference
Dashboard
These docs are for v2023.01. Click to read the latest docs for v2024.09.

Create a Batch of Shipments

post
https://api.easyship.com/2023-01/batches/shipments

Create a batch of shipments and schedule it for processing.

Required authorization scope: Batch, Shipment

The Batch scope may be unavailable in the list of scopes. Get in touch with your account manager or Easyship Support Team to enable it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
defaults
object

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

shipments
array of objects
length between 1 and 1000
shipments
uuid
uuid
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

boolean

This is automatically validated for US addresses. If specified, validation is bypassed.

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.

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.

string | null
enum
Defaults to DDU

Terms of Sale

Allowed:
insurance
object | null

Insurance

order_data
object

Free-form data related to the eCommerce platform

courier_selection
object
shipping_settings
object
parcels
array of objects
required
length ≥ 1
parcels*
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
product
object
required
integer
Defaults to 1

Item quantity

string
enum

Item currency. ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP).

number

Item customs value, must be greater than 0 unless category is documents.

Responses

Updated 10 months ago

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago