company.CategoryAvailablePeriod

Request

Fields when send to the api inside a request.

Field Type Description
start_date Date Start date of the period
end_date Date End date of the period
available Bool Are products available during this period or not?
all_products Bool Does this concern all products in this category?
products [Int] Optional. List of products for which this is active
has_priority Bool Optional. Does this have priority over the product available periods

Response

Fields when returned by the api in a response.

Field Type Description
start_date Date Start date of the period
end_date Date End date of the period
available Bool Are products available during this period or not?
all_products Bool Does this concern all products in this category?
id Int ID of the period
category_id Int Id of the linked category
products [Int] Optional. List of products for which this is active
has_priority Bool Optional. Does this have priority over the product available periods

Examples

Request

When used inside a request.

Example 1 

{
    "start_date": "2019-01-31",
    "end_date": "2019-01-31",
    "available": true,
    "all_products": true,
    "products": [
        15,
        13,
        19
    ],
    "has_priority": true
}

Response

When returned in a response.

Example 1 

{
    "start_date": "2019-01-31",
    "end_date": "2019-01-31",
    "available": false,
    "all_products": false,
    "id": 17,
    "category_id": 16,
    "products": [
        15,
        19,
        17
    ],
    "has_priority": true
}
1.9.0 stable