Skip to main content
GET
/
commerce
/
inventory
/
v1
/
config
/
fetchfile
Error
A valid request URL is required to generate request examples
{
  "fetchFileConfigID": 123,
  "tenantID": 123,
  "active": true,
  "failed_attempts": 123,
  "lastModified": "<string>",
  "emailList": "<string>",
  "refreshEnabled": true,
  "refreshFileDescription": "<string>",
  "updateEnabled": true,
  "updateFileDescription": "<string>",
  "ftpServer": "<string>",
  "ftpUsername": "<string>",
  "ftpPassword": "<string>",
  "ftpPort": 123,
  "ftpRemotePath": "<string>",
  "ftpRemotePathArchive": "<string>",
  "region": "<string>",
  "s3Key": "<string>",
  "secret": "<string>",
  "bucket": "<string>",
  "s3Path": "<string>",
  "archiveBucket": "<string>",
  "s3ArchivePath": "<string>",
  "lockName": "<string>",
  "postProcessAction": 123,
  "useControlFile": true,
  "multipleFiles": true,
  "zeroOutNegatives": true,
  "fieldNameMap": [
    "<string>"
  ],
  "ignoreExtraFields": true,
  "blankQuantityIsZero": true,
  "csvDelimiter": "<string>",
  "exportAfterRefresh": true,
  "postImportExportId": 123,
  "postImportFtpId": 123,
  "productMapping": "SWAP_PART_NUMBER_WITH_UPC"
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Response

Success

Fetch File Config Model

fetchFileConfigID
integer

Fetch File Config ID

tenantID
integer

Tenant ID

active
boolean

Active

failed_attempts
integer

Failed Attempts

lastModified
string

Time config was last modified

emailList
string

Email List

refreshEnabled
boolean

Flag for Refresh Enabled

refreshFileDescription
string

Description for the refresh file

updateEnabled
boolean

Flag for Update Enabled

updateFileDescription
string

Description for the update file

ftpServer
string

FTP server address

ftpUsername
string

FTP server username

ftpPassword
string

FTP server password

ftpPort
integer

FTP server port

ftpRemotePath
string

FTP server remote path

ftpRemotePathArchive
string

FTP server remote path archive

region
string

S3 Region

s3Key
string

S3 Key

secret
string

S3 Secret

bucket
string

S3 Bucket

s3Path
string

S3 Bucket Path (directory)

archiveBucket
string

S3 Archive Bucket

s3ArchivePath
string

S3 Archive Bucket Path (directory)

lockName
string

Lock name

postProcessAction
integer

Enum denoting action post processing

useControlFile
boolean

Flag for using control file

multipleFiles
boolean

Flag for using multiple files

zeroOutNegatives
boolean

Flag for converting negatives to zero

fieldNameMap
string[]

List of field names

ignoreExtraFields
boolean

Flag for ignoring extra fields

blankQuantityIsZero
boolean

Flag to convert null quantities to zero

csvDelimiter
string

CSV Delimiter

exportAfterRefresh
boolean

Flag for exporting after refresh

postImportExportId
integer

Export id post import

postImportFtpId
integer

FTP id post import

productMapping
enum<string>

Enum for fetch file mapping

Available options:
SWAP_PART_NUMBER_WITH_UPC,
SWAP_SKU_WITH_UPC