Create Consignment API

Create a Consignment

Endpoint: POST /v1/consignments
Description: Creates a new consignment (shipment) and returns its details and tracking information.

Request Example

{
  "accountNumber": "123456",
  "reference": "ORDER-1001",
  "sender": {
    "name": "ABC Distribution",
    "addressLine1": "12 Warehouse Road",
    "suburb": "Penrose",
    "city": "Auckland",
    "postcode": "1061",
    "contact": {
      "name": "John Doe",
      "phone": "0211234567",
      "email": "john.doe@abc.co.nz"
    }
  },
  "receiver": {
    "name": "Jane Smith",
    "addressLine1": "45 Beach Road",
    "suburb": "City Centre",
    "city": "Tauranga",
    "postcode": "3110",
    "contact": {
      "name": "Jane Smith",
      "phone": "0279876543"
    }
  },
  "items": [
    {
      "description": "Carton of books",
      "weightKg": 5.2,
      "dimensionsCm": {
        "length": 40,
        "width": 30,
        "height": 25
      },
      "dangerousGoods": false
    }
  ],
  "serviceCode": "ONC",
  "specialInstructions": "Leave at reception if unattended"
}

Response Example (201 Created)

{
  "consignmentId": "FW123456789",
  "ticketNumber": "NZC12345678",
  "carrier": "NZ Couriers",
  "labelUrl": "https://api.freightways.co.nz/v1/labels/FW123456789",
  "trackingUrl": "https://api.freightways.co.nz/v1/track/NZC12345678",
  "status": "Created"
}
 

Field Notes

Field Description
accountNumber Freightways customer account number
reference Your internal reference number (e.g., order ID)
sender / receiver Required address and contact information
items List of items in the consignment
serviceCode Freightways service code (e.g., ONC = Overnight Courier)
specialInstructions Optional delivery notes

Did this article answer your question?

Can't find the answer to your question?

Suggest an article