Sign in
latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Products

Create a product

Create a new product

post/v1/products

Response

Successfully created a new product

objectstring
idstring
booking_feeinteger nullable

Optional booking fee in cents which is charged per product to the customer and the funds are paid to you. We would recommend charging no more than 10% of the product price.

currency'gbp' | 'usd' | 'eur' | 'sgd' | 'aud' | 'brl' | 'cad' | 'czk' | 'dkk' | 'hkd' | 'huf' | 'ils' | 'jpy' | 'myr' | 'mxn' | 'nok' | 'nzd' | 'php' | 'pln' | 'rub' | 'sek' | 'chf' | 'twd' | 'thb' | 'try' nullable

Information about the currency the product is configured to use

descriptionstring nullable

Description of the product

event_series_idsstring[] nullable

List of associated event series IDs

imagestring nullable

Image associated with the product

instructionsstring nullable

Instructions on how to use the product

issued_countinteger

Number of sold products

issue_ticket_voucherstring nullable

A boolean value indicating whether a QR code is to be issued for the product

linked_to_all_event_seriesstring nullable

A 'true' or 'false' value to determine if the product is linked to all the event series

membership_type_idstring nullable

The ID of the membership type associated with the product

namestring

Name of the product

priceinteger

Price in cents. Could be null.

quantityinteger nullable

Number available for purchase for all event occurrences

quantity_per_event_occurrenceinteger nullable

Number available for purchase per event occurrence

sell_in_storestring

A boolean value indicating whether product is being sold in store

status'on_sale' | 'hidden' | 'sold_out' nullable

Status of the product

voucher_idstring nullable

The ID of the voucher of type gift card associated with the product

Example response

{
  "object": "product",
  "id": "pr_1",
  "booking_fee": 100,
  "created_at": {
    "date": "2020-05-01",
    "formatted": "Fri 1 May 2020 10:30 PM",
    "iso": "2020-05-01T22:30:00+01:00",
    "time": "22:30",
    "timezone": "+01:00",
    "unix": 1588368600
  },
  "currency": "usd",
  "description": "This is a product",
  "event_series_ids": [
    "es_123",
    "es_234",
    "es_345"
  ],
  "instructions": "Buy this product at the venue",
  "issued_count": 0,
  "issue_ticket_voucher": "false",
  "voucher_id": null,
  "membership_type_id": null,
  "linked_to_all_event_series": "true",
  "name": "Test Product",
  "price": 956,
  "quantity": 10,
  "sell_in_store": "false",
  "status": "on_sale",
  "updated_at": {
    "date": "2020-05-01",
    "formatted": "Fri 1 May 2020 10:30 PM",
    "iso": "2020-05-01T22:30:00+01:00",
    "time": "22:30",
    "timezone": "+01:00",
    "unix": 1588368600
  }
}