GET api/OrderTrackingDatas?id={id}&ClientOrderId={ClientOrderId}

Retrieves full details on an order by order number including tracking. Also looks up any order containing the text of the submitted ClientOrderId value.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Only one of these parameters are required. The id is the int OrderId in the BGS system.

integer

None.

ClientOrderId

Only one of these parameters are required. This is the string ClientOrderId from your system.

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of OrderTrackingData
NameDescriptionTypeAdditional information
OrderId

integer

None.

ClientOrderId

string

Required

String length: inclusive between 1 and 100

ClientOrderId2

string

None.

WarehouseCode

string

None.

OrderStatus

string

None.

OrderDate

date

Required

ShipByDate

date

None.

DeliverByDate

date

None.

CompanyOrName

string

Required

String length: inclusive between 2 and 35

Attention

string

String length: inclusive between 2 and 35

AddressLine1

string

Required

String length: inclusive between 2 and 35

AddressLine2

string

String length: inclusive between 2 and 35

AddressLine3

string

String length: inclusive between 2 and 35

City

string

Required

String length: inclusive between 2 and 35

State

string

Required

String length: inclusive between 2 and 35

PostalCode

string

Required

String length: inclusive between 2 and 35

Country

string

Required

String length: inclusive between 2 and 35

Phone

string

String length: inclusive between 0 and 35

Email

string

String length: inclusive between 0 and 100

ShippingMethod

string

None.

NotesToCustomerPackingSlip

string

String length: inclusive between 0 and 500

NotesToWarehouse

string

String length: inclusive between 0 and 255

OrderDetailData

Collection of OrderDetailData

None.

ShippingData

