GET
/
inventory-imports
/
{importId}
curl --request GET \
  --url https://api.fabric.inc/v3/inventory-imports/{importId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "attributes": {
    "attribute": "12345"
  },
  "createdAt": "2022-08-01T18:03:28.483Z",
  "errorFileUrl": "https://example.com/tenant/import/bulk/1654680575676.csv?X-Amz-Security-Token=IQoJb3JpZ2",
  "fileName": "orderUpload.csv",
  "finishedAt": "2022-08-01T18:03:28.483Z",
  "importCount": {
    "error": 2000,
    "processed": 8000,
    "uploaded": 10000
  },
  "importId": "62ff5c0bec0aed3c86202c32",
  "originalFileUrl": "https://example.com/tenant/import/bulk/1654680575676.csv?X-Amz-Security-Token=IQoJb3JpZ2",
  "statusCode": "INITIATED",
  "type": "INVENTORY",
  "updatedAt": "2022-08-01T20:03:28.483Z"
}

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.

Path Parameters

​
importId
string
required

Upload file document's unique ID

Response

200
*/*
OK

An object containing the inventory import status 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"

​
attributes
object

Custom attributes. This is a placeholder for additional info in key: value pairs

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

Directory path where file uploaded

Example:

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

​
fileName
string

Uploaded file name

Example:

"orderUpload.csv"

​
finishedAt
string

Date and time file import was completed

Example:

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

​
importCount
object

Import count object

​
originalFileUrl
string

Path to download the uploaded file

Example:

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

​
statusCode
enum<string>

Uploaded file's current status

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

"INITIATED"

​
type
enum<string>
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?

Get uploaded files that match specified criteriaForce import halt