Skip to main content
POST
/
commerce
/
inventory
/
v1
/
config
/
fetchfile
Error
A valid request URL is required to generate request examples
{
  "messages": [
    "<string>"
  ],
  "numResults": 123,
  "success": true
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Body

application/json

Request to fetch file configs

Request for Fetch File Configs

active
boolean

Flag for active state

archiveBucket
string

S3 Archive Bucket

blankQuantityIsZero
boolean

Flag to convert null quantities to zero

bucket
string

S3 Bucket

csvDelimiter
string

Delimiter

emailList
string

Email List

fetchFileConfigID
integer

Fetch File Config ID

fieldNameMap
string[]

List of field names

ftpPassword
string

FTP server password

ftpPort
integer

FTP server port

ftpRemotePath
string

FTP server remote path

ftpRemotePathArchive
string

FTP server remote path archive

ftpServer
string

FTP server address

ftpUsername
string

FTP server username

ignoreExtraFields
boolean

Flag for ignoring extra fields

locationCode
string

Location Code

lockName
string

Lock name

multipleFiles
boolean

Flag for using multiple files

pageNum
integer

which page to show

pageSize
integer

how many results to show per page

postProcessAction
integer

Enum denoting action post processing

productMapping
enum<string>

Enum for fetch file productMapping

Available options:
SWAP_PART_NUMBER_WITH_UPC,
SWAP_SKU_WITH_UPC
refreshEnabled
boolean

Flag for Refresh Enabled

refreshFileDescription
string

Description for the refresh file

region
string

S3 Region

s3ArchivePath
string

S3 Archive Bucket Path (directory)

s3Path
string

S3 Bucket Path (directory)

sortBy
string

index to sort results by

testFTPConfigs
boolean

Flag for if its a test ftp config

updateEnabled
boolean

Flag for Update Enabled

updateFileDescription
string

Description for the update file

useControlFile
boolean

Flag for using control file

userID
integer

user id

zeroOutNegatives
boolean

Flag for converting negatives to zero

Response

Success

Base Response Model

messages
string[]

List of messages

numResults
integer

Number of results

success
boolean

Flag for success