Get Shipment

Path parameters

Example response

<?php

return [
  'success' => true,
  'data' => [
    'shipment_id' => 'shp_101',
    'merchant_id' => 'mrc_001',
    'environment_id' => 'env_live_001',
    'merchant_order_ref' => 'ORD-8842',
    'collection_date' => '2026-02-18',
    'status' => 'in_transit',
    'pickup_address' => [
      'location_id' => 'loc_001',
      'name' => 'Warehouse A',
      'address_line_1' => '12 Jet Park Rd',
      'city' => 'Johannesburg',
      'country' => 'ZA',
      'post_code' => '1459',
      'latitude' => -26.1367,
      'longitude' => 28.2225
    ],
    'dropoff_address' => [
      'location_id' => 'loc_002',
      'name' => 'Customer Address',
      'address_line_1' => '90 Bree St',
      'city' => 'Cape Town',
      'country' => 'ZA',
      'post_code' => '8001',
      'latitude' => -26.1367,
      'longitude' => 28.2225
    ],
    'pickup_instructions' => 'Collect from loading bay 2',
    'dropoff_instructions' => 'Call on arrival',
    'ready_at' => '2026-02-18T07:30:00Z',
    'metadata' => [
      'source' => 'shopify'
    ],
    'parcels' => [
      [
        'parcel_id' => 'prc_001',
        'weight_kg' => '3.50',
        'length_cm' => '35',
        'width_cm' => '22',
        'height_cm' => '18',
        'declared_value' => '899.00',
        'contents_description' => 'Electronics accessories'
      ]
    ],
    'created_at' => '2026-02-17T10:22:00Z'
  ]
];