Retail
Retail products are things you sell without a date or time slot: merchandise, gifts and gift
vouchers. Each is an experience with experienceType RETAIL (or VOUCHER for a gift voucher)
that sells from SKUs instead of options and slots. Optional variation axes (Colour, Size) combine
into SKUs, and each SKU has its own price, optional stock count and purchase questions.
Retail is bought on an ordinary booking order: send retailItems to POST /v2/booking-orders or
.../add, and the lines are held and confirmed with the order. Each confirmed line is a retail
item you can list, mark delivered, cancel and refund under /v2/retail-items. Buying a gift
voucher produces a code that its holder redeems on a later order against the seller's own
experiences: check it with GET /v2/retail-vouchers/{code}, then send it as the order's
voucherCode or as its payment at confirm.
Endpoints
- GET
/v2/experiences/{experienceId}/retail-attributesList a retail product's variation axes - POST
/v2/experiences/{experienceId}/retail-attributesAdd a variation axis - GET
/v2/experiences/{experienceId}/retail-attributes/{attributeId}Get a variation axis - PUT
/v2/experiences/{experienceId}/retail-attributes/{attributeId}Replace a variation axis - DELETE
/v2/experiences/{experienceId}/retail-attributes/{attributeId}Remove a variation axis - PATCH
/v2/experiences/{experienceId}/retail-attributes/{attributeId}Update a variation axis - GET
/v2/experiences/{experienceId}/retail-skusList a retail product's SKUs - POST
/v2/experiences/{experienceId}/retail-skus/generateBuild the SKU grid - POST
/v2/experiences/{experienceId}/retail-skus/bulk-updateUpdate many SKUs at once - GET
/v2/experiences/{experienceId}/retail-skus/{skuId}Get a SKU - PUT
/v2/experiences/{experienceId}/retail-skus/{skuId}Replace a SKU's settings - PATCH
/v2/experiences/{experienceId}/retail-skus/{skuId}Configure a SKU - POST
/v2/experiences/{experienceId}/retail-skus/{skuId}/add-stockAdd stock to a SKU - POST
/v2/experiences/{experienceId}/retail-skus/{skuId}/remove-stockRemove stock from a SKU - GET
/v2/experiences/{experienceId}/retail-skus/{skuId}/stock-movementsList a SKU's stock ledger - GET
/v2/experiences/{experienceId}/retail-voucher-configGet a gift voucher's redemption rules - PUT
/v2/experiences/{experienceId}/retail-voucher-configSet a gift voucher's redemption rules - GET
/v2/retail-vouchers/{code}Look up a gift voucher code - GET
/v2/retail-itemsList retail items - GET
/v2/retail-items/{id}Get a retail item - POST
/v2/retail-items/{id}/cancelCancel a retail item - POST
/v2/retail-items/{id}/deliverMark a retail item as delivered - POST
/v2/retail-items/{id}/refundRefund a cancelled retail item