Order Export
Exporting orders and related data from OMS
The order export tool is designed to obtain "raw" data about existing orders in the system in the form of a table suitable for further processing.
To navigate to the working area of the Orders section in the system menu of the portal, go to Store and Catalog () ➔ Orders.
Note: Export of any entities related to the order is available for users with access: OMS Manager, Company Manager
Order Export
- Go to the working section Orders.
Note: Existing orders are displayed in the working area of the Orders section as a list, sorted by the last modification.
- To export orders, click Export, then click Export Orders.
Note: When exporting orders from a child tenant, only orders created in that tenant are exported. When exporting orders from a parent tenant, orders from all tenants are exported.
- After downloading the export file, save the file in the desired location, open the file in a convenient format for work, and process the order data.
Note: The file format when exporting from the system: *.csv. The file format for editing data is *.excel in an application that supports format conversion: .csv ➔ .excel.
Structure of the Order Export File
The export file represents a data structure and describes the order model in the OMS system database in the form of a table.
Each record in the table describes one order. The first record of the table contains the names of the attributes (fields) of the table. The names of the table fields are tied to the OMS system database.
| Field Name | Description |
|---|---|
| id | Unique identifier of the order in the OMS system database |
| description | Comment on the order. Note: The comment on the order can be left by a user with access: OMS Administrator. |
| currency_id | Unique identifier of the currency in the PIM system |
| currency | Order currency |
| paid_amount | Actual payment amount |
| prepayment_amount | Actual prepayment amount |
| prepayment_deadline | Deadline for the customer to send the prepayment. Note: International transaction times are 3–7 days depending on the country. |
| payment_deadline_at | Deadline for the customer to send the payment. Note: International transaction times are 3–7 days depending on the country. |
| total_cost | Total cost of the order |
| plant.id | Unique identifier of the production site in the database |
| plant.code | Code of the production site |
| route.id | Unique identifier of the delivery route in the database |
| route.name | Name of the delivery route |
| tenant.id | Unique identifier of the tenant where the order was created |
| tenant.name | Name of the tenant where the order was created |
| user.id | Unique identifier of the user who created the order |
| user.full_name | Name of the user who created the order |
| status.id | Unique identifier of the current status of the order |
| status.name | Name of the current status of the order |
| planned_status.<n>.status_id | Unique identifier of the corresponding status in the database, where n is the ordinal number in the list of existing statuses (matches the status number in the status chain of the order) and takes values: 0, 1, 2 ... |
| planned_status.<n>.status_name | Name of the corresponding status, where n is the ordinal number in the list of existing statuses (matches the status number in the status chain of the order) and takes values: 0, 1, 2 ... |
| planned_status.<n>.first_planned_at | First planned date of the corresponding status in the database, where n is the ordinal number in the list of existing statuses (matches the status number in the status chain of the order) and takes values: 0, 1, 2 ...Planned date in the format: YYYY-MM-DD, where:
|
| planned_status.<n>.last_planned_at | Last planned date of the corresponding status in the database, where n is the ordinal number in the list of existing statuses (matches the status number in the status chain of the order) and takes values: 0, 1, 2 ...Planned date in the format: YYYY-MM-DD, where:
|
| created_at | Order creation date in the format: YYYY-MM-DDTHH:MM:SS.SSSSSSZ, where:
|
| updated_at | Date of the last update of the order in the format: YYYY-MM-DDTHH:MM:SS.SSSSSSZ, where:
|