Create Export Settings

Creates entirely new export configurations for both FTP and S3 settings. This call allows you to specify all the values for the Export Settings object, such as file type and specific location groups or sites (which cannot be edited through FTP- or S3-specific endpoints). This is the initial setup request required to configure inventory export.

POST /commerce/inventory/v1/export/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

Request needed for creating Export Settings

exportSettings · Export Settings · object

Export Settings

Show child attributes

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