GET api/vouchers/order/{token}

Get order

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

The token of the order

string

Required

Body Parameters

Response Information

Resource Description

A token for futher processing

voucherorderresult
NameDescriptionTypeAdditional information
success

Indicates if the action was successfull

boolean

None.

remark

A description regarding the result

string

None.

product

The product of this order

voucherproduct

None.

confirmed

Indicates if the order is confirmed

boolean

None.

voucherbundlecode

The code of the generated bundle

string

None.

quantity

The number vouchers in this bundle

integer

None.

vouchercodes

A list of vouchercode

Collection of vouchercode

None.

transactiondatetime

The date and time the transaction is registered

date

None.

receiptnumber

The receiptnumber of the transaction

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "remark": "sample string 2",
  "product": {
    "productcode": "sample string 1",
    "description": "sample string 2",
    "extradescription": [
      "sample string 1",
      "sample string 2"
    ],
    "price": 3.0,
    "originalprice": 4.0,
    "quantity": 5
  },
  "confirmed": true,
  "voucherbundlecode": "sample string 4",
  "quantity": 5,
  "vouchercodes": [
    {
      "code": "sample string 1",
      "used": true
    },
    {
      "code": "sample string 1",
      "used": true
    }
  ],
  "transactiondatetime": "2024-11-24T12:41:03.9582178+01:00",
  "receiptnumber": 1
}

application/xml, text/xml

Sample:
<voucherorderresult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechnoDataSystems.Enterprise.TotalWash.Web.API">
  <confirmed>true</confirmed>
  <product>
    <description>sample string 2</description>
    <extradescription xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </extradescription>
    <originalprice>4</originalprice>
    <price>3</price>
    <productcode>sample string 1</productcode>
    <quantity>5</quantity>
  </product>
  <quantity>5</quantity>
  <receiptnumber>1</receiptnumber>
  <remark>sample string 2</remark>
  <success>true</success>
  <transactiondatetime>2024-11-24T12:41:03.9582178+01:00</transactiondatetime>
  <voucherbundlecode>sample string 4</voucherbundlecode>
  <vouchercodes>
    <vouchercode>
      <code>sample string 1</code>
      <used>true</used>
    </vouchercode>
    <vouchercode>
      <code>sample string 1</code>
      <used>true</used>
    </vouchercode>
  </vouchercodes>
</voucherorderresult>