POST
/
inventory-imports
curl --request POST \
  --url https://api.fabric.inc/v3/inventory-imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "fileName": "import-file.csv",
  "type": "INVENTORY"
}'
{
  "attributes": {
    "attribute": "12345"
  },
  "createdAt": "2022-08-01T18:03:28.483Z",
  "fileName": "orderUpload.csv",
  "importId": "62ff5c0bec0aed3c86202c32",
  "statusCode": "INITIATED",
  "type": "INVENTORY",
  "updatedAt": "2022-08-01T20:03:28.483Z",
  "uploadFileUrl": "https://example.com/tenant/import/bulk/1654680575676.csv?X-Amz-Security-Token=IQoJb3JpZ2"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

​
x-fabric-request-id
string

Unique request ID

​
x-fabric-channel-id
string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is an optional field. The default US channel is 12 while the default Canada channel is 13.

Body

application/json

An object containing the inventory import request details.

​
fileName
string
required

Uploaded file name

Example:

"import-file.csv"

​
type
enum<string>
required
Available options:
INVENTORY,
INVENTORY_COUNTERS
Example:

"INVENTORY"

Response

201
*/*
Created

An object containing the inventory import response details.

​
createdAt
string
required

Time of import request

Example:

"2022-08-01T18:03:28.483Z"

​
importId
string
required

Imported file's unique ID

Example:

"62ff5c0bec0aed3c86202c32"

​
uploadFileUrl
string
required

Uploaded file's path (including security token) generated by the system and returned in the response of the Create import request endpoint.

Example:

"https://example.com/tenant/import/bulk/1654680575676.csv?X-Amz-Security-Token=IQoJb3JpZ2"

​
attributes
object

A custom attribute placeholder.

Example:
{ "attribute": "12345" }
​
fileName
string

Uploaded file name

Example:

"orderUpload.csv"

​
statusCode
enum<string>

Uploaded file's current status

Available options:
INITIATED,
PROCESSING,
COMPLETED,
SYSTEM_ERROR
Example:

"INITIATED"

​
type
enum<string>

Import file type

Available options:
INVENTORY,
INVENTORY_COUNTERS
Example:

"INVENTORY"

​
updatedAt
string

Date and time record was last modified

Example:

"2022-08-01T20:03:28.483Z"

Was this page helpful?

Inventory FAQGet uploaded files that match specified criteria