GET
/
oms-exports
/
{exportId}

Authorizations

Authorization
string
headerrequired

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

Headers

x-fabric-tenant-id
string
required

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

x-fabric-request-id
string

Unique request ID

Path Parameters

exportId
string
required

Unique export ID

Response

200 - application/json

Export log details

module
string
required

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

recordFormat
enum<string>
default: CSVrequired

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.

Available options:
CSV,
JSON
version
integer
required

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.

createdAt
string

Time when the export operation was triggered for the first time

csvHeadersConfig
string

Header name by which the module is exported to CSV

exportId
string

Unique ID for export request

status
enum<string>

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.

Available options:
INITIATED,
PROCESSING,
FINISHED,
SYSTEM_ERROR
totalRecordsExported
integer

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

totalRowsExported
integer

Total number of rows exported for a record

updatedAt
string

Time when the export operation was updated last time

url
string

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

Was this page helpful?

OverviewGet export jobs by query