[v2.6] OrderConsolidation

Overview

Order Consolidation is designed to take in a request of demand lines with many attributes and determine, based on those attributes, whether any particular line should be consolidated with another.

These attributes are fields such as Customer, End Address, Customer PO, Mode of Delivery, etc. Base request fields such as shipping address and date/time are also considered.

Utilizing attributes instead of base data fields allows you to define the consolidating characteristics instead of limiting them to just Orchestrate definitions.

POST /OrderConsolidation

Request Body

Property

Data Type

Notes

consolidationPolicy

string

The policy to run the demand lines against for consolidation.

Because each policy can be configured differently, it's important to understand and ensure the right demand lines are being submitted with the proper policy.

demandLines

Property	Data Type	Notes
sourceOrder	string	The unique order number provided by the host entity. Orchestrate is agnostic to the order type, so inbound or outbound order types are both permissible. Furthermore, this is the order number, not the line number.
demandLineNumber	integer	Unique identifier for the demand line. int32
shipDate	string	The expected time for the shipment to be confirmed outbound. date-time
hostItem	string	Unique identifier for the item demanded.
quantity	number	The quantity ordered by the demand line. decimal
quantityUoM	string	Unit of measure as defined by the host system.
shipToAddress		The address of the final destination for the shipment.

shipToAddress

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

attributes

Property	Data Type	Notes
name	string	Name of the given attribute attached to the requested demand line.
value	string	Where applicable, the value of the given attribute.

Response

Property	Data Type	Notes
consolidationPolicy	string	The policy used for considering consolidation of the requested demand lines.
errorMessages	string	Any errors encountered are provided here.

consolidatedDemandLines

Property

Data Type

Notes

groupID

string

The unique identifier for the group of demand lines consolidated together per policy rules.

A different group will be created for each consolidation group.

consolidatedDemandLineResults

Property

Data Type

Notes

sourceOrder

string

The unique order number for any orders that were consolidated.

demandLineNumber

integer

Unique identifier for for any demand lines that were consolidated.

int32

unconsolidatedDemandLines

Property

Data Type

Notes

sourceOrder

string

The unique order number for any orders that were unconsolidated.

demandLineNumber

interger

Unique identifier for for any demand lines that were unconsolidated.

int32

Ship + Buy + Tender + Orchestrate

[v2.6] OrderConsolidation

Analytics

Overview

POST /OrderConsolidation

Related content

Feedback