The deliveryModel field defines the pickup and delivery method for a shipment. It specifies whether the shipment is picked up from and/or delivered to a shipper/consignee address or an SPL branch. Four delivery models are supported: DoortoDoor, DoortoRetail, RetailtoDoor, and RetailtoRetail. Select the value that matches the intended shipment flow and pickup/delivery locations.
|
Value |
Collection |
Delivery |
Pickup task |
Use when |
|
DoortoDoor |
Shipper address |
Consignee address |
Yes |
You want the standard end to end service. |
|
DoortoRetail |
Shipper address |
SPL branch |
Yes |
The consignee will collect from a branch. |
|
RetailtoDoor |
SPL branch |
Consignee address |
No |
You have no scheduled pickup and will drop off yourself. |
|
RetailtoRetail |
SPL branch |
SPL branch |
No |
Both parties use a branch. |
-
DoortoDoor
|
Exact value |
DoortoDoor. Confirm casing. |
|
Collection |
SPL collects from the shipper address. A pickup task is created and assigned to a courier. |
|
Delivery |
SPL delivers to the consignee address. Last mile delivery is performed. |
|
Mandatory fields |
Full shipper address and full consignee address, per the isNationalAddress rule. No destination branch identifier is required. |
|
To author |
Confirm with GN TEQ: whether a pickup can be scheduled for a future date, whether a pickup window can be requested, the cut off time for same day pickup, and what happens when collection fails. |
-
DoortoRetail
|
Exact value |
DoortoRetail. Confirmed in the SPL UAT contract. |
|---|---|
|
Collection |
SPL collects from the shipper address. A pickup task is created. |
|
Delivery |
SPL delivers to a nominated SPL retail branch. The consignee collects in person. No delivery to the consignee address occurs. |
|
Mandatory fields |
Full shipper address. Consignee contact details remain mandatory because the consignee must be notified to collect. Consignee city remains required. |
|
Additional mandatory |
The nominated collection branch must be identified. Strongly suspected to be locationCode1. Must be confirmed and documented, with the branch list published as reference data. Without it a merchant cannot use this model at all. |
|
To author |
Confirm with GN TEQ: the notification sent to the consignee, how many days the parcel is held before return to origin, the identification required to collect, and whether a third party may collect on the consignee behalf. |
-
RetailtoDoor
|
Exact value |
RetailtoDoor. Confirm casing. |
|
Collection |
The shipper drops the parcel at an SPL retail branch. No pickup task is created and no courier is dispatched. |
|
Delivery |
SPL delivers to the consignee address. Last mile delivery is performed. |
|
Mandatory fields |
Full consignee address per the isNationalAddress rule. Shipper contact remains mandatory. Shipper address remains required by the schema. |
|
Additional mandatory |
Confirm with GN TEQ: whether the drop off branch must be nominated in the payload, or whether the shipper may drop at any branch. This has a direct operational consequence and cannot be left unstated. |
|
To author |
The label must be printed before drop off. State whether the branch prints on the merchant behalf, what identification is required, and how long the shipment stays valid between creation and drop off before automatic cancellation. |
-
RetailtoRetail
|
Exact value |
RetailtoRetail. Confirm casing. |
|
Collection |
The shipper drops the parcel at an SPL retail branch. No pickup task. |
|
Delivery |
The consignee collects from a nominated SPL retail branch. No last mile delivery. |
|
Mandatory fields |
Contact details for both parties remain mandatory. Both cities remain required. Neither street address is used for delivery, but state whether the schema still requires them. |
|
Additional mandatory |
The destination branch identifier, as for DoortoRetail. Confirm whether the origin branch must also be nominated. |
|
To author |
Confirm with GN TEQ: the branch holding period, return to origin behaviour when not collected, and whether this model is available for all product types or domestic only. |