Object Reference

Addon

Describes an additional service provided by shipping method.

code 🔗	string External code, as defined in carrier's system
data 🔗	hash Additional data that has to be passed to use the addon
description 🔗	string Description of the addon
name 🔗	string Internal identifier of an addon

AddParcelRequest

parcel 🔗	ParcelDetails optional Parcel details contains information about the parcel. If not provided the first existing parcel will be duplicated.
shipment_id 🔗	string
site_id 🔗	string

Address

Common address entity that used almost everywhere in Ingrid's API.

address_lines 🔗	string[] List of address lines part of address such as street and building number
apartment_number 🔗	string Number of the apartment
attn 🔗	string optional Attention field. Can be used to indicate an employee if the address is a company address
building_name 🔗	string in the UK some buildings do not have a number, only a name
care_of 🔗	string optional Care of part of address usually written as `c/o`
city 🔗	string Name of the city
coordinates 🔗	Coordinates Geolocation coordinates of the address. If reverse geolocation lookup of the address was successful this property will be populated. If coordinates are available they will be used to in service point search. In case of `search_address` coordinates can also be set by merchant if known
country 🔗	string Country should be specified as two uppercase letters (ISO Alpha-2). Example `SE` for Sweden, `ES` for Spain
door_code 🔗	string optional The door code to the main entrance of the building if applicable
floor_number 🔗	string optional Floor number
name 🔗	string Customer or company name
po_box_id 🔗	string optional ID of the PO Box
postal_code 🔗	string Postal code (or zipcode in US)
region 🔗	string optional Region can be a state or a province
street 🔗	string Name of the street
street_number 🔗	string Number of the street
subregion 🔗	string optional Further division of regions. Example countries are GB, IE, IT, LT, MX For example for The Republic Of Ireland there are 4 provinces (regions), e.g. `Connacht` and 26 counties (subregions), e.g. `Galway` Format is ISO 3166 where applicable, exceptions are e.g. Mexico

Any

type_url 🔗	string
value 🔗	string

BatchGetConsolidatedShipmentResponse

consolidated_shipments 🔗

ConsolidatedShipment[]

BookConsolidatedShipmentRequest

consolidated_shipment_id 🔗	string required Consolidated Shipment ID that is to be booked
customs_declaration 🔗	CustomsDeclaration Holds information about customs declaration for the consolidated shipment
meta 🔗	hash optional Shipment metadata tags. Any new ones will be added
pallets 🔗	Pallet[] required Pallets included in the shipment. The length of the array corresponds to the number of pallets

BookConsolidatedShipmentResponse

consolidated_shipment 🔗

ConsolidatedShipment

BookingMethod

carrier 🔗	string
custom 🔗	boolean
delivery_types 🔗	DeliveryType[] - UNKNOWN: Delivery type is not known for some reason. DELIVERY: Home delivery. PICKUP: Delivery to a service point or a locker. MAILBOX: Delivery to customer's mailbox. INSTORE: Delivery to one of the merchants stores. INWAREHOUSE: Delivery to the warehouse. This type is used with chain delivery in warehouse-warehouse-delivery/pickup
id 🔗	string
name 🔗	string
parcel_type 🔗	ParcelType - NONE: None indicates that parcels are not available for shipping method. Can be UNKNOWN, DELIVERY, PICKUP, MAILBOX, INSTORE, INWAREHOUSE

BookingRecord

Represents a delivery that is or has to be booked.

executed_at 🔗	string
ftp_name 🔗	string
id 🔗	string
site_id 🔗	string
strategy 🔗	Strategy
tracking_number 🔗	string
url 🔗	string

BookParcelsBulkRequest

shipment_ids 🔗

string[] required

The IDs of the shipments which parcels should be booked

BookParcelsBulkResponse

failed_shipment_ids 🔗	string[] The IDs of the shipments which parcels failed to book
succeeded_shipment_ids 🔗	string[] The IDs of the shipments which parcels successfully booked

BookParcelsRequest

Perform a booking request to generate tracking numbers, shipping labels and tracking links.

shipment_id 🔗

string required

The ID of the shipment which parcels should be booked.

BookParcelsResponse

Returns latest shipment state together with generated shipping labels, tracking numbers and tracking links.

shipment 🔗

Shipment

Current shipment object state

BookPickupRequest

Book a pickup with the shipping company.

tracking_number 🔗

string required

Tracking number of the delivery which should be booked.

BookPickupResponse

Returns the state of the booked delivery.

delivery 🔗

Delivery

Booked delivery state

CancelDeliveryRequest

Request to cancel a delivery if the shipment has not been picked up yet.

id 🔗	string Delivery ID
tracking_number 🔗	string Delivery tracking number

CancelShipmentRequest

Request to cancel a shipment if the shipment has not been picked up yet.

shipment_id 🔗

string

Shipment ID

ConsolidatedShipment

