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

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

type

string

The purchase type. Can be PPV or ACCESS_PASS

purchasedAfter

date

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

purchasedBefore

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

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.

Responses

Response body

object

currentPage

int32

The current page of results.

numberOfPages

int32

The total number of result pages of the current page size.

totalResults

int64

The total number of available results.

previousPageLink

string

Link to get the previous page of results, if one is available.

nextPageLink

string

Link to get the next page of results, if one is available.

searchId

string

If a searchId was supplied in the request, it is returned here in the response

items

array of objects

The purchased item details

items

object

type

string

required

The purchase type. Can be PPV or ACCESS_PASS

purchaseDate

date-time

required

The date and time of purchase, in ISO8601 date/time format in UTC time zone

salesItemCode

string

Sales item code

salesItemName

string

required

Sales item name

itemData

object

Any additional details to be held as part of the purchase of this item.

entitlements

array of objects

PPV or access pass entitlement product details

entitlements

object

string

required

The ID of the entitlement.

name

string

required

The name of the entitlement.

duration

int32

The duration (in hours) that this access pass is available for the customer.

startDate

date-time

The date and time when access pass will start, in ISO8601 date/time format in UTC time zone

expiryDate

date-time

The date and time when access pass will expire, in ISO8601 date/time format in UTC time zone

orderId

int64

The order number of the order placed for the item

accountItemId

integer

The ID of the charge account item in the account on which charges for this item appear

paymentId

integer

The ID of the payment associated with this item

paymentMethodId

int64

The ID of the payment method used to pay for this item (if any)

status

string

The current status of this item. Indicates whether this is still active, or has expired

ACTIVE EXPIRED

cost

object

Holds a monetary value

accountId

integer

The ID of the account on which charges/payment for this item appear

accountBalance

object

Holds a monetary value

auditInfo

object

Standard fields appearing on any object which has audit information

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://virtserver.swaggerhub.com/purchases/v1/customer/customerId/purchases/page?pagesize=20' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200Search request successful.

400Bad request