developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Voucher APIVoucherBases

Get voucher basis list

gethttps://voucher-api.ancon.io/public/api/v1/Outlets/{outletId}/OrderVoucherBases
View .mdOpenAPI

Filtering

Filter the list with filter[field]=operator:value; see how filtering works.

  • created (datetime)
  • status (enum)
  • publisheddate (datetime)
  • vouchernumber (int)
  • recalculatedat (nullable datetime)
  • outletid (guid)

Try filters

Build a filter for this endpoint and copy the request. How filtering works

Filters

Documented filter fields

Reads asNo filters: the endpoint returns everything (paged).

Request
(no filters)

No sample data for this endpoint; the request above is what you would send.

Authorization

  • Access-Tokenheaderrequired

    Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

  • outletIdstring (uuid)required

Query parameters

  • Offsetinteger (int32)
  • Limitinteger (int32)

    min 0, max 1000.

  • Orderstring
  • Searchstring
  • Filtermap<string, array<string>>

Filter takes filter[field]=operator:value on 6 fields. Build a filter

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • itemsarray<object> | null
    8 fields in items
    • idstring (uuid)
    • createdstring (date-time)
    • voucherNumberstring | null

      Unique number for the voucher, will increment each day

    • statusinteger (int32)

      Allowed values: 0, 1.

    • publishedDatestring (date-time) | null

      The date and time when the voucher basis was published

    • standardPartobject | null
      12 fields in standardPart
      • paymentMethodAmountnumber (double)
      • paymentMethodCurrencystring | null
      • productGroupAmountInclTaxnumber (double)
      • productGroupCurrencyInclTaxstring | null
      • productGroupAmountExclTaxnumber (double)
      • productGroupCurrencyExclTaxstring | null
      • orderFeeAmountInclTaxnumber (double)
      • orderFeeCurrencyInclTaxstring | null
      • orderFeeAmountExclTaxnumber (double)
      • orderFeeCurrencyExclTaxstring | null
      • taxAmountnumber (double)
      • taxCurrencystring | null
    • invoicePartobject | null
      12 fields in invoicePart
      • paymentMethodAmountnumber (double)
      • paymentMethodCurrencystring | null
      • productGroupAmountInclTaxnumber (double)
      • productGroupCurrencyInclTaxstring | null
      • productGroupAmountExclTaxnumber (double)
      • productGroupCurrencyExclTaxstring | null
      • orderFeeAmountInclTaxnumber (double)
      • orderFeeCurrencyInclTaxstring | null
      • orderFeeAmountExclTaxnumber (double)
      • orderFeeCurrencyExclTaxstring | null
      • taxAmountnumber (double)
      • taxCurrencystring | null
    • mewsPartobject | null
      12 fields in mewsPart
      • paymentMethodAmountnumber (double)
      • paymentMethodCurrencystring | null
      • productGroupAmountInclTaxnumber (double)
      • productGroupCurrencyInclTaxstring | null
      • productGroupAmountExclTaxnumber (double)
      • productGroupCurrencyExclTaxstring | null
      • orderFeeAmountInclTaxnumber (double)
      • orderFeeCurrencyInclTaxstring | null
      • orderFeeAmountExclTaxnumber (double)
      • orderFeeCurrencyExclTaxstring | null
      • taxAmountnumber (double)
      • taxCurrencystring | null
  • metaobject | null
    2 fields in meta
    • countinteger (int32)
    • offsetinteger (int32)
401Unauthorizedapplication/json