GET api/orderstatus?poNumber={poNumber}

Get order status for a specific po number

Request Information

Parameters

NameDescriptionAdditional information
poNumber
The external po to get

Define this parameter in the request URI.

Response Information

An order status for the po number

Response body formats

application/json, text/json

Sample:
{
  "OrderNumber": "sample string 1",
  "ExternalOrderNumber": "sample string 2",
  "PoNumber": "sample string 3",
  "Carrier": "sample string 4",
  "OrderDate": "2021-12-07T15:42:29.7327149-05:00",
  "ShippingAddress": {
    "Name": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "Address3": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "ZipCode": "sample string 7",
    "Country": "sample string 8"
  },
  "Invoices": [
    {
      "InvoiceNumber": "sample string 1",
      "InvoiceDate": "2021-12-07T15:42:29.7327149-05:00",
      "CarrierName": "sample string 3",
      "ShippingCost": 1.0,
      "OrderTotal": 1.0,
      "ShipDate": "2021-12-07T15:42:29.7327149-05:00"
    },
    {
      "InvoiceNumber": "sample string 1",
      "InvoiceDate": "2021-12-07T15:42:29.7327149-05:00",
      "CarrierName": "sample string 3",
      "ShippingCost": 1.0,
      "OrderTotal": 1.0,
      "ShipDate": "2021-12-07T15:42:29.7327149-05:00"
    },
    {
      "InvoiceNumber": "sample string 1",
      "InvoiceDate": "2021-12-07T15:42:29.7327149-05:00",
      "CarrierName": "sample string 3",
      "ShippingCost": 1.0,
      "OrderTotal": 1.0,
      "ShipDate": "2021-12-07T15:42:29.7327149-05:00"
    }
  ],
  "Packages": [
    {
      "TrackingNumber": "sample string 1",
      "ShipDate": "2021-12-07T15:42:29.7327149-05:00",
      "PackageId": 2,
      "Items": [
        {
          "Sku": "sample string 1",
          "Quantity": 2.0
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2.0
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2.0
        }
      ],
      "ShippingWeight": 1.0,
      "CarrierName": "sample string 3"
    },
    {
      "TrackingNumber": "sample string 1",
      "ShipDate": "2021-12-07T15:42:29.7327149-05:00",
      "PackageId": 2,
      "Items": [
        {
          "Sku": "sample string 1",
          "Quantity": 2.0
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2.0
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2.0
        }
      ],
      "ShippingWeight": 1.0,
      "CarrierName": "sample string 3"
    },
    {
      "TrackingNumber": "sample string 1",
      "ShipDate": "2021-12-07T15:42:29.7327149-05:00",
      "PackageId": 2,
      "Items": [
        {
          "Sku": "sample string 1",
          "Quantity": 2.0
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2.0
        },
        {
          "Sku": "sample string 1",
          "Quantity": 2.0
        }
      ],
      "ShippingWeight": 1.0,
      "CarrierName": "sample string 3"
    }
  ],
  "Status": "sample string 5"
}

application/xml, text/xml

Sample:
<OrderStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OrderNumber>sample string 1</OrderNumber>
  <ExternalOrderNumber>sample string 2</ExternalOrderNumber>
  <PoNumber>sample string 3</PoNumber>
  <Carrier>sample string 4</Carrier>
  <OrderDate>2021-12-07T15:42:29.7327149-05:00</OrderDate>
  <ShippingAddress>
    <Name>sample string 1</Name>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <Address3>sample string 4</Address3>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <ZipCode>sample string 7</ZipCode>
    <Country>sample string 8</Country>
  </ShippingAddress>
  <Invoices>
    <Invoice>
      <InvoiceNumber>sample string 1</InvoiceNumber>
      <InvoiceDate>2021-12-07T15:42:29.7327149-05:00</InvoiceDate>
      <CarrierName>sample string 3</CarrierName>
      <ShippingCost>1</ShippingCost>
      <OrderTotal>1</OrderTotal>
      <ShipDate>2021-12-07T15:42:29.7327149-05:00</ShipDate>
    </Invoice>
    <Invoice>
      <InvoiceNumber>sample string 1</InvoiceNumber>
      <InvoiceDate>2021-12-07T15:42:29.7327149-05:00</InvoiceDate>
      <CarrierName>sample string 3</CarrierName>
      <ShippingCost>1</ShippingCost>
      <OrderTotal>1</OrderTotal>
      <ShipDate>2021-12-07T15:42:29.7327149-05:00</ShipDate>
    </Invoice>
    <Invoice>
      <InvoiceNumber>sample string 1</InvoiceNumber>
      <InvoiceDate>2021-12-07T15:42:29.7327149-05:00</InvoiceDate>
      <CarrierName>sample string 3</CarrierName>
      <ShippingCost>1</ShippingCost>
      <OrderTotal>1</OrderTotal>
      <ShipDate>2021-12-07T15:42:29.7327149-05:00</ShipDate>
    </Invoice>
  </Invoices>
  <Packages>
    <Package>
      <TrackingNumber>sample string 1</TrackingNumber>
      <ShipDate>2021-12-07T15:42:29.7327149-05:00</ShipDate>
      <PackageId>2</PackageId>
      <Items>
        <Item>
          <Sku>sample string 1</Sku>
          <Quantity>2</Quantity>
        </Item>
        <Item>
          <Sku>sample string 1</Sku>
          <Quantity>2</Quantity>
        </Item>
        <Item>
          <Sku>sample string 1</Sku>
          <Quantity>2</Quantity>
        </Item>
      </Items>
      <ShippingWeight>1</ShippingWeight>
      <CarrierName>sample string 3</CarrierName>
    </Package>
    <Package>
      <TrackingNumber>sample string 1</TrackingNumber>
      <ShipDate>2021-12-07T15:42:29.7327149-05:00</ShipDate>
      <PackageId>2</PackageId>
      <Items>
        <Item>
          <Sku>sample string 1</Sku>
          <Quantity>2</Quantity>
        </Item>
        <Item>
          <Sku>sample string 1</Sku>
          <Quantity>2</Quantity>
        </Item>
        <Item>
          <Sku>sample string 1</Sku>
          <Quantity>2</Quantity>
        </Item>
      </Items>
      <ShippingWeight>1</ShippingWeight>
      <CarrierName>sample string 3</CarrierName>
    </Package>
    <Package>
      <TrackingNumber>sample string 1</TrackingNumber>
      <ShipDate>2021-12-07T15:42:29.7327149-05:00</ShipDate>
      <PackageId>2</PackageId>
      <Items>
        <Item>
          <Sku>sample string 1</Sku>
          <Quantity>2</Quantity>
        </Item>
        <Item>
          <Sku>sample string 1</Sku>
          <Quantity>2</Quantity>
        </Item>
        <Item>
          <Sku>sample string 1</Sku>
          <Quantity>2</Quantity>
        </Item>
      </Items>
      <ShippingWeight>1</ShippingWeight>
      <CarrierName>sample string 3</CarrierName>
    </Package>
  </Packages>
  <Status>sample string 5</Status>
</OrderStatus>