GET api/v1/store/{storeID}/order/{orderID}/status?latest={latest}&pricing={pricing}

Request Information

URI Parameters

Name	Type	Additional information
storeID	string	Required
orderID	string	Required
latest	boolean	Default value is False
pricing	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of OrderStatusHistoryResponse

Name	Type	Additional information
ItemID	integer	None.
ProductID	string	None.
OrderID	string	None.
PartnerOrderReference	string	None.
OrderNumber	string	None.
TrackingNumber	string	None.
ShippedDate	string	None.
DeliveryMethod	string	None.
DeliveryDate	date	None.
DeliverySignedBy	string	None.
Timestamp	date	None.
StatusID	integer	None.
StatusDescription	string	None.
PFLLinkStatus	OrderStatus	None.
StatusUpdateFailed	boolean	None.
Packages	Collection of OrderStatusHistoryPackage	None.
Errors	Collection of PFLError	None.
ProofUrl	string	None.
RenderedPageUrls	Collection of string	None.
IntelligentMailingBarcode	string	None.
IntelligentMailingSerialNumber	string	None.
TotalQuantity	integer	None.
ItemTotal	decimal number	None.
ShippingTotal	decimal number	None.
RushTotal	decimal number	None.
TotalPrice	decimal number	None.
_meta	ResponseMeta	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ItemID": 1,
    "ProductID": "sample string 1",
    "OrderID": "sample string 2",
    "PartnerOrderReference": "sample string 3",
    "OrderNumber": "sample string 4",
    "TrackingNumber": "sample string 5",
    "ShippedDate": "sample string 6",
    "DeliveryMethod": "sample string 7",
    "DeliveryDate": "2024-12-04T08:23:36.2121151+00:00",
    "DeliverySignedBy": "sample string 8",
    "Timestamp": "2024-12-04T08:23:36.2121151+00:00",
    "StatusID": 0,
    "StatusDescription": "None",
    "PFLLinkStatus": 0,
    "StatusUpdateFailed": true,
    "Packages": [
      {
        "DeliveryDate": "2024-12-04T08:23:36.2121151+00:00",
        "DeliverySignedBy": "sample string 1",
        "TrackingNumber": "sample string 2"
      },
      {
        "DeliveryDate": "2024-12-04T08:23:36.2121151+00:00",
        "DeliverySignedBy": "sample string 1",
        "TrackingNumber": "sample string 2"
      }
    ],
    "Errors": [
      {
        "dataElement": "sample string 1",
        "dataElementErrors": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "dataElement": "sample string 1",
        "dataElementErrors": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "ProofUrl": "sample string 13",
    "RenderedPageUrls": [
      "sample string 1",
      "sample string 2"
    ],
    "IntelligentMailingBarcode": "sample string 14",
    "IntelligentMailingSerialNumber": "sample string 15",
    "TotalQuantity": 2,
    "ItemTotal": 1.0,
    "ShippingTotal": 1.0,
    "RushTotal": 1.0,
    "TotalPrice": 1.0,
    "_meta": {
      "Messages": [
        "sample string 1",
        "sample string 2"
      ],
      "ChangeType": "Created"
    }
  },
  {
    "ItemID": 1,
    "ProductID": "sample string 1",
    "OrderID": "sample string 2",
    "PartnerOrderReference": "sample string 3",
    "OrderNumber": "sample string 4",
    "TrackingNumber": "sample string 5",
    "ShippedDate": "sample string 6",
    "DeliveryMethod": "sample string 7",
    "DeliveryDate": "2024-12-04T08:23:36.2121151+00:00",
    "DeliverySignedBy": "sample string 8",
    "Timestamp": "2024-12-04T08:23:36.2121151+00:00",
    "StatusID": 0,
    "StatusDescription": "None",
    "PFLLinkStatus": 0,
    "StatusUpdateFailed": true,
    "Packages": [
      {
        "DeliveryDate": "2024-12-04T08:23:36.2121151+00:00",
        "DeliverySignedBy": "sample string 1",
        "TrackingNumber": "sample string 2"
      },
      {
        "DeliveryDate": "2024-12-04T08:23:36.2121151+00:00",
        "DeliverySignedBy": "sample string 1",
        "TrackingNumber": "sample string 2"
      }
    ],
    "Errors": [
      {
        "dataElement": "sample string 1",
        "dataElementErrors": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "dataElement": "sample string 1",
        "dataElementErrors": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ],
    "ProofUrl": "sample string 13",
    "RenderedPageUrls": [
      "sample string 1",
      "sample string 2"
    ],
    "IntelligentMailingBarcode": "sample string 14",
    "IntelligentMailingSerialNumber": "sample string 15",
    "TotalQuantity": 2,
    "ItemTotal": 1.0,
    "ShippingTotal": 1.0,
    "RushTotal": 1.0,
    "TotalPrice": 1.0,
    "_meta": {
      "Messages": [
        "sample string 1",
        "sample string 2"
      ],
      "ChangeType": "Created"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderStatusHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Response">
  <OrderStatusHistoryResponse>
    <DeliveryDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-04T08:23:36.2121151Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </DeliveryDate>
    <DeliveryMethod>sample string 7</DeliveryMethod>
    <DeliverySignedBy>sample string 8</DeliverySignedBy>
    <Errors xmlns:d3p1="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI.Response">
      <d3p1:PFLError>
        <d3p1:Element>sample string 1</d3p1:Element>
        <d3p1:Errors xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:Errors>
      </d3p1:PFLError>
      <d3p1:PFLError>
        <d3p1:Element>sample string 1</d3p1:Element>
        <d3p1:Errors xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:Errors>
      </d3p1:PFLError>
    </Errors>
    <IntelligentMailingBarcode>sample string 14</IntelligentMailingBarcode>
    <IntelligentMailingSerialNumber>sample string 15</IntelligentMailingSerialNumber>
    <ItemID>1</ItemID>
    <OrderID>sample string 2</OrderID>
    <OrderNumber>sample string 4</OrderNumber>
    <Packages>
      <OrderStatusHistoryPackage>
        <DeliveryDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-12-04T08:23:36.2121151Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DeliveryDate>
        <DeliverySignedBy>sample string 1</DeliverySignedBy>
        <TrackingNumber>sample string 2</TrackingNumber>
      </OrderStatusHistoryPackage>
      <OrderStatusHistoryPackage>
        <DeliveryDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-12-04T08:23:36.2121151Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DeliveryDate>
        <DeliverySignedBy>sample string 1</DeliverySignedBy>
        <TrackingNumber>sample string 2</TrackingNumber>
      </OrderStatusHistoryPackage>
    </Packages>
    <PartnerOrderReference>sample string 3</PartnerOrderReference>
    <PfllinkStatus>Legacy</PfllinkStatus>
    <Pricing xmlns:d3p1="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI.Response">
      <d3p1:Items>
        <d3p1:ResponseOrderPriceItem>
          <d3p1:Price>
            <d3p1:EnvelopePrice>1</d3p1:EnvelopePrice>
            <d3p1:MailingPrice>1</d3p1:MailingPrice>
            <d3p1:PrintPrice>1</d3p1:PrintPrice>
            <d3p1:PrintingCostEach>1</d3p1:PrintingCostEach>
            <d3p1:PromotionalDiscount>1</d3p1:PromotionalDiscount>
            <d3p1:RetailFulfillmentPrice>1</d3p1:RetailFulfillmentPrice>
            <d3p1:RetailPrintPrice>1</d3p1:RetailPrintPrice>
            <d3p1:RetailReimbursementPrice>1</d3p1:RetailReimbursementPrice>
            <d3p1:RetailRushPrice>1</d3p1:RetailRushPrice>
            <d3p1:RetailShippingPrice>1</d3p1:RetailShippingPrice>
            <d3p1:RushPrice>1</d3p1:RushPrice>
            <d3p1:SecondSheetPrice>1</d3p1:SecondSheetPrice>
            <d3p1:ShipPrice>1</d3p1:ShipPrice>
            <d3p1:TotalPrice>1</d3p1:TotalPrice>
            <d3p1:TotalPrintingPrice>1</d3p1:TotalPrintingPrice>
          </d3p1:Price>
          <d3p1:ProductID>sample string 1</d3p1:ProductID>
          <d3p1:Quantity>2</d3p1:Quantity>
        </d3p1:ResponseOrderPriceItem>
        <d3p1:ResponseOrderPriceItem>
          <d3p1:Price>
            <d3p1:EnvelopePrice>1</d3p1:EnvelopePrice>
            <d3p1:MailingPrice>1</d3p1:MailingPrice>
            <d3p1:PrintPrice>1</d3p1:PrintPrice>
            <d3p1:PrintingCostEach>1</d3p1:PrintingCostEach>
            <d3p1:PromotionalDiscount>1</d3p1:PromotionalDiscount>
            <d3p1:RetailFulfillmentPrice>1</d3p1:RetailFulfillmentPrice>
            <d3p1:RetailPrintPrice>1</d3p1:RetailPrintPrice>
            <d3p1:RetailReimbursementPrice>1</d3p1:RetailReimbursementPrice>
            <d3p1:RetailRushPrice>1</d3p1:RetailRushPrice>
            <d3p1:RetailShippingPrice>1</d3p1:RetailShippingPrice>
            <d3p1:RushPrice>1</d3p1:RushPrice>
            <d3p1:SecondSheetPrice>1</d3p1:SecondSheetPrice>
            <d3p1:ShipPrice>1</d3p1:ShipPrice>
            <d3p1:TotalPrice>1</d3p1:TotalPrice>
            <d3p1:TotalPrintingPrice>1</d3p1:TotalPrintingPrice>
          </d3p1:Price>
          <d3p1:ProductID>sample string 1</d3p1:ProductID>
          <d3p1:Quantity>2</d3p1:Quantity>
        </d3p1:ResponseOrderPriceItem>
      </d3p1:Items>
      <d3p1:PartnerOrderReference>sample string 1</d3p1:PartnerOrderReference>
      <d3p1:Total>
        <d3p1:BundleCouponAmount>1</d3p1:BundleCouponAmount>
        <d3p1:EnvelopeTotalPrice>2</d3p1:EnvelopeTotalPrice>
        <d3p1:MailingPriceTotal>3</d3p1:MailingPriceTotal>
        <d3p1:OrderTotalPrice>4</d3p1:OrderTotalPrice>
        <d3p1:PrintPriceTotal>5</d3p1:PrintPriceTotal>
        <d3p1:RushTotalPrice>6</d3p1:RushTotalPrice>
        <d3p1:SecondSheetTotal>7</d3p1:SecondSheetTotal>
        <d3p1:ShipPriceTotal>8</d3p1:ShipPriceTotal>
      </d3p1:Total>
    </Pricing>
    <ProductID>sample string 1</ProductID>
    <ProofUrl>sample string 13</ProofUrl>
    <RenderedPageUrls xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RenderedPageUrls>
    <ShippedDate>sample string 6</ShippedDate>
    <Status>Legacy</Status>
    <StatusDescription>None</StatusDescription>
    <StatusUpdateFailed>true</StatusUpdateFailed>
    <Timestamp>2024-12-04T08:23:36.2121151+00:00</Timestamp>
    <TrackingNumber>sample string 5</TrackingNumber>
    <_meta>
      <ChangeType>Created</ChangeType>
      <Messages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Messages>
    </_meta>
  </OrderStatusHistoryResponse>
  <OrderStatusHistoryResponse>
    <DeliveryDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-12-04T08:23:36.2121151Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </DeliveryDate>
    <DeliveryMethod>sample string 7</DeliveryMethod>
    <DeliverySignedBy>sample string 8</DeliverySignedBy>
    <Errors xmlns:d3p1="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI.Response">
      <d3p1:PFLError>
        <d3p1:Element>sample string 1</d3p1:Element>
        <d3p1:Errors xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:Errors>
      </d3p1:PFLError>
      <d3p1:PFLError>
        <d3p1:Element>sample string 1</d3p1:Element>
        <d3p1:Errors xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d3p1:Errors>
      </d3p1:PFLError>
    </Errors>
    <IntelligentMailingBarcode>sample string 14</IntelligentMailingBarcode>
    <IntelligentMailingSerialNumber>sample string 15</IntelligentMailingSerialNumber>
    <ItemID>1</ItemID>
    <OrderID>sample string 2</OrderID>
    <OrderNumber>sample string 4</OrderNumber>
    <Packages>
      <OrderStatusHistoryPackage>
        <DeliveryDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-12-04T08:23:36.2121151Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DeliveryDate>
        <DeliverySignedBy>sample string 1</DeliverySignedBy>
        <TrackingNumber>sample string 2</TrackingNumber>
      </OrderStatusHistoryPackage>
      <OrderStatusHistoryPackage>
        <DeliveryDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2024-12-04T08:23:36.2121151Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DeliveryDate>
        <DeliverySignedBy>sample string 1</DeliverySignedBy>
        <TrackingNumber>sample string 2</TrackingNumber>
      </OrderStatusHistoryPackage>
    </Packages>
    <PartnerOrderReference>sample string 3</PartnerOrderReference>
    <PfllinkStatus>Legacy</PfllinkStatus>
    <Pricing xmlns:d3p1="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI.Response">
      <d3p1:Items>
        <d3p1:ResponseOrderPriceItem>
          <d3p1:Price>
            <d3p1:EnvelopePrice>1</d3p1:EnvelopePrice>
            <d3p1:MailingPrice>1</d3p1:MailingPrice>
            <d3p1:PrintPrice>1</d3p1:PrintPrice>
            <d3p1:PrintingCostEach>1</d3p1:PrintingCostEach>
            <d3p1:PromotionalDiscount>1</d3p1:PromotionalDiscount>
            <d3p1:RetailFulfillmentPrice>1</d3p1:RetailFulfillmentPrice>
            <d3p1:RetailPrintPrice>1</d3p1:RetailPrintPrice>
            <d3p1:RetailReimbursementPrice>1</d3p1:RetailReimbursementPrice>
            <d3p1:RetailRushPrice>1</d3p1:RetailRushPrice>
            <d3p1:RetailShippingPrice>1</d3p1:RetailShippingPrice>
            <d3p1:RushPrice>1</d3p1:RushPrice>
            <d3p1:SecondSheetPrice>1</d3p1:SecondSheetPrice>
            <d3p1:ShipPrice>1</d3p1:ShipPrice>
            <d3p1:TotalPrice>1</d3p1:TotalPrice>
            <d3p1:TotalPrintingPrice>1</d3p1:TotalPrintingPrice>
          </d3p1:Price>
          <d3p1:ProductID>sample string 1</d3p1:ProductID>
          <d3p1:Quantity>2</d3p1:Quantity>
        </d3p1:ResponseOrderPriceItem>
        <d3p1:ResponseOrderPriceItem>
          <d3p1:Price>
            <d3p1:EnvelopePrice>1</d3p1:EnvelopePrice>
            <d3p1:MailingPrice>1</d3p1:MailingPrice>
            <d3p1:PrintPrice>1</d3p1:PrintPrice>
            <d3p1:PrintingCostEach>1</d3p1:PrintingCostEach>
            <d3p1:PromotionalDiscount>1</d3p1:PromotionalDiscount>
            <d3p1:RetailFulfillmentPrice>1</d3p1:RetailFulfillmentPrice>
            <d3p1:RetailPrintPrice>1</d3p1:RetailPrintPrice>
            <d3p1:RetailReimbursementPrice>1</d3p1:RetailReimbursementPrice>
            <d3p1:RetailRushPrice>1</d3p1:RetailRushPrice>
            <d3p1:RetailShippingPrice>1</d3p1:RetailShippingPrice>
            <d3p1:RushPrice>1</d3p1:RushPrice>
            <d3p1:SecondSheetPrice>1</d3p1:SecondSheetPrice>
            <d3p1:ShipPrice>1</d3p1:ShipPrice>
            <d3p1:TotalPrice>1</d3p1:TotalPrice>
            <d3p1:TotalPrintingPrice>1</d3p1:TotalPrintingPrice>
          </d3p1:Price>
          <d3p1:ProductID>sample string 1</d3p1:ProductID>
          <d3p1:Quantity>2</d3p1:Quantity>
        </d3p1:ResponseOrderPriceItem>
      </d3p1:Items>
      <d3p1:PartnerOrderReference>sample string 1</d3p1:PartnerOrderReference>
      <d3p1:Total>
        <d3p1:BundleCouponAmount>1</d3p1:BundleCouponAmount>
        <d3p1:EnvelopeTotalPrice>2</d3p1:EnvelopeTotalPrice>
        <d3p1:MailingPriceTotal>3</d3p1:MailingPriceTotal>
        <d3p1:OrderTotalPrice>4</d3p1:OrderTotalPrice>
        <d3p1:PrintPriceTotal>5</d3p1:PrintPriceTotal>
        <d3p1:RushTotalPrice>6</d3p1:RushTotalPrice>
        <d3p1:SecondSheetTotal>7</d3p1:SecondSheetTotal>
        <d3p1:ShipPriceTotal>8</d3p1:ShipPriceTotal>
      </d3p1:Total>
    </Pricing>
    <ProductID>sample string 1</ProductID>
    <ProofUrl>sample string 13</ProofUrl>
    <RenderedPageUrls xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </RenderedPageUrls>
    <ShippedDate>sample string 6</ShippedDate>
    <Status>Legacy</Status>
    <StatusDescription>None</StatusDescription>
    <StatusUpdateFailed>true</StatusUpdateFailed>
    <Timestamp>2024-12-04T08:23:36.2121151+00:00</Timestamp>
    <TrackingNumber>sample string 5</TrackingNumber>
    <_meta>
      <ChangeType>Created</ChangeType>
      <Messages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Messages>
    </_meta>
  </OrderStatusHistoryResponse>
</ArrayOfOrderStatusHistoryResponse>

multipart/form-data

Sample:

An exception has occurred while using the formatter 'MultiPartMediaFormat' to generate sample for media type 'multipart/form-data'. Exception message: The media type formatter of type 'MultiPartMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/png

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/png'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpeg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpeg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/bmp

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/bmp'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.