GET
/
offers-imports-jobs
/
{jobId}
Get import job by ID
curl --request GET \
  --url https://api.fabric.inc/v3/offers-imports-jobs/{jobId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "id": "643eda1bd4c15c0008b4fb67",
  "startAt": "2023-04-18T17:57:07.260Z",
  "endAt": "2023-04-18T17:57:54.445Z",
  "fileName": "coupon/5f689caa4216e7000750d1ef/stg02/1681840413797-coupon.csv",
  "errorFileName": "coupon/5f689caa4216e7000750d1ef/stg02/1681840413797-error-coupon.csv",
  "type": "PRICE",
  "details": [
    {
      "timestamp": "2023-04-18T17:57:07.260Z",
      "isSuccess": true,
      "message": "Import coupon codes job started: Tue Apr 18 2023 17:57:47 GMT+0000 (Coordinated Universal Time)"
    }
  ],
  "errors": [
    {
      "message": "Price should always be >= 0.00",
      "count": 8
    }
  ],
  "totalJob": 10,
  "completedJob": 5,
  "totalRowsCount": 100,
  "insertedRowsCount": 60,
  "failedRowsCount": 40,
  "createdAt": "2019-08-20T14:15:22.000Z",
  "updatedAt": "2019-08-20T14:15:22.000Z"
}

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.

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

The sales channel ID.

Example:

"12"

​
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.

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

Path Parameters

​
jobId
string
required

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

Example:

"606469bdf4fb7900085f1761"

Response

OK

The details of the import job.

​
id
string
required

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

Example:

"643eda1bd4c15c0008b4fb67"

​
startAt
string
required

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

Example:

"2023-04-18T17:57:07.260Z"

​
fileName
string
required

The name of the uploaded file

Example:

"coupon/5f689caa4216e7000750d1ef/stg02/1681840413797-coupon.csv"

​
type
enum<string>
required

The import job type for which details are retrieved.

Available options:
PRICE,
PRICE_RANGE,
PRICELIST,
PROMOTION,
COUPON,
COUPON_CODE,
REDEMPTION
Example:

"PRICE"

​
details
object[]
required

Represents the steps involved in the import process.

​
createdAt
string<date-time>
required

Record's creation time

Example:

"2019-08-20T14:15:22.000Z"

​
updatedAt
string<date-time>
required

Record's last updated time

Example:

"2019-08-20T14:15:22.000Z"

​
endAt
string | null

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

Example:

"2023-04-18T17:57:54.445Z"

​
errorFileName
string | null

Error file name if any error

Example:

"coupon/5f689caa4216e7000750d1ef/stg02/1681840413797-error-coupon.csv"

​
errors
object[]

The errors details.

​
totalJob
integer

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

Example:

10

​
completedJob
integer

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

Example:

5

​
totalRowsCount
integer

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

Example:

100

​
insertedRowsCount
integer

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

Example:

60

​
failedRowsCount
integer

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

Example:

40