API ReferenceDocs
API Reference
Dashboard

Update a Shipment

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

Update shipment details.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Easyship Shipment ID provided when creating the shipment

Body Params
origin_address
object

Origin Address

uuid

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

sender_address
object

Sender Address. Only applies if the courier allows a different address to be displayed on the label. If not specified, the origin address is used by default.

uuid

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

return_address
object

Return Address. If not specified, the origin address is used by default.

uuid

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

destination_address
object
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

US addresses will be automatically validated when not specified. If specified, the validation will be 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.

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
length between 1 and 200

Parcels

parcels

Rate parcel

uuid

ID of the parcel that should be updated

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

A line item in a shipment manifest; may be multiple physical objects.

string
required
≤ 200

Description of the item

string | null
≤ 200

Item category name or slug. Required if hs_code is not provided. Use the Item Categories API to retrieve a list of available item categories.

string

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

string
≤ 100

Item Stock Keeping Unit (SKU) as listed in your store.

string | null

Platform Product ID (PPID). Unique identifier from your store platform (e.g. Shopify variant ID, WooCommerce product ID). Used to link shipment items to product catalog entries for auto-population of product attributes.

string | null

Manufacturer Part Number (MPN). The manufacturer's internal code or part number for the product. Useful for wholesale and B2B operations to identify products by their source.

string | null

Global Trade Item Number (GTIN). Internationally recognized unique identifier for trade items, including UPC (US/Canada), EAN (Europe), JAN (Japan), and ISBN (books). Used by retailers and carriers for product identification and inventory tracking.

boolean | null

Whether the item contains a PI966 battery (applicable when HS code is used).

boolean | null

Whether the item contains a PI967 battery (applicable when HS code is used).

boolean | null

Whether the item contains liquids (applicable when HS code is used).

string | null
enum

Country Code in Alpha-2 format (ISO 3166-1)

integer
Defaults to 1

Item quantity

dimensions
object

Dimensions of the item

number

Item actual weight in kg. Must be greater than 0.
Optional when total_actual_weight is provided.
Required when the shipping rule action split_parcels_by_sku is enabled, regardless of the existence of total_actual_weight

string
enum
required

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

number
required

Item customs value, must be greater than 0 unless category is documents. Please note that this value refers to the unit rather than the total.

cpsc_compliance
object | null

CPSC compliance data to store on this product. All fields are optional -- partial data is accepted and does not block the product from being saved.

Important: fields are scoped to coc_type. Only the fields relevant to the current (or newly submitted) coc_type are ever persisted:

  • registered: certifier_identifier, version_identifier, product_identifier_type
  • unregistered: citation_code, certifier_identity, manufacturing_detail, manufacturing_date, testing_detail, laboratory, records_custodian, product_identifier_type
  • exempted: disclaim_code

Any field outside the resulting coc_type's group is silently cleared to null, whether it was left over from a previous update or submitted in the same request. This happens without an error, so a field you send may come back null in the response if it doesn't match the coc_type you set (or the product's existing coc_type, if you didn't change it). If you are switching coc_type, submit coc_type together with the new path's fields in the same request.

uuid

ID of the item that should be updated

Responses

Updated about 1 month ago

Did this page help you?
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 about 1 month ago

Did this page help you?