Object Reference

External code, as defined in carrier's system

Additional data that has to be passed to use the addon

Description of the addon

Internal identifier of an addon

List of address lines part of address such as street and building number

Number of the apartment

Attention field. Can be used to indicate an employee if the address is a company address

Care of part of address usually written as `c/o`

Name of the city

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 should be specified as two uppercase letters (ISO Alpha-2). Example `SE` for Sweden, `ES` for Spain

The door code to the main entrance of the building if applicable

Customer or company name

Postal code (or zipcode in US)

Region can be a state or a province

Name of the street

Number of the street

- 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

- NONE: None indicates that parcels are not available for shipping method. Can be UNKNOWN, DELIVERY, PICKUP, MAILBOX, INSTORE, INWAREHOUSE

The IDs of the shipments which parcels should be booked

The IDs of the shipments which parcels failed to book

The IDs of the shipments which parcels successfully booked

The ID of the shipment which parcels should be booked.

Current shipment object state

Tracking number of the delivery which should be booked.

Booked delivery state

Delivery ID

Delivery tracking number

Shipment ID

External orders contained in this shipment

Goods a.k.a. line items

Transport orders contained in this shipment, so called consolidated shipment

Latitude

Longitude

List of addons

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

Contents of the shipment

Optional instructions to the courier

Must be fully specified in case customs declaration should be generated for shipment

Time range when the deliveries will most likely be delivered to the customer

Can be used to store a unique identifier from the merchant. For example external order ID or external shipment ID

Generic key-value object that can be used to attach additional information to the shipment

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

ParcelFreeText is a custom description to be assigned to all parcels in the shipment

The date that the shipment will most likely be dispatched from the warehouse.

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

TosId is an order ID as given from TOS.

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

CosSessionId a session id as given from COS.

Must be fully specified in case customs declaration should be generated for shipment

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

ParcelFreeText is a custom description to be assigned to all parcels in the shipment

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

The date that the shipment will most likely be dispatched from the warehouse.

Addons that should be used for the shipment

Address where the shipment will be dispatched from. Most often the address of the warehouse.

ID of the warehouse, from which package will be delivered

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

Destination address. For example address of the service point or the click and collect store.

Contents of shipment. Can be of different types - goods, transport orders and external orders

Optional instructions to the courier

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

Must be fully specified in case customs declaration should be generated for shipment

Time range when the deliveries will most likely be delivered to the customer

Dimensions will override the dimensions for each created parcel. If not set, the total weight of each parcel will be calculated from the line items if that information is available. Default unit is millimeters. (mm)

DirectionType informs about initial shipment direction.

Can be used to store a unique identifier from the merchant. For example external order ID or external shipment ID

Use `contents` instead

ID of the pickup location where the parcels should be delivered to

Generic key-value object that can be used to attach additional information to the shipment

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

ID of the OUTBOUND shipment (delivered from merchant to customer). Must be used only for the return shipment creation (with direction_type = "RETURN").

Custom description (notes) that will be assigned to all parcels in the shipment

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

Total value of the shipment including tax. Example 10000 is 100 SEK

ID of shipping category that user choice belongs to. It's used to resolve virtual methods connected with ship. category

The date that the shipment will most likely be dispatched from the warehouse.

Specific shipping product ID by which the generated parcels should be delivered.

Order ID from TOS. If provided, you don't have to provide all the shipment details, Ingrid will take all the required data for the shipment from the order. But you still will have a possibility to override order data with the data you would give in the request

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

Current shipment object state

Customer's home address

Customer's email

Customer's national identification number, eg. SSN

Customer's mobile phone number

Customs declaration provided in request

Customs declaration document available after booking the parcel with customs declaration request

File format (ex. "pdf", "png")

The url where the declaration label is located

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

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

Contents explanation - short general description

Content type of goods inside the parcel. For example - Sale, Gift etc. See ContentsType reference for details

Purchase currency

EORI number for imports/exports from UK

List of items packed inside parcel

Total gross weight is parcel weight in grams (including packaging)

Country of origin - country were this item were produced

General description of this item

Harmonized System tariff number

Quantity of this item

Total net weight of the item in grams (for the whole quantity)

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

Addons available for the shipment

Origin address for this delivery

The return address to which a delivery that is returned should be sent

Destination address for this delivery

Optional instructions to the courier

Timestamp when delivery was created

State of the delivery. Possible values are 'created','booked','pickup'

Time range when the deliveries will most likely be delivered to the customer

Additional reference set by carrier which can be used to identify and search delivery

Unique id of the delivery (uuid)

URL of the delivery's shipping label

ID of the service point location if applicable

ID of the parcel which the delivery belongs to

Name of a Custom Shipping method used during booking

URL of the delivery's return label

Tracking number for the return delivery

Consolidated tracking number for all deliveries in a shipment

