POST api/integration/ziplingo/order

Gets additional order information.

Request Information

URI Parameters

None.

Body Parameters

The payload.

ZipLingoGetOrderInfoRequest
NameDescriptionTypeAdditional information
OrderIDs

The list of order IDs to retrieve the information.

 Collection of integer

None.

Request Formats

application/xml, text/xml

Sample: 
<ZipLingoGetOrderInfoRequest>
  <OrderIDs>
    <Int32>1</Int32>
    <Int32>2</Int32>
  </OrderIDs>
</ZipLingoGetOrderInfoRequest>

application/json, text/json

Sample: 
{
  "OrderIDs": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'ZipLingoGetOrderInfoRequest'.

Response Information

Resource Description

Collection of ZipLingoOrderInfoResponse
NameDescriptionTypeAdditional information
OrderID

The order identifier.

 integer

None.
OnlyVirtualItems

Indicates whether the order only constains virtual items or not.

 boolean

None.
OrderDetailURL

The order detail URL.

 string

None.

Response Formats

application/xml, text/xml

Sample: 
<ListOfZipLingoOrderInfoResponse>
  <ZipLingoOrderInfoResponse>
    <OrderID>1</OrderID>
    <OnlyVirtualItems>True</OnlyVirtualItems>
    <OrderDetailURL>sample string 3</OrderDetailURL>
  </ZipLingoOrderInfoResponse>
  <ZipLingoOrderInfoResponse>
    <OrderID>1</OrderID>
    <OnlyVirtualItems>True</OnlyVirtualItems>
    <OrderDetailURL>sample string 3</OrderDetailURL>
  </ZipLingoOrderInfoResponse>
</ListOfZipLingoOrderInfoResponse>

application/json, text/json

Sample: 
[
  {
    "OrderID": 1,
    "OnlyVirtualItems": true,
    "OrderDetailURL": "sample string 3"
  },
  {
    "OrderID": 1,
    "OnlyVirtualItems": true,
    "OrderDetailURL": "sample string 3"
  }
]