Shipping Ports

Retrieve shipping port reference data for container and international shipments.

Endpoints Overview

Get Shipping Ports Page

Retrieve a paginated list of shipping ports.

Endpoint: GET /v1/shipping-ports

Query Parameters

Request Example

curl -X GET "https://api.consignlyhq.com/v1/shipping-ports?PageIndex=1&PageSize=50&SearchText=Auckland" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example

{
  "index": 1,
  "total": 3,
  "shippingPorts": [
    {
      "id": "550e8400-e29b-41d4-a716-446655449400",
      "code": "NZAKL",
      "name": "Auckland",
      "country": "New Zealand"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655449401",
      "code": "NZTRG",
      "name": "Tauranga",
      "country": "New Zealand"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655449402",
      "code": "NZWLG",
      "name": "Wellington",
      "country": "New Zealand"
    }
  ]
}

Response Fields

Get Shipping Port Details

Retrieve details for a specific shipping port.

Endpoint: GET /v1/shipping-ports/{shippingPortId}

Path Parameters

Request Example

curl -X GET "https://api.consignlyhq.com/v1/shipping-ports/550e8400-e29b-41d4-a716-446655449400" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example

{
  "id": "550e8400-e29b-41d4-a716-446655449400",
  "code": "NZAKL",
  "name": "Auckland",
  "country": "New Zealand"
}

Response Fields

Using Shipping Port Codes

Shipping port codes are used in consignment imports for container shipments:

{
  "loadShippingPortCode": "CNSHA",
  "dischargeShippingPortCode": "NZAKL",
  "containerNumber": "MSKU1234567",
  ...
}

Common Port Codes

Related Endpoints

• Consignment Import - Create consignments with port information
• Consignments - View port details on consignments