Shipping product ID for the delivery

Tracking number for the delivery

Tracking URL for the upcoming delivery if available

Transit time

Timestamp when delivery was last updated

Weight of the delivery in grams

Height in millimeters. For example `50` is 0,05 m

Length in millimeters. For example `140` is 0,14 m

Width in millimeters. For example `20` is 2 cm

Content type of goods inside the parcel. For example - Sale, Gift etc. See ContentsType reference for details

Purchase currency

List of items packed in the parcel

Country where this item was produced

General description of this item

Harmonized System tariff number

Quantity of this item

Quantity units of this item

Total net weight of this item in grams (for the whole quantity)

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

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

Buyer's personal customs clearance number/id

Purchase currency

Date when the invoice was issued

Unique number that identifies the invoice

List of items packed inside parcel

Seller's Customs Authorization Number. Required for orders above 6000 EUR

SoldTo is the address of the person who paid for the purchase

Brand of the item

Country of origin - country were this item were produced

General description of this item

Harmonized System tariff number

Quantity of this item

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

Contents explanation - short general description

Content type of goods inside the parcel. For example - Sale, Gift etc. See ContentsType reference for details

Purchase currency

Date when the invoice was issued

Unique number that identifies the invoice

List of items packed inside parcel

SoldTo is the address of the person who paid for the purchase

Total gross weight is parcel weight in grams (including packaging)

Country of origin - country were this item were produced

General description of this item

Harmonized System tariff number

Quantity of this item

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

A reference to an external (merchant) order

For example EORI, VOEC, IOSS, HMRC

Contents explanation - short general description

Content type of goods inside the parcel. For example - Sale, Gift etc. See ContentsType reference for details

Purchase currency

International Commercial Terms

Date when the invoice was issued

Unique number that identifies the invoice

List of items packed inside the parcel

For example EORI, VOEC, IOSS, HMRC

The address of the person who paid for the purchase

Total gross weight of the parcel in grams (including packaging)

Item's brand

Item's commodity category, for example, babies products

Country of origin - country were this item were produced

Harmonized System tariff number

Name of this item

Quantity of this item

SKU of this item

Gross weight of the item in grams (including packaging), without taking quantity into account

Net weight of the item in grams, without taking quantity into account

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

Delivery object state

Current shipment object state

Currency of the line item.

Description of the product

Dimensions of the line item.

Harmonized System tariff number

Product name or title

Price of the line item.

Number of items.

Unique product identifier.

List of tags or attributes that can be attached to this line item

Weight of the line item in grams. For example `200` is 0,2 kg

Contents of the parcel

Timestamp when parcel was created

Deliveries associated with the parcel

Length, height and width

Custom description (notes) of a parcel

Unique ID of the parcel (uuid)

Custom information about parcel visible on a label

Use `contents` instead

Index number of the individual parcel in a shipment, i.e parcel 3 of 5

Not used

ID of the shipment that parcel belongs to (uuid)

Timestamp when parcel was last updated

Total weight of the parcel in grams

Addons that should be used for the shipment

Address where the shipment will be dispatched from. Most often the address of the warehouse

Address where deliveries of this shipment should be returned to

Destination address. For example address of the service point or the click and collect store

Contents of shipment. Can be of different types - goods, transport orders and external orders

Timestamp when shipment was created

Contains the customer information such as name, email, phone and address

Holds information about customs for the shipment

DirectionType informs about initial shipment direction

Can be used to store a unique identifier from the merchant. For example external order ID or external shipment ID

ID of the shipment (uuid)

Use `contents` instead

Generic key-value object that can be used to attach additional information to the shipment

Parcels associated with this shipment

Total value of the shipment including tax in cents. Example 10000 is 100 SEK

The date that the shipment will most likely be dispatched from the warehouse

Site ID to which the shipment belongs to

ID of a corresponding order

Timestamp when shipment was last updated

Additional reference which can be used freely by the client to tie together a SOM shipment with an internal ID

Transport order id

List of shipment addons

Address where the shipment will be dispatched from. Most often the address of the warehouse.

Address where deliveries of this shipment should be returned to.

Destination address. For example address of the service point or the click and collect store.

Optional instructions to the courier

Contains the customer information such as name, email, phone and address

Time range when the deliveries will most likely be delivered to the customer

Can be used to store a unique identifier from the merchant. For example external order ID or external shipment ID

ID of the pickup location where the parcels should be delivered to

Generic key-value object that can be used to attach additional information to the shipment

Custom description (notes) that will be assigned to all parcels in the shipment

Shipment ID

Total value of the shipment including tax. Example 10000 is 100 SEK

The date that the shipment will most likely be dispatched from the warehouse.

Specific shipping product ID by which the generated parcels should be delivered.

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.

The updated shipment state

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

The ID of the shipment for which customs declaration upserting

The ID of the site to which this request belongs