Customer Service

Customer

Payment Method Service

PaymentMethod

Contracts Service

Contract

Products Service

Content
Providers
- Search providerspost

Purchase Service

Purchase

Catalogue Service

Catalogue

Event Listener Service

EventListener
- Handles an event posted to a listening servicepost

Customer Service

Customer

Payment Method Service

PaymentMethod

Contracts Service

Contract

Products Service

Content
Providers
- Search providerspost

Purchase Service

Purchase

Catalogue Service

Catalogue

Event Listener Service

EventListener
- Handles an event posted to a listening servicepost

Get catalogue item details

get https://virtserver.swaggerhub.com/catalogue/v1/item/{itemId}

Look up details of an sales item from its ID
Response Code | Fault Code | Fault | Suggested User Message
------------- | ---------- | ----- | ----------------------
500 | 90061 | SystemFailureFault | System Failure, please try again later
500 | 4931 | BadInputException | sales item code is empty
500 | 7001 | BadInputException | Currency is null or empty
500 | 7000 | CatalogueNotFoundException | No Category Item found

Path Params

itemId

string

required

the ID of the catalogue item to look up (sales item code)

Query Params

currency

string

required

3 character currency code used to provide correct price

Headers

tenantId

string

The ID of the tenant 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

itemId

string

required

length ≤ 20

Sales item code

name

string

required

length ≤ 100

Sales item name

itemType

string

required

Type of the sales item

SERVICE PPV STOCK ACCESS_PASS

description

string

length ≤ 250

Self service description

active

boolean

required

Whether this item is available for sale

minimumTerm

object

For a subscription SERVICE item, any minimum term

frequency

string

the unit of term, e.g. MONTH

length

integer

the number of units, e.g. 3

pricing

object

required

Category item pricing. Initial, recurring, and frequency will appear for SERVICE itemType, oneOff for all other

initial

object

Holds a monetary value

recurring

object

Holds a monetary value

oneOff

object

Holds a monetary value

frequency

object

For a SERVICE item, how often the recurring amount is charged

availability

object

If the item is only available from/to/between certain dates and times, indicates that time period. May be open at either end.

from

date-time

Date and time from which the item becomes available to purchase.

date-time

Date and time after which the item is no longer available to purchase.

duration

number

The duration (in hours) that this item is available for. In accessPass terms, this means the period of entitlement that this item can be accessed by the customer

entitlements

array of objects

A list of entitlements associated with the the subscription. Only applicable for SERVICE types.

entitlements

object

string

required

The ID of the entitlement.

name

string

required

The name of the entitlement.

categoryId

int64

Id of catalogue category

Response body

object

errorCode

string

required

A short code representing the error which has occurred.

userMessage

string

A descriptive message for displaying details of the error.

developerMessage

string

A detailed description of the error which has occurred.

moreInfo

string

Extra information relating to the error that occurred.

Response body

object

errorCode

string

required

A short code representing the error which has occurred.

userMessage

string

A descriptive message for displaying details of the error.

developerMessage

string

A detailed description of the error which has occurred.

moreInfo

string

Extra information relating to the error that occurred.

Updated over 1 year ago

Get promo code details.

Get catalogue item discounts details

Did this page help you?

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://virtserver.swaggerhub.com/catalogue/v1/item/itemId \
3
     --header 'accept: application/json'

Choose an example:

application/json

Updated over 1 year ago

Get promo code details.

Get catalogue item discounts details

Did this page help you?

Customer Service
Customer
Authenticate customer username and passwordpost
Get the details of the RaF.get
Customer requests password reset emailpost
Checks the status of a VCN.post
Gets the available customer consents.get
Checks if a username is available to be used.post
Refreshes entitlements to the customers subscriptions.post
Anonymise personal details of a customer.post
Locate customer.post
Locate customer.post
Update a customer.patch
Get customer details.get
Create customer.post

Payment Method Service
PaymentMethod
Get available providers.post
Get provider redirect details.post
List customer available payment methodsget
Removes the customers payment method.post
Activates the customers payment method.post
Deactivates the customers payment method.post
Set the customer default payment method.post
Add payment method.post

Contracts Service
Contract
Set referrer on a contract.post
Sets the payment method for a contract.post
Sets the payment method for all customer contracts.post
Resumes a paused contract.post
Withdraws a request to pause a contract.post
Pause contract.post
Get the cost of changing a contract.post
Withdraws a request to change a contract.post
Get available crossgrades for a contract, in a structured catalogue form.get
Change a contract.post
Get available crossgrades for a contract.get
List available crossgrades for a contract, in a structured catalogue form.get
List available crossgrades for a contract.get
Withdraws a scheduled contract cancellation.post
Get contract cancellation costs.post
Get next default contract cancellation date.get
Cancel contract.post
Get contract details.get
Get customer contracts.get

Products Service
Content
Search content itemspost
Update content item details.patch
Get content item details.get
Create a new content itemspost
Providers
Search providerspost

Purchase Service
Purchase
Get promo code details.get
Retrieve available filtersget
Search purchased productspost
Search purchased PPV itemspost
Checkoutpost
Set discount codepost
Remove itemspost
Add itemspost
Get cart details.get
Create a new cart, optionally adding items and discountpost

Catalogue Service
Catalogue
Search sales items available within given categorypost
Get the structure of the given categoryget
List the top level structure of the catalogueget
Get catalogue item discounts detailsget
Get catalogue item detailsget

Event Listener Service
EventListener
Handles an event posted to a listening servicepost

Customer Service
Customer
Authenticate customer username and passwordpost
Get the details of the RaF.get
Customer requests password reset emailpost
Checks the status of a VCN.post
Gets the available customer consents.get
Checks if a username is available to be used.post
Refreshes entitlements to the customers subscriptions.post
Anonymise personal details of a customer.post
Locate customer.post
Locate customer.post
Update a customer.patch
Get customer details.get
Create customer.post

Payment Method Service
PaymentMethod
Get available providers.post
Get provider redirect details.post
List customer available payment methodsget
Removes the customers payment method.post
Activates the customers payment method.post
Deactivates the customers payment method.post
Set the customer default payment method.post
Add payment method.post

Contracts Service
Contract
Set referrer on a contract.post
Sets the payment method for a contract.post
Sets the payment method for all customer contracts.post
Resumes a paused contract.post
Withdraws a request to pause a contract.post
Pause contract.post
Get the cost of changing a contract.post
Withdraws a request to change a contract.post
Get available crossgrades for a contract, in a structured catalogue form.get
Change a contract.post
Get available crossgrades for a contract.get
List available crossgrades for a contract, in a structured catalogue form.get
List available crossgrades for a contract.get
Withdraws a scheduled contract cancellation.post
Get contract cancellation costs.post
Get next default contract cancellation date.get
Cancel contract.post
Get contract details.get
Get customer contracts.get

Products Service
Content
Search content itemspost
Update content item details.patch
Get content item details.get
Create a new content itemspost
Providers
Search providerspost

Purchase Service
Purchase
Get promo code details.get
Retrieve available filtersget
Search purchased productspost
Search purchased PPV itemspost
Checkoutpost
Set discount codepost
Remove itemspost
Add itemspost
Get cart details.get
Create a new cart, optionally adding items and discountpost

Catalogue Service
Catalogue
Search sales items available within given categorypost
Get the structure of the given categoryget
List the top level structure of the catalogueget
Get catalogue item discounts detailsget
Get catalogue item detailsget

Event Listener Service
EventListener
Handles an event posted to a listening servicepost

200Success

400Bad request

404Not found