Responses
| Retorno | Descrição |
|---|---|
| 200 | Sucesso |
| 201 | Criado |
| 204 | Sem conteúdo |
| 401 | Sem autorização |
| 403 | Acesso Negado |
| 404 | Not found |
# Criar Cor
POST https://api.dooca.store/colors
Descrição dos campos:
| Campo | Tipo | Descrição |
|---|---|---|
| external_id | Number | Id do código externo |
| name | String | Nome da cor |
| hexadecimal | Number | Valor da cor em hexadecimal |
| image | String | URL da imagem da api |
| position | Number | Posição da variação |
| active | Boolean | Definir se a cor será criada de forma ativa ou inativa |
Body
{
"external_id": null,
"name": "Generic",
"hexadecimal": "#000000",
"image": null,
"position": 99,
"active": 1
}
# Editar Cor
PUT https://api.dooca.store/colors/:id
Descrição dos campos:
| Campo | Tipo | Descrição |
|---|---|---|
| external_id | Number | Id do código externo |
| name | String | Nome da cor |
| hexadecimal | Number | Valor da cor em hexadecimal |
| image | String | URL da imagem da api |
| position | Number | Posição da variação |
| active | Boolean | Definir se a cor será criada de forma ativa ou inativa |
Payload:
{
"name": "Generic edit"
}
# Deletar Cor
DELETE https://api.dooca.store/colors/:id
Parâmetro: O ID da cor.
# Consultar Cor
GET https://api.dooca.store/colors/:id
Parâmetro: O ID da cor.
HTTP STATUS: 200 OK
{
"data": [
{
"id": 2492,
"external_id": null,
"name": "Generic",
"slug": "generic",
"hexadecimal": "#000000",
"image": null,
"position": 99,
"active": true,
"created_at": "2020-01-09 08:54:55",
"updated_at": "2020-01-09 08:54:55"
}
],
"links": {
"first": "https://api/colors?page=1",
"last": "https://api/colors?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://api/colors",
"per_page": 25,
"to": 1,
"total": 1
}
}
# Listar Cores
GET https://api.dooca.store/colors
HTTP STATUS: 200 OK
{
"data": [
{
"id": 2492,
"external_id": null,
"name": "Generic",
"slug": "generic",
"hexadecimal": "#000000",
"image": null,
"position": 99,
"active": true,
"created_at": "2020-01-09 08:54:55",
"updated_at": "2020-01-09 08:54:55"
}
],
"links": {
"first": "https://api/colors?page=1",
"last": "https://api/colors?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://api/colors",
"per_page": 25,
"to": 1,
"total": 1
}
}
Comentários
0 comentário
Por favor, entre para comentar.