carrier_contract_id 🔗	string optional ID of the carrier contract to be used for booking
created_at 🔗	string [output] Status of the consolidated shipment. Status status = 14; [output] Timestamp when consolidated shipment was created. RFC-3339 format
customs_declaration 🔗	CustomsDeclaration Holds information about customs declaration for the consolidated shipment
documents 🔗	ConsolidatedShipmentDocuments[] [output] URL of the consolidated shipment's documents
external_id 🔗	string optional External ID of the shipment. Can be used to store a unique identifier from the merchant
from 🔗	Party required Address where the shipment will be dispatched from. Most often the address of the warehouse
id 🔗	string [output] ID of the shipment (uuid)
meta 🔗	hash optional Shipment metadata tags
pallets 🔗	Pallet[] required Pallets included in the shipment. The length of the array corresponds to the number of pallets. Must include at least one pallet
shipment_ids 🔗	string[] [output] IDs of the shipments that are part of the consolidated shipment. Shipments are added when booking them
shipping_date 🔗	string required Date when the shipment will most likely be dispatched from the warehouse. RFC-3339 format
shipping_method 🔗	string required Shipping method for the consolidated shipment
site_id 🔗	string [output] Site ID to which the shipment belongs to
to 🔗	Party required Destination address. For example address of the distribution center of the carrier
tracking_number 🔗	string [output] Tracking number for the consolidated shipment
updated_at 🔗	string [output] Timestamp when consolidated shipment was last updated. RFC-3339 format

ConsolidatedShipmentDetails

ConsolidatedShipmentDetails contains the details of a Consolidated Shipment that this shipment can be a part of.

consolidated_shipment_id 🔗

string required

ID of the consolidated shipment that this shipment is part of

ConsolidatedShipmentDocuments

id 🔗	string Id of the document. Might be useful for returning CMR/Waybill number
name 🔗	string Name of the document
type 🔗	ConsolidatedShipmentDocumentsDocumentType Type of the document
url 🔗	string The url that points to the document

ConsolidatedShipmentDocumentsDocumentType

Enum Values:

DOCUMENT_UNKNOWN
INVOICE
CMR
TRANSPORT_LABEL

Contents contains all goods sent in a Shipment or Parcel. Goods can either be defined directly by providing the full details of the goods, it can be referenced by transport order id or an external reference to goods defined by an external system.

description 🔗	string optional Description of the contents.
external_orders 🔗	ExternalOrderContentItem[] External orders contained in this shipment
goods 🔗	LineItem[] Goods a.k.a. line items
transport_orders 🔗	TransportOrderContentItem[] Transport orders contained in this shipment, so called consolidated shipment

ContentsType

Enum Values:

UNKNOWN
DOCUMENTS
GIFT
COMMERCIAL_SAMPLE
SALE
RETURN
OTHER
DANGEROUS_GOODS
HUMANITARIAN_DONATIONS

Coordinates

Geolocation coordinates

lat 🔗	number Latitude
lng 🔗	number Longitude

CountPendingShipmentsRequest

filtering 🔗

FilteringPendingShipments

CountPendingShipmentsResponse

total_count 🔗

string

CreateCompositeShipmentFromOrderRequest

Request object that is used to create a Shipment from order.

addons 🔗	Addon[] List of addons
address_return 🔗	Address optional Address where deliveries of this shipment should be returned to. A default return address is taken from the sender address ("address_from") which is usually the address of the warehouse
carrier_contract_id 🔗	string optional ID of the carrier contract to be used for booking.
contents 🔗	Contents Contents of the shipment
courier_instructions 🔗	string Optional instructions to the courier
customs_declaration 🔗	CustomsDeclaration Must be fully specified in case customs declaration should be generated for shipment
delivery_time 🔗	DateTimeRange Time range when the deliveries will most likely be delivered to the customer
external_id 🔗	string Can be used to store a unique identifier from the merchant. For example external order ID or external shipment ID
meta 🔗	hash Generic key-value object that can be used to attach additional information to the shipment
number_of_parcels 🔗	string Number of parcels to generate. If supplied it will override the number of parcels created for this shipment. Otherwise the number of parcels will default to one
parcel_free_text 🔗	string ParcelFreeText is a custom description to be assigned to all parcels in the shipment
shipping_date 🔗	string required The date that the shipment will most likely be dispatched from the warehouse.
shipping_method 🔗	string Specific shipping product ID by which the generated parcels should be delivered. If tos_id is provided and the referenced order has field metadata.session.method, this field is optional. Otherwise, it is required
tos_id 🔗	string required TosId is an order ID as given from TOS.

CreateCompositeShipmentFromRequest

Request object that is used to create a Shipment from another source, for example via a COS session.

address_return 🔗	Address optional Address where deliveries of this shipment should be returned to. A default return address is taken from the sender address ("address_from") which is usually the address of the warehouse
carrier_contract_id 🔗	string optional ID of the carrier contract to be used for booking.
cos_session_id 🔗	string required CosSessionId a session id as given from COS.
customs_declaration 🔗	CustomsDeclaration Must be fully specified in case customs declaration should be generated for shipment
number_of_parcels 🔗	string Number of parcels to generate. If supplied it will override the number of parcels created for this shipment. Otherwise the number of parcels will default to one
parcel_free_text 🔗	string ParcelFreeText is a custom description to be assigned to all parcels in the shipment. Cannot be used together with parcels.free_text
parcels 🔗	ParcelDetails[] If the parcels element is provided the number_of_parcels field should be set to the length of the parcels array or when number_of_parcel value is skipped the number_of_parcel will be calculated based on parcels array length
shipping_date 🔗	string required The date that the shipment will most likely be dispatched from the warehouse.

CreateCompositeShipmentRequest

Request object that is used to create a Shipment together with Parcels and Deliveries all at once.

