Create Export Settings FTP

Creates new FTP settings and adds them to an existing Export Settings object, which may be useful if you want the export to go to a new endpoint instead of the one originally set up (or if the export needs to go to multiple endpoints). This call will not function unless you have performed the initial Create Export Settings request first.

POST /commerce/inventory/v1/export/ftp/create

Error

A valid request URL is required to generate request examples

200

{
  "exportSettingsFTPName": "<string>",
  "exportSettingsName": "<string>",
  "exportSettingsS3Name": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Body

application/json

Request to create a new Export Settings FTP

Request needed for creating Export Settings FTP

exportSettingsFTP · Export Settings FTP · object

Export Settings FTP

Show child attributes

exportSettingsName · string

Export Settings Name to associate the ftp settings with

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

200

application/json

Success

Job ID Response

exportSettingsFTPName · string

Created Export Settings FTP Name

exportSettingsName · string

Created Export Settings Name

exportSettingsS3Name · string

Created Export Settings S3 Name