OfferItem

Request

Fields when send to the api inside a request.

Field Type Description
applies_to String String enumarion of 'category', 'product', 'product-price'
item_id Int ID of the category, product or product price where the offer applies to.
type String String enumarion of 'percentage', 'volume'
percentage Int? Optional. Nullable. Only required when "type" is percentage. e.g. 10,53% = 1053
minimum_amount Int? Optional. Nullable. Minimum amount required for the offer to apply.
free_amount Int? Optional. Nullable. Only required when "type" is volume.

Response

Fields when returned by the api in a response.

Field Type Description
applies_to String String enumarion of 'category', 'product', 'product-price'
item_id Int ID of the category, product or product price where the offer applies to.
type String String enumarion of 'percentage', 'volume'
id Int An integer value
percentage Int? Optional. Nullable. Only required when "type" is percentage. e.g. 10,53% = 1053
minimum_amount Int? Optional. Nullable. Minimum amount required for the offer to apply.
free_amount Int? Optional. Nullable. Only required when "type" is volume.

Examples

Request

When used inside a request.

Example 1 

{
    "applies_to": "category",
    "item_id": 12,
    "type": "percentage",
    "percentage": 14,
    "minimum_amount": 18,
    "free_amount": 17
}

Response

When returned in a response.

Example 1 

{
    "applies_to": "category",
    "item_id": 10,
    "type": "percentage",
    "id": 14,
    "percentage": 14,
    "minimum_amount": 13,
    "free_amount": 18
}
1.9.0 stable