POST
/
oms-imports

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

Body

application/json

Import request object

fileName
string
required

Uploaded file name

module
enum<string>
required

Module name

Available options:
ALLOCATION,
ORDER,
LOCATION,
SHIPMENT,
INVENTORY,
INVOICE,
TRANSFER,
LOCATION_OUTAGE,
TRANSFER_SHIPMENT,
LOCATION_CAPACITY_OVERRIDE
type
enum<string>
default: BULKrequired

Import type. An overlay import will set all configured inventory counters to zero to "true up" on overlay, except for the counters in the file (the counters in the file will update the counters for inventory contained in the file).

Available options:
BULK,
OVERLAY,
ROOT
fileMd5Hash
string

Base64 encoded MD5 hash for file

Response

202 - application/json

Import response object

createdAt
string
required

Time of import request

importId
string
required

Imported file's unique ID

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.

attributes
object

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

fileName
string

Uploaded file name

module
enum<string>

Module name

Available options:
ALLOCATION,
ORDER,
LOCATION,
SHIPMENT,
INVENTORY,
INVOICE,
TRANSFER,
LOCATION_OUTAGE,
TRANSFER_SHIPMENT,
LOCATION_CAPACITY_OVERRIDE
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?

Getting Started with ImportsGet uploaded files that match specified criteria