• Contact Sales
  • Get Support
  • Help Centre
      • Nothing Found
  • Contact Sales
  • Get Support
  • Help Centre
    Get started
      API overview
      Quick start
      Configuring Postman
      Changelog
    Basics
    Guides
    Reference
      Tracking
      Post-allocation
      Pre-allocation
      Customer Support
        post
        Search for parcel journeys using sensitive data

Search for parcel journeys using sensitive data

Search for parcel journeys using sensitive data, such as a customers email address or customer reference.

The email address or the customer reference can be used to search for parcel journeys over a period of 90 days.

A parcel journey contains the full tracking history related to the delivery of a parcel.

It unifies in a normalised format all of the events that have been published for the parcel, both pre-allocation and post-allocation.

These events include deliveries, delivery legs, and carrier tracking events.

SecurityBasicAuth
Request
header Parameters
User-Agent
string

The name of the client that interacts with the API.

Example: REPLACE-WITH-YOUR-USER-AGENT
Request Body schema: application/json
Any of:
email
string

The email address of the customer for which the parcel journeys are being requested.

Responses
200

OK

400

Bad request.

The request failed validation due to missing required information in the parameters or the body of the request.

Error code: PS-0400.

401

Unauthorized.

The request did not provide the credentials required to authorize access to the API.

Error code: PS-0401.

403

Forbidden.

The API user is not authorized to proceed with the processing of the request.

Error code: PS-0403.

500

Internal Server Error.

The processing of the request failed due to an internal problem. The request needs to be retried.

Error code: PS-0500.

post/parcel-journeys/search
Request samples
  • Payload
  • curl
  • JavaScript
  • Node.js
  • Python
  • C#
  • Java
  • Go
  • PHP
  • Ruby
application/json
{
  • "customerRef": "REPLACE-WITH-YOUR-CUSTOMER-REF"
}
Response samples
  • 200
  • 400
  • 401
  • 403
  • 500
