v1

latestSwagger 2.02026-07-13107214235.7 KB
Shipment

Get a specific shipment.

Get a specific shipment.

get/v1/workgroups/{workgroup_id}/projects/{project_id}/shipments/{shipment_id}

Path parameters

workgroup_idstring required
project_idstring required
shipment_idstring required

Response

Successful retrieval

status_codeinteger
status_reasonstring

Example response

{
  "result": {
    "locations": [
      {
        "city": "sample city",
        "company_name": "sample company_name",
        "country": "sample country",
        "country_code": "sample country_code",
        "custom_fields": [
          {
            "param_name": "sample param_name",
            "string_value": "sample string_value"
          }
        ],
        "description_or_title": "sample description_or_title",
        "email": "sample email",
        "first_name": "sample first_name",
        "last_name": "sample last_name",
        "line_1": "sample line_1",
        "line_2": "sample line_2",
        "line_3": "sample line_3",
        "middle_name": "sample middle_name",
        "postal": "sample postal",
        "proof_type": "sample proof_type",
        "received_comments": "sample received_comments",
        "requested_shipping_carrier": "sample requested_shipping_carrier",
        "requested_shipping_method": "sample requested_shipping_method",
        "shipped_comments": "sample shipped_comments",
        "shipped_in_uofm": "sample shipped_in_uofm",
        "shipped_shipping_carrier": "sample shipped_shipping_carrier",
        "shipped_shipping_method": "sample shipped_shipping_method",
        "shipping_instruction": "sample shipping_instruction",
        "state": "sample state",
        "tracking_number": "sample tracking_number",
        "type": "sample type",
        "weight_uofm": "sample weight_uofm",
        "work_phone_number": "sample work_phone_number",
        "workgroup_name": "sample workgroup_name"
      }
    ],
    "shipment_status": "sample shipment_status",
    "spec": {
      "reference_number": "sample reference_number",
      "spec_name": "sample spec_name"
    }
  },
  "resut": {
    "locations": [
      {
        "city": "sample city",
        "company_name": "sample company_name",
        "country": "sample country",
        "country_code": "sample country_code",
        "custom_fields": [
          {
            "param_name": "sample param_name",
            "string_value": "sample string_value"
          }
        ],
        "description_or_title": "sample description_or_title",
        "email": "sample email",
        "first_name": "sample first_name",
        "last_name": "sample last_name",
        "line_1": "sample line_1",
        "line_2": "sample line_2",
        "line_3": "sample line_3",
        "middle_name": "sample middle_name",
        "postal": "sample postal",
        "proof_type": "sample proof_type",
        "received_comments": "sample received_comments",
        "requested_shipping_carrier": "sample requested_shipping_carrier",
        "requested_shipping_method": "sample requested_shipping_method",
        "shipped_comments": "sample shipped_comments",
        "shipped_in_uofm": "sample shipped_in_uofm",
        "shipped_shipping_carrier": "sample shipped_shipping_carrier",
        "shipped_shipping_method": "sample shipped_shipping_method",
        "shipping_instruction": "sample shipping_instruction",
        "state": "sample state",
        "tracking_number": "sample tracking_number",
        "type": "sample type",
        "weight_uofm": "sample weight_uofm",
        "work_phone_number": "sample work_phone_number",
        "workgroup_name": "sample workgroup_name"
      }
    ],
    "shipment_status": "sample shipment_status",
    "spec": {
      "reference_number": "sample reference_number",
      "spec_name": "sample spec_name"
    }
  },
  "status_reason": "sample status_reason"
}