Collection of ShippingData

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "OrderId": 2,
    "ClientOrderId": "sample string 3",
    "ClientOrderId2": "sample string 4",
    "WarehouseCode": "sample string 6",
    "OrderStatus": "sample string 7",
    "OrderDate": "2025-12-14T15:23:43.1937126+00:00",
    "ShipByDate": "2025-12-14T15:23:43.1937126+00:00",
    "DeliverByDate": "2025-12-14T15:23:43.1937126+00:00",
    "CompanyOrName": "sample string 10",
    "Attention": "sample string 11",
    "AddressLine1": "sample string 12",
    "AddressLine2": "sample string 13",
    "AddressLine3": "sample string 14",
    "City": "sample string 15",
    "State": "sample string 16",
    "PostalCode": "sample string 17",
    "Country": "sample string 18",
    "Phone": "sample string 19",
    "Email": "sample string 20",
    "ShippingMethod": "sample string 22",
    "NotesToCustomerPackingSlip": "sample string 23",
    "NotesToWarehouse": "sample string 24",
    "OrderDetailData": [
      {
        "ItemSKU": "sample string 4",
        "ItemSKU2": "sample string 5",
        "ItemDescription": "sample string 6",
        "ItemQuantity": 7,
        "IsKitHeader": true,
        "IsPicked": true,
        "PickType": "sample string 10",
        "OrderDetailLotData": [
          {
            "InventoryUnitId": 2,
            "LicenseId": "sample string 3",
            "Lot": "sample string 4",
            "ExpirationDate": "2025-12-14T15:23:43.1937126+00:00",
            "ItemQuantity": 5
          },
          {
            "InventoryUnitId": 2,
            "LicenseId": "sample string 3",
            "Lot": "sample string 4",
            "ExpirationDate": "2025-12-14T15:23:43.1937126+00:00",
            "ItemQuantity": 5
          }
        ]
      },
      {
        "ItemSKU": "sample string 4",
        "ItemSKU2": "sample string 5",
        "ItemDescription": "sample string 6",
        "ItemQuantity": 7,
        "IsKitHeader": true,
        "IsPicked": true,
        "PickType": "sample string 10",
        "OrderDetailLotData": [
          {
            "InventoryUnitId": 2,
            "LicenseId": "sample string 3",
            "Lot": "sample string 4",
            "ExpirationDate": "2025-12-14T15:23:43.1937126+00:00",
            "ItemQuantity": 5
          },
          {
            "InventoryUnitId": 2,
            "LicenseId": "sample string 3",
            "Lot": "sample string 4",
            "ExpirationDate": "2025-12-14T15:23:43.1937126+00:00",
            "ItemQuantity": 5
          }
        ]
      }
    ],
    "ShippingData": [
      {
        "ShipDate": "2025-12-14T15:23:43.1937126+00:00",
        "Carrier": "sample string 4",
        "PalletCount": 1,
        "WeightInLbs": 1.1,
        "TrackingNumber": "sample string 5",
        "UCC128": "sample string 6"
      },
      {
        "ShipDate": "2025-12-14T15:23:43.1937126+00:00",
        "Carrier": "sample string 4",
        "PalletCount": 1,
        "WeightInLbs": 1.1,
        "TrackingNumber": "sample string 5",
        "UCC128": "sample string 6"
      }
    ]
  },
  {
    "OrderId": 2,
    "ClientOrderId": "sample string 3",
    "ClientOrderId2": "sample string 4",
    "WarehouseCode": "sample string 6",
    "OrderStatus": "sample string 7",
    "OrderDate": "2025-12-14T15:23:43.1937126+00:00",
    "ShipByDate": "2025-12-14T15:23:43.1937126+00:00",
    "DeliverByDate": "2025-12-14T15:23:43.1937126+00:00",
    "CompanyOrName": "sample string 10",
    "Attention": "sample string 11",
    "AddressLine1": "sample string 12",
    "AddressLine2": "sample string 13",
    "AddressLine3": "sample string 14",
    "City": "sample string 15",
    "State": "sample string 16",
    "PostalCode": "sample string 17",
    "Country": "sample string 18",
    "Phone": "sample string 19",
    "Email": "sample string 20",
    "ShippingMethod": "sample string 22",
    "NotesToCustomerPackingSlip": "sample string 23",
    "NotesToWarehouse": "sample string 24",
    "OrderDetailData": [
      {
        "ItemSKU": "sample string 4",
        "ItemSKU2": "sample string 5",
        "ItemDescription": "sample string 6",
        "ItemQuantity": 7,
        "IsKitHeader": true,
        "IsPicked": true,
        "PickType": "sample string 10",
        "OrderDetailLotData": [
          {
            "InventoryUnitId": 2,
            "LicenseId": "sample string 3",
            "Lot": "sample string 4",
            "ExpirationDate": "2025-12-14T15:23:43.1937126+00:00",
            "ItemQuantity": 5
          },
          {
            "InventoryUnitId": 2,
            "LicenseId": "sample string 3",
            "Lot": "sample string 4",
            "ExpirationDate": "2025-12-14T15:23:43.1937126+00:00",
            "ItemQuantity": 5
          }
        ]
      },
      {
        "ItemSKU": "sample string 4",
        "ItemSKU2": "sample string 5",
        "ItemDescription": "sample string 6",
        "ItemQuantity": 7,
        "IsKitHeader": true,
        "IsPicked": true,
        "PickType": "sample string 10",
        "OrderDetailLotData": [
          {
            "InventoryUnitId": 2,
            "LicenseId": "sample string 3",
            "Lot": "sample string 4",
            "ExpirationDate": "2025-12-14T15:23:43.1937126+00:00",
            "ItemQuantity": 5
          },
          {
            "InventoryUnitId": 2,
            "LicenseId": "sample string 3",
            "Lot": "sample string 4",
            "ExpirationDate": "2025-12-14T15:23:43.1937126+00:00",
            "ItemQuantity": 5
          }
        ]
      }
    ],
    "ShippingData": [
      {
        "ShipDate": "2025-12-14T15:23:43.1937126+00:00",
        "Carrier": "sample string 4",
        "PalletCount": 1,
        "WeightInLbs": 1.1,
        "TrackingNumber": "sample string 5",
        "UCC128": "sample string 6"
      },
      {
        "ShipDate": "2025-12-14T15:23:43.1937126+00:00",
        "Carrier": "sample string 4",
        "PalletCount": 1,
        "WeightInLbs": 1.1,
        "TrackingNumber": "sample string 5",
        "UCC128": "sample string 6"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfOrderTrackingData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCBGSAPI.Models">
  <OrderTrackingData>
    <AddressLine1>sample string 12</AddressLine1>
    <AddressLine2>sample string 13</AddressLine2>
    <AddressLine3>sample string 14</AddressLine3>
    <Attention>sample string 11</Attention>
    <CarrierCode>sample string 21</CarrierCode>
    <City>sample string 15</City>
    <ClientCode>sample string 5</ClientCode>
    <ClientOrderId>sample string 3</ClientOrderId>
    <ClientOrderId2>sample string 4</ClientOrderId2>
    <CompanyOrName>sample string 10</CompanyOrName>
    <Country>sample string 18</Country>
    <DeliverByDate>2025-12-14T15:23:43.1937126+00:00</DeliverByDate>
    <Email>sample string 20</Email>
    <ImportDate>2025-12-14T15:23:43.1937126+00:00</ImportDate>
    <NotesToCustomerPackingSlip>sample string 23</NotesToCustomerPackingSlip>
    <NotesToWarehouse>sample string 24</NotesToWarehouse>
    <OrderDataId>1</OrderDataId>
    <OrderDate>2025-12-14T15:23:43.1937126+00:00</OrderDate>
    <OrderDetailData>
      <OrderDetailData>
        <IsKitHeader>true</IsKitHeader>
        <IsPicked>true</IsPicked>
        <ItemDescription>sample string 6</ItemDescription>
        <ItemQuantity>7</ItemQuantity>
        <ItemSKU>sample string 4</ItemSKU>
        <ItemSKU2>sample string 5</ItemSKU2>
        <OrderDetailDataId>1</OrderDetailDataId>
        <OrderDetailId>2</OrderDetailId>
        <OrderDetailLotData>
          <OrderDetailLotData>
            <ExpirationDate>2025-12-14T15:23:43.1937126+00:00</ExpirationDate>
            <InventoryLotId>1</InventoryLotId>
            <InventoryUnitId>2</InventoryUnitId>
            <ItemQuantity>5</ItemQuantity>
            <LicenseId>sample string 3</LicenseId>
            <Lot>sample string 4</Lot>
            <MultiLotId>1</MultiLotId>
            <OrderDetailLotDataId>1</OrderDetailLotDataId>
          </OrderDetailLotData>
          <OrderDetailLotData>
            <ExpirationDate>2025-12-14T15:23:43.1937126+00:00</ExpirationDate>
            <InventoryLotId>1</InventoryLotId>
            <InventoryUnitId>2</InventoryUnitId>
            <ItemQuantity>5</ItemQuantity>
            <LicenseId>sample string 3</LicenseId>
            <Lot>sample string 4</Lot>
            <MultiLotId>1</MultiLotId>
            <OrderDetailLotDataId>1</OrderDetailLotDataId>
          </OrderDetailLotData>
        </OrderDetailLotData>
        <OrderId>3</OrderId>
        <PickType>sample string 10</PickType>
      </OrderDetailData>
      <OrderDetailData>
        <IsKitHeader>true</IsKitHeader>
        <IsPicked>true</IsPicked>
        <ItemDescription>sample string 6</ItemDescription>
        <ItemQuantity>7</ItemQuantity>
        <ItemSKU>sample string 4</ItemSKU>
        <ItemSKU2>sample string 5</ItemSKU2>
        <OrderDetailDataId>1</OrderDetailDataId>
        <OrderDetailId>2</OrderDetailId>
        <OrderDetailLotData>
          <OrderDetailLotData>
            <ExpirationDate>2025-12-14T15:23:43.1937126+00:00</ExpirationDate>
            <InventoryLotId>1</InventoryLotId>
            <InventoryUnitId>2</InventoryUnitId>
            <ItemQuantity>5</ItemQuantity>
            <LicenseId>sample string 3</LicenseId>
            <Lot>sample string 4</Lot>
            <MultiLotId>1</MultiLotId>
            <OrderDetailLotDataId>1</OrderDetailLotDataId>
          </OrderDetailLotData>
          <OrderDetailLotData>
            <ExpirationDate>2025-12-14T15:23:43.1937126+00:00</ExpirationDate>
            <InventoryLotId>1</InventoryLotId>
            <InventoryUnitId>2</InventoryUnitId>
            <ItemQuantity>5</ItemQuantity>
            <LicenseId>sample string 3</LicenseId>
            <Lot>sample string 4</Lot>
            <MultiLotId>1</MultiLotId>
            <OrderDetailLotDataId>1</OrderDetailLotDataId>
          </OrderDetailLotData>
        </OrderDetailLotData>
        <OrderId>3</OrderId>
        <PickType>sample string 10</PickType>
      </OrderDetailData>
    </OrderDetailData>
    <OrderId>2</OrderId>
    <OrderStatus>sample string 7</OrderStatus>
    <Phone>sample string 19</Phone>
    <PostalCode>sample string 17</PostalCode>
    <ShipByDate>2025-12-14T15:23:43.1937126+00:00</ShipByDate>
    <ShippingData>
      <ShippingData>
        <Carrier>sample string 4</Carrier>
        <PalletCount>1</PalletCount>
        <ShipDate>2025-12-14T15:23:43.1937126+00:00</ShipDate>
        <ShippingDataId>1</ShippingDataId>
        <ShippingId>2</ShippingId>
        <TrackingNumber>sample string 5</TrackingNumber>
        <UCC128>sample string 6</UCC128>
        <WeightInLbs>1.1</WeightInLbs>
      </ShippingData>
      <ShippingData>
        <Carrier>sample string 4</Carrier>
        <PalletCount>1</PalletCount>
        <ShipDate>2025-12-14T15:23:43.1937126+00:00</ShipDate>
        <ShippingDataId>1</ShippingDataId>
        <ShippingId>2</ShippingId>
        <TrackingNumber>sample string 5</TrackingNumber>
        <UCC128>sample string 6</UCC128>
        <WeightInLbs>1.1</WeightInLbs>
      </ShippingData>
    </ShippingData>
    <ShippingMethod>sample string 22</ShippingMethod>
    <State>sample string 16</State>
    <WarehouseCode>sample string 6</WarehouseCode>
  </OrderTrackingData>
  <OrderTrackingData>
    <AddressLine1>sample string 12</AddressLine1>
    <AddressLine2>sample string 13</AddressLine2>
    <AddressLine3>sample string 14</AddressLine3>
    <Attention>sample string 11</Attention>
    <CarrierCode>sample string 21</CarrierCode>
    <City>sample string 15</City>
    <ClientCode>sample string 5</ClientCode>
    <ClientOrderId>sample string 3</ClientOrderId>
    <ClientOrderId2>sample string 4</ClientOrderId2>
    <CompanyOrName>sample string 10</CompanyOrName>
    <Country>sample string 18</Country>
    <DeliverByDate>2025-12-14T15:23:43.1937126+00:00</DeliverByDate>
    <Email>sample string 20</Email>
    <ImportDate>2025-12-14T15:23:43.1937126+00:00</ImportDate>
    <NotesToCustomerPackingSlip>sample string 23</NotesToCustomerPackingSlip>
    <NotesToWarehouse>sample string 24</NotesToWarehouse>
    <OrderDataId>1</OrderDataId>
    <OrderDate>2025-12-14T15:23:43.1937126+00:00</OrderDate>
    <OrderDetailData>
      <OrderDetailData>
        <IsKitHeader>true</IsKitHeader>
        <IsPicked>true</IsPicked>
        <ItemDescription>sample string 6</ItemDescription>
        <ItemQuantity>7</ItemQuantity>
        <ItemSKU>sample string 4</ItemSKU>
        <ItemSKU2>sample string 5</ItemSKU2>
        <OrderDetailDataId>1</OrderDetailDataId>
        <OrderDetailId>2</OrderDetailId>
        <OrderDetailLotData>
          <OrderDetailLotData>
            <ExpirationDate>2025-12-14T15:23:43.1937126+00:00</ExpirationDate>
            <InventoryLotId>1</InventoryLotId>
            <InventoryUnitId>2</InventoryUnitId>
            <ItemQuantity>5</ItemQuantity>
            <LicenseId>sample string 3</LicenseId>
            <Lot>sample string 4</Lot>
            <MultiLotId>1</MultiLotId>
            <OrderDetailLotDataId>1</OrderDetailLotDataId>
          </OrderDetailLotData>
          <OrderDetailLotData>
            <ExpirationDate>2025-12-14T15:23:43.1937126+00:00</ExpirationDate>
            <InventoryLotId>1</InventoryLotId>
            <InventoryUnitId>2</InventoryUnitId>
            <ItemQuantity>5</ItemQuantity>
            <LicenseId>sample string 3</LicenseId>
            <Lot>sample string 4</Lot>
            <MultiLotId>1</MultiLotId>
            <OrderDetailLotDataId>1</OrderDetailLotDataId>
          </OrderDetailLotData>
        </OrderDetailLotData>
        <OrderId>3</OrderId>
        <PickType>sample string 10</PickType>
      </OrderDetailData>
      <OrderDetailData>
        <IsKitHeader>true</IsKitHeader>
        <IsPicked>true</IsPicked>
        <ItemDescription>sample string 6</ItemDescription>
        <ItemQuantity>7</ItemQuantity>
        <ItemSKU>sample string 4</ItemSKU>
        <ItemSKU2>sample string 5</ItemSKU2>
        <OrderDetailDataId>1</OrderDetailDataId>
        <OrderDetailId>2</OrderDetailId>
        <OrderDetailLotData>
          <OrderDetailLotData>
            <ExpirationDate>2025-12-14T15:23:43.1937126+00:00</ExpirationDate>
            <InventoryLotId>1</InventoryLotId>
            <InventoryUnitId>2</InventoryUnitId>
            <ItemQuantity>5</ItemQuantity>
            <LicenseId>sample string 3</LicenseId>
            <Lot>sample string 4</Lot>
            <MultiLotId>1</MultiLotId>
            <OrderDetailLotDataId>1</OrderDetailLotDataId>
          </OrderDetailLotData>
          <OrderDetailLotData>
            <ExpirationDate>2025-12-14T15:23:43.1937126+00:00</ExpirationDate>
            <InventoryLotId>1</InventoryLotId>
            <InventoryUnitId>2</InventoryUnitId>
            <ItemQuantity>5</ItemQuantity>
            <LicenseId>sample string 3</LicenseId>
            <Lot>sample string 4</Lot>
            <MultiLotId>1</MultiLotId>
            <OrderDetailLotDataId>1</OrderDetailLotDataId>
          </OrderDetailLotData>
        </OrderDetailLotData>
        <OrderId>3</OrderId>
        <PickType>sample string 10</PickType>
      </OrderDetailData>
    </OrderDetailData>
    <OrderId>2</OrderId>
    <OrderStatus>sample string 7</OrderStatus>
    <Phone>sample string 19</Phone>
    <PostalCode>sample string 17</PostalCode>
    <ShipByDate>2025-12-14T15:23:43.1937126+00:00</ShipByDate>
    <ShippingData>
      <ShippingData>
        <Carrier>sample string 4</Carrier>
        <PalletCount>1</PalletCount>
        <ShipDate>2025-12-14T15:23:43.1937126+00:00</ShipDate>
        <ShippingDataId>1</ShippingDataId>
        <ShippingId>2</ShippingId>
        <TrackingNumber>sample string 5</TrackingNumber>
        <UCC128>sample string 6</UCC128>
        <WeightInLbs>1.1</WeightInLbs>
      </ShippingData>
      <ShippingData>
        <Carrier>sample string 4</Carrier>
        <PalletCount>1</PalletCount>
        <ShipDate>2025-12-14T15:23:43.1937126+00:00</ShipDate>
        <ShippingDataId>1</ShippingDataId>
        <ShippingId>2</ShippingId>
        <TrackingNumber>sample string 5</TrackingNumber>
        <UCC128>sample string 6</UCC128>
        <WeightInLbs>1.1</WeightInLbs>
      </ShippingData>
    </ShippingData>
    <ShippingMethod>sample string 22</ShippingMethod>
    <State>sample string 16</State>
    <WarehouseCode>sample string 6</WarehouseCode>
  </OrderTrackingData>
</ArrayOfOrderTrackingData>