Exporting Orders
The Export feature provides you with the ability to export all your order-related data. This topic covers the process of exporting order data.
Previous exports can be viewed in the Orders > Activity Log page. You can download previous export files from this page.
Prerequisites
Ensure that you have the Orders & Inventory Editor or Admin privilege for fabric Orders. For more information, see the Role-Based Access Control section.
Export logic
Exporting downloads a zip folder containing a JSON source file or multiple CSV files depending on the option you select.
JSON
The JSON zip folder contains a single JSON file. The JSON file contains objects for each orderId. Each order object contains the entire history and information of an order including the SKUs for each item in the order.
CSV
The CSV zip folder contains CSV files for orders (exported by item), adjustments, appeasements, discounts, logs, notes, payments, and shipInfo.
Each row in the order CSV file represents a product in the order. If an order contains multiple products, duplicate orderId rows are displayed for each product.
The following table outlines each column in the order CSV file and provides example values. Values in the CSV file are populated only if the data is available.
| Column name | Description | Example value |
|---|---|---|
| orderId | The 24-character system-generated order ID. | 65c0e0d07044e34a495a05c8 |
| orderNumber | A merchant-defined order identifier. If omitted, this is generated by fabric’s sequence generator using the configuration service. | 6250002317 |
| version | The current version of the order. The number displayed indicates the number of times the order is updated by any operation. | 11 |
| orderedAt | The merchant-defined order creation time (UTC). | 2022-05-12T09:30:31.198Z |
| cancelledAt | The system-generated order cancellation time (UTC). | 2022-05-12T09:30:31.198Z |
| allocatedAt | The system-generated order allocation time (UTC). | 2022-05-12T09:30:31.198Z |
| channelId | The merchant-defined sales channel ID. | WHBM |
| cartId | The unique cart identifier, either from fabric cart service or an external cart service. It is used for linking an order to a specific cart. | 5f2d15e8-a837-41a3-9bf1-4467e8e1893a |
| type | The order type. | WEB |
| subtype | The order subtype. This is used if further classification is required. | ANDROID |
| processName | Order process name (V2) only. | |
| employeeId | The employee (ID or name) who initiated the request. | 3213123 |
| retail | Determines if an order was created from a Point-of-Sale system. | true |
| orderSubtotal | Recalculated orderSubtotal - summationOfAll(itemSubTotal) | 24.55 |
| originalSubtotal | A system-generated order subtotal, auto-filled by the orders service when an order is placed. This is saved for reference in case the value changes later. | 24.55 |
| orderDiscount | Recalculated order discount. | 49 |
| originalDiscount | The system-generated total discount, auto-filled by the orders service when an order is placed. This is saved for reference in case the value changes later. | 49.99 |
| feeTotal | Recalculated total fee, calculated as orderedQuantity* itemFeeTotal | 7.95 |
| originalFeeTotal | The system-generated total fees, auto-filled by the orders service when an order is placed. | 7.95 |
| taxTotal | Recalculated total tax on an order. summationOfAll(itemTaxTotal)+summationOf(tax[].value) | 13.45 |
| appeasementTotal | The final appeasement amount. | -10 |
| originalTaxTotal | The system-generated total tax, auto-filled by the orders service when an order is placed. | 12.93 |
| returnTotal | The return total of order. Calculated as summationOfAll(itemReturnTotal) | -3 |
| cancelTotal | The amount to be returned after an order cancellation. Calculated as cancelledQuantity / orderedQuantity * itemTotal | 85.19 |
| invoiceTotal | The total payment captured by fabrics invoice service. If you are using a third-party service, then this amount will be null. For partial payment scenarios, this value will be different from orderTotal. | 149.09 |
| orderTotal | The total amount to be charged for the order. Calculated as orderSubTotal - orderDiscountTotal + orderFeeTotal + orderTaxTotal | 149.09 |
| originalOrderTotal | A system-generated order total, auto-filled by the orders service when an order is placed. This is saved for reference in case the orderTotal changes. | 234.28 |
| currency | A three-letter currency code as defined by ISO-4217. | USD |
| statusCode | The current status of the order. | ORDER_SHIPPED |
| statusDescription | A human readable brief description of the statusCode value. | Order Shipped |
| orderReleasedAt | The order released time (UTC). | 2022-05-12T09:30:31.198Z |
| createdAt | The order creation time (UTC). | 2024-02-05T13:21:20.686Z |
| updatedAt | The timestamp for the latest update that was made to the order (UTC). | 2024-02-21T20:12:42.127Z |
| adjustmentTotal | The total price adjustment made to the item. | 0 |
| originalAdjustmentTotal | A system-generated order adjustment total, auto-filled by the orders service when an order is placed. This is saved for reference in case the adjustmentTotal value changes. | 0 |
The remaining CSV files for adjustments, appeasements, discounts, logs, notes, payments, and shipInfo contain one or more of the following columns.
For example, the adjustment-order CSV file contains columns for orderId, orderNumber, itemId, sku, lineItemId, and lineItemNumber.
| Column name | Description | Example value |
|---|---|---|
| orderId | The 24-character system-generated order ID. | 65dce9816a08674c56ecdef2 |
| orderNumber | A merchant-defined order identifier. If omitted, this is generated by fabric’s sequence generator using the configuration service. | 6250002317 |
| cartId | The unique cart identifier, either from fabric cart service or an external cart service. It is used for linking an order to a specific cart. | 5f2d15e8-a837-41a3-9bf1-4467e8e1893a |
| statusCode | The current status of the order. | ORDER_ALLOCATED |
| itemId | A system-generated unique identifier of an item from fabric Product Catalog service. | 1145 |
| channelId | The merchant-defined sales channel ID. | CHS |
| sku | The stock keeping unit (SKU), unique identifier of item. | P1135 |
| lineItemId | A merchant-defined unique identifier for each item in an order. When omitted, fabric generates it in UUID format during order creation. | d538b1f1-0e45-43c6-bfc6-9666fc1188ca |
| lineItemNumber | A merchant-defined line item number to identify each item in an order. | 15 |
| lineOrderStatus | A system generated status for each item in the order. | SHIPPED |
Procedure
-
In the left menu, click Orders.
The Orders tab is displayed on the Manage Orders page.
-
To export specific orders, filter the number of orders displayed using the filters on the Orders tab.
Only the filtered results displayed in the table are exported during the export operation. For example, if you set the filter criteria to Last 7 Days, only the orders from the last seven days are exported.
-
Click Export.
The Export Order Activity as CSV or JSON File window is displayed.
-
In the Export format field, select one of the following:
- CSV: Select this if you want to export CSV files.
- JSON: Select this if you want to export a JSON file.
-
Click Export.
A zip file containing your export is downloaded.
Related topics
Was this page helpful?