View Shipment

Introduction

This API document is a draft

To view the details of a shipment we need to know its unique ID, not shipment number or tracking related information.

The label will be returned as a base 64 encoded string containing the pdf formatted label document with one label per document.

GET /shipments/{uniqueId}

Example Requests

GET /shipments/3fa85f64-5717-4562-b3fc-2c963f66afa6

Example Responses

HTTP 200

{ 
  "shipmentNumber": "string", 
  "despatchDate": "2022-09-28T09:50:30.653Z", 
  "deliveryInstructions": "string", 
  "carrier": "string", 
  "carrierService": "string", 
  "hsCode": "string", 
  "descriptionOfGoods": "string", 
  "collectionAddress":  
  { 
    "businessName": "string", 
    "fullName": "string", 
    "phoneNumber": "string", 
    "emailAddress": "string", 
    "addressLine1": "string", 
    "addressLine2": "string", 
    "addressLine3": "string", 
    "county": "string", 
    "city": "string", 
    "countryTwoCharacterISOCode": "string", 
    "postZipCode": "string" 
  }, 
  "deliveryAddress":  
  { 
    "businessName": "string", 
    "fullName": "string", 
    "phoneNumber": "string", 
    "emailAddress": "string", 
    "addressLine1": "string", 
    "addressLine2": "string", 
    "addressLine3": "string", 
    "county": "string", 
    "city": "string", 
    "countryTwoCharacterISOCode": "string", 
    "postZipCode": "string" 
  }, 
  "reference": "string", 
  "cost": 0, 
  "insuredValue": 0, 
  "currency": "GBP", 
  "shipmentPieces": [ 
    { 
      "description": "string", 
      "weight": 0, 
      "weightUnit": "KG", 
      "length": 0, 
      "width": 0, 
      "height": 0, 
      "dimensionUnit": "CM", 
      "base64String": "string", 
      "trackingNumber": "string" 
    } 
  ] 
}

HTTP 400, 404

{ 
  "type": "string", 
  "title": "string", 
  "status": 0, 
  "detail": "string", 
  "instance": "string", 
  "additionalProp1": "string", 
  "additionalProp2": "string", 
  "additionalProp3": "string" 
}