Oryx Docs

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

  1. 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.

  1. 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.

  1. 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 NameDescription
idUnique identifier of the order in the OMS system database
descriptionComment on the order.
Note: The comment on the order can be left by a user with access: OMS Administrator.
currency_idUnique identifier of the currency in the PIM system
currencyOrder currency
paid_amountActual payment amount
prepayment_amountActual prepayment amount
prepayment_deadlineDeadline for the customer to send the prepayment.
Note: International transaction times are 3–7 days depending on the country.
payment_deadline_atDeadline for the customer to send the payment.
Note: International transaction times are 3–7 days depending on the country.
total_costTotal cost of the order
plant.idUnique identifier of the production site in the database
plant.codeCode of the production site
route.idUnique identifier of the delivery route in the database
route.nameName of the delivery route
tenant.idUnique identifier of the tenant where the order was created
tenant.nameName of the tenant where the order was created
user.idUnique identifier of the user who created the order
user.full_nameName of the user who created the order
status.idUnique identifier of the current status of the order
status.nameName of the current status of the order
planned_status.<n>.status_idUnique 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_nameName 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_atFirst 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:
  • YYYY — year (4 digits);
  • MM — month (2 digits, from 01 to 12);
  • DD — day of the month (2 digits, from 01 to 31)
planned_status.<n>.last_planned_atLast 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:
  • YYYY — year (4 digits);
  • MM — month (2 digits, from 01 to 12);
  • DD — day of the month (2 digits, from 01 to 31)
created_atOrder creation date in the format: YYYY-MM-DDTHH:MM:SS.SSSSSSZ, where:
  • YYYY — year (4 digits);
  • MM — month (2 digits, from 01 to 12);
  • DD — day of the month (2 digits, from 01 to 31);
  • T — separator between date and time (the letter T is a mandatory marker);
  • HH — hours in 24-hour format (2 digits, from 00 to 23);
  • MM — minutes (2 digits, from 00 to 59);
  • SS — seconds (2 digits, from 00 to 59);
  • SSSSSS — fractional part of seconds (up to 6 digits after the decimal point);
  • Z — timezone designation (Zulu time, i.e., UTC+0)
updated_atDate of the last update of the order in the format: YYYY-MM-DDTHH:MM:SS.SSSSSSZ, where:
  • YYYY — year (4 digits);
  • MM — month (2 digits, from 01 to 12);
  • DD — day of the month (2 digits, from 01 to 31);
  • T — separator between date and time (the letter T is a mandatory marker);
  • HH — hours in 24-hour format (2 digits, from 00 to 23);
  • MM — minutes (2 digits, from 00 to 59);
  • SS — seconds (2 digits, from 00 to 59);
  • SSSSSS — fractional part of seconds (up to 6 digits after the decimal point);
  • Z — timezone designation (Zulu time, i.e., UTC+0)

On this page