Update a category available period

PATCH /company/categories/availableperiods/@period_id

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

Body

Pass the following properties via application/json or form encoding in the body of the request.

The available periods for a category

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

Example request 1 

PATCH /company/categories/availableperiods/@period_id HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 199

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

Response

The available periods for a category

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

Example response 1 

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 238


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