Get Shipment Details

Will return detailed Shipment Object.

HTTP Request

GET /api/v1/shipments/{shipment_id}

Example

  {
      "data": {
          "id": 18174,
          "from_address": {
              "id": 109,
              "company": "Labelnship Corp",
              "contact_name": "Labelnship Corp",
              "email": null,
              "phone": "514-555-5555",
              "address_1": "22 Atlas Ave",
              "address_2": null,
              "city": "York",
              "province_state": "ON",
              "country": "CA",
              "zip_postal": "L4J3J8",
              "residential": null,
              "created_at": "2021-10-03 21:29:42",
              "updated_at": "2021-10-03 21:29:42"
          },
          "to_address": {
              "id": 110,
              "company": "Client Corp",
              "contact_name": "Mr Client",
              "email": null,
              "phone": "416-555-5555",
              "address_1": "390 Bay St",
              "address_2": null,
              "city": "Toronto",
              "province_state": "ON",
              "country": "CA",
              "zip_postal": "m5h2y2",
              "residential": null,
              "created_at": "2021-10-03 21:29:42",
              "updated_at": "2021-10-03 21:29:42"
          },
          "return_address": null,
          "package": [
              {
                  "Width": "10",
                  "Height": "5",
                  "Length": "10",
                  "Weight": "2",
                  "Insurance": "0",
                  "Description": null
              }
          ],
          "customs": null,
          "rates": [
              {
                  "rate_id": "rate_7bccb68a7df5441ba151726ef13e5d5b",
                  "days": 1,
                  "carrier": "FedEx",
                  "service": "FEDEX_EXPRESS_SAVER",
                  "price": {
                      "pre-tax": "12.46",
                      "tax": "1.62",
                      "taxName": "HST",
                      "tax2": null,
                      "tax2Name": null,
                      "residential": null,
                      "insurance": null,
                      "total": "14.08"
                  }
              },
              {
                  "rate_id": "rate_2557efaff33f403b92972d646bab4418",
                  "days": 3,
                  "carrier": "CanadaPost",
                  "service": "RegularParcel",
                  "price": {
                      "pre-tax": "14.93",
                      "tax": "1.94",
                      "taxName": "HST",
                      "tax2": null,
                      "tax2Name": null,
                      "residential": null,
                      "insurance": null,
                      "total": "16.87"
                  }
              },
              {
                  "rate_id": "rate_d1352a905612461f862aad83eb4a941a",
                  "days": 2,
                  "carrier": "CanadaPost",
                  "service": "ExpeditedParcel",
                  "price": {
                      "pre-tax": "15.07",
                      "tax": "1.96",
                      "taxName": "HST",
                      "tax2": null,
                      "tax2Name": null,
                      "residential": null,
                      "insurance": null,
                      "total": "17.03"
                  }
              }
          ],
          "selected_rate": {
              "rate_id": "rate_2557efaff33f403b92972d646bab4418",
              "days": 3,
              "carrier": "CanadaPost",
              "service": "RegularParcel",
              "price": {
                  "tax": "1.94",
                  "tax2": null,
                  "total": "16.87",
                  "pre-tax": "14.93",
                  "taxName": "HST",
                  "tax2Name": null,
                  "insurance": null,
                  "residential": null
              }
          },
          "label": "/api/shipment/eyJ.....IiJ9/labels",
          "created_at": "2021-10-10 22:05:14",
          "updated_at": "2021-10-10 22:05:45"
      }
  }
  {
      "message": "Not Found!"
  }