PATCH v3/basket
To add additional information to the basket, such as a Customer, Promocode, Attributes and Delivery Methods
Request Information
URI Parameters
None.
Body Parameters
BasketPatch| Name | Description | Type | Additional information |
|---|---|---|---|
| Customer | string |
None. |
|
| AgentCustomer | AgentCustomerPatch |
None. |
|
| TicketDelivery | NewDelivery |
None. |
|
| MerchandiseDelivery | NewDelivery |
None. |
|
| WaiveTransactionCommission | boolean |
None. |
|
| PromoCode | string |
None. |
|
| Attributes | There will be additional properties (custom to each client) with the prefix 'Attribute_' |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json
Sample:
{
"promoCode": "sample string 3"
}
text/xml
Sample:
The response/request for text/xml format is no longer supported for this endpoint.
Response Information
Resource Description
Basket| Name | Description | Type | Additional information |
|---|---|---|---|
| MultibuyOffers | Collection of MultibuyOffer |
None. |
|
| TotalDiscount | decimal number |
None. |
|
| MerchandiseDeliveryOptions | Collection of DeliveryOption |
None. |
|
| DefaultCardPaymentFee | decimal number |
None. |
|
| PotentialOffers | Collection of Offer |
None. |
|
| TicketDeliveryOptions | Collection of DeliveryOption |
None. |
|
| PromoCode | string |
None. |
|
| Id | string |
None. |
|
| BasketId | string |
None. |
|
| MerchandiseDelivery | Delivery |
None. |
|
| TransactionCommission | BasketCommission |
None. |
|
| Offers | Collection of Offer |
None. |
|
| TicketDelivery | Delivery |
None. |
|
| TicketSubscriptions | Collection of TicketSubscription |
None. |
|
| DisableWebComponents | boolean |
None. |
|
| Hash |
A value representing this basket. This will change any time the basket changes, and can be used to decide whether to redraw the basket. |
string |
None. |
| AgentCustomer | AgentCustomer |
None. |
|
| Attributes | There will be additional properties (custom to each client) with the prefix 'Attribute_' |
None. |
|
| CustomPayments | Collection of CustomPayment |
None. |
|
| Customer | Customer |
None. |
|
| MerchandiseItems | Collection of MerchandiseItem |
None. |
|
| Donations | Collection of Donation |
None. |
|
| Notes | string |
None. |
|
| Tickets | Collection of Ticket |
None. |
|
| MembershipSubscriptions | Collection of MembershipSubscription |
None. |
|
| GiftVouchers | Collection of GiftVoucher |
None. |
|
| Total | decimal number |
None. |
|
| Charges | Collection of Charge |
None. |
Response Formats
application/json, text/xml
Sample:
Sample not available.