Tipos de Variação¶
Para trabalhar com variações nas lojas virtuais da Dezwork, você precisa cadastrar os seus tipos e suas opções. Por exemplo: Cores (tipo): Azul, Branco, Preto (opções), Tamanhos (tipo): P, M, G (opções).
Adicionar Tipos de Variação¶
Referência¶
POST https://api.dezwork.com/v1/produtos/tipoVariacao
Parameters | type | Descrição |
---|---|---|
title* | string | Nome/título do tipo de variação |
active | int(0, 1) | Tipo de variação ativo? |
Nota
Parâmetros com asterisco ( * ) são obrigatórios
Exemplo de Requisição¶
{
"title": "Tipo de Variação 1",
"active": 1
}
Resposta¶
Status 201: CREATED¶
{
"success": true,
"data": {
"variationType": {
"id": 1,
"title": "Tipo de Variação 1",
"active": 1
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT001",
"errorMessage": "Campo {$campo} é obrigatório"
}
Atualizar Tipos de Variação¶
Referência¶
PUT https://api.dezwork.com/v1/produtos/tipoVariacao
Nota
Parâmetros com asterisco ( * ) são obrigatórios
Exemplo de Requisição¶
{
"id": 1,
"description": "Tipo de Variação 1",
"active": 1
}
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"variationType": {
"id": 1,
"title": "Tipo de Variação 1",
"active": 1
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT001",
"errorMessage": "Campo {$campo} é obrigatório"
}
Consultar Tipos de Variação¶
Referência¶
GET https://api.dezwork.com/v1/produtos/tipoVariacao
Basta uma requisição GET simples para esse endpoint para retornar todas os tipos de variação cadastrados em uma loja.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"variationTypes": [
{
"id": 1,
"title": "Tipo de Variação 1",
"active": true
},
{
"id": 2,
"title": "Tipo de Variação 2",
"active": true
}
]
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT001",
"errorMessage": "Campo {$campo} é obrigatório"
}
Consultar Tipos de Variação por ID¶
Referência¶
GET https://api.dezwork.com/v1/produtos/tipoVariacao/{id}
Basta uma requisição GET simples para esse endpoint, informando o ID do tipo de variação na URL para retornar o tipo de variação em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"variationType": {
"id": 1,
"title": "Tipo de Variação 1",
"active": 1
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT001",
"errorMessage": "Campo {$campo} é obrigatório"
}
Excluir Tipos de Variação¶
Referência¶
DELETE https://api.dezwork.com/v1/produtos/tipoVariacao/{id}
Basta uma requisição DELETE simples para esse endpoint, informando o ID do tipo de variação na URL para excluir o tipo de variação em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"variationType": {
"id": 1,
"title": "Tipo de Variação 1",
"active": 1
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT001",
"errorMessage": "Campo {$campo} é obrigatório"
}