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 |
| allow_invoices | 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. |
| currency | String | A String value |
PATCH /company/shops/17 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.1
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 1355
{
"name": "Richard Lemke",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": false,
"allow_invoices": false,
"category_ids": [
13,
11,
17
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
11,
11,
19
],
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
11,
13,
12
],
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
18,
11,
13
],
"uuid": "..."
}
],
"currency": "..."
}| 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 |
| allow_invoices | 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. |
| currency | String | A String value |
| 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: 6826
{
"name": "Miss Kathleen Carter Jr.",
"active": true,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": true,
"allow_invoices": false,
"categories": [
{
"name": "Garth Rowe",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"id": 11,
"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": "Adipisci enim quas nisi fugit omnis."
},
"description": {
"en": "Deserunt est vel temporibus aut modi quo. Et tempora eaque perferendis ratione quaerat et. Sed in quia provident animi voluptatem possimus quo."
},
"url": {
"en": "http://www.trantow.net/et-ut-odio-alias"
}
}
},
{
"name": "Miss Kailey Nolan DDS",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"id": 13,
"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": "Maiores voluptates rerum optio aspernatur necessitatibus."
},
"description": {
"en": "Eligendi asperiores possimus libero veritatis voluptatum in et. Odio deleniti recusandae maiores dolorum."
},
"url": {
"en": "http://www.cole.com/doloremque-minima-labore-sint"
}
}
},
{
"name": "Mrs. Rosemary Oberbrunner",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"id": 14,
"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": "In at et odit cumque sunt nesciunt maxime dolorum."
},
"description": {
"en": "Praesentium doloribus modi qui et enim. Autem facilis velit pariatur sit eveniet harum natus. Illo nisi fuga iste eius vero sint cumque."
},
"url": {
"en": "https://wilkinson.org/magni-illo-doloremque-eligendi-veritatis-rerum-eligendi-aliquid-doloremque.html"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
11,
12,
17
],
"id": 14,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
14,
10,
10
],
"id": 15,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
14,
11,
15
],
"id": 10,
"uuid": "..."
}
],
"currency": "...",
"id": 13,
"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": true
}
}