POST
/
exports

Authorizations

Authorization
string
headerrequired

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

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

LibExportQuery Model

filters
object
required

JSON to do filtration of records. to filter records json structure should be similar to target entity structure i.e order, shipment etc

module
enum<string>
required

Define module for which you need to export data

Available options:
ORDER,
LOCATION,
ALLOCATION,
INVENTORY,
INVOICE,
SHIPMENT,
SHIPPING_METHODS,
NETWORK
limit
integer
default: 10

Numbers of records to be returned.

offset
integer
default: 0

Number of records to skipped.

sortBy
string
default: updatedAt

Item property on which data needed to be sorted on.

sortDirection
enum<string>
default: desc

Direction of sorting i.e ascending or descending

Available options:
asc,
desc
csvHeadersConfig
string

Define config name that contains the expected headers to be exported with each export file

Response

200 - application/json

OMSExportLog Model

module
string
required
keyId
string
version
integer
status
string
totalRowsExported
integer
totalRecordsExported
integer
createdAt
string
updatedAt
string
filters
object

Was this page helpful?

OverviewGet list of headers for given module