Skip to main content
POST
/
commerce
/
inventory
/
v1
/
export
Error
A valid request URL is required to generate request examples
{
  "exportInventoryJobResponses": [
    {
      "exportSettingsID": 123,
      "jobID": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Body

application/json

Request to run an inventory export

Export Inventory Request

development
boolean

Flag for sending the exports to the development droppoint

exportSettingsFTPName
string

Name of the FTP Settings to use. Will only check for this if exportID is already set

exportSettingsName
string

Name of the Export Settings to use

exportSettingsS3Name
string

Name of the S3 Settings to use. Will only check for this if exportID is already set

locationCode
string

Location Code

pageNum
integer

which page to show

pageSize
integer

how many results to show per page

sortBy
string

index to sort results by

userID
integer

user id

Response

Success

Response for Export Inventory api

exportInventoryJobResponses
Export Inventory Job Response · object[]

List of Export Inventory Job Responses