POST api/v2/orders

Returns the Order details and status information

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PurchaseOrderNumber	A list of customer assigned idenfiers for the orders.	Collection of string	None.

Request Formats

application/json, text/json
application/xml, text/xml

Sample:

{
  "PurchaseOrderNumber": [
    "sample string 1",
    "sample string 2"
  ]
}

Sample:

<OrderStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PurchaseOrderNumber xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PurchaseOrderNumber>
</OrderStatusRequest>

Response Information

Resource Description

OrderStatusResponse

Name	Description	Type	Additional information
OrderStatuses	List of order statuses	Collection of OrderStatus	None.

Sample:

{
  "OrderStatuses": [
    {
      "OrderNumber": "sample string 1",
      "PurchaseOrderNumber": "sample string 2",
      "Status": "sample string 3",
      "OrderTotal": 1.0,
      "InvoiceTotal": 1.0,
      "SalesTax": 1.0,
      "PostageAndHandling": 1.0,
      "OrderDate": "2024-12-04T07:02:25.1462297-06:00",
      "ScheduledShipDate": "2024-12-04T07:02:25.1462297-06:00",
      "ActualShipDate": "2024-12-04T07:02:25.1462297-06:00",
      "InvoiceDate": "2024-12-04T07:02:25.1462297-06:00",
      "ShipMethod": "sample string 6",
      "TrackingNumber": "sample string 7",
      "TrackingLink": "sample string 8",
      "OrderStatusDetails": [
        {
          "LineNumber": 1,
          "ItemNumber": "sample string 2",
          "OrderQuantity": 3,
          "OrderQuantityUnitOfMeasure": "sample string 4",
          "ShipQuantity": 5,
          "ShipQuantityUnitOfMeasure": "sample string 6",
          "UnitPrice": 7.0,
          "UnitPriceUnitOfMeasure": "sample string 8"
        },
        {
          "LineNumber": 1,
          "ItemNumber": "sample string 2",
          "OrderQuantity": 3,
          "OrderQuantityUnitOfMeasure": "sample string 4",
          "ShipQuantity": 5,
          "ShipQuantityUnitOfMeasure": "sample string 6",
          "UnitPrice": 7.0,
          "UnitPriceUnitOfMeasure": "sample string 8"
        }
      ]
    },
    {
      "OrderNumber": "sample string 1",
      "PurchaseOrderNumber": "sample string 2",
      "Status": "sample string 3",
      "OrderTotal": 1.0,
      "InvoiceTotal": 1.0,
      "SalesTax": 1.0,
      "PostageAndHandling": 1.0,
      "OrderDate": "2024-12-04T07:02:25.1462297-06:00",
      "ScheduledShipDate": "2024-12-04T07:02:25.1462297-06:00",
      "ActualShipDate": "2024-12-04T07:02:25.1462297-06:00",
      "InvoiceDate": "2024-12-04T07:02:25.1462297-06:00",
      "ShipMethod": "sample string 6",
      "TrackingNumber": "sample string 7",
      "TrackingLink": "sample string 8",
      "OrderStatusDetails": [
        {
          "LineNumber": 1,
          "ItemNumber": "sample string 2",
          "OrderQuantity": 3,
          "OrderQuantityUnitOfMeasure": "sample string 4",
          "ShipQuantity": 5,
          "ShipQuantityUnitOfMeasure": "sample string 6",
          "UnitPrice": 7.0,
          "UnitPriceUnitOfMeasure": "sample string 8"
        },
        {
          "LineNumber": 1,
          "ItemNumber": "sample string 2",
          "OrderQuantity": 3,
          "OrderQuantityUnitOfMeasure": "sample string 4",
          "ShipQuantity": 5,
          "ShipQuantityUnitOfMeasure": "sample string 6",
          "UnitPrice": 7.0,
          "UnitPriceUnitOfMeasure": "sample string 8"
        }
      ]
    }
  ]
}

Sample:

<OrderStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OrderStatuses>
    <OrderStatus>
      <OrderNumber>sample string 1</OrderNumber>
      <PurchaseOrderNumber>sample string 2</PurchaseOrderNumber>
      <Status>sample string 3</Status>
      <InvoiceTotal>1</InvoiceTotal>
      <OrderTotal>1</OrderTotal>
      <SalesTax>1</SalesTax>
      <PostageAndHandling>1</PostageAndHandling>
      <OrderDate>2024-12-04T07:02:25.1462297-06:00</OrderDate>
      <ScheduledShipDate>2024-12-04T07:02:25.1462297-06:00</ScheduledShipDate>
      <ActualShipDate>2024-12-04T07:02:25.1462297-06:00</ActualShipDate>
      <InvoiceDate>2024-12-04T07:02:25.1462297-06:00</InvoiceDate>
      <ShipMethod>sample string 6</ShipMethod>
      <TrackingNumber>sample string 7</TrackingNumber>
      <TrackingLink>sample string 8</TrackingLink>
      <OrderStatusDetails>
        <OrderStatusDetail>
          <LineNumber>1</LineNumber>
          <ItemNumber>sample string 2</ItemNumber>
          <OrderQuantity>3</OrderQuantity>
          <OrderQuantityUnitOfMeasure>sample string 4</OrderQuantityUnitOfMeasure>
          <ShipQuantity>5</ShipQuantity>
          <ShipQuantityUnitOfMeasure>sample string 6</ShipQuantityUnitOfMeasure>
          <UnitPrice>7</UnitPrice>
          <UnitPriceUnitOfMeasure>sample string 8</UnitPriceUnitOfMeasure>
        </OrderStatusDetail>
        <OrderStatusDetail>
          <LineNumber>1</LineNumber>
          <ItemNumber>sample string 2</ItemNumber>
          <OrderQuantity>3</OrderQuantity>
          <OrderQuantityUnitOfMeasure>sample string 4</OrderQuantityUnitOfMeasure>
          <ShipQuantity>5</ShipQuantity>
          <ShipQuantityUnitOfMeasure>sample string 6</ShipQuantityUnitOfMeasure>
          <UnitPrice>7</UnitPrice>
          <UnitPriceUnitOfMeasure>sample string 8</UnitPriceUnitOfMeasure>
        </OrderStatusDetail>
      </OrderStatusDetails>
    </OrderStatus>
    <OrderStatus>
      <OrderNumber>sample string 1</OrderNumber>
      <PurchaseOrderNumber>sample string 2</PurchaseOrderNumber>
      <Status>sample string 3</Status>
      <InvoiceTotal>1</InvoiceTotal>
      <OrderTotal>1</OrderTotal>
      <SalesTax>1</SalesTax>
      <PostageAndHandling>1</PostageAndHandling>
      <OrderDate>2024-12-04T07:02:25.1462297-06:00</OrderDate>
      <ScheduledShipDate>2024-12-04T07:02:25.1462297-06:00</ScheduledShipDate>
      <ActualShipDate>2024-12-04T07:02:25.1462297-06:00</ActualShipDate>
      <InvoiceDate>2024-12-04T07:02:25.1462297-06:00</InvoiceDate>
      <ShipMethod>sample string 6</ShipMethod>
      <TrackingNumber>sample string 7</TrackingNumber>
      <TrackingLink>sample string 8</TrackingLink>
      <OrderStatusDetails>
        <OrderStatusDetail>
          <LineNumber>1</LineNumber>
          <ItemNumber>sample string 2</ItemNumber>
          <OrderQuantity>3</OrderQuantity>
          <OrderQuantityUnitOfMeasure>sample string 4</OrderQuantityUnitOfMeasure>
          <ShipQuantity>5</ShipQuantity>
          <ShipQuantityUnitOfMeasure>sample string 6</ShipQuantityUnitOfMeasure>
          <UnitPrice>7</UnitPrice>
          <UnitPriceUnitOfMeasure>sample string 8</UnitPriceUnitOfMeasure>
        </OrderStatusDetail>
        <OrderStatusDetail>
          <LineNumber>1</LineNumber>
          <ItemNumber>sample string 2</ItemNumber>
          <OrderQuantity>3</OrderQuantity>
          <OrderQuantityUnitOfMeasure>sample string 4</OrderQuantityUnitOfMeasure>
          <ShipQuantity>5</ShipQuantity>
          <ShipQuantityUnitOfMeasure>sample string 6</ShipQuantityUnitOfMeasure>
          <UnitPrice>7</UnitPrice>
          <UnitPriceUnitOfMeasure>sample string 8</UnitPriceUnitOfMeasure>
        </OrderStatusDetail>
      </OrderStatusDetails>
    </OrderStatus>
  </OrderStatuses>
</OrderStatusResponse>