POST Public/api/Search/Index

The entry point for searching or listing giftcards

Request Information

URI Parameters

None.

Body Parameters

SearchRequest
NameDescriptionTypeAdditional information
AuthToken

Your unique partner identification token

globally unique identifier

Required

Buyer

The search criteria relating to the buyer

Buyer
Receiver

The search criteria relating to the receiver

Receiver
Product

The search criteria relating to the product

Product
Voucher

The search criteria relating to the voucher

Voucher
From

The earliest time and date to include in search

date
To

The latest time and date to include in search

date
ResultsPerPage

The amount of results to include per page (only accepts 1 to 100, default is 25)

integer
PageNumber

The page index of results that you want to return (1-indexed)

integer

Request Formats

application/json, text/json

Sample:
{
  "authToken": "9f7f0648-228d-421d-a685-2646de815a5f",
  "buyer": {
    "name": "sample string 1",
    "companyName": "sample string 2",
    "email": "sample string 3",
    "number": 1,
    "refID": "sample string 4",
    "transactionID": "sample string 5",
    "ip": "sample string 6"
  },
  "receiver": {
    "deliveryMethod": 0,
    "nameOrCompanyName": "sample string 1",
    "careOfOrAttention": "sample string 2",
    "email": "sample string 3",
    "number": 1,
    "address": "sample string 4",
    "messengerID": "sample string 5",
    "zipcode": "sample string 6",
    "city": "sample string 7",
    "message": "sample string 8",
    "deliveryDatetime": "2024-02-28T00:27:46.3394605+01:00"
  },
  "product": {
    "token": "724966f0-e631-4952-9741-92ad2d90d70c"
  },
  "voucher": {
    "id": 1,
    "code": "sample string 1",
    "redeemLink": "sample string 2",
    "created": "2024-02-28T00:27:46.3394605+01:00",
    "used": "2024-02-28T00:27:46.3394605+01:00",
    "expires": "2024-02-28T00:27:46.3394605+01:00",
    "cvv": "sample string 5"
  },
  "from": "2024-02-28T00:27:46.3394605+01:00",
  "to": "2024-02-28T00:27:46.3394605+01:00",
  "resultsPerPage": 1,
  "pageNumber": 1
}

application/xml, text/xml

Sample:
<SearchController.SearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Controllers">
  <AuthToken>9f7f0648-228d-421d-a685-2646de815a5f</AuthToken>
  <Buyer>
    <CompanyName xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 2</CompanyName>
    <Email xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 3</Email>
    <IP xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 6</IP>
    <Name xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 1</Name>
    <Number xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">1</Number>
    <RefID xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 4</RefID>
    <TransactionID xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 5</TransactionID>
  </Buyer>
  <From>2024-02-28T00:27:46.3394605+01:00</From>
  <PageNumber>1</PageNumber>
  <Product>
    <Token>724966f0-e631-4952-9741-92ad2d90d70c</Token>
  </Product>
  <Receiver>
    <Address xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 4</Address>
    <CareOfOrAttention xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 2</CareOfOrAttention>
    <City xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 7</City>
    <DeliveryDatetime xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">2024-02-28T00:27:46.3394605+01:00</DeliveryDatetime>
    <Email xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 3</Email>
    <Message xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 8</Message>
    <MessengerID xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 5</MessengerID>
    <NameOrCompanyName xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 1</NameOrCompanyName>
    <Number xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">1</Number>
    <Zipcode xmlns="http://schemas.datacontract.org/2004/07/HuurayV3.Areas.Public.Models">sample string 6</Zipcode>
    <DeliveryMethod>None</DeliveryMethod>
  </Receiver>
  <ResultsPerPage>1</ResultsPerPage>
  <To>2024-02-28T00:27:46.3394605+01:00</To>
  <Voucher>
    <CVV>sample string 5</CVV>
    <Code>sample string 1</Code>
    <Created>2024-02-28T00:27:46.3394605+01:00</Created>
    <Expires>2024-02-28T00:27:46.3394605+01:00</Expires>
    <ID>1</ID>
    <RedeemLink>sample string 2</RedeemLink>
    <Used>2024-02-28T00:27:46.3394605+01:00</Used>
  </Voucher>
</SearchController.SearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object containing all orders that matches the search criteria.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.