Search purchased products

post

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

Search for products purchased by given customer. Results matching all criteria are returned, in reverse purchase date order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

uuid

required

The ID of the customer to search purchased products for

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.

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 purchased products

salesItemName

string

The name of the purchased sales item. May be wildcarded to allow a partial match, e.g '%Subs%'.

type

string

enum

The purchase type.

Allowed:

purchasedAfter

date

full-date

Search for products purchased on or after this date Format must be YYYY-MM-DD.

purchasedBefore

date

full-date

Search for products purchased on or before this date Format must be YYYY-MM-DD.

status

string

enum

Search for purchased products with the given status.

isDiscounted

boolean

If supplied, indicates whether to include in results only purchased products with, or only those without, a discount. If omitted, returns matching products regardless of discount.

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

Language

Loading…

Response

Choose an example:

application/json

200Search request successful.

400Bad request