Create Shipment

Introduction

This API document is a draft

To create a shipment we need to receive all the relevant information: addresses, pieces with dimensions, reference, carrier, service, etc.

POST /shipments

Example Requests

POST /shipments

{
  "despatchDate": "2022-09-28T09:50:30.653Z", 
  "goodsDescription": "string", 
  "deliveryInstructions": "string", 
  "carrierId": 0, 
  "carrierServiceId": 0, 
  "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" 
  }, 
  "referenceOne": "string", 
  "referenceTwo": "string", 
  "referenceThree": "string", 
  "cost": 0, 
  "insuredValue": 0, 
  "currency": "GBP", 
  "shipmentPieces": [ 
    { 
      "description": "string", 
      "weightUnit": "KG",
      "dimensionUnit": "CM",
      "weight": 0,
      "length": 0, 
      "width": 0, 
      "height": 0
    } 
  ],
  "carrierFeatures": [
    0
  ]
}

Example Responses

HTTP 200

{ 
  "success": true, 
  "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 
  "shipmentNumber": "string", 
  "shipmentPieces": [ 
    { 
      "sequenceNumber": 0, 
      "base64String": "string", 
      "trackingNumber": "string" 
    } 
  ] 
}

HTTP 400, 404

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