POST api/bfg/v1/orders/values

Get calculated values for a batch of orders.

Request Information

URI Parameters

None.

Body Parameters

Request containing Order IDs to retrieve values for.

Name	Description	Type	Additional information
OrderIDs		Collection of integer	Required

Request Formats

application/json, text/json

Sample:

{
  "OrderIDs": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<OrderValuesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
  <OrderIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </OrderIDs>
</OrderValuesRequest>

Response Information

Resource Description

List of order values including outstanding value.

Collection of OrderValuesResult

Name	Type	Additional information
OrderID	integer	None.
OutstandingValue	decimal number	None.
Error	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderID": 1,
    "OutstandingValue": 1.0,
    "Error": "sample string 2"
  },
  {
    "OrderID": 1,
    "OutstandingValue": 1.0,
    "Error": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderValuesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
  <OrderValuesResult>
    <Error>sample string 2</Error>
    <OrderID>1</OrderID>
    <OutstandingValue>1</OutstandingValue>
  </OrderValuesResult>
  <OrderValuesResult>
    <Error>sample string 2</Error>
    <OrderID>1</OrderID>
    <OutstandingValue>1</OutstandingValue>
  </OrderValuesResult>
</ArrayOfOrderValuesResult>

Error Response Information

Resource Description

List of order values including outstanding value.

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>