Schema
ShipJob
An object of the Qoene Delivery API.
Fields
| Field | Type | Description |
|---|---|---|
public_idRequired | string | Ship run IDPattern ^(?:QD-SHJ-[A-F0-9]{24}|QDSHJ[A-Z0-9]{3,31})$ |
statusRequired | enum | One of QUEUED, RUNNING, COMPLETED |
optionsOptional | object | |
declaration_versionOptional | string | |
created_atOptional | string (date-time) | |
started_atOptional | string (date-time) or null | |
finished_atOptional | string (date-time) or null | |
retry_of_job_public_idOptional | string or null | |
requested_by_api_client_idOptional | string or null | |
requested_by_api_client_nameOptional | string or null | |
total_countRequired | integer | |
queued_countOptional | integer | |
processing_countOptional | integer | |
created_countOptional | integer | |
failed_countOptional | integer | |
skipped_countOptional | integer | |
itemsOptional | array of object | Detail only: one result per order. |
positionRequired | integer | |
statusRequired | enum | One of QUEUED, PROCESSING, CREATED, FAILED, SKIPPED |
order_public_idRequired | string | |
external_order_idOptional | string | |
order_referenceOptional | string | |
shipment_public_idOptional | string or null | |
tracking_numberOptional | string or null | |
amount_minorOptional | MinorAmount or null | |
label_statusOptional | string or null | ISSUED, or AWAITING_PAYMENT for a prepaid parcel. |
label_public_idOptional | string or null | |
failure_codeOptional | string or null | |
failure_reasonOptional | string or null |