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

Add items

post https://virtserver.swaggerhub.com/purchases/v1/customer/{customerId}/cart/{cartId}/add

Add one or more items to an existing cart
Response Code | Fault Code | Fault | Suggested User Message
------------- | ---------- | ----- | ----------------------
400 | 90035 | ItemAlreadyPurchasedFault | Item Already Purchased
404 | 90040 | NoCartFoundFault | Cart does not exist
400 | 90036 | ItemNotWithinBuyWindowFault | Item unavailable for purchase
403 | 90076 | ValidateWithProviderFailedFault | Provider {name} cannot validate the device
400 | 90023 | InvalidItemCombinationFault | Item {itemCode} cannot be added to this cart
404 | 90069 | UnknownItemCodeFault | Incorrect Item Code provided
400 | 90079 | VCNRequiredFault | No VCN Provided
400 | 90062 | UnableToAddItemsFault | Item {itemCode} cannot be added to this cart
400 | 90009 | InactiveVCNFault | Inactive VCN provided
400 | 90052 | PpvPinIncorrectFault | Incorrect PIN provided
400 | 90031 | InvalidVCNFault | Invalid VCN provided
500 | 90061 | SystemFailureFault | System Failure, please try again later
400 | 90053 | PpvPinRequiredFault | PIN required

Path Params

customerId

uuid

required

The ID of the customer who owns the cart

cartId

int64

required

The ID of the cart to add items to

Body Params

The items to be added to the cart

items

array of objects

items

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

int64

The unique identifier of this cart

totalCost

object

Holds a monetary value

currency

string

required

The currency code

amount

number

required

The amount

items

array of objects

Details of the items in the cart

items

object

itemCode

string

required

The identifier for the item. Specific sales item code as obtained from catalogue.

itemData

object

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

itemName

string

The name of the item

quantity

int32

The quantity of this item being purchased. Normally 1

cost

object

Holds a monetary value

freeTrial

object

The information about free trial.Returned if subscription has free trial available.

vcn

string

The viewing card number (VCN) if required.

discountCode

object

Details of any code applied to the cart which may give a discount

campaignCode

string

The provided campaign code

sourceCode

string

The provided source code

promoCode

string

The provided promotion code

discount

object

Details of any discount applied to the cart

discountName

string

The name of the discount

discountAmount

object

Holds a monetary value

itemCode

string

The sales item code for the item which is being discounted

discountCode

object

If discount codes have been used to enable the discount, the matched code criteria

numberOfOccurrences

number

The number of times the discount will be applied

indefinite

boolean

Set to true if the discount is applied for the lifetime of the contract

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 cart details.

Remove items

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://virtserver.swaggerhub.com/purchases/v1/customer/customerId/cart/cartId/add \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

Updated over 1 year ago

Get cart details.

Remove items

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