You can list parcel related to your delivery requests via /parcels endpoint.
These parameters are available to you:
Name | Type | Description |
limit | number | Number of entries per page. |
orderNumber | string | Return only parcels related to this order number. |
parcelId | string | ID of the parcel in our system. Return only parcel/s with this ID. |
pageToken | string | Set this token to return records for given page. You get this for each response. |
See an example of an integration:
GET /parcels
curl -X 'GET' \
‘.../parcels?limit=50’ \
-H 'accept: application/json'
Status Code 200
{
"pagination": {
"first": "string",
"last": "string",
"next": "string",
"prev": "string"
},
"count": 0,
"data": [
{
"id": "string",
"state": "new",
"name": "Smartphone",
"value": "4.56",
"weight": "1.6",
"compartmentSize": 0,
"originDeliveryRefId": "string",
"destinationDeliveryRefId": "string",
"itemRefId": "string",
"allowReturn": true,
"deliveryRequest": {
"typeOfService": "same-day",
"description": "string",
"orderNumber": "string",
"invoiceValue": "25.50",
"paymentMode": "prepaid",
"amountToBeCollected": "25.50",
"allowReturn": false,
"notifyOnAccepted": "[email protected]",
"origin": {
"contactNumber": "+30 21 4 655 1234",
"contactEmail": "string",
"contactName": "Yiannis Papadopoulos",
"deliveryPartnerId": "7983",
"title": "ΠΑΝΤΕΛΟΓΛΟΥ ΔΗΜΗΤΡΗΣ",
"name": "ΠΑΝΤΕΛΟΓΛΟΥ ΔΗΜΗΤΡΗΣ",
"addressLine1": "ΛΕΩΦΟΡΟΣ ΕΙΡΗΝΗΣ 28",
"addressLine2": "string",
"postalCode": "15121",
"country": "GR",
"note": "You can find it behind the pet shop",
"locationId": "string"
},
"destination": {
"contactNumber": "+30 21 4 655 1234",
"contactEmail": "string",
"contactName": "Yiannis Papadopoulos",
"deliveryPartnerId": "7983",
"title": "ΠΑΝΤΕΛΟΓΛΟΥ ΔΗΜΗΤΡΗΣ",
"name": "ΠΑΝΤΕΛΟΓΛΟΥ ΔΗΜΗΤΡΗΣ",
"addressLine1": "ΛΕΩΦΟΡΟΣ ΕΙΡΗΝΗΣ 28",
"addressLine2": "string",
"postalCode": "15121",
"country": "GR",
"note": "You can find it behind the pet shop",
"locationId": "string"
},
"items": [
{
"id": "string",
"name": "Smartphone",
"value": "3.45",
"weight": 0,
"compartmentSize": 0,
"originDeliveryParcelId": "415-02914-308",
"destinationDeliveryParcelId": "415-02914-308"
}
]
},
"events": [
{
"type": "new",
"locationDisplayName": "Ελληνικά Ταχυδρομεία",
"postalCode": "104 37",
"createTime": "2021-06-07T12:33:18.723Z"
}
]
}
]
}
Status Code 400
The server cannot or will not process the request due to something that is perceived to be your error (e.g., malformed request syntax, invalid request message). You are to modify the request before sending it again.
{
"code": "string",
"message": "string"
}
Status Code 401
Not Authorized. You are either using an expired Access token to access the data or trying to initialize Auth session with invalid data.