GET api/OrderStatusDatas/{id}?ClientOrderId={ClientOrderId}

Retrieves order status details by order number.

Request Information

URI Parameters

Name	Description	Type	Additional 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

OrderStatusData

Name	Description	Type	Additional information
OrderId	Unique identifier from the BGS system that is assigned at order creation, and it can be used as the id parameter.	integer	None.
ClientOrderId	Unique order identifier from your system.	string	None.
ClientOrderId2	Alternate order identifier from your system. For example, a PO number.	string	None.
OrderDate		date	None.
ImportDate	Date the order was imported into the BGS system.	date	None.
OrderStatus	Assigned by BGS to show the current status of the order.	string	None.
CarrierCode		string	None.
ShippingMethod		string	None.
ShippingData	Includes the ShipDate and Tracking information for the order.	Collection of ShippingData	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": 2,
  "ClientOrderId": "sample string 3",
  "ClientOrderId2": "sample string 4",
  "OrderDate": "2025-12-14T15:23:33.2583605+00:00",
  "ImportDate": "2025-12-14T15:23:33.2583605+00:00",
  "OrderStatus": "sample string 7",
  "CarrierCode": "sample string 8",
  "ShippingMethod": "sample string 9",
  "ShippingData": [
    {
      "ShipDate": "2025-12-14T15:23:33.2583605+00:00",
      "Carrier": "sample string 4",
      "PalletCount": 1,
      "WeightInLbs": 1.1,
      "TrackingNumber": "sample string 5",
      "UCC128": "sample string 6"
    },
    {
      "ShipDate": "2025-12-14T15:23:33.2583605+00:00",
      "Carrier": "sample string 4",
      "PalletCount": 1,
      "WeightInLbs": 1.1,
      "TrackingNumber": "sample string 5",
      "UCC128": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<OrderStatusData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCBGSAPI.Models">
  <CarrierCode>sample string 8</CarrierCode>
  <ClientOrderId>sample string 3</ClientOrderId>
  <ClientOrderId2>sample string 4</ClientOrderId2>
  <ImportDate>2025-12-14T15:23:33.2583605+00:00</ImportDate>
  <OrderDate>2025-12-14T15:23:33.2583605+00:00</OrderDate>
  <OrderId>2</OrderId>
  <OrderStatus>sample string 7</OrderStatus>
  <OrderStatusDataId>1</OrderStatusDataId>
  <ShippingData>
    <ShippingData>
      <Carrier>sample string 4</Carrier>
      <PalletCount>1</PalletCount>
      <ShipDate>2025-12-14T15:23:33.2583605+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:33.2583605+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 9</ShippingMethod>
</OrderStatusData>