Get Shipment

To get a particular shipment, you need to make a call to the shipments endpoint and pass id as a path parameter to get the appropriate response.

Get Shipment

https://live.sendbox.co/shipping/shipments/:id

This gets a particular shipment by id

Request

Path Parameters

Name	Type	Description
id	number	the shipment id

Headers

Name	Type	Description
Authorization	String	Authorization-key
Content-type	String	application/json

Response

200:OK

{
  "destination_contact_phone": "070787354687",
  "code": "0005111734",
  "status_code": "drafted",
  "height": 0.0,
  "time_schedule": {
    "code": "anytime",
    "name": "Anytime"
  },
  "amount": null,
  "is_spillable": false,
  "narration": null,
  "owner": "Sendbox",
  "destination_address": "22 ekilezicuvuj Ikangba Plateau Nigeria",
  "destination_name": "Gary Estrada",
  "incoming_option": {
    "code": "drop_off",
    "name": "Drop Off"
  },
  "payment_options": null,
  "origin_city": "Ikeja",
  "width": 0.0,
  "package_delivery_attempt": 0,
  "short_origin_address": "Ikeja Lagos Nigeria",
  "origin_phone": "070679992262",
  "package_received_by": null,
  "destination_city": "Ikangba",
  "package_delivery_status_code": null,
  "recurrent_cards": [],
  "package_label_image": null,
  "origin_state": {
    "code": "LOS",
    "name": "Lagos"
  },
  "has_waybill_error": false,
  "insurance_option_code": "standard",
  "pk": "896205",
  "package_invoice_image": null,
  "transaction_id": null,
  "merchant": {
    "username": null,
    "email": "[e-mail]",
    "id": 11499,
    "phone": "[phone]",
    "name": "kiko jayson"
  },
  "delivery_priority": {
    "code": "next_day",
    "name": "Next Day"
  },
  "payment_option": {
    "code": null,
    "name": null
  },
  "courier": {
    "name": null
  },
  "total_value": 1.0,
  "package_fulfilment_status_code": null,
  "origin_address": "11 sokdubzubohg Ikeja Lagos Nigeria",
  "package_agent": {
    "username": null,
    "email": null,
    "id": 0,
    "phone": null,
    "name": null
  },
  "min_quoted_fee": 3074.0,
  "pickup_attempts": [],
  "origin_state_code": "LOS",
  "package_type_code": null,
  "max_quoted_fee": 3074.0,
  "tracking": {
    "destination_country": null,
    "status": null,
    "origin_city": null,
    "destination_city": null,
    "origin_name": null,
    "destination_name": null,
    "current_awb": null,
    "origin_country": null
  },
  "client_id": 0,
  "destination_email": "[e-mail]",
  "origin_contact_phone": "070679992262",
  "package_delivery_fee": 0.0,
  "origin_post_code": null,
  "coupon_description": null,
  "possible_actions": [
    {
      "code": "pay",
      "name": "Pay"
    },
    {
      "code": "cancel",
      "name": "Cancel"
    }
  ],
  "notes": null,
  "current_status": {
    "code": "drafted",
    "name": "On Hold"
  },
  "use_selected_rate": null,
  "destination_street": "22 ekilezicuvuj",
  "package_delivery_date": null,
  "reference_code": null,
  "selected_rate_id": null,
  "pod": "Prepaid",
  "destination_state": {
    "code": "PLT",
    "name": "Plateau"
  },
  "shipment_id": null,
  "origin_city_id": 1154,
  "domain": null,
  "package_type": {
    "code": null,
    "name": null
  },
  "last_updated": "2019-11-27T09:22:28.161606",
  "weight": 0.5,
  "amount_to_receive": 1.0,
  "destination_state_code": "PLT",
  "sensitivity": "",
  "package_fulfilment_status": {
    "code": null,
    "name": null
  },
  "package_delivery_eta": null,
  "origin_country": {
    "code": "NG",
    "name": "Nigeria"
  },
  "package_courier_id": null,
  "delivery_priority_code": "next_day",
  "origin_country_code": "NG",
  "package_agent_id": 0,
  "package_date_received": null,
  "package_delivery_status": {
    "code": null,
    "name": null
  },
  "has_waybill": null,
  "delivery_type_code": "last_mile",
  "short_destination_address": "Ikangba Plateau Nigeria",
  "pickup_courier": {
    "status": null,
    "courier_name": null
  },
  "origin_name": "Sarah Malone",
  "waybill_error": "false",
  "package_received_by_signature": null,
  "payment_option_code": null,
  "id": 896205,
  "package_last_updated": null,
  "payment_source_code": null,
  "origin_email": "[e-mail]",
  "pickup_date": null,
  "destination_country_code": "NG",
  "status": {
    "code": "drafted",
    "name": "On Hold"
  },
  "priority_pickup_fee": 0.0,
  "package_rejection_reason": null,
  "package_received_by_phone": null,
  "destination_phone": "070787354687",
  "time_schedule_code": "anytime",
  "paid": 0.0,
  "incoming_option_code": "drop_off",
  "fee": 2766.0,
  "courier_id": 0,
  "merchant_id": 11499,
  "destination_post_code": null,
  "destination_country": {
    "code": "NG",
    "name": "Nigeria"
  },
  "is_confidential": false,
  "package_courier": {
    "name": null
  },
  "origin_street": "11 sokdubzubohg",
  "current_awb": null,
  "items": [
    {
      "description": null,
      "weight": 0.5,
      "amount_to_receive": 1.0,
      "package_size_code": null,
      "item_type_code": "letter_or_document",
      "id": 917030,
      "name": "Test",
      "accept_value_on_delivery": false,
      "value": 1.0,
      "item_type": {
        "code": "letter_or_document",
        "name": "Letters or Documents"
      },
      "reference_code": null,
      "quantity": 1
    }
  ],
  "is_fragile": false,
  "accept_value_on_delivery": false,
  "package_date_created": null,
  "coupon_code": "marketrush",
  "length": 0.0,
  "selected_courier": {
    "name": "DHL"
  },
  "selected_courier_id": 22,
  "action": null,
  "date_created": "2019-11-27T09:22:28.102707",
  "fee_balance": 0.0,
  "delivery_type": {
    "code": "last_mile",
    "name": "Door to Door Delivery"
  },
  "quantity": 1,
  "api_endpoint": "shipments"
}

Staging URL: Staging URL: https://sandbox.staging.sendbox.co/shipping/shipments/:id