application/json
[
  • {
    • "order": {
      • "orderRef": "REPLACE-WITH-YOUR-ORDER-REF",
      • "orderDate": "2019-08-24T14:15:22Z",
      • "marketplace": "Acme",
      • "billingAddress": {
        • "addressLine1": "200 Grays Inn Road",
        • "addressLine2": "string",
        • "postCode": "WC1X 8XZ",
        • "countryCode": "GBR",
        • "companyName": "Metapack",
        • "city": "London",
        • "stateProvince": "London",
        • "timeZone": "Europe/London"
        },
      • "customer": {
        • "customerRef": "REPLACE-WITH-YOUR-CUSTOMER-REF",
        • "customerSegment": "VIP",
        • "email": "john.doe@example.com",
        • "name": "John Doe",
        • "phone": "07814354765"
        },
      • "products": [
        • {
          • "productRef": "PRD-12345",
          • "name": "Trainers",
          • "description": "string",
          • "longDescription": "string",
          • "quantity": 1,
          • "size": "39 / 6",
          • "colour": "Blue",
          • "pageURL": "https://some.cdn.com/products/PRD-12345.html",
          • "images": {
            • "desktop": "https://some.cdn.com/products/images/desktop/PRD-12345.png",
            • "mobile": "https://some.cdn.com/products/images/mobile/PRD-12345.png",
            • "altTag": "Picture of trainers"
            },
          • "salePrice": {
            • "amount": 60.99,
            • "currencyCode": "GBP"
            },
          • "items": [
            • {
              • "itemRef": "PRD-12345-BL-06"
              }
            ]
          }
        ],
      • "seller": {
        • "brand": "Phasion for Men",
        • "brandRef": "PH20MEN",
        • "companyName": "Phasion",
        • "id": "6a624ffb-1032-4941-ba4b-c23834bfc876",
        • "parentOrg": "Metapack"
        }
      },
    • "recipient": {
      • "addressLine1": "200 Grays Inn Road",
      • "addressLine2": "string",
      • "postCode": "WC1X 8XZ",
      • "countryCode": "GBR",
      • "companyName": "Metapack",
      • "city": "London",
      • "stateProvince": "London",
      • "timeZone": "Europe/London",
      • "contact": {
        • "name": "John Doe",
        • "email": "johndoe@email.com",
        • "phone": "07814354765",
        • "identity": {
          • "birthDate": "13/05/1978"
          }
        }
      },
    • "delivery": {
      • "carrierPINCode": "2351",
      • "carrierServiceType": "TRACKED",
      • "direction": "OUTBOUND",
      • "instructions": "Please collect your parcel from the pick up location",
      • "returnType": "ON_DEMAND",
      • "shippedDateTime": "2019-08-24T14:15:22Z",
      • "type": "PUDO",
      • "deliveryWindow": {
        • "from": "2019-08-24T14:15:22Z",
        • "to": "2019-08-24T14:15:22Z"
        },
      • "selectedTimeSlot": {
        • "from": "11:00:00",
        • "to": "12:00:00"
        }
      },
    • "collection": {
      • "accessibility": true,
      • "daysHeld": 7,
      • "information": "Collection counter on 2nd floor next to womenswear",
      • "locationId": "EASYCOLLECT-1234",
      • "openingHours": [
        • "Mo 08:00-12:00,14:00-17:00",
        • "Tu 09:00-20:00",
        • "We 09:00-20:00",
        • "Th 09:00-20:00",
        • "Fr 09:00-20:00",
        • "Sa 09:00-17:00",
        • "Su 09:00-17:00"
        ],
      • "parkingAvailability": true,
      • "storeDetailsURL": "https://easycollect.com/shops/info",
      • "address": {
        • "addressLine1": "200 Grays Inn Road",
        • "addressLine2": "string",
        • "postCode": "WC1X 8XZ",
        • "countryCode": "GBR",
        • "companyName": "Metapack",
        • "city": "London",
        • "stateProvince": "London",
        • "timeZone": "Europe/London",
        • "contact": {
          • "email": "somebody@example.com",
          • "phone": "0800155781"
          }
        },
      • "location": {
        • "latitude": 51.52325226913702,
        • "longitude": -0.1146692876584629,
        • "what3words": "lowest.homes.calm",
        • "name": "Warehouse 11"
        }
      },
    • "parcel": {
      • "deliveryRef": "REPLACE-WITH-YOUR-DELIVERY-REF",
      • "parcelRef": "REPLACE-WITH-YOUR-PARCEL-REF",
      • "deliveryLegs": [
        • {
          • "carrierCode": "DPD_UK",
          • "carrierDisplayName": "DPD UK",
          • "carrierServiceCode": "DPD_UK_CLASSIC",
          • "carrierTrackingURL": "https://track.dpd.co.uk/parcels/REPLACE-WITH-YOUR-TRACKING-IDENTIFIER",
          • "finalDeliveryLeg": true,
          • "trackingIdentifier": "REPLACE-WITH-YOUR-TRACKING-IDENTIFIER"
          }
        ],
      • "items": [
        • {
          • "itemRef": "PRD-12345-BL-06"
          }
        ]
      },
    • "latestTrackingStatus": {
      • "trackingIdentifier": "REPLACE-WITH-YOUR-TRACKING-IDENTIFIER",
      • "deliveryRef": "REPLACE-WITH-YOUR-DELIVERY-REF",
      • "eventCode": "AWAITING_COLLECTION_FROM_PICKUP_POINT",
      • "eventDate": "2019-08-24T14:15:22Z",
      • "eventSource": "STORE",
      • "eventTimeZone": "Europe/London",
      • "eventLocation": {
        • "location": {
          • "latitude": 51.52325226913702,
          • "longitude": -0.1146692876584629,
          • "what3words": "lowest.homes.calm",
          • "name": "Warehouse 11"
          },
        • "address": {
          • "addressLine1": "200 Grays Inn Road",
          • "addressLine2": "string",
          • "postCode": "WC1X 8XZ",
          • "countryCode": "GBR",
          • "companyName": "Metapack",
          • "city": "London",
          • "stateProvince": "London",
          • "timeZone": "Europe/London"
          }
        },
      • "eventDescription": "Ready to collect",
      • "eventCategory": "HAPPY",
      • "exceptionMessage": "The delivery company will provide instructions about where to collect your order.",
      • "statusCode": "READY_TO_COLLECT",
      • "statusDescription": "Ready to collect"
      },
    • "sender": {
      • "addressLine1": "200 Grays Inn Road",
      • "addressLine2": "string",
      • "postCode": "WC1X 8XZ",
      • "countryCode": "GBR",
      • "companyName": "Metapack",
      • "city": "London",
      • "stateProvince": "London",
      • "timeZone": "Europe/London"
      },
    • "trackingEvents": [
      • {
        • "trackingIdentifier": "REPLACE-WITH-YOUR-TRACKING-IDENTIFIER",
        • "deliveryRef": "REPLACE-WITH-YOUR-DELIVERY-REF",
        • "eventCode": "AWAITING_COLLECTION_FROM_PICKUP_POINT",
        • "eventDate": "2019-08-24T14:15:22Z",
        • "eventSource": "STORE",
        • "eventTimeZone": "Europe/London",
        • "eventLocation": {
          • "location": {
            • "latitude": 51.52325226913702,
            • "longitude": -0.1146692876584629,
            • "what3words": "lowest.homes.calm",
            • "name": "Warehouse 11"
            },
          • "address": {
            • "addressLine1": "200 Grays Inn Road",
            • "addressLine2": "string",
            • "postCode": "WC1X 8XZ",
            • "countryCode": "GBR",
            • "companyName": "Metapack",
            • "city": "London",
            • "stateProvince": "London",
            • "timeZone": "Europe/London"
            }
          },
        • "eventDescription": "Ready to collect",
        • "eventCategory": "HAPPY",
        • "exceptionMessage": "The delivery company will provide instructions about where to collect your order.",
        • "statusCode": "READY_TO_COLLECT",
        • "statusDescription": "Ready to collect"
        }
      ]
    }
]
Resources
  • Metapack.com
  • Carrier Library
  • Support
APIs
  • Shipping
  • Tracking
Copyright © Metapack Limited 2021-2022. All right reserved.