Skip to main content
GET
/
commerce
/
inventory
/
v1
/
export
Error
A valid request URL is required to generate request examples
[
  {
    "exportSettings": {
      "name": "<string>",
      "fileFormat": "XML",
      "exportType": "AGGREGATE",
      "ftpInformation": [
        {
          "name": "<string>",
          "ftpServer": "<string>",
          "ftpPort": 123,
          "ftpDirectory": "<string>",
          "active": true,
          "exportSettingsID": 123,
          "exportSettingsFTPID": 123,
          "ftpDirectoryControlFile": "<string>",
          "ftpUser": "<string>",
          "ftpPassword": "<string>",
          "deliveryClass": "<string>",
          "controlFile": "<string>",
          "controlFileEmail": "<string>",
          "remoteFileName": "<string>",
          "controlFileName": "<string>",
          "endpoint": "<string>",
          "environment": "<string>"
        }
      ],
      "onlySendAvailable": true,
      "onlySendActiveLocations": true,
      "s3Information": [
        {
          "name": "<string>",
          "region": "<string>",
          "bucket": "<string>",
          "exportSettingsID": 123,
          "exportSettingsS3ID": 123,
          "active": true
        }
      ],
      "exportSingleFile": true,
      "safetyStock": "SAFETY_STOCK_MAX",
      "floor": "FLOOR_MAX",
      "ltd": "LTD_MAX",
      "fileName": "<string>",
      "shortenFilename": true,
      "includeAttributes": true,
      "zipFiles": true,
      "zipFileName": "<string>",
      "untransformedFileName": "<string>",
      "untransformedZipFileName": "<string>",
      "locationGroupIDs": [
        123
      ],
      "siteIDs": [
        123
      ],
      "directShip": true,
      "pickup": true,
      "transfer": true,
      "productMapping": "SWAP_PART_NUMBER_WITH_UPC",
      "isClassic": true,
      "ignoreNegativeInventoryLocations": true,
      "tags": {}
    }
  }
]

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

exportSettingsName
string

Export Settings Name

Response

Success

exportSettings
Export Settings · object

Export Settings