addons 🔗	Addon[] Addons that should be used for the shipment
address_from 🔗	Address required Address where the shipment will be dispatched from. Most often the address of the warehouse.
address_from_location_ref 🔗	string ID of the warehouse, from which package will be delivered
address_return 🔗	Address optional Address where deliveries of this shipment should be returned to. A default return address is taken from the sender address ("address_from") which is usually the address of the warehouse
address_to 🔗	Address required Destination address. For example address of the service point or the click and collect store.
carrier_contract_id 🔗	string optional ID of the carrier contract to be used for booking.
consolidated_shipment 🔗	ConsolidatedShipmentDetails optional Info on the Consolidated shipment that this shipment is part of
contents 🔗	Contents Contents of shipment. Can be of different types - goods, transport orders and external orders. Either contents has to be provided on the shipment or on each parcel, but not both
courier_instructions 🔗	string Optional instructions to the courier
customer_info 🔗	CustomerInfo Contains the customer information such as name, email, phone and address. This field can be omitted, only if tos_id is not empty and the referenced order has enough data to derive customer info from it
customs_declaration 🔗	CustomsDeclaration Must be fully specified in case customs declaration should be generated for shipment
delivery_time 🔗	DateTimeRange Time range when the deliveries will most likely be delivered to the customer
dimensions 🔗	Dimensions deprecated Dimensions will override the dimensions for each created parcel. Unit is millimeters (mm)
direction_type 🔗	DirectionType optional DirectionType informs about initial shipment direction.
external_id 🔗	string Can be used to store a unique identifier from the merchant. For example external order ID or external shipment ID
line_items 🔗	LineItem[] deprecated Use `contents` instead
location_ref 🔗	string ID of the pickup location where the parcels should be delivered to
location_type 🔗	PickupLocationType optional Indicates the kind of pickup location
meta 🔗	hash Generic key-value object that can be used to attach additional information to the shipment
number_of_parcels 🔗	string Number of parcels to generate if parcel details is not provided. Defaults to 1 if not set. If parcel details is used then this should not be set
outbound_shipment_id 🔗	string optional ID of the OUTBOUND shipment (delivered from merchant to customer). Must be used only for the return shipment creation (with direction_type = "RETURN").
parcel_free_text 🔗	string Custom description (notes) that will be assigned to all parcels in the shipment. Cannot be used together with parcels.free_text
parcels 🔗	ParcelDetails[] If provided, the number_of_parcels field should be set to the length of the parcels array or if number_of_parcel is not set it will be calculated based on parcels array length
pending_shipment_id 🔗	string ID of the pending shipment that this shipment is based on
shipment_value 🔗	string Total value of the shipment including tax. Example 10000 is 100 SEK
shipping_category_ref 🔗	string ID of shipping category that user choice belongs to. It's used to resolve virtual methods connected with ship. category
shipping_date 🔗	string required The date that the shipment will most likely be dispatched from the warehouse.
shipping_method 🔗	string required Specific shipping product ID by which the generated parcels should be delivered.
tos_id 🔗	string optional Order ID from TOS. If provided, shipment details from the TOS will be used to populate fields not set in the request. Fields provided in the request will override fields from the TOS
weight 🔗	string Weight in grams (g). If using parcels instead of number_of_parcels, prefer to set weight individually on each parcel. If not set, the weight will be calculated as the sum of the weights of the Contents.Goods (if available)

CreateCompositeShipmentResponse

Response from the shipment create call. Contains the latest shipment state.

shipment 🔗

Shipment

Current shipment object state

CustomBookingMethod

addresses 🔗	CustomBookingMethodAddresses
booking_method 🔗	string
carrier 🔗	string Carrier full name
id 🔗	string
method 🔗	string
name 🔗	string Name of the shipping product
return_booking 🔗	CustomBookingMethodReturnBooking
status 🔗	BookingMethodStatus
steps 🔗	CustomBookingMethodStep[]

CustomBookingMethodAddresses

return 🔗

Address

CustomBookingMethodReturnBooking

label_consolidation 🔗	boolean
method 🔗	string
use_address_from_as_return 🔗	boolean

CustomBookingMethodStep

actions 🔗	StepExpression[]
filters 🔗	StepExpression[]
name 🔗	string

CustomBookingMethodTestRunLog

custom_booking_methods 🔗	hash
steps 🔗	StepLog[]

CustomBookingsMethodTestRun

errors 🔗	string Errors produced during preparation of the shipment, or during the CBM engine execution
input_hash 🔗	string The hash of the input shipment. Acknowledges that the input shipment has been received
input_shipment 🔗	CreateCompositeShipmentRequest
output_shipment 🔗	CreateCompositeShipmentRequest
run_logs 🔗	CustomBookingMethodTestRunLog

CustomerInfo

Contains the necessary information about a customer in order to make a delivery

address 🔗	Address Customer's home address
email 🔗	string Customer's email
national_identification_number 🔗	string Customer's national identification number, eg. SSN
phone 🔗	string Customer's mobile phone number

Customs

declaration 🔗	CustomsDeclaration Customs declaration provided in request
document 🔗	CustomsDeclarationDocument Customs declaration document available after booking the parcel with customs declaration request

CustomsDeclaration

cn22 🔗	DeclarationCN deprecated Use GeneralCustomsDeclaration instead.
cn23 🔗	DeclarationCN deprecated Use GeneralCustomsDeclaration instead.
cp72 🔗	DeclarationCN deprecated Use GeneralCustomsDeclaration instead.
electronic_invoice_fedex 🔗	ElectronicInvoiceFedex deprecated Use GeneralCustomsDeclaration instead.
electronic_invoice_lotte 🔗	ElectronicInvoiceLotte deprecated Use GeneralCustomsDeclaration instead.
electronic_invoice_ups 🔗	ElectronicInvoiceUPS deprecated Use GeneralCustomsDeclaration instead.
general_customs_declaration 🔗	GeneralCustomsDeclaration

