Documentation for GET api/order/Order/ReturnOrder/ByOrderID?orderId={orderId}

GET api/order/Order/ReturnOrder/ByOrderID?orderId={orderId}

Gets the list of objects linked to specific order ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId	The ID of the linked order.	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of return orders.

Collection of ReturnOrderViewModel

Name	Description	Type	Additional information
OrderID	Freedom OrderID	integer	None.
StatusID	Order Status	integer	None.
InvoiceNumber	Invoice Number associated to the Return Order	string	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfReturnOrderViewModel>
  <ReturnOrderViewModel>
    <OrderID>1</OrderID>
    <StatusID>2</StatusID>
    <InvoiceNumber>sample string 3</InvoiceNumber>
  </ReturnOrderViewModel>
  <ReturnOrderViewModel>
    <OrderID>1</OrderID>
    <StatusID>2</StatusID>
    <InvoiceNumber>sample string 3</InvoiceNumber>
  </ReturnOrderViewModel>
</ListOfReturnOrderViewModel>

application/json, text/json

Sample:

[
  {
    "OrderID": 1,
    "StatusID": 2,
    "InvoiceNumber": "sample string 3"
  },
  {
    "OrderID": 1,
    "StatusID": 2,
    "InvoiceNumber": "sample string 3"
  }
]