Get a forced-products
GET/forced-products/:forced-products_id
Returns all properties of the requested forced-products.
Request
Path Parameters
The id of the forced-products to fetch
Responses
- 200
- 403
- 404
- 410
forced-products found
- application/json
- Schema
- Example (from schema)
Schema
The guid of the Product Type that is used as a Forced Product.
Whether the Forced Product is enabled by default. Enabled Forced Products are added to all shops by default.
Possible values: [null
, shop
, company
]
Which entities are allowed to register a preference whether the Forced Product is added. Specifying preference allows for overriding the 'enabled' value for some entity. Setting this to implies specifying preference is also allowed for companies
product
object
The Product Type which is forced.
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.
preferences
object
Whether the Forced Product is added by default.
The preference of whether the Forced Product is added to this Shop. Null, if the Shop cannot be deduced or no preference has been registered.
The preference of whether the Forced Product is added to all Shops of this Company by default. Null, if the Company cannot be deduced or no preference has been registered.
The time it was created.
The time it was last updated.
{
"product_id": "string",
"enabled": true,
"updatable_by": "null",
"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
]
},
"preferences": {
"self": true,
"shop": true,
"company": true
},
"created_at": "string",
"updated_at": "string"
}
Access to forced-products denied
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
forced-products not found
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
The requested forced-products has been deleted (an admin can undelete it)
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}