Search purchased PPV items

post

https://virtserver.swaggerhub.com/purchases/v1/customer/{customerId}/purchases/{page}

Search for PPVs and access passes purchased by given customer. Results matching all criteria are returned.

Response Code	Fault Code	Fault	Suggested User Message
tbc	tbc	New API created for 2.0	tbc

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

uuid

required

The ID of the customer who purchased PPVs

page

integer

required

The specific page of results to retrieve

Query Params

pagesize

integer

5 to 100

Defaults to 20

The number of results to show on a single page. Value should be between 5 and 100 inclusive. If not supplied or not valid, defaults to 20.

orderBy

string

Field and direction to order results

searchId

string

Used for matching search requests and responses where clients may be making multiple concurrent requests

Body Params

The search criteria

Details used for searching purchases

type

string

The purchase type. Can be PPV or ACCESS_PASS

purchasedAfter

date

full-date

Search for items purchased after this date (inclusive), format must be [YYYY-MM-DD].

purchasedBefore

date

full-date

Search for items purchased before this date (inclusive), format must be [YYYY-MM-DD].

Headers

tenantId

string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

userId

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

source

string

enum

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Allowed:

Responses

200Search request successful.

400Bad request