Developers
API referenceBusiness sign in

Schema

ShipJob

An object of the Qoene Delivery API.

Fields

ShipJob fields
FieldTypeDescription
public_idRequiredstringShip run IDPattern ^(?:QD-SHJ-[A-F0-9]{24}|QDSHJ[A-Z0-9]{3,31})$
statusRequiredenumOne of QUEUED, RUNNING, COMPLETED
optionsOptionalobject
declaration_versionOptionalstring
created_atOptionalstring (date-time)
started_atOptionalstring (date-time) or null
finished_atOptionalstring (date-time) or null
retry_of_job_public_idOptionalstring or null
requested_by_api_client_idOptionalstring or null
requested_by_api_client_nameOptionalstring or null
total_countRequiredinteger
queued_countOptionalinteger
processing_countOptionalinteger
created_countOptionalinteger
failed_countOptionalinteger
skipped_countOptionalinteger
itemsOptionalarray of objectDetail only: one result per order.
positionRequiredinteger
statusRequiredenumOne of QUEUED, PROCESSING, CREATED, FAILED, SKIPPED
order_public_idRequiredstring
external_order_idOptionalstring
order_referenceOptionalstring
shipment_public_idOptionalstring or null
tracking_numberOptionalstring or null
amount_minorOptionalMinorAmount or null
label_statusOptionalstring or nullISSUED, or AWAITING_PAYMENT for a prepaid parcel.
label_public_idOptionalstring or null
failure_codeOptionalstring or null
failure_reasonOptionalstring or null

Used by