Import Job

The jobs endpoint provides a programmatic way of running long running background tasks with Eshopbox.

The process of reading a file can take a long time which should not block user's experience. Hence to carry process in background we have Jobs.

Attribute

Type

Description

id

number

Id to define the import job uniquely

jobType

string

Import Job for different modules .For details refer the The Job Type Object

channelId

number

The channel for which file has been uploaded

importFilters

object

Filter parameters required while uploading the respective file

filePath

String

File Path of Uploaded file

successCount

number

No of Success Records in the uploaded file

failureCount

number

No of failed records in the uploaded file

failedFilePath

String

File path with reason for failure

status

string

Status to track the progress of uploaded file. For details refer the The Status Object

additionalDetails

String

Extra information required by a particular import job while processing the job.

fileReadFailureReason

String

File failure reason if any while uploading

userId

number

Used to identify the user who has uploaded the file

createdAt

string

Creation date and time

updatedAt

string

Updation date and time

The Status Object

Status Value

Description

processing

The job is currently running.

completed

The job is completed and file is ready for download.

failed

The job couldn't be completed due to some error.

The Job Type Object

Job Type

Description

listing_update

listing_create

create_order

discount_upload

return_upload

fee_rule

Upload charge rule for a fee

invoice_event

base_product

statement

listing

virtual_combo

kit

return

get_inventory

Last updated