Update a product
POSThttps://api.tickettailor.com/v1/products/:product_id
Updates an existing product
Request
Path Parameters
The unique identifier for the product
- application/x-www-form-urlencoded
Body
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 that the product can be purchased in. Defaults to the box office currency.
Description of the product
event_series_ids object
Raw image file data
Instructions on how to purchase the product
Indicate whether the QR code is to be issued for the product
Indicate whether the product is linked to all event series
Number of products to add or remove. The number should be preceded by a + or - sign
Name of the product
Cost of the product in cents
Number of products available for purchase
Number of products available for purchase per event
If set to 'true', the quantity will be set to unlimited. Otherwise, it will be set to the quantity given
Possible values: [true
, false
]
Product status: on_sale, hidden or sold_out
Responses
- 200
- default
Successfully updated the product
- application/json
- Schema
- Example (auto)
Schema
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.
created_at nullable
Information about the currency the product is configured to use
Possible values: [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
]
Description of the product
List of associated event series IDs
Image associated with the product
Instructions on how to use the product
Number of sold products
A boolean value indicating whether a QR code is to be issued for the product
Possible values: [true
, false
]
A 'true' or 'false' value to determine if the product is linked to all the event series
Possible values: [true
, false
]
Name of the product
Price in cents. Could be null.
Number available for purchase for all event occurrences
Number available for purchase per event occurrence
A boolean value indicating whether product is being sold in store
Possible values: [true
, false
]
Status of the product
Possible values: [on_sale
, hidden
, sold_out
]
updated_at nullable
{
"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",
"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
}
}
Error schema
- application/json
- Schema
- Example (auto)
Schema
Http status code
Readable error code
Detailed error message
errors object[]
{
"status": 0,
"error_code": "string",
"message": "string",
"errors": [
{
"field": "string",
"messages": [
"string"
]
}
]
}
Authorization: http
name: BasicAuthtype: httpdescription: Use base64 encoded api key created in Ticket Tailor dashboard. scheme: basic
- curl
- php
- ruby
- python
- nodejs
- go
- CURL
curl -L -X POST 'https://api.tickettailor.com/v1/products/:product_id' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'