Export service (2.0.0)

Download OpenAPI specification:Download

fabrics export APIs for multi tenant service

Export Controller

These endpoints help in performing export operations

Export records by query

Exports records by query

SecurityAuthorization or context
Request
header Parameters
required
object (XSiteContext)

x-site-context value

Request Body schema: application/json
limit
integer <int32>
Default: 10

Numbers of records to be returned.

offset
integer <int64>
Default: 0

Number of records to skipped.

sortBy
string
Default: "updatedAt"

Item property on which data needed to be sorted on.

sortDirection
string
Default: "desc"

Direction of sorting i.e ascending or descending

Enum: "asc" "desc"
required
object
Default: {}

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

module
required
string

Define module for which you need to export data

Enum: "ORDER" "LOCATION" "ALLOCATION" "INVENTORY" "INVOICE" "SHIPMENT" "SHIPPING_METHODS" "NETWORK"
csvHeadersConfig
string

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

Responses
200

[SUCCESS] Record export process Initiated

400

[BAD REQUEST]

404

Not Found

500

Internal Server Error

post/
Request samples
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "sortBy": "updatedAt",
  • "sortDirection": "desc",
  • "filters": {
    },
  • "module": "ORDER",
  • "csvHeadersConfig": "default"
}
Response samples
application/json
{
  • "keyId": "6213c2d4deeadd00debb46b4",
  • "version": 0,
  • "module": "order",
  • "status": "FINISHED",
  • "totalRowsExported": 20,
  • "totalRecordsExported": 20,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "filters": {
    }
}

Get OMS export log history by query

Retrieves OMS export log history by query

SecurityAuthorization or context
Request
header Parameters
required
object (XSiteContext)

x-site-context value

Request Body schema: application/json
limit
integer <int32>
Default: 10

Numbers of records to be returned.

offset
integer <int64>
Default: 0

Number of records to skipped.

sortBy
string
Default: "updatedAt"

Item property on which data needed to be sorted on.

sortDirection
string
Default: "desc"

Direction of sorting i.e ascending or descending

Enum: "asc" "desc"
required
object
Default: {}

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

Responses
200

OMSExportLog list matching query

400

[BAD REQUEST]

404

Not Found

500

Internal Server Error

post/history
Request samples
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "sortBy": "updatedAt",
  • "sortDirection": "desc",
  • "filters": {
    }
}
Response samples
application/json
{
  • "count": 100,
  • "limit": 10,
  • "offset": 1
}

Get record export status for given request

Retrieves record export status for given request

SecurityAuthorization or context
Request
query Parameters
keyId
required
string
header Parameters
required
object (XSiteContext)

x-site-context value

Responses
200

Record Export status

400

[BAD REQUEST]

404

KeyId provided is incorrect

500

Internal Server Error

get/status
Response samples
application/json
{
  • "keyId": "6213c2d4deeadd00debb46b4",
  • "version": 0,
  • "module": "order",
  • "status": "FINISHED",
  • "totalRowsExported": 20,
  • "totalRecordsExported": 20,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "filters": {
    }
}

Get list of headers for given module

Retrieves list of headers for given module. Accepted values are order, location, allocation, inventory, invoice, and network.

SecurityAuthorization or context
Request
query Parameters
module
required
string
header Parameters
required
object (XSiteContext)

x-site-context value

Responses
200

List of headers

400

[BAD REQUEST]

404

Not a valid module name

500

Internal Server Error

get/headers-list
Response samples
application/json
{
  • "header1": true,
  • "header2": true
}

Get list of files for given module

Retrieves list of files for given module. Accepted values are order, location, allocation, inventory, invoice, and network.

SecurityAuthorization or context
Request
query Parameters
module
required
string
header Parameters
required
object (XSiteContext)

x-site-context value

Responses
200

List of network export keys

400

[BAD REQUEST]

404

Not a valid module name

500

Internal Server Error

get/files-list
Response samples
application/json
"[KeyId1, KeyId2]"

Get URL for downloading exports

Gets URL for downloading exports

SecurityAuthorization or context
Request
query Parameters
keyId
required
string
header Parameters
required
object (XSiteContext)

x-site-context value

Responses
200

OMSExportLog download url

400

[BAD REQUEST]

404

Key does not exist!

500

Internal Server Error

get/download-url
Response samples
application/json
{}