Skip to main content
GET
Get add-on import status
This endpoint is restricted and not generally available: organizations that have not been enabled receive a 403. Contact your Let’s Do This representative if you’d like access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

jobId
string
required

The jobId the import returned when it accepted the batch.

Query Parameters

page[size]
number | null

How many results to return per page, from 1 to 50. Defaults to 50.

Required range: 1 <= x <= 50
Example:

50

page[after]
string | null

Pass page.next from the previous response to get the next page.

page[before]
string | null

Pass page.prev from the previous response to get the previous page.

Response

The job's progress so far, and a page of products with each one's result.

The state of an add-on import.

results holds one entry per product, with its status and errors. It's the only field that says whether a product was imported, so act on it. status is completed once the job has finished, even if every product failed. counts tracks the job's background work, not your products.

importId
string
required
jobId
string
required
status
enum<string>
required
Available options:
queued,
processing,
completed,
cancelled
counts
AddOnProductImportJobCounts · object
required

Progress of the job's background work. These count units of work, not your rows: one unit can cover several rows, and a finished unit counts as success even if all its rows failed. Read results for each row's outcome.

results
AddOnProductExecutionResult · object[]
required
page
PageCursor · object
required

Where you are in a paginated list.

Pass next as page[after] to get the next page, or prev as page[before] to get the previous one. An empty cursor means there are no more pages in that direction. Treat cursors as opaque strings.

Example: