Order
An order object defines key information for the associated order lines, such as buyer, supplier, and delivery and shipment dates.
Orders 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 Order
object. For more
information, see Sample files.
The following configuration rules apply:
- Planned ship date is used for date-based emission metrics.
- Quantity must be specified.
- Orders must be inbound.
The Table 1 describes the fields of the Order object that are configured during onboarding.
Field name | Data type | Display name | Example | Description | Required |
---|---|---|---|---|---|
orderIdentifier |
String | Order ID | 100013204 | Unique identifier for an order. | Required |
orderType |
String | Order type | INBOUND | Specifies whether the order is inbound or outbound. Use INBOUND only. | Required |
vendor. |
String reference to
Organization. . |
Supplier ID | Amos | A unique ID for the supplier. | Required |
buyer. |
String reference to Organization. . |
Customer | LightTree | A unique ID for the buying organization. | Required |
shipFrom |
String reference to Organization. . |
Ship from location ID | Amos - Philadelphia | The location that the order is being shipped from. | Recommended |
shipToLocation. |
Location | Ship to location ID | LT-8 | The location where the order is being shipped to. | Recommended |
order |
String | Order status | Received | The overall status of the order, considering shipment, invoice, and payment. | Recommended |
createdDate |
DateTime |
Created date | 2023-06-28T14:30:36+0000 | The date and time that the order was created in the source system. It follows the ISO 8601 standard. | Recommended |
requested e |
DateTime |
Requested ship date | 2023-06-28T14:30:36+0000 | The date and time that the buyer requested that the order be shipped. It follows the ISO 8601 standard. | Recommended |
requested |
DateTime |
Requested delivery date | 2023-06-28T14:30:36+0000 | The date and time that the buyer requested that the order be delivered. It follows the ISO 8601 standard. | Recommended |
plannedS |
DateTime |
Planned ship date | 2023-06-28T14:30:36+0000 | The date and time that fulfillment expects to ship the order. It follows the ISO 8601 standard. | Required |
planned |
DateTime |
Planned delivery date | 2023-06-28T14:30:36+0000 | The date and time that the order is planned for delivery. It follows the ISO 8601 standard. | Recommended |
totalValue |
Float | Total value | 367 | Total value of the products or materials in the order. | Recommended |
orderValue |
String | Value currency | USD | Currency designation in ISO 4217 format. | Recommended |
lineCount |
Int | Line count | 5 | Count of orders lines that are associated with the order. | Recommended |
Example
The following is example is an excerpt from the sample CSV file for the Order
object.
orderIdentifier,orderType,vendor.organizationIdentifier,buyer.organizationIdentifier
1000100001,INBOUND,LightLens,LightTree
1000100002,INBOUND,LightLens,LightTree
1000100003,INBOUND,LightLens,LightTree