GET
/
offers-imports-jobs
/
{jobId}

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.

Required string length: 24
x-fabric-channel-id
string

The sales channel ID.

x-client-id
string

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

x-fabric-request-id
string

A unique request ID.

Path Parameters

jobId
string
required

Import job ID that's created when the import process starts

Response

200 - application/json

The details of the import job.

id
string
required

A 24-character system-generated ID of the import job.

startAt
string
required

The start time of the import job, in UTC format.

fileName
string
required

The name of the uploaded file

type
enum<string>
required

The import job type for which details are retrieved.

Available options:
PRICE,
PRICE_RANGE,
PRICELIST,
PROMOTION,
COUPON,
COUPON_CODE,
REDEMPTION
details
object[]
required

Represents the steps involved in the import process.

createdAt
string
required

Record's creation time

updatedAt
string
required

Record's last updated time

endAt
string | null

The end time of the import job, in UTC format.

errorFileName
string | null

Error file name if any error

errors
object[]

The errors details.

totalJob
integer

Indicates the total number of processes required to upload the entire file. For internal processing only.

completedJob
integer

Indicates the total number of completed processes for uploading the entire file. For internal processing only.

totalRowsCount
integer

Indicates the total number of rows in the CSV file. For internal processing only.

insertedRowsCount
integer

Indicates the total number of rows in the CSV file that were processed successfully. For internal processing only.

failedRowsCount
integer

Indicates the total number of rows in the CSV file that failed to process. For internal processing only.

Was this page helpful?

Get import jobsRetrieve the download URL for an error file