CustomsDeclarationDocument

format 🔗	string File format (ex. "pdf", "png")
type 🔗	CustomsDeclarationDocumentType
url 🔗	string The url where the declaration label is located

CustomsDeclarationDocumentType

Enum Values:

TYPE_UNKNOWN
TYPE_CN22
TYPE_CN23
TYPE_CP72
TYPE_ELECTRONIC_INVOICE_UPS
TYPE_ELECTRONIC_INVOICE_LOTTE
TYPE_ELECTRONIC_INVOICE_FEDEX
TYPE_ELECTRONIC_INVOICE

DateTimeRange

Provides a date interval. Depending on a case, `start` and `end` parts are not guaranteed to be present.

end 🔗	string End of the interval. Date is returned in RFC3339 format. Example `2018-09-08T22:47:31Z`
start 🔗	string Start of the interval. Date is returned in RFC3339 format. Example `2018-09-08T22:47:31Z`

DeclarationCN

contents_explanation 🔗	string Contents explanation - short general description
contents_type 🔗	ContentsType Content type of goods inside the parcel. For example - Sale, Gift etc. See ContentsType reference for details
currency 🔗	string Purchase currency
eori_number 🔗	string EORI number for imports/exports from UK
items 🔗	DeclarationCNItem[] List of items packed inside parcel
total_gross_weight 🔗	integer Total gross weight is parcel weight in grams (including packaging)

DeclarationCNItem

country_of_origin 🔗	string Country of origin - country were this item were produced
description 🔗	string General description of this item
hs_tariff_number 🔗	string Harmonized System tariff number
quantity 🔗	integer Quantity of this item
total_net_weight 🔗	integer Total net weight of the item in grams (for the whole quantity)
total_value 🔗	integer Total value of this item (for the whole quantity). Only integer values are supported and because of that provided value should always be in smallest currency unit possible (fractional monetary unit) For example, 25.99 USD should be converted to 2599

DeleteDraftCustomBookingMethodRequest

id 🔗

string

Delivery

Delivery is the parcel with start and end destination. A delivery always has one parcel that it belongs to.

addons 🔗	Addon[] Addons available for the shipment
address_from 🔗	Address Origin address for this delivery
address_return 🔗	Address The return address to which a delivery that is returned should be sent
address_to 🔗	Address Destination address for this delivery
courier_instructions 🔗	string Optional instructions to the courier
created_at 🔗	string Timestamp when delivery was created
delivery_status 🔗	string State of the delivery. Possible values are 'created','booked','pickup'
delivery_time 🔗	DateTimeRange Time range when the deliveries will most likely be delivered to the customer. When time is set to 00:00 it means Ingrid has presented a set of days or business days e.g. 2-3 Business days
documents 🔗	Documents Documents associated with the delivery
external_ref 🔗	string Additional reference set by carrier which can be used to identify and search delivery
id 🔗	string Unique id of the delivery (uuid)
label_url 🔗	string deprecated Use documents.label_url instead.
location_ref 🔗	string ID of the service point location if applicable
location_type 🔗	PickupLocationType Indicates the kind of pickup location
parcel_id 🔗	string ID of the parcel which the delivery belongs to
requested_shipping_method 🔗	string Name of a Custom Shipping method used during booking
return_label_url 🔗	string deprecated Use documents.return_label_url instead.
return_shipping_method 🔗	string Shipping product ID for the return delivery
return_tracking_number 🔗	string Tracking number for the return delivery
return_tracking_url 🔗	string Tracking URL for return delivery if available
shipment_tracking_number 🔗	string Consolidated tracking number for all deliveries in a shipment
shipping_method 🔗	string Shipping product ID for the delivery
tracking_number 🔗	string Tracking number for the delivery
tracking_url 🔗	string Tracking URL for the upcoming delivery if available
transit_time 🔗	TransitTime deprecated Transit time
updated_at 🔗	string Timestamp when delivery was last updated
weight 🔗	string Weight of the delivery in grams

DeliveryType

Indicates the type of the delivery

Enum Values:

UNKNOWN
DELIVERY
PICKUP
MAILBOX
INSTORE
INWAREHOUSE

Dimensions

Length, height and width in millimeters.

height 🔗	string Height in millimeters. For example `50` is 0,05 m
length 🔗	string Length in millimeters. For example `140` is 0,14 m
width 🔗	string Width in millimeters. For example `20` is 2 cm

DirectionType

Indicates intended direction of parcel, shipment etc.

- OUTBOUND: From merchant to customer.
- RETURN: Return from customer to merchant.
- UNSPECIFIED: Unspecified means we do not know the direction. It is the default state when we do not know any better.

Enum Values:

UNKNOWN_DIRECTION_TYPE
OUTBOUND
RETURN
UNSPECIFIED

Documents

label_url 🔗	string URL of the delivery's shipping label
qr_code_url 🔗	string QR code URL that can be used instead of the shipping label
return_label_url 🔗	string URL of the delivery's return label
return_qr_code_url 🔗	string QR code URL that can be used instead of the return shipping label

ElectronicInvoiceFedex

contents_type 🔗	ContentsType Content type of goods inside the parcel. For example - Sale, Gift etc. See ContentsType reference for details
currency 🔗	string Purchase currency
declaration_statement 🔗	string Statement that provides the legal explanation that customs uses to process your shipment. Needs to meet certain country's law restrictions
incoterms 🔗	InCoTerms International Commercial Terms
items 🔗	ElectronicInvoiceFedexItem[] List of items packed in the parcel

