Updates a specific MetaData from a Product
POST/order/:guid/ticket/:order_ticket_guid/product/:order_ticket_product_guid/bymetadataid/:order_metadata_guid
One can use this to update an existing MetaData value, or create a new MetaData (linked to the Product).
Request
Path Parameters
The guid of the Order.
The guid of the Ticket.
The guid of the Product of the Ticket.
The guid of the OrderMetaData of the Order.
- application/json
Body
Input data
The value of the OrderMetaData.
Responses
- 200
- 403
- 404
- 406
Return the full updated Order.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
Array [
]
Array [
]
Array [
- If the Ticket Type of the Ticket has a min price, then this is the original price of the Ticket divided by the number of force products;
- Otherwise, this is the original price of the Product.
Array [
]
]
]
Array [
Array [
]
]
The guid of the Order.
The channel through which the Order is purchased.
The original price, i.e. the price of the Order before any CouponCodes have been applied.
The value of the Order used when deriving the service fees. This is the price that is paid for the Order, i.e. the sum of the values of the Tickets of the Order.
The service fees of the Order. This is calculated upon the value.
The total price of the Order. This is the sum of the value, and service fees.
The guid of the Shop associated with the Order.
Whether any of the Tickets of the Order is seated.
The email address of the Receiver.
Whether to send the PDF to the visitor.
Whether the Order is complete, i.e. whether all required OrderMetaData is filled in.
Whether the Order has a receipt.
Whether the PDF has been rendered.
The status of the Order.
Replaced by the finn values.
Replaced by the finn values.
The date at which this Order was invalidated.
The reason why this Order was invalidated.
The first name of the Receiver.
The last name of the Receiver.
The locale of the Receiver.
The full name of the Receiver
The link where the Order can be downloaded.
Whether the Order can be downloaded.
The link to the receipt of the Order.
The time it was created.
The time it was last updated.
The time it was created at as a unix timestamp.
shop
object
The guid of the Shop.
Possible values: <= 255 characters
The name of the Shop.
Possible values: <= 65536 characters
The description of the Shop.
Possible values: [auto, enabled, disabled]
Default value: auto
Whether to show the Event selection as first step in the Shop. On default this will be enabled if there are 5 or more Events available.
Possible values: >= 8 characters and <= 15 characters
A Google Tag code from Google Tag Manager to include in the Shop.
The terms of the Company of the Shop. This is a url.
Any custom css the Shop has.
Whether people should be auto-attended or not, when they are logging in with Facebook.
The full url to the Facebook Page. This will be shown in shop as header.
Whether for seats, orphan seats are allowed.
Whether a date should be preselected. When set to true, the shop always falls back to date-selection mode.
Extra rules which can be enforced on the emails when placing Orders, i.e. Laraval validation rules.
Whether all emails should be unique, i.e. only 1 Order can be placed with the same email address.
Whether to allow auto pruning.
Calculated property, the Whitelabel terms a visitor has to accept.
Default value: EUR
Currency for the Orders, currently ignored.
Possible values: <= 3600
How long reserved Tickets and/or Products remain reserved. The time is in minutes.
The public key to use with Seats.io.
metaData
object[]
The guid of the OrderMetadata.
The guid of the Metadata this OrderMetadata belongs to.
The guid of the Order this OrderMetadata belongs to.
The value of the OrderMetaData.
Whether the OrderMetaData is required to be filled in.
Whether the OrderMetaData has been filled in.
metadata
object
The guid of the MetaData.
Possible values: <= 255 characters
The human readable name for the MetaData.
Additional info for the MetaData, i.e. the description of the MetaData.
Possible values: [integer, string, date, enum, enumOther, boolean, values, seatSelect, phone]
The type of the MetaData is related to UI that needs to be presented. The "seatSelect" type can only be set by an admin.
Possible values: <= 60000 characters
Extra information which is required for the type, i.e. this is Laravel validation rules.
When a ticket swap creates a new Ticket Type, whether the value of this MetaData should be copied to the new Ticket Type. If you are unsure, leave this false; incorrect usage could leak personal information.
Possible values: [none, first_name, last_name, email, gender, date_of_birth, age, city, country]
The Facebook input type to auto fill the MetaData. This has been disabled by Facebook.
The translated name. This property is calculated.
Whether the MetaData is translatable or not.
The time it was created.
The time it was last updated.
The time it was created at as a unix timestamp.
tickets
object[]
The guid of the Ticket.
The original price, i.e. the minimum price of the Ticket Type.
The value of the Ticket used when deriving the service fees. This is the price that is paid for the Ticket, i.e. the sum of the inner values of the Products minus its own inner value.
The actual value of the Ticket, i.e. the sum of the values of the Products of this Ticket.
The service fees of the Ticket. This is calculated based upon the value.
The total price of the Ticket, i.e. the sum of the value, inner value, and service fees.
The barcode of the Ticket.
Whether the Order is complete, i.e. whether all required OrderMetaData is filled in.
After this unix timestamp the Ticket is downloadable by the visitor.
Replaced by the finn values.
Replaced by the finn values.
The link where the PDF of the Ticket can be downloaded.
The time it was created.
The time it was last updated.
The date at which this was invalidated.
The reason why this was invalidated.
The time it was created at as a unix timestamp.
ticket
object
The guid of the the Ticket Type.
The guid of the Company associated with the Ticket Type.
The guid of the Event associated with the Ticket Type.
Possible values: <= 255 characters
The name of the Ticket Type.
Possible values: <= 65536 characters
The description for the Ticket Type.
Possible values: <= 999999
The minimum price of this Ticket Type in cents, overwrites the mandatory Product Type prices.
Possible values: <= 100
The VAT percentage which applies to this Ticket Type. This is a float with at most 2 decimals, because VAT percentages in some countries have fractions of a percent.
Whether the Metadata within the Ticket Type can be LatePersonalized. When true MetaData is not asked in Shop but before download.
Possible values: [auto, sold_out]
One can overwrite the status for a Ticket Type here.
Possible values: [EventProtect, RefundProtect, RandomNumberGenerator, PlayPass, Co2Compensate, Giro555]
Which class the Ticket Type needs to trigger after for example a Payment.
Possible values: >= 1
Default value: 1
The Ticket Type can only be ordered in groups of this size, i.e. the count of ordered Ticket Types needs to be exactly divisible by this number. This should be less or equal to min_orderable_amount_per_order.
The start of the availability range for this Ticket Type. Has to be set when available_until is set.
The end of the availability range for this Ticket Type. Has to be set when available_from is set.
Possible values: <= 999999999
The margin for which the Ticket Type will show-up (with countdown for example) in the Shop.
Possible values: >= 1
Default value: 1
Specifies the minimum number of Ticket Types a visitor can select within one Order. This should be less or equal to max_orderable_amount_per_order.
Possible values: <= 250
Default value: 20
Specifies the maximum number of Ticket Types a visitor can select within one Order. This should be greater or equal to min_orderable_amount_per_order.
Possible values: <= 100
How many fees will be in the Ticket Type.
Possible values: <= 255
The category key from the Chart where the Ticket Type should be applied to (see Seats.io).
Default value: false
Whether to hide this Ticket Type when no Coupon is used.
Default value: true
Whether to combine the Products into the Ticket Type price or not. If false, Products show up separately on the receipt/invoices.
Default value: true
Whether it is possible to swap the Ticket Type.
Default value: false
Whether a Ticket Type is available in Cashr.
Possible values: [sold_out, not_sold_right_now, available]
The sale status of the Ticket Type.
Whether a Ticket Type is seated or not.
Whether to include the service costs into the price.
products
object[]
The guid of the Product Type.
The guid of the Event associated with the Product Type.
Possible values: <= 255 characters
The name of the Product Type.
Possible values: <= 65536 characters
The description of the Product Type.
Possible values: <= 100
The VAT percentage which applies to this Product Type. This is a float with at most 2 decimals, because VAT percentages in some countries have fractions of a percent.
The price of this Product Type in cents.
Possible values: [own, container]
The type of pricing method. Whether the container value or its own value is used for varying kickback calculations.
Possible values: [EventProtect, RefundProtect, RandomNumberGenerator, PlayPass, Co2Compensate, Giro555]
The class which get called on order Events.
Possible values: [date, ticket, product]
The type of Product Type. This is either date, ticket, or product. This is auto-generated.
Possible values: [auto, sold_out]
The sale status of the Product Type.
Extra class data.
metaData
object[]
The guid of the OrderMetadata.
The guid of the Metadata this OrderMetadata belongs to.
The guid of the Order this OrderMetadata belongs to.
The value of the OrderMetaData.
Whether the OrderMetaData is required to be filled in.
Whether the OrderMetaData has been filled in.
metadata
object
The guid of the MetaData.
Possible values: <= 255 characters
The human readable name for the MetaData.
Additional info for the MetaData, i.e. the description of the MetaData.
Possible values: [integer, string, date, enum, enumOther, boolean, values, seatSelect, phone]
The type of the MetaData is related to UI that needs to be presented. The "seatSelect" type can only be set by an admin.
Possible values: <= 60000 characters
Extra information which is required for the type, i.e. this is Laravel validation rules.
When a ticket swap creates a new Ticket Type, whether the value of this MetaData should be copied to the new Ticket Type. If you are unsure, leave this false; incorrect usage could leak personal information.
Possible values: [none, first_name, last_name, email, gender, date_of_birth, age, city, country]
The Facebook input type to auto fill the MetaData. This has been disabled by Facebook.
The translated name. This property is calculated.
Whether the MetaData is translatable or not.
The time it was created.
The time it was last updated.
The time it was created at as a unix timestamp.
products
object[]
The guid of the Product.
The original price, i.e. the price of the Product.
The value of the Product used when deriving the service fees. This is the price that is paid for the Product. Only used for optional Products.
The actual value of the Product, i.e.
The service fees of the Product.
The total price of the Product. This is the sum of the value, inner value, and service fees.
Whether this Product is an optional Product.
Whether the Order is complete, i.e. whether all required OrderMetaData is filled in.
The code of the CouponCode this Product belongs to.
The guid of the CouponCode this Product belongs to.
Replaced by the finn values.
The VAT percentage which applies to this Product. This is a float with at most 2 decimals, because VAT percentages in some countries have fractions of a percent.
The time it was created.
The time it was last updated.
The date at which this was invalidated.
The reason why this was invalidated.
The time it was created at as a unix timestamp.
metaData
object[]
The guid of the OrderMetadata.
The guid of the Metadata this OrderMetadata belongs to.
The guid of the Order this OrderMetadata belongs to.
The value of the OrderMetaData.
Whether the OrderMetaData is required to be filled in.
Whether the OrderMetaData has been filled in.
metadata
object
The guid of the MetaData.
Possible values: <= 255 characters
The human readable name for the MetaData.
Additional info for the MetaData, i.e. the description of the MetaData.
Possible values: [integer, string, date, enum, enumOther, boolean, values, seatSelect, phone]
The type of the MetaData is related to UI that needs to be presented. The "seatSelect" type can only be set by an admin.
Possible values: <= 60000 characters
Extra information which is required for the type, i.e. this is Laravel validation rules.
When a ticket swap creates a new Ticket Type, whether the value of this MetaData should be copied to the new Ticket Type. If you are unsure, leave this false; incorrect usage could leak personal information.
Possible values: [none, first_name, last_name, email, gender, date_of_birth, age, city, country]
The Facebook input type to auto fill the MetaData. This has been disabled by Facebook.
The translated name. This property is calculated.
Whether the MetaData is translatable or not.
The time it was created.
The time it was last updated.
The time it was created at as a unix timestamp.
couponCode
object
The guid of the CouponCode.
The guid of the Company associated with the CouponCode.
The guid of the Coupon (Campaign) the CouponCode belongs to.
Possible values: >= 4 characters
The actual code.
Possible values: >= 1 and <= 9999999999
Default value: 1
The maximum number of times this CouponCode can be applied within a single Order.
The amount of monetary value for which this CouponCode is used.
Product
object
The guid of the Product Type.
The guid of the Event associated with the Product Type.
Possible values: <= 255 characters
The name of the Product Type.
Possible values: <= 65536 characters
The description of the Product Type.
Possible values: <= 100
The VAT percentage which applies to this Product Type. This is a float with at most 2 decimals, because VAT percentages in some countries have fractions of a percent.
The price of this Product Type in cents.
Possible values: [own, container]
The type of pricing method. Whether the container value or its own value is used for varying kickback calculations.
Possible values: [EventProtect, RefundProtect, RandomNumberGenerator, PlayPass, Co2Compensate, Giro555]
The class which get called on order Events.
Possible values: [date, ticket, product]
The type of Product Type. This is either date, ticket, or product. This is auto-generated.
Possible values: [auto, sold_out]
The sale status of the Product Type.
Extra class data.
payments
object[]
The guid of the Payment.
The monetary value of the Payment in cents.
The service fees of the Payment in cents.
The total price of the Payment, this is finn_value + finn_service_fee.
The current status of the Payment.
The guid of the PaymentMethod used to execute the Payment.
The id of the payment (transaction) provided by the external Payment Provider.
The amount of money (to be) paid in cents.
The currency in which the Payment will be paid.
A description of the Payment.
statii
object[]
A list of all the statii that the Payment has had.
The status of the Payment.
Possible values: <= 255 characters
The reason for the status.
The time it was created.
The time it was last updated.
The time it was created at as a unix timestamp.
The time it was created.
The time it was last updated.
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"purchase_channel": "string",
"finn_original_price": 0,
"finn_value": 0,
"finn_service_fee": 0,
"finn_price": 0,
"shop_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"is_seated": true,
"email": "user@example.com",
"send_email": true,
"is_complete": true,
"has_receipt": true,
"pdf_rendered": true,
"status": "string",
"invalidated_since": "string",
"invalidated_reason": "string",
"firstName": "string",
"lastName": "string",
"locale": "string",
"fullname": "string",
"download_link": "string",
"download_ready": true,
"receipt_link": "string",
"created_at": "string",
"updated_at": "string",
"created_at_int": 0,
"shop": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"event_selection": "auto",
"google_tag": "string",
"company_terms": "string",
"css": "string",
"facebook_auto_attend": true,
"facebook_page_url": "string",
"seats_allow_orphan": true,
"greedy_date_selection": true,
"email_validation_rule": "string",
"email_must_be_unique": true,
"auto_prune": true,
"global_terms": "string",
"currency": "EUR",
"reservation_time": 0,
"seats_public_key": "string"
},
"metaData": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"metadata_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"value": "string",
"is_required": true,
"is_complete": true,
"metadata": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"shop_description": "string",
"type": "integer",
"extra": "string",
"copy_on_swap": true,
"auto_fill_facebook": "none",
"translate_name": "string",
"translatable": true
},
"created_at": "string",
"updated_at": "string",
"created_at_int": 0
}
],
"tickets": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"finn_original_price": 0,
"finn_value": 0,
"finn_inner_value": 0,
"finn_service_fee": 0,
"finn_price": 0,
"ticket_number": "string",
"is_complete": true,
"retrievable_after": 0,
"download_link": "string",
"created_at": "string",
"updated_at": "string",
"invalidated_since": "string",
"invalidated_reason": "string",
"created_at_int": 0,
"ticket": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"min_price": 0,
"vat_percentage": 0,
"late_personalization": true,
"status_overrule": "auto",
"class": "EventProtect",
"increment": 1,
"available_from": "string",
"available_until": "string",
"availability_margin": 0,
"min_orderable_amount_per_order": 1,
"max_orderable_amount_per_order": 20,
"seats_category_key": 0,
"hide_without_coupon": false,
"combines_products": true,
"swappable": true,
"status": "sold_out",
"seated": true,
"products": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"vat_percentage": 0,
"price": 0,
"pricing_method": "own",
"class": "EventProtect",
"origin_type": "date",
"status": "auto",
"extra_data": [
null
]
}
]
},
"metaData": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"metadata_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"value": "string",
"is_required": true,
"is_complete": true,
"metadata": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"shop_description": "string",
"type": "integer",
"extra": "string",
"copy_on_swap": true,
"auto_fill_facebook": "none",
"translate_name": "string",
"translatable": true
},
"created_at": "string",
"updated_at": "string",
"created_at_int": 0
}
],
"products": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"finn_original_price": 0,
"finn_value": 0,
"finn_inner_value": 0,
"finn_service_fee": 0,
"finn_price": 0,
"is_optional": true,
"is_complete": true,
"coupon_code": "string",
"coupon_code_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vat": 0,
"created_at": "string",
"updated_at": "string",
"invalidated_since": "string",
"invalidated_reason": "string",
"created_at_int": 0,
"metaData": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"metadata_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"value": "string",
"is_required": true,
"is_complete": true,
"metadata": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"shop_description": "string",
"type": "integer",
"extra": "string",
"copy_on_swap": true,
"auto_fill_facebook": "none",
"translate_name": "string",
"translatable": true
},
"created_at": "string",
"updated_at": "string",
"created_at_int": 0
}
],
"couponCode": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"coupon_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"applies_to_count": 1,
"used_amount": 0
},
"Product": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"vat_percentage": 0,
"price": 0,
"pricing_method": "own",
"class": "EventProtect",
"origin_type": "date",
"status": "auto",
"extra_data": [
null
]
}
}
]
}
],
"payments": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"finn_value": 0,
"finn_service_fee": 0,
"finn_price": 0,
"status": "string",
"payment_method_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payment_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"amount": 0,
"currency": "string",
"description": "string",
"statii": [
{
"status": "string",
"reason": "string",
"created_at": "string",
"updated_at": "string",
"created_at_int": 0
}
],
"created_at": "string",
"updated_at": "string"
}
]
}
Unauthorized. You do not have permission to manage the Order or read the MetaData.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
Order, Ticket, Product, or MetaData not found.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
Request is invalid, see error context for validation errors.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}