- Documentation
- Sandbox
Create one brands
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | true | Nom de la marque |
| Name | Required? | Description |
|---|---|---|
| Authorization | true | Authorization token |
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 - Brands create |
|||
| name | string | * | brand name |
| id | integer | * | Id autoincrement |
| Status Code | Description |
|---|---|
| 200 |
|
Update one brands
| Name | Requirement | Type | Description |
|---|---|---|---|
| brandId |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | true | Nom de la marque |
| Name | Required? | Description |
|---|---|---|
| Authorization | true | Authorization token |
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 - Brands create |
|||
| name | string | * | brand name |
| id | integer | * | Id autoincrement |
| Status Code | Description |
|---|---|
| 200 |
|
Get all active categories
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 - Categories found |
|||
| [] | array of objects (Categories) | * | |
| [][name] | string | * | Category name |
| [][id] | integer | * | Id autoincrement |
| Status Code | Description |
|---|---|
| 200 |
|
Create one categories
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | true | Nom de la categorie |
| Name | Required? | Description |
|---|---|---|
| Authorization | true | Authorization token |
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 - Categories create |
|||
| name | string | * | Category name |
| id | integer | * | Id autoincrement |
| Status Code | Description |
|---|---|
| 200 |
|
Update one categories
| Name | Requirement | Type | Description |
|---|---|---|---|
| categoriesId |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | true | Nom de la marque |
| Name | Required? | Description |
|---|---|---|
| Authorization | true | Authorization token |
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 - Categories create |
|||
| name | string | * | Category name |
| id | integer | * | Id autoincrement |
| Status Code | Description |
|---|---|
| 200 |
|
Get the information about all product
Pour la pagination, la route retourne les headers suivant :
'X-Pagination-Count' => Nombre total d'élements en base,
'X-Pagination-Start' => 1er élement à récuperer,
'X-Pagination-Limit' => Nombre d'élement à récuperer,
'X-Pagination-Result' => Résultat retournée,
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| start | integer | false | 1er élement à récuperer | |
| limit | integer | false | Nombre d'élement à récuperer | |
| search | string | false | Recherche sur le nom du produit | |
| order | string | false | Trié par un champ (defaut : p.name) | |
| sort | string | false | ASC/DESC | Send du tri (defaut : ASC) |
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 - Products found |
|||
| [] | array of objects (Products) | * | |
| [][name] | string | * | Product name |
| [][description] | string | * | Product description |
| [][brand] | object (Brands) | * | Product brand |
| [][brand][id] | integer | * | Id autoincrement |
| [][brand][name] | string | * | brand name |
| [][url] | * | ||
| [][md5] | string | * | MD5 de l'id |
| [][image] | string | * | |
| [][id] | integer | * | Id autoincrement |
| [][categories][] | array of objects (Categories) | * | Product categories |
| [][categories][][id] | integer | * | Id autoincrement |
| [][categories][][name] | string | * | Category name |
| Status Code | Description |
|---|---|
| 200 |
|
Create one product
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | true | Nom du produit | |
| description | string | true | Description du produit | |
| url | string | false | URL du produit (http, https, ftp) | |
| categories[] | array of choices | false | Id des catégories séléctionnées | |
| brand | choice | true | Id de la marque séléctionnée |
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 |
|||
| name | string | * | Product name |
| description | string | * | Product description |
| brand | object (Brands) | * | Product brand |
| brand[id] | integer | * | Id autoincrement |
| brand[name] | string | * | brand name |
| url | * | ||
| md5 | string | * | MD5 de l'id |
| image | string | * | |
| id | integer | * | Id autoincrement |
| categories[] | array of objects (Categories) | * | Product categories |
| categories[][id] | integer | * | Id autoincrement |
| categories[][name] | string | * | Category name |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Get the information about one product
| Name | Requirement | Type | Description |
|---|---|---|---|
| productId |
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 - Product found |
|||
| name | string | * | Product name |
| description | string | * | Product description |
| brand | object (Brands) | * | Product brand |
| brand[id] | integer | * | Id autoincrement |
| brand[name] | string | * | brand name |
| url | * | ||
| md5 | string | * | MD5 de l'id |
| image | string | * | |
| id | integer | * | Id autoincrement |
| categories[] | array of objects (Categories) | * | Product categories |
| categories[][id] | integer | * | Id autoincrement |
| categories[][name] | string | * | Category name |
| Status Code | Description |
|---|---|
| 200 |
|
| 404 |
|
Update one product
| Name | Requirement | Type | Description |
|---|---|---|---|
| productId |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | true | Nom du produit | |
| description | string | true | Description du produit | |
| url | string | false | URL du produit (http, https, ftp) | |
| categories[] | array of choices | false | Id des catégories séléctionnées | |
| brand | choice | true | Id de la marque séléctionnée |
| Parameter | Type | Versions | Description |
|---|---|---|---|
200 - Product update |
|||
| name | string | * | Product name |
| description | string | * | Product description |
| brand | object (Brands) | * | Product brand |
| brand[id] | integer | * | Id autoincrement |
| brand[name] | string | * | brand name |
| url | * | ||
| md5 | string | * | MD5 de l'id |
| image | string | * | |
| id | integer | * | Id autoincrement |
| categories[] | array of objects (Categories) | * | Product categories |
| categories[][id] | integer | * | Id autoincrement |
| categories[][name] | string | * | Category name |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 404 |
|
Documentation auto-generated on Sun, 19 Apr 26 17:15:39 +0200