GET
/
exports
/
status
curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/exports/status \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "keyId": "6213c2d4deeadd00debb46b4",
  "version": 123,
  "module": "order",
  "status": "FINISHED",
  "totalRowsExported": 20,
  "totalRecordsExported": 20,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "filters": {
    "orderSubTotal": {
      "gte": 1300,
      "lt": 1400
    },
    "orderNumber": "order-*Z",
    "statusCode": [
      "ORDER_CREATED"
    ],
    "createdAt": {
      "lt": "2022-09-11T23:12:00.123Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

​
keyId
string
required

Response

200
application/json
Record Export status

OMSExportLog Model

​
module
string
required
Example:

"order"

​
keyId
string
Example:

"6213c2d4deeadd00debb46b4"

​
version
integer
​
status
string
Example:

"FINISHED"

​
totalRowsExported
integer
Example:

20

​
totalRecordsExported
integer
Example:

20

​
createdAt
string
​
updatedAt
string
​
filters
object
Example:
{
  "orderSubTotal": { "gte": 1300, "lt": 1400 },
  "orderNumber": "order-*Z",
  "statusCode": ["ORDER_CREATED"],
  "createdAt": { "lt": "2022-09-11T23:12:00.123Z" }
}

Was this page helpful?