ElectronicInvoiceFedexItem

country_of_origin 🔗	string Country where this item was produced
description 🔗	string General description of this item
hs_tariff_number 🔗	string Harmonized System tariff number
quantity 🔗	integer Quantity of this item
quantity_units 🔗	string Quantity units of this item
total_net_weight 🔗	integer Total net weight of this item in grams (for the whole quantity)
total_value 🔗	integer Total value of this item (for the whole quantity) Only integer values are supported and because of that provided value should always be in smallest currency unit possible (fractional monetary unit) For example, 25.99 USD should be converted to 2599
unit_value 🔗	integer Value per unit of quantity Only integer values are supported and because of that provided value should always be in smallest currency unit possible (fractional monetary unit) For example, 25.99 USD should be converted to 2599

ElectronicInvoiceLotte

buyer_personal_customs_clearance_number 🔗	string Buyer's personal customs clearance number/id
currency 🔗	string Purchase currency
invoice_date 🔗	string Date when the invoice was issued
invoice_number 🔗	string Unique number that identifies the invoice
items 🔗	ElectronicInvoiceLotteItem[] List of items packed inside parcel
seller_customs_authorization_number 🔗	string Seller's Customs Authorization Number. Required for orders above 6000 EUR
sold_to 🔗	Address SoldTo is the address of the person who paid for the purchase

ElectronicInvoiceLotteItem

brand 🔗	string Brand of the item
country_of_origin 🔗	string Country of origin - country were this item were produced
description 🔗	string General description of this item
hs_tariff_number 🔗	string Harmonized System tariff number
quantity 🔗	integer Quantity of this item
total_value 🔗	integer Total value of this item (for the whole quantity). Only integer values are supported and because of that provided value should always be in smallest currency unit possible (fractional monetary unit) For example, 25.99 USD should be converted to 2599

ElectronicInvoiceUPS

contents_explanation 🔗	string Contents explanation - short general description
contents_type 🔗	ContentsType Content type of goods inside the parcel. For example - Sale, Gift etc. See ContentsType reference for details
currency 🔗	string Purchase currency
invoice_date 🔗	string Date when the invoice was issued
invoice_number 🔗	string Unique number that identifies the invoice
items 🔗	ElectronicInvoiceUPSItem[] List of items packed inside parcel
sold_to 🔗	Address SoldTo is the address of the person who paid for the purchase
total_gross_weight 🔗	integer Total gross weight is parcel weight in grams (including packaging)

ElectronicInvoiceUPSItem

country_of_origin 🔗	string Country of origin - country were this item were produced
description 🔗	string General description of this item
hs_tariff_number 🔗	string Harmonized System tariff number
quantity 🔗	integer Quantity of this item
total_value 🔗	integer Total value of this item (for the whole quantity). Only integer values are supported and because of that provided value should always be in smallest currency unit possible (fractional monetary unit) For example, 25.99 USD should be converted to 2599

Error

code 🔗	integer
details 🔗	Any[]
error 🔗	string
message 🔗	string

ExternalOrderContentItem

Reference to goods defined by an external system.

external_id 🔗

string

A reference to an external (merchant) order

FilteringPendingShipments

created_at_range 🔗	DateTimeRange
id 🔗	string Id will be matched against: pending_shipment_id, tos_id and external_id

GeneralCustomsDeclaration

buyer_contact 🔗	GeneralCustomsDeclarationContactInfo Contact info of a buyer / importer
buyer_identification_numbers 🔗	TaxIdentificationNumbers A unique identification numbers of a buyer / importer, for instance, EORI, VOEC
buyer_tax_id_number 🔗	string A unique VAT tax identification number of a buyer / importer. Deprecated: use `buyer_identification_numbers` instead
contents_explanation 🔗	string Contents explanation - short general description
contents_type 🔗	ContentsType Content type of goods inside the parcel. For example - Sale, Gift etc. See ContentsType reference for details
currency 🔗	string Purchase currency
declaration_statement 🔗	string Statement that provides the legal explanation that customs uses to process your shipment. Needs to meet certain country's law restrictions
incoterms 🔗	InCoTerms International Commercial Terms
invoice_date 🔗	string The date when the invoice was issued
invoice_number 🔗	string A unique number that identifies the invoice
items 🔗	GeneralCustomsDeclarationItem[] List of items packed inside the parcel
place_of_incoterms 🔗	string Name of port of departure, shipment or destination as required under the applicable delivery term
seller_address 🔗	Address The address of a seller / exporter
seller_contact 🔗	GeneralCustomsDeclarationContactInfo Contact info of a seller / exporter
seller_identification_numbers 🔗	TaxIdentificationNumbers A unique identification numbers of a seller / exporter, for instance, EORI, VOEC
seller_tax_id_number 🔗	string A unique VAT tax identification number of a seller / exporter. Deprecated: use `seller_identification_numbers` instead
sold_to 🔗	Address The address of a buyer / importer
special_instructions 🔗	string Additional Instructions provided in the customs
total_gross_weight 🔗	integer Total gross weight of the parcel in grams (including packaging)

GeneralCustomsDeclarationContactInfo

email 🔗	string
phone 🔗	string

GeneralCustomsDeclarationItem

