Documentation

Object Reference

Addon

Describes an additional service provided by shipping method.

AddParcelRequest

AddParcelResponse

Address

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

Any

BookingMethod

BookingRecord

Represents a delivery that is or has to be booked.

BookParcelsBulkRequest

BookParcelsBulkResponse

BookParcelsRequest

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

BookParcelsResponse

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

BookPickupRequest

Book a pickup with the shipping company.

BookPickupResponse

Returns the state of the booked delivery.

CancelDeliveryRequest

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

CancelShipmentRequest

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

Contents

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.

Coordinates

Geolocation coordinates

CreateCompositeShipmentFromOrderRequest

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

CreateCompositeShipmentFromRequest

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

CreateCompositeShipmentRequest

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

CreateCompositeShipmentResponse

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

CustomerInfo

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

Customs

CustomsDeclaration

CustomsDeclarationDocument

DateTimeRange

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

DeclarationCN

DeclarationCNItem

Delivery

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

Dimensions

Length, height and width

ElectronicInvoiceFedex

ElectronicInvoiceFedexItem

ElectronicInvoiceLotte

ElectronicInvoiceLotteItem

ElectronicInvoiceUPS

ElectronicInvoiceUPSItem

Error

ExternalOrderContentItem

Reference to goods defined by an external system.

GeneralCustomsDeclaration

GeneralCustomsDeclarationContactInfo

GeneralCustomsDeclarationItem

GetDeliveryResponse

Returns a delivery object

GetRecordResponse

GetShipmentResponse

Returns latest shipment state.

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.

ListConfiguredBookingMethodsResponse

Parcel

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

ParcelDetails

ParcelDetails contains additional information about parcels.

SendFreightDocumentsForReturnShipmentRequest

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.

TaxIdentificationNumbers

TransportOrderContentItem

Reference to goods defined by a transport order.

UpdateShipmentRequest

Update a shipment request

UpdateShipmentResponse

Returns the updated shipment

UpsertCustomsDeclarationRequest

UpsertCustomsDeclarationResponse

Last updated: Mon, Apr 15, 06:15 AM