/
[v2.6] OrderConsolidation

[v2.6] OrderConsolidation

Owned by Megan Stanage
Sept 05, 2024

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
PropertyData TypeNotes
consolidationPolicystring

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
PropertyData TypeNotes
sourceOrderstring

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.

demandLineNumberinteger

Unique identifier for the demand line.

  • int32
shipDatestring

The expected time for the shipment to be confirmed outbound.

  • date-time
hostItemstringUnique identifier for the item demanded.
quantitynumber

The quantity ordered by the demand line.

  • decimal
quantityUoMstringUnit of measure as defined by the host system.
shipToAddress
The address of the final destination for the shipment.


 shipToAddress
PropertyData TypeNotes
namestringmax length: 100
companystringmax length: 150
attentionTostringmax length: 150
addressLinesstring
citystringmax length: 150
postalCodestringmax length: 15
stateProvinceCodestringmax length: 5
countrystring
countryCodestringmax length: 5
phoneNumberstringmax length: 20
residentialboolean
taxIdstring
emailAddressstringmax length: 400
countystringmax length: 30


 identificationNumbers
PropertyData TypeNotes
vatstring
eoristring
 attributes
PropertyData TypeNotes
namestringName of the given attribute attached to the requested demand line.
valuestringWhere applicable, the value of the given attribute.
 Response
PropertyData TypeNotes
consolidationPolicystringThe policy used for considering consolidation of the requested demand lines.
errorMessagesstring

Any errors encountered are provided here.


 consolidatedDemandLines
PropertyData TypeNotes
groupIDstring

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
PropertyData TypeNotes
sourceOrderstringThe unique order number for any orders that were consolidated.
demandLineNumberinteger

Unique identifier for for any demand lines that were consolidated.

  • int32
 unconsolidatedDemandLines
PropertyData TypeNotes
sourceOrderstringThe unique order number for any orders that were unconsolidated.
demandLineNumberinterger

Unique identifier for for any demand lines that were unconsolidated.

  • int32



Feedback

Submit feedback.