additional_information 🔗	string[] optional Allows for providing one or more lines of additional information as needed such as manufacturer address info.
brand 🔗	string Item's brand
category 🔗	string Item's commodity category, for example, babies products
country_of_origin 🔗	string Country of origin - country were this item were produced
description 🔗	string optional Used to describe items such as composition. For example, 50 percent wool and 50 percent leather.
hs_tariff_number 🔗	string Harmonized System tariff number
name 🔗	string Name of this item
quantity 🔗	integer Quantity of this item
references 🔗	ItemReference[] optional Item references can be used to communicate order numbers, make, models, dangerous goods content identifiers, registration numbers and more.
sku 🔗	string SKU of this item
unit_alternative_value 🔗	integer Used only for special case scenarios when unit_value should not be used such as when custom declarations should be using a transfer price for eg. US exports
unit_gross_weight 🔗	integer Gross weight of the item in grams (including packaging), without taking quantity into account
unit_net_weight 🔗	integer Net weight of the item in grams, without taking quantity into account
unit_value 🔗	integer Value of the single item, without taking quantity into account. Only integer values are supported and because of that provided value should always be in smallest currency unit possible (fractional monetary unit). For example, 25.99 USD should be converted to 2599

GetConsolidatedShipmentResponse

consolidated_shipment 🔗

ConsolidatedShipment

GetCustomBookingMethodResponse

custom_booking_method 🔗

CustomBookingMethod

GetDeliveryResponse

Returns a delivery object

delivery 🔗

Delivery

Delivery object state

GetPendingShipmentResponse

Returns a Pending Shipment

pending_shipment 🔗

PendingShipment

Pending Shipment result object

GetRecordResponse

record 🔗

BookingRecord

GetShipmentResponse

Returns latest shipment state.

shipment 🔗

Shipment

Current shipment object state

HydrateShipmentResponse

shipment 🔗

CreateCompositeShipmentRequest

InCoTerms

International Commercial Terms.

- EXW: Ex Works.
- FCA: Free Carrier.
- FAS: Free Alongside Ship.
- FOB: Free On Board.
- CFR: Cost And Freight.
- CIF: Cost, Insurance and Freight.
- CPT: Carriage Paid To.
- CIP: Carriage Insurance Paid To.
- DAT: Delivered At Terminal.
- DAP: Delivered At Place.
- DDP: Delivered Duty Paid.
- DAF: Delivered At Frontier.
- DDU: Delivery Duty Unpaid.
- DEQ: Delivered Ex Quay.
- DES: Delivered Ex Ship.
- DPU: Delivered at Place Unloaded.

Enum Values:

INCOTERMS_UNKNOWN
EXW
FCA
FAS
FOB
CFR
CIF
CPT
CIP
DAT
DAP
DDP
DAF
DDU
DEQ
DES
DPU

ItemReference

code 🔗	string The code corresponds to the type. Following the example of using MID as type the MID code should be specified here as a value
type 🔗	string The type of code needs to be specified. For example "MID" (Manufacturers Identification Code) can be specified as the type

LineItem

Physical item of the parcel. A parcel can contain many line items. The parameters on the line item are used by the shipping rules framework to make better shipping decisions.

currency 🔗	string optional Currency of the line item.
description 🔗	string optional Description of the product
dimensions 🔗	Dimensions optional Dimensions of the line item.
hs_tariff_number 🔗	string Harmonized System tariff number
name 🔗	string required Product name or title
price 🔗	string optional Price of the line item.
quantity 🔗	string required Number of items.
sku 🔗	string required Unique product identifier.
tags 🔗	string[] List of tags or attributes that can be attached to this line item
weight 🔗	string Weight of the line item in grams. For example `200` is 0,2 kg

ListConfiguredBookingMethodsResponse

methods 🔗

BookingMethod[]

ListCustomBookingMethodsRequest

filtering 🔗	ListCustomBookingMethodsRequestFiltering
order_by_direction 🔗	OrderDirection
pagination 🔗	Pagination

ListCustomBookingMethodsRequestFiltering

booking_methods 🔗	string[]
id 🔗	string Id will be matched against Published and Draft custom booking methods
include_statuses 🔗	BookingMethodStatus[]
methods 🔗	string[]
name 🔗	string[]

ListCustomBookingMethodsResponse

custom_booking_methods 🔗

CustomBookingMethod[]

ListPendingShipmentsRequest

filtering 🔗	FilteringPendingShipments
order_by_direction 🔗	OrderDirection
pagination 🔗	Pagination

ListPendingShipmentsResponse

pending_shipments 🔗

PendingShipment[]

ListShipmentsRequestOrderDirection

Enum Values:

DESCENDING
ASCENDING

OpenConsolidatedShipmentRequest

carrier_contract_id 🔗	string optional ID of the carrier contract to be used for booking
customs_declaration 🔗	CustomsDeclaration Holds information about customs declaration for the consolidated shipment
external_id 🔗	string optional External ID of the shipment. Can be used to store a unique identifier from the merchant
from 🔗	Party required Address where the shipment will be dispatched from. Most often the address of the warehouse
meta 🔗	hash optional Shipment metadata tags
shipping_date 🔗	string required Date when the shipment will most likely be dispatched from the warehouse. RFC-3339 format
shipping_method 🔗	string required Shipping method for the Consolidated Shipment
to 🔗	Party required Destination address. For example address of the distribution center of the carrier

OpenConsolidatedShipmentResponse

consolidated_shipment 🔗

ConsolidatedShipment

OrderDirection

Enum Values:

DESCENDING
ASCENDING

Pallet

