Skip to main content

Get all forced-products

GET 
/forced-products

Can only be executed as admin.

Request​

Responses​

forced-products found

Schema

  • Array [

    • product_id guid

    The guid of the Product Type that is used as a Forced Product.

    enabled boolean

    Whether the Forced Product is enabled by default. Enabled Forced Products are added to all shops by default.

    updatable_by string

    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.

    guid uuidrequired

    The guid of the Product Type.

    event_id uuidrequired

    The guid of the Event associated with the Product Type.

    name stringrequired

    Possible values: <= 255 characters

    The name of the Product Type.

    description string

    Possible values: <= 65536 characters

    The description of the Product Type.

    vat_percentage floatrequired

    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.

    price integer

    The price of this Product Type in cents.

    pricing_method string

    Possible values: [own, container]

    The type of pricing method. Whether the container value or its own value is used for varying kickback calculations.

    class string

    Possible values: [EventProtect, RefundProtect, RandomNumberGenerator, PlayPass, Co2Compensate, Giro555]

    The class which get called on order Events.

    origin_type string

    Possible values: [date, ticket, product]

    The type of Product Type. This is either date, ticket, or product. This is auto-generated.

    status string

    Possible values: [auto, sold_out]

    The sale status of the Product Type.

    extra_data array

    Extra class data.

    preferences

    object

    self boolean

    Whether the Forced Product is added by default.

    shop boolean

    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.

    company boolean

    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.

    created_at ISO 8601

    The time it was created.

    updated_at ISO 8601

    The time it was last updated.

  • ]

Loading...