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

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

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