created_at 🔗	string [output] Timestamp when pallet was created. RFC-3339 format
dimensions 🔗	Dimensions optional Dimensions of the pallet. If provided, this value will be sent to carrier
external_id 🔗	string optional External ID of the pallet. Can be used to store a unique identifier from the merchant
id 🔗	string [output] ID of the pallet (uuid)
label_url 🔗	string [output] URL of the pallet's shipping label
shipping_methods 🔗	string[] optional Shipping methods on the pallet. If provided, this value will be sent to carrier. Required for some carriers
tracking_number 🔗	string [output] Tracking number for the pallet
tracking_url 🔗	string [output] URL of the pallet's tracking number
updated_at 🔗	string [output] Timestamp when pallet was updated. RFC-3339 format
weight 🔗	string optional Weight of the pallet in grams. If provided, this value will be sent to carrier. If omitted (or zero), the weight will be summed by the weights of the shipments in the pallet

Parcel

Parcel is the physical package. One parcel can have at least one delivery at a time.

contents 🔗	Contents Contents of the parcel
created_at 🔗	string Timestamp when parcel was created
deliveries 🔗	Delivery[] Deliveries associated with the parcel
dimensions 🔗	Dimensions optional Length, height and width
free_text 🔗	string Custom description (notes) of a parcel
id 🔗	string Unique ID of the parcel (uuid)
label_free_text 🔗	string Custom information about parcel visible on a label
line_items 🔗	LineItem[] deprecated Use `contents` instead
parcel_number 🔗	integer deprecated Index number of the individual parcel in a shipment, i.e parcel 3 of 5.
parcel_total 🔗	integer deprecated Not used
shipment_id 🔗	string ID of the shipment that parcel belongs to (uuid)
updated_at 🔗	string Timestamp when parcel was last updated
weight 🔗	string Total weight of the parcel in grams

ParcelDetails

ParcelDetails contains additional information about parcels. Represents the non-output-only subset of Shipment Parcels.

contents 🔗	Contents Parcel contents
dimensions 🔗	Dimensions Parcel dimensions
free_text 🔗	string Custom description (notes) of a parcel
label_free_text 🔗	string
weight 🔗	string Weight in grams

ParcelType

- NONE: None indicates that parcels are not available for shipping method.

Enum Values:

PARCEL_TYPE_UNKNOWN
NONE
LETTER
PACKAGE
PALLET

Party

address 🔗	Address
email 🔗	string
phone 🔗	string

PendingShipment

Pending shipment that has generated an error in the creation process and therefore is in an invalid state and needs modifying. This is an opt in feature for merchants

created_at 🔗	string Timestamp when shipment was received
expires_at 🔗	string Timestamp of when the pending shipment be deleted
id 🔗	string ID of the shipment (uuid)
lookup_id 🔗	string Lookup ID of the shipment. This is a shorter version of the id that can be used to reference the shipment
payload 🔗	string Shipment request that caused the error. Includes the errornous part of the request
raw_error_message 🔗	string Error message recieved during create (and/or) booking of shipment

PickupLocationType

Indicates the kind of pickup location

Enum Values:

UNKNOWN_PICKUP_LOCATION_TYPE
LOCKER
STORE
POSTOFFICE
MANNED

PublishCustomBookingMethodsRequest

custom_booking_methods 🔗

CustomBookingMethod[]

SaveDraftCustomBookingMethodsRequest

custom_booking_methods 🔗

CustomBookingMethod[]

SchedulePickupRequest

Schedule the shipment for pickup by the carrier service.

id 🔗	string Shipment ID

SendFreightDocumentsForReturnShipmentRequest

email 🔗	string
return_shipment_id 🔗	string
site_id 🔗	string

Shipment

Shipment is the top level object in SOM. A shipment can be composed of multiple parcels and each parcel can contain many deliveries. Only one delivery can be active at a time.

addons 🔗	Addon[] Addons that should be used for the shipment
address_from 🔗	Address required Address where the shipment will be dispatched from. Most often the address of the warehouse
address_return 🔗	Address Address where deliveries of this shipment should be returned to
address_to 🔗	Address required Destination address. For example address of the service point or the click and collect store
carrier_contract_id 🔗	string ID of the carrier contract to be used for booking
consolidated_shipment_details 🔗	ConsolidatedShipmentDetails If the shipment is part of a consolidated shipment, this field will contain the details
contents 🔗	Contents Contents of shipment. Can be of different types - goods, transport orders and external orders
created_at 🔗	string Timestamp when shipment was created
customer_info 🔗	CustomerInfo required Contains the customer information such as name, email, phone and address
customs 🔗	Customs Holds information about customs for the shipment
direction_type 🔗	DirectionType DirectionType informs about initial shipment direction
external_id 🔗	string Can be used to store a unique identifier from the merchant. For example external order ID or external shipment ID
id 🔗	string ID of the shipment (uuid)
line_items 🔗	LineItem[] deprecated Use contents instead
meta 🔗	hash Generic key-value object that can be used to attach additional information to the shipment
outbound_shipment_id 🔗	string If the shipment is an outbound shipment, this field will contain the shipment id of the return shipment if it exists
parcels 🔗	Parcel[] Parcels associated with this shipment
return_shipment_id 🔗	string If the shipment is a return shipment, this field will contain the shipment id of the outbound shipment if it exists
shipment_value 🔗	string Total value of the shipment including tax in cents. Example 10000 is 100 SEK
shipping_date 🔗	string required The date that the shipment will most likely be dispatched from the warehouse
site_id 🔗	string Site ID to which the shipment belongs to
status 🔗	ShipmentStatus required Status of the shipment. Equivalent to the old Delivery.delivery_status.
tos_id 🔗	string ID of a corresponding order
updated_at 🔗	string Timestamp when shipment was last updated

