A Logistic Order Document covers the logistic of a sales order, either all the lines or just a sub part of them.
No Additional PropertiesIf the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
Identifier is required if eventHeader.type is EVENT or not present (defaults to EVENT)
"EVENT"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"LOGISTIC_ORDER_HEADER"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"LOGISTIC_ORDER_LINES"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"PACKAGES"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"DELIVERY"
The following properties are required when the logistic order type is SALES.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"SALES"
{
"eventHeader": {
"source": "OPCO",
"version": "1.0.0",
"type": "EVENT",
"scopes": [
"LOGISTIC_ORDER_HEADER",
"LOGISTIC_ORDER_LINES",
"PACKAGES",
"DELIVERY"
]
},
"identifier": {
"logisticOrderId": "DO12345"
},
"logisticOrderHeader": {
"accountId": "ACC123",
"deliveryType": "DELIVERY",
"type": "SALES",
"status": "ACCEPTED",
"createdOn": "2023-10-01T00:00:00Z",
"modifiedOn": "2023-10-03T00:00:00Z",
"from": {
"facilityId": "FAC123"
},
"to": {
"facilityId": "FAC456",
"clientLocation": {
"addressLine1": "123 Main St",
"addressLine2": "Suite 100",
"addressLine3": "Floor 2",
"postalCode": "12345",
"city": "Anytown",
"region": "CA",
"department": "Sales",
"country": "USA",
"addressName": "Main Office",
"companyName": "Example Corp",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+1234567890",
"deliveryIndication": "Leave at front desk",
"customerReference": "Ref123"
}
}
},
"logisticOrderLines": [
{
"salesOrderId": "SO12345",
"salesOrderLineId": "SOL123",
"logisticOrderLineId": "DOL123",
"packageIds": [
"PKG123"
],
"productId": "PROD123",
"supplierId": "SUP123",
"quantity": 10,
"status": "PACKED",
"modifiedOn": "2023-10-02T00:00:00Z",
"additionalInformation": [
{
"name": "warehouseName",
"value": "P570629"
}
]
}
],
"packages": [
{
"packageId": "PKG123",
"status": "IN_TRANSIT",
"type": "DRUM",
"modifiedOn": "2023-10-02T00:00:00Z",
"weight": 200,
"weightUnit": "KGM",
"trackingId": "TRACK123",
"carrierId": "CARR123",
"lineItem": [
{
"salesOrderLineId": "SOL123",
"logisticOrderLineId": "DOL123",
"productId": "PROD123",
"quantity": 10,
"status": "PACKED",
"modifiedOn": "2023-10-02T00:00:00Z"
}
],
"length": 2.4,
"width": 1.2,
"depth": 3.5,
"diameter": 5.2,
"volume": 1.2,
"volumeUnit": "cm^3",
"dimensionUnit": "mm"
}
],
"delivery": {
"expectedDeliveryDate": "2023-10-03",
"estimatedDeliveryDate": "2023-10-03",
"modifiedOn": "2023-10-02T00:00:00Z",
"attachedDocuments": [
{
"type": "PROOF_OF_DELIVERY",
"id": "POD123",
"createdAt": "2023-10-01T00:00:00Z",
"source": "OPCO",
"fileName": "Proof of Delivery POD123",
"extension": ".docx"
}
]
}
}
Contains information about the event, including the source, version, and scopes.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EVENT"
"OPCO"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"COMMAND"
Application that can produce a logistic order command.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"OPCO"
Represents the origin of the event. It could be 'OPCO' for EVENT type, or from LogisticOrderCommandProducer for COMMAND type.
Must be at least 1 characters long
Represents the version of the event schema. It's used to handle changes and evolution of the event structure over time.
Must be at least 1 characters long
Represents the scopes of the event. Each string in the array is a scope that the event pertains to. The possible values are LOGISTIC_ORDER_HEADER, LOGISTIC_ORDER_LINES, PACKAGES and DELIVERY. This field is used to specify which parts of the logistic order the event is related to.
LOGISTIC_ORDER_HEADER has to be sent first before any other scopesMust contain a minimum of 1 items
The type of the event.
"COMMAND"
The request information associated with the event.
{
"id": "1234567",
"target": "SPARK"
}
The unique identifier of the request provided by the slave system on the COMMAND message, and then also returned by the master into the EVENT message. It is used to correlate the EVENT message to the COMMAND message on the slave system source of a change request. It can be the technical id on the slave system. This can be ignored by the other slave systems
Must be at least 1 characters long
"1234567"
The target system that the message is intended for from the master POV. In case the message is sent by a slave system the value of this field must be the same as source field. The same value will be returned by the master system in response message (COMMAND or EVENT).
"SPARK"
Contains the unique identifier for the logistic order.
Represents the order logistic document id from the System of Records ( usually usually WMS, in charge of the preparation and shipping of the goods in the warehouse )
Must be at least 1 characters long
Contains information about the logistic order, including the sales order ID, account IDs, preparation step , shipping status of each packages, type of delivery, status, and creation and modification dates.
No Additional PropertiesRepresents the customerAccountId used as the soldTo in the sales Order
Must be at least 1 characters long
Optional field, needed by OpCo organised with a regional model or commercial organisation. It can be used to filter or route based on the orgId.
Must be at least 1 characters long
"org123"
"SNE"
ACCEPTED: delivery order accepted but preparation not started
PARTIALLY_ACCEPTED: delivery order has been partially accepted and preparation not started
IN_PREPARATION : goods are in preparation ( picking, packing, labelling
IN_TRANSIT : shipment is on the way to destination location
PARTIALLY_DELIVERED : goods covered by this logistic order are partially delivered to the customer.
DELIVERED : in case of pick up, customer has retrieved the goods with sign off of the delivery note. In case of delivery, goods have been delivered to the customer address with sign off of the delivery note. It is a combination of two previous status COLLECTED and DELIVERED
CANCELLED : delivery order has been cancelled due any decision related to opco not able to perform delivery as aligned with the promise
REJECTED : order has been rejected (mostly used for Marketplace by a seller to reject this order)
NO_TRACKING : order has been shipped but is going to be delivered with a carrier which don't provide tracking information.
DELETED : logistic order that has been internally cancelled and marked for soft deletion. This status indicates the order will likely be re-created later by the system without requiring any customer interaction or notification. Used primarily for internal order management and optimization processes where the order needs to be temporarily invalidated but may be reinstated with updated information
In case of multiple shipments, delivery status is equal to the status of the shipment the less advanced in the shipping process.
Location point from where the logistic order merchandise is shipped
Facility id of the location
Must be at least 1 characters long
Location point to where the logistic order merchandise is delivered or picked up
FacilityId of the location
Must be at least 1 characters long
Client address of the location
An address.
OpCo internal system's unique identifier for the address.
Must be at least 1 characters long
"237564557868778"
The first line of the address. Should contain Street name, no, street type. Usually the whole address can fit on one line
Must be at least 1 characters long
"235 Donaghy Ave"
The second line of the address. Should complete the address with other details (e.g. floor number)
Must be at least 1 characters long
The third line of the address. Should complete the address with other information. e.g. Apartment no
Must be at least 1 characters long
The postal code
Must be at least 1 characters long
"V7P 1E2"
The city in which the street address is, and which is in the adminDevison(region)
Must be at least 1 characters long
"North Vancouver"
The region in which the locality is, and which is in the country.
"BC"
The department in which the locality is, and which is in the country.
Must be at least 1 characters long
"BC"
The ISO 3166-1 alpha-3 of the country
Must be at least 1 characters long
"CAN"
Represents additional fields of the delivery address
Extra description about the address
Must be at least 1 characters long
"Building site 1"
Company name, it might differ from the account name
Must be at least 1 characters long
"Easy Electric"
Address contact's first name
Must be at least 1 characters long
"John"
Address contact's last name
Must be at least 1 characters long
"Doe"
Address contact's Phone number (The phone number of the person receiving the shipment)
Must be at least 1 characters long
"+330287345678"
Optional indications or instructions about the delivery
"Please leave the parcel next the front door"
Optional reference about the customer
Must be at least 1 characters long
"Reference 123"
{
"addressLine1": "chaussee Verlinden 22",
"addressLine2": "Apartment 2",
"city": "Bruges",
"country": "BEL",
"postalCode": "0287",
"addressName": "Building #2",
"companyName": "Easy Electric",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhoneNumber": "+333746573829",
"deliveryIndication": "Please leave the parcel next the front door.",
"customerReference": "Ref 364361"
}
The requested date for logistic order to be delivered.
Must be at least 1 characters long
Date of creation of the logistic order document
Must be at least 1 characters long
Date of modification of the logistic order document
Must be at least 1 characters long
Additional order information filled by the customer when placing the order or added by the OpCo system during the order processing.
No Additional ItemsObject representing an additional information.
Name of the additional reference
Must be at least 1 characters long
"warehouseName"
Value of the additional reference filled by the customer
Must be at least 1 characters long
"P570629"
[
{
"name": "warehouseName",
"value": "Z.I. Fourviere"
}
]
Package in the logistic order.
Must contain a minimum of 1 items
A package in the logistic order.
No Additional PropertiesPackage ID in OPCO System of record ( TMS equivalent )
Must be at least 1 characters long
List of possible status:
IN_STAGE: package is dispatched in the dock, ready to be loaded
LOADED: package has been loaded in the truck
SHIPPED : package has left the dock
IN_TRANSIT : truck is on the way to destination location
DAMAGED : package has been damaged
LOST : package has been lost
AVAILABLE_FOR_PICKUP status should be used in PICKUP when the order is ready to be picked up
DELIVERED : delivered to the destination location, invoice can be triggered
COLLECTED status should be used in PICKUP when the order has been collected from branch or locker.
Date of modification of the package
Must be at least 1 characters long
An array of order line items
No Additional ItemsLogistic order line id of this logistic order
Must be at least 1 characters long
Number of items ordered.
10
The weight of the package to be delivered
200
The units in which the weights are computed and displayed following the GS1 units of measure
"KGM"
The units in which the volumes are computed and displayed in e.g mm^3
Must be at least 1 characters long
"cm^3"
The units in which the dimensions are computed and displayed in e.g cm, mm, inch etc applicable for length, width, height, diameter
Must be at least 1 characters long
"mm"
Length of packing object
2.4
Width of packing object
1.2
Depth of packing object
3.5
Diameter of packing object
5.2
Volume of packing object
1.2
Tracking number used as a public id for track and trace purpose
Must be at least 1 characters long
ID of the carrier, filled only when external carrier is used
Must be at least 1 characters long
The lines in the logistic order.
No Additional ItemsThis is identical to opCoOrderId
The sales order id that triggers this logistic order to cover a full or partial set of goods to be prepared and shipped from the warehouse.
Must be at least 1 characters long
"4999569661752721026"
"49995696_ORG1"
Sales order line id of the sales order .
Must be at least 1 characters long
Logistic order line id of this logistic order
Must be at least 1 characters long
List of package id where this order lines belongs to
No Additional ItemsPackage id where this order lines belongs to
Must be at least 1 characters long
"PKG123"
"PKG456"
Product id as defined in the sales order line id
Must be at least 1 characters long
Match with the supplier id that has provided the product goods. can match with the manufacturer of the product or can be different as a wholesales supplier company
Must be at least 1 characters long
Whole or part of the product id quantity as defined in the sales order line id
PICKED order line has been picked up
ACCEPTED order line has been accepted
CANCELLED order line has been cancelled
REJECTED order line has been rejected
PACKED: order line has been packed
delete action for the logistic order line, indicate the line is to be deleted when consumed
"DELETE"
Date of modification of the logistic order document
Must be at least 1 characters long
Additional line item information
No Additional ItemsObject representing an additional information.
Name of the additional reference
Must be at least 1 characters long
"warehouseName"
Value of the additional reference filled by the customer
Must be at least 1 characters long
"P570629"
Contains information about the delivery of the logistic order.
No Additional PropertiesThe documents attached to the delivery.
No Additional ItemsA document attached to the delivery.
The type of the document
"DELIVERY_NOTES"
The id of the document
Must be at least 1 characters long
"4999569661752721026"
Date on which the document has been created, in ISO 8601 format.
Must be at least 1 characters long
"2017-07-21T08:30:22.804Z"
System/component where the document is to be sourced from.
"MARKETPLACE"
"OPCO"
The actual file name that will be shown to the user
Must be at least 1 characters long
"Note de crédit"
"Creditnota"
The file extension of the document
Must match regular expression:^\.[a-zA-Z0-9]+(\.[a-zA-Z0-9]+)*$
Must be at least 1 characters long
".pdf"
".csv"
".txt"
Dock id where the logistic order is prepared for shipping
Must be at least 1 characters long
TRUE if delivery has been achieved as in DELIVERED status except in this case invoicing is blocked
Date on which the logistic order is expected to be delivered (on it's way to the customer).
Must be at least 1 characters long
"2021-10-12"
Date on which we estimate the logistic order will be delivered (hasn't headed to the customer yet).
Must be at least 1 characters long
"2021-10-12"
Date on which the logistic order was actually delivered.
Must be at least 1 characters long
"2021-10-12"
Range of dates for the delivery
The start date of the range
Must be at least 1 characters long
The end date of the range
Must be at least 1 characters long
Date when the logistic order has ben shipped
Must be at least 1 characters long
List of carrier id that participated to deliver all the packages linked to this delivery
No Additional ItemsID of the carrier, filled only when external carrier is used
Must be at least 1 characters long
"CA124"
"CA18798"
An information message about this delivery to display to the user
The type of the message whether its info or warning
"INFORMATION"
The actual message to display
{
"fr-BE": "Votre commande est en cours de livraison et devrait être livrée d'ici 15h aujourd'hui",
"nl-BE": "Je bestelling is klaar voor bezorging en zou vandaag om 15u bezorgd moeten zijn"
}
Each additional property must conform to the following schema
Type: stringMust be at least 1 characters long
Date of modification of the logistic order document
Must be at least 1 characters long