GET v1/customer/CustomerTracking/{CustomerRefNum}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CustomerRefNum

string

Required

Body Parameters

None.

Response Information

Resource Description

CustomerTracking
NameDescriptionTypeAdditional information
CustomerRefNum

string

None.

Title

string

None.

Order_ID

integer

None.

Shipment_Pickup_Date

date

None.

Shipment_Delivery_Date

date

None.

TotalStops

integer

None.

OrderCreatedDate

date

None.

CheckPoints

Collection of CustomerCheckPoints

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerRefNum": "sample string 1",
  "Title": "sample string 2",
  "Order_ID": 3,
  "Shipment_Pickup_Date": "2024-11-14T21:45:55.8660887-05:00",
  "Shipment_Delivery_Date": "2024-11-14T21:45:55.8660887-05:00",
  "TotalStops": 6,
  "OrderCreatedDate": "2024-11-14T21:45:55.8660887-05:00",
  "CheckPoints": [
    {
      "Created_at": "2024-11-14T21:45:55.881717-05:00",
      "Location": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Zip": "sample string 5",
      "Tag": "sample string 6",
      "Checkpoint_Time": "2024-11-14T21:45:55.881717-05:00",
      "ShipmentIndex": 8
    },
    {
      "Created_at": "2024-11-14T21:45:55.881717-05:00",
      "Location": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Zip": "sample string 5",
      "Tag": "sample string 6",
      "Checkpoint_Time": "2024-11-14T21:45:55.881717-05:00",
      "ShipmentIndex": 8
    }
  ]
}

application/xml, text/xml

Sample:
<CustomerTracking xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerRefNum>sample string 1</CustomerRefNum>
  <Title>sample string 2</Title>
  <Order_ID>3</Order_ID>
  <Shipment_Pickup_Date>2024-11-14T21:45:55.8660887-05:00</Shipment_Pickup_Date>
  <Shipment_Delivery_Date>2024-11-14T21:45:55.8660887-05:00</Shipment_Delivery_Date>
  <TotalStops>6</TotalStops>
  <OrderCreatedDate>2024-11-14T21:45:55.8660887-05:00</OrderCreatedDate>
  <CheckPoints>
    <CustomerCheckPoints>
      <Created_at>2024-11-14T21:45:55.881717-05:00</Created_at>
      <Location>sample string 2</Location>
      <City>sample string 3</City>
      <State>sample string 4</State>
      <Zip>sample string 5</Zip>
      <Tag>sample string 6</Tag>
      <Checkpoint_Time>2024-11-14T21:45:55.881717-05:00</Checkpoint_Time>
      <ShipmentIndex>8</ShipmentIndex>
    </CustomerCheckPoints>
    <CustomerCheckPoints>
      <Created_at>2024-11-14T21:45:55.881717-05:00</Created_at>
      <Location>sample string 2</Location>
      <City>sample string 3</City>
      <State>sample string 4</State>
      <Zip>sample string 5</Zip>
      <Tag>sample string 6</Tag>
      <Checkpoint_Time>2024-11-14T21:45:55.881717-05:00</Checkpoint_Time>
      <ShipmentIndex>8</ShipmentIndex>
    </CustomerCheckPoints>
  </CheckPoints>
</CustomerTracking>