ShipmentStatus

message 🔗	string optional Used to attach a message to the current status.
type 🔗	StatusStatusType required The type of the status. Used to determine the state of the shipment.

StatusStatusType

- CREATED: CREATED is the initial state of the shipment.
- BOOKED: BOOKED indicates that shipment has been booked, also known as having a label generated for it.
- PICKUP_SCHEDULED: PICKUP_SCHEDULED indicates that shipment has been scheduled for pickup. The intricacies of the pickup is determined by the carrier and the site configuration.
- CANCELED: CANCELED indicates that the delivery has been suspended and will not proceed.
- INVALID_BOOKING: INVALID_BOOKING indicates that a booking failed due to a bad request to the carrier service.
- CANCEL_FAILED: CANCEL_FAILED indicates that the shipment could not be canceled by the carrier

Enum Values:

UNKNOWN
CREATED
BOOKED
PICKUP_SCHEDULED
CANCELED
INVALID_BOOKING
CANCEL_FAILED

StepExpression

expression 🔗	string
raw_error 🔗	string

StepLog

actions 🔗	string[]
filters 🔗	hash
input 🔗	CreateCompositeShipmentRequest
name 🔗	string
output 🔗	CreateCompositeShipmentRequest

Strategy

Represents a booking strategy used by a delivery.

Enum Values:

STRATEGY_UNKNOWN
STRATEGY_SCHEDULED
STRATEGY_IMMEDIATE

TaxIdentificationNumbers

ein 🔗	string Refers to the Employer Identification Number (EIN) for tax identification
eori 🔗	string Stands for Economic Operator Registration and Identification (EORI) number. The EORI number is used for customs purposes to identify economic operators involved in the import or export of goods within the European Union
hmrc 🔗	string Refers to Their Majesty's Revenue and Customs (HMRC) identification
ioss 🔗	string Indicates the Import One-Stop Shop (IOSS) number
pan 🔗	string Represents the Permanent Account Number (PAN) used in certain jurisdictions
pccc 🔗	string Personal Customs Clearance Code : P+12digit number (Ex : P123456789012). Needed for shipments to South Korea
ssn 🔗	string Stands for Social Security Number (SSN) used in specific regions
tin 🔗	string Signifies the Taxpayer Identification Number (TIN) used for tax purposes
ukims 🔗	string UK Internal Market Scheme Number (Example: GBUKIMS123456789012202409011000)
vat 🔗	string Stands for Value Added Tax (VAT) identification number
voec 🔗	string Represents the Value of Exported Commodities (VOEC) number

TestCustomBookingMethodsRequest

custom_booking_methods 🔗	CustomBookingMethod[]
shipments 🔗	CreateCompositeShipmentRequest[]

TestCustomBookingMethodsResponse

test_run_results 🔗

CustomBookingsMethodTestRun[]

TransportOrderContentItem

Reference to goods defined by a transport order.

external_ref 🔗	string Additional reference which can be used freely by the client to tie together a SOM shipment with an internal ID
tos_id 🔗	string Transport order id

TriggerPickupResponse

records 🔗

BookingRecord[]

A list of records that have been succesfully booked

UpdateShipmentRequest

Update a shipment request

addons 🔗	Addon[] List of shipment addons
address_from 🔗	Address required Address where the shipment will be dispatched from. Most often the address of the warehouse.
address_return 🔗	Address optional Address where deliveries of this shipment should be returned to.
address_to 🔗	Address required Destination address. For example address of the service point or the click and collect store.
carrier_contract_id 🔗	string optional ID of the carrier contract to be used for booking.
courier_instructions 🔗	string Optional instructions to the courier
customer_info 🔗	CustomerInfo Contains the customer information such as name, email, phone and address
delivery_time 🔗	DateTimeRange Time range when the deliveries will most likely be delivered to the customer
external_id 🔗	string Can be used to store a unique identifier from the merchant. For example external order ID or external shipment ID
location_ref 🔗	string ID of the pickup location where the parcels should be delivered to
location_type 🔗	PickupLocationType optional Indicates the kind of pickup location
meta 🔗	hash Generic key-value object that can be used to attach additional information to the shipment
parcel_free_text 🔗	string Custom description (notes) that will be assigned to all parcels in the shipment
shipment_id 🔗	string Shipment ID
shipment_value 🔗	string Total value of the shipment including tax. Example 10000 is 100 SEK
shipping_date 🔗	string required The date that the shipment will most likely be dispatched from the warehouse.
shipping_method 🔗	string required Specific shipping product ID by which the generated parcels should be delivered.
weight 🔗	string deprecated Weight in grams (g). If not set, the total weight of each parcel will be calculated from its line items if that information is available.

UpdateShipmentResponse

Returns the updated shipment

shipment 🔗

Shipment

The updated shipment state

UpsertCustomsDeclarationRequest

customs_declaration 🔗	GeneralCustomsDeclaration Customs declaration information that will be upserted to the shipment. If empty field given, information about the customs declaration will be removed from the shipment
shipment_id 🔗	string required The ID of the shipment for which customs declaration upserting
site_id 🔗	string required The ID of the site to which this request belongs

UpsertCustomsDeclarationResponse

shipment 🔗

Shipment

Last updated: Fri, Jun 20, 06:15 AM