Export data by query

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

Unique request ID

JSON to filter records. JSON structure should match the schema of the target entity such as, order, shipment, and invoice.

The module, also known as the fabric service, thAT data will be exported from. Accepted values are ORDER, LOCATION, LOCATION_OUTAGE, LOCATION_CAPACITY_OVERRIDE, ALLOCATION, INVENTORY, INVOICE, SHIPMENT, NETWORK, SHIPPING_METHODS, AGGREGATED_NETWORK.

The file format used to export your records. The records are exported in a zip file that can be downloaded from the provided URL link and extracted. Both CSV and JSON are supported.

Header name by which the module will be exported to CSV

Property by which data is sorted

Module (fabric service) for which data is exported. Accepted values are ORDER, LOCATION, ALLOCATION, INVENTORY, INVOICE, SHIPMENT, NETWORK, SHIPPING_METHODS, AGGREGATED_NETWORK

The file format used to export your records. The records are exported in a zip file that can be downloaded from the provided URL link and extracted. Both CSV and JSON are supported.

Number of updates happened to this export document. This gets incremented with every update that happens to the export document. For example, when export of data is initiated, the status is marked INITIATED, then the status gets updated to PROCESSING, and then it's marked FINISHED, thereby the document gets updated thrice. So, the version will be 3.

Time when the export operation was triggered for the first time

Header name by which the module is exported to CSV

Unique ID for export request

Export log status. INITIATED: Export request is successfully initiated. PROCESSING: Export request is accepted, and the export is under process. FINISHED: Request is successfully completed. Use the GET/exports/{exportId} endpoint to download export records. SYSTEM_ERROR: Request errored out for some reason.

Total number of records (allocation, order, etc) exported

Total number of rows exported for a record

Time when the export operation was updated last time

Download URL. The URL will be available to download only when status is FINISHED