PATCH /company/shops/@id
This endpoint requires authentication.
| Header | Value |
|---|---|
| Authorization | Set the value to Bearer + + access_token |
Replace the @ keywords in the URL with their corresponding value.
A dictionary with fields
| Field | Type | Description |
|---|---|---|
| id | Int | The ID of the shop you want to update |
Pass the following properties via application/json or form encoding in the body of the request.
| Field | Type | Description |
|---|---|---|
| name | String | Name of the shop (not translateable for now) |
| active | Bool | A boolean value |
| address | Address.detailed | An address |
| allow_comments | Bool | A boolean value |
| allow_orders | Bool | A boolean value |
| delivery_use_intervals | Bool | A boolean value |
| category_ids | [Int] | List of the categories (in the right order) of all the categories visible for the shop |
| category_groups | [company.CategoryGroup] | List of the category groups linked to the shop. More information can be found on the category group documentation page. |
PATCH /company/shops/12 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.0.1
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 1219
{
"name": "Kellen Emard",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"allow_orders": false,
"delivery_use_intervals": true,
"category_ids": [
13,
14,
17
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
12,
12,
15
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
15,
19,
17
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
15,
17,
13
]
}
]
}| Field | Type | Description |
|---|---|---|
| name | String | Name of the shop (not translateable for now) |
| active | Bool | A boolean value |
| address | Address.detailed | An address |
| allow_comments | Bool | A boolean value |
| allow_orders | Bool | A boolean value |
| delivery_use_intervals | Bool | A boolean value |
| categories | [company.Category.simple] | List of the categories of all the categories visible for the shop |
| category_groups | [company.CategoryGroup] | List of the category groups linked to the shop. More information can be found on the category group documentation page. |
| id | Int | ID of the shop |
| avatar | Image? | Nullable. |
| banner | Image? | Nullable. |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 6708
{
"name": "Rosalyn Conn",
"active": true,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"name": "Dr. Koby Kozey II",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"id": 19,
"banner": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
"seo": {
"title": {
"en": "Delectus sapiente consequuntur libero quo officia in."
},
"description": {
"en": "Nihil magni dolores accusantium sint distinctio. Veniam dolores magnam placeat dolores quis. Voluptatem voluptate ducimus ut ea ea id et. Qui blanditiis cumque eveniet qui et."
},
"url": {
"en": "http://www.rempel.com/eum-nobis-blanditiis-aut-est-nihil-suscipit-id-quia.html"
}
}
},
{
"name": "Ms. Josie Witting Sr.",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"id": 12,
"banner": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
"seo": {
"title": {
"en": "Expedita nulla ipsum aut voluptatem quia."
},
"description": {
"en": "Amet cum rerum aliquid voluptas voluptate molestiae est. Soluta ut magnam incidunt incidunt et sed error. Illo eligendi est possimus ducimus sequi neque nam."
},
"url": {
"en": "http://cremin.biz/unde-voluptas-consequatur-quidem-aliquid-nihil-numquam-ea-nam.html"
}
}
},
{
"name": "Prof. Fletcher Sipes",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"id": 10,
"banner": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
"seo": {
"title": {
"en": "Sunt optio natus error accusamus aperiam aperiam rerum dolores."
},
"description": {
"en": "Quasi debitis velit in quia qui quos. Enim nisi ab maxime. Nisi qui voluptatem enim veniam."
},
"url": {
"en": "http://lynch.info/cumque-eaque-eum-maiores-sed-consectetur-ut"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
15,
15,
18
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
15,
13,
18
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
10,
15,
13
]
}
],
"id": 12,
"avatar": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
"banner": {
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
}
}