Comment on page
Delivery
This is the central unit within Shippify. It consists of a set of two points, a collection point and a delivery point through which the associated packages must be transported.
.png?alt=media&token=a5ef0c32-e4d4-4bc2-9790-d087775e8114)
Property | Type | Description | Required | Constraint |
|---|---|---|---|---|
pickup | Contains the task pickup information. | YES | | |
dropoff | Contains the task dropoff information. | YES | | |
packages | Arrangement of packages containing the delivery. | YES | | |
referenceId | string | Identifiers from your system that can be attached to a Shippify delivery | NO | Depending on the company's configuration, this may be unique or mandatory. |
tags | array of string | Array of tag names to be added to the task. | NO | |
metadata | object | Object containing additional information of the task. It isn't visible in the dash | NO | |
extraData | object | Object containing additional information of the task. It's visible in the dash | NO | |
cod | number | Use this option if the driver needs to collect money from your client | NO | |
{
"pickup": {
"contact": {
"name": "Administrador Tienda Florida Center",
"email": "[email protected]",
"phonenumber": "+5622222222"
},
"location": {
"address": "Vicuña Mackenna 6100, La Florida, Región Metropolitana, Chile",
"lat": -33.511333999,
"lng": -70.6102933,
"instructions": "Local 1001"
}
},
"dropoff": {
"contact": {
"name": "Administrador Tienda Plaza Tobalaba",
"email": "[email protected]",
"phonenumber": "+562222222"
},
"location": {
"address": "Av. Camilo Henríquez 3296, Santiago, Puente Alto, Región Metropolitana, Chile",
"lat": -33.569311,
"lng": -70.5561712,
"instructions": "-"
}
},
"tags": ["PRIME", "CLOTHES"],
"packages": [
{
"name": "POLERA ML FULL CLBK CR I22 AZUL 10",
"qty": 1,
"weight": "1",
"size": 3,
"properties": [
{
"name": "Volumen",
"value": "0.1"
}
]
}
],
"referenceId": "0390052015954210132313",
"metadata": {
"storeId": 10057,
"pickupChannel": "1",
"empresaTransporte": "SHIPPIFY",
"virtualStoreId": "1195-1"
},
"extraData": [{"name":"Billing", "value":"0000-123-334"}],
"cod":10
}
Last modified 1mo ago