Handover Jobs
A handover job represents the handover of an order to the end consumer or parcel service provider and provides all the necessary information.
Last updated
Was this helpful?
A handover job represents the handover of an order to the end consumer or parcel service provider and provides all the necessary information.
Last updated
Was this helpful?
Despite general information like the order date, tenant order id or a reference to the corresponding facility a handover job carries handover relevant information like the handover channel (DELIVERY: will it be handed over to a parcel service provider or COLLECT: will it be handed over to the end customer) or handover job cancel reason (it was not handed over due to a no show of the customer, the order was cancelled, etc.).
A handover will automatically created when a parcel has changed to status FINISHED while the related Pick Job was in status CLOSED or a pick job has changed to status CLOSED and there is at least one Parcel of the related Shipment that is in status FINISHED.
Alternatively a Handover Job can be created via REST Api
channel
The channel describes whether this order will be collected by the customer or by a parcel service provider. The value can either be COLLECT
or DELIVERY
facilityRef
The id of the facility this order is handed over in
orderDate
The date and time this order was placed
targetTime
The date and time this handover job has to be handed over
carrierLogoUrl
The url to the logo of the carrier for displaying purposes in the Backoffice
carrierRef
The id of the carrier in case this is an order fulfilled by a parcel service provider
carrierTrackingNumber
The tracking number provided by the parcel service provider.
customAttributes
Additional information you might want to add to this Handover Job.
handoverJobLineItems
The items that the Handover Job contains.
loadUnitRefs
The ids of the Load Units used in the picking process of this order.
parcelRef
The id of the Parcel used
pickJobRef
The id of the related Pick Job
processId
The id of the related Process
operativeProcessRef
The id of the related Operative Process
shipmentRef
The id of the related shipment.
shortIdentifier
A short id
status
The status of the Handover Job it should be created in. Can be: OPEN
, HANDED_OVER
, OBSOLETE
, CANCELED
(created in OPEN when not provided)
tenantOrderId
The id you use internally for this order.
paid
A boolean flag that indicates whether this order has already been paid for or not
tags
The tags that are related to this Handover Job
stickers
Stickers that are related to this Handover Job.
cancelReason
The reason this hand over has been cancelled. Can be: CONSUMER_NO_SHOW
, CONSUMER_REJECTS
, ORDER_CANCELLED
invoiceAddress
Address of the invoice.
recipientAddress
Address of the recipient.
fullIdentifier
A longer identifier
transfers
Transfers related to this Handover Job.
lineItems
lineItems that have (not) been handed over. You can pass an array of line items that have been handed over (or not) including substitute items and add information about items that have been refused (by the customer).
While you can configure available refused reasons via the Handover Job Configuration, the reasons that are passed with this request will not be validated against those that have been configured. This gives you the flexibility between having e.g. free forms for the refused reasons as well as providing pre-defined ones for your clients.
Passing no reason is not allowed. To pass no reasons an appropriate reason (e.g. 'No Reasons') should be used.
The URL to the carrier logo
Tracking number for the created shipment
Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
The id of the facility reference.
Esb20gpHBL94X5NdMp3C
Reference to array of load unit Refs
The date this order was created at the supplying system.
2020-02-03T08:45:50.525Z
The reference to the parcel.
2fOge2ZGW54K4TgvDTQw
The reference to the pickjob for which the handoverjob is assigned to
ca525716-7208-4a63-a2a6-11274eb37f67-0
Id of the global process related to this entity. For example used for starting the GDPR process and others.
The reference to the shipment belonging to the handoverjob
Esb20gpHBL94X5NdMp3C
The short identifier of the shipment.
The time the handoverjob is expected to be picked up at the facility.
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546
Indicates if the order is already paid
false
Tags can only be set when there is no process related with this handoverJob. Setting processId and tags will lead to an validationError.
An information to identify the recipient