Order line

An order line object refers to individual quantifies of purchased products, which tie to an order.

Emission calculations are made at the order line level. Order lines are defined during the initial load of CSV data and are maintained on an ongoing basis by uploading the data to Cloud Object Storage.

The full set of primary and secondary entities for the product object are defined in the data dictionary.

You can use the sample CSV files to define the Orderline object. For more information, see Sample files.

The following configuration rules apply:

Emission factors codes must be assigned to entities in the product catalog before you add orders and orderlies.
Quantity must be specified.
Orders must be inbound.

Table 1 describes the fields of the Orderline object that are configured during onboarding.

Table 1. Object model
Field name	Data type	Display name	Example	Description	Required
`order.order Identifier`	String reference to `Order. orderIdentifier`.	Order ID	100013204	A unique identifier for an order that the order line is fulfilling.	Required
`orderLine Number`	String	Order line number	100	Sequential number of the order line.	Required
`order. orderType`	String reference to `Order. orderType`.	Order type	INBOUND	Set to INBOUND.	Required
`product. partNumber`	String reference to `Product. partNumber`.	Product ID	HMC CR9	The unique identifier of the product in the order line.	Required
`shipFrom InstructionLocation. locationIdentifier`	String reference to `Organization. locationIdentifier`.	Ship from location ID	9K8	The location that the order line is being shipped from.	Required
`shipToLocation. locationIdentifier`	String reference to `Organization. locationIdentifier`.	Ship to location ID	BIGO	The location that the order line is being shipped to.	Required
`status`	String	Order line status	On hold	The status of the order line.	Recommended
`createdDate`	`DateTime`	Created date		The date and time that the order was created in the source system.	Recommended
`requested ShipDate`	`DateTime`	Requested ship date		The date and time that the buyer requested that the order line be shipped.	Recommended
`requested DeliveryDate`	`DateTime`	Requested delivery date		The date and time that the buyer requested that the order line be shipped.	Recommended
`planned ShipDate`	`DateTime`	Planned ship date	2023-06-28T14:30:36+0000	The date and time that fulfillment expects to ship the order line.	Required
`planned DeliveryDate`	`DateTime`	Planned delivery date	2023-06-28T14:30:36+0000	The date and time that the order line is planned for delivery.	Recommended
`quantity`	Float	Quantity	56	The quantity of products or materials in the order line.	Required
`quantityUnits`	String	Quantity units	EA	The units of measure from the source system. Use standard UOM or ISO format.	Required
`productValue`	Float	Product value	2170	Total value of the products or materials in the order line.	Recommended
`value`	Float	Total value	10850	Total value of the products or materials in the order.	Recommended
`valueCurrency`	String	Value currency	USD	Currency designation in ISO 4217 format.	Recommended
`shipmentCount`	Int	Shipment count	5	The number of shipment lines that are associated with the order	Recommended

Example

The following is example is an excerpt from the sample CSV file for the Orderline object.

order.orderIdentifier,orderLineNumber,order.orderType,product.partNumber,shipFromInstructionLocation.locationIdentifier,shipToLocation.locationIdentifier,plannedShipDate,quantity,quantityUnits
1000100001,100,INBOUND,BBG-3256,LightLens - Ipswich ,LT-2,2023-01-17T00:00:00Z,56,EA
1000100002,100,INBOUND,HBS-8201,LightLens - Ipswich ,LT-2,2023-01-17T00:00:00Z,56,EA
1000100003,100,INBOUND,LGC-1234,LightLens - Ipswich ,LT-1,2023-01-17T00:00:00Z,44,EA