GET
/
oms-imports
/
{importId}

Authorizations

Authorization
string
headerrequired

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-channel-id
string
required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id
string

Unique request ID

Path Parameters

importId
string
required

Upload file document's unique ID

Response

200 - application/json

Import status response object

createdAt
string
required

Time of import request

importId
string
required

Imported file's unique ID

attributes
object

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

errorFileUrl
string

Path (including security token) the file was uploaded to

fileName
string

The uploaded file name.

finishedAt
string

Date and time file import was completed

importCount
object

Import count object

module
enum<string>

Module name

Available options:
ALLOCATION,
ORDER,
LOCATION,
SHIPMENT,
INVENTORY,
INVOICE,
TRANSFER,
LOCATION_OUTAGE,
TRANSFER_SHIPMENT,
LOCATION_CAPACITY_OVERRIDE
originalFileUrl
string

URL of originally uploaded file

statusCode
enum<string>

Uploaded file's current status

Available options:
INITIATED,
PROCESSING,
COMPLETED,
SYSTEM_ERROR
type
enum<string>

Import type

Available options:
BULK,
OVERLAY,
ROOT
updatedAt
string

Date and time record was last modified

Was this page helpful?

Get uploaded files that match specified criteriaOverview