Variações¶
Variação do Produto¶
Adicionar variação de produto¶
Referência¶
POST https://api.dezwork.com/v1/produtos/variacoes
| Parâmetros | Tipo | Descrição |
|---|---|---|
| idProduct* | int | ID do produto relacionado com a variação |
| subtitle | string | Subtítulo da variação de produto |
| reference | int | Código de referência da variação de produto |
| ncm* | int | NCM (Nomenclatura Comum do Mercosul) |
| barcode | string | Código de barras da variação de produto |
| sku | string | Unidade de Manutenção de Estoque da variação (Stock Keeping Unit) |
| taxGroup | string | Grupo tributário da variação de produto |
| relevance* | int | Relevância da variação de produto (1 - muito baixa, 2 - baixa,
3 - normal, 4 - alta, 5 - muito alta, 6 - super alta)
|
| stock* | int | Quantidade em estoque |
| width* | decimal | Largura da variação de produto (em centímetros) |
| height* | decimal | Altura da variação de produto (em centímetros) |
| length* | decimal | Comprimento da variação de produto (em centímetros) |
| weight* | decimal | Peso da variação de produto (em gramas) |
| value | decimal | Valor bruto da variação (normalmente visto como “Valor de:”) |
| valueOff* | decimal | Valor real de venda da variação de produto |
| active | boolean | Produto ativo? |
| types* | array | Array contendo objetos Tipo de Variação ou
IDs de tipos de variação já existentes
|
| images* | array | Array contendo objetos foto. Necessário pelo menos uma foto |
Nota
Parâmetros com asterisco ( * ) são obrigatórios
Exemplo de Requisição¶
{
"idProduct": 1,
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku":"2SKU123456",
"taxGroup":"1",
"relevance":5,
"stock": 100,
"width": "50.00",
"height": "50.00",
"length": "50.00",
"weight": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"types":[
{
"title":"cor",
"options": ["preto", "branco"]
},
{
"title":"tamanho",
"options": ["P", "M", "G"]
}
],
"images":[
{
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true,
"orderNumber": 1
}
]
}
Resposta¶
Status 201: CREATED¶
É criada uma variação para cada Opção de Variação. Caso seja informado mais do que um Tipo de Variação (como no exemplo acima), será realizada a combinação das opções.
{
"success": true,
"data": [
{
"id": 1,
"idProduct": 1,
"url": "produto-1-preto-p",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 1,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
},
{
"id": 2,
"idProduct": 1,
"url": "produto-1-preto-m",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 2,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
},
{
"id": 3,
"idProduct": 1,
"url": "produto-1-preto-g",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 3,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
},
{
"id": 4,
"idProduct": 1,
"url": "produto-1-branco-p",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 4,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
},
{
"id": 5,
"idProduct": 1,
"url": "produto-1-branco-m",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 5,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
},
{
"id": 6,
"idProduct": 1,
"url": "produto-1-branco-g",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 6,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
}
]
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Atualizar variação de produto¶
Referência¶
POST https://api.dezwork.com/v1/produtos/variacoes/atualizar
Nota
A atualização de variações de produto, diferentemente de outros itens, deve ser feita usando o método POST, pois o método PUT não aceita multipart/form-data para o caso de envio de arquivos de imagens.
Nota
Parâmetros com asterisco ( * ) são obrigatórios
- Explicando a funcionalidade das imagens:
- Para atualização de variação de produto, são aceitos arrays de objetos e arrays de IDs de itens já existentes.No caso de array de objetos, eles irão seguir as regras descritas na sessão do respectivo objeto.No caso de array de IDs, os IDs serão validados e relacionados com a variação de produto em questão.Caso informe no array IDs que ainda não estão relacionados a variação, eles serão validados e relacionados.Caso informe um array sem IDs que já estão relacionados a variação, eles serão removidos.
- Exemplo prático usando imagens:
- Inseri uma variação com as imagens [1, 2, 3].Fiz uma requisição de atualização, enviando no array images os valores [1, 2].Nesse caso, a imagem 3 será removida.Inseri uma variação com as imagens [1, 2, 3].Fiz uma requisição de atualização, enviando no array images os valores [1, 2, 3, 4].Nesse caso, as imagens [1, 2, 3] serão mantidas, e a imagem 4 será adicionada a variação de produto.
Exemplo de Requisição¶
{
"id": 1,
"idProduct": 1,
"subtitle": "new subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "150.00",
"valueOff": "100.00",
"active": true,
"images": [
{
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
}
Resposta¶
Status 200: OK¶
{
"success": true,
"data":
{
"id": 1,
"idProduct": 1,
"subtitle": "new subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "150.00",
"valueOff": "100.00",
"active": true,
"images": [
{
"id": 1,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Consultar variações de produto¶
Referência¶
GET https://api.dezwork.com/v1/produtos/variacoes/pagina/{numero-pagina}
A API realiza a consulta com paginação, onde a variável {numero-pagina} corresponde ao número da página desejado (1, 2, 3 …) e são retornadas 50 variações de produtos por página.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": [
{
"id": 1,
"idProduct": 1,
"url": "produto-1-preto-p",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 1,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
},
{
"id": 2,
"idProduct": 1,
"url": "produto-1-preto-m",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 2,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
}
]
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Consultar variação de produto por ID¶
Referência¶
GET https://api.dezwork.com/v1/produtos/variacoes/{id}
Basta uma requisição GET simples para esse endpoint, informando o ID da variação de produto na URL, para retornar a variação em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": [
{
"id": 1,
"idProduct": 1,
"url": "produto-1-preto-p",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 1,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
}
]
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Excluir variação de produto¶
Referência¶
DELETE https://api.dezwork.com/v1/produtos/variacoes/{id}
Basta uma requisição DELETE simples para esse endpoint, informando o ID da variação na URL, para excluir a variação em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": [
{
"id": 1,
"idProduct": 1,
"url": "produto-1-preto-p",
"subtitle": "subtitle",
"reference": "132123121",
"ncm": "21234567",
"barcode": "2ASD1234FRE4",
"sku": "2SKU123456",
"taxGroup": "1",
"relevance": "5",
"stock": "100",
"width": "50.00",
"height": "50.00",
"weight": "50.00",
"length": "50.00",
"value": "45.00",
"valueOff": "40.00",
"active": true,
"images": [
{
"id": 1,
"fileP": "http://url.da.imagem.p",
"fileM": "http://url.da.imagem.m",
"fileG": "http://url.da.imagem.g",
"active": true
}
]
}
]
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Tipo de Variação¶
Adicionar tipo de variação¶
Referência¶
POST https://api.dezwork.com/v1/produtos/tipoVariacao
| Parâmetros | Tipo | Descrição |
|---|---|---|
| title* | string | Nome/título do tipo de variação |
| active | boolean | Tipo de variação ativo? |
| options | Array | Array contendo objetos Opção de Variação ou
strings com somente o title da option a ser criada
|
Nota
Parâmetros com asterisco ( * ) são obrigatórios
Exemplo de Requisição¶
{
"title": "Cor",
"active": true,
"options":[
"azul", "verde", "branco", "rosa"
]
}
Resposta¶
Status 201: CREATED¶
{
"success": true,
"data": {
"type": {
"id": 1,
"title": "Cor",
"active": true,
"options": [
{
"id": 1,
"title": "azul",
"active": true,
"idType": 1
},
{
"id": 2,
"title": "verde",
"active": true,
"idType": 1
},
{
"id": 3,
"title": "branco",
"active": true,
"idType": 1
},
{
"id": 4,
"title": "rosa",
"active": true,
"idType": 1
}
]
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Atualizar tipo de variação¶
Referência¶
PUT https://api.dezwork.com/v1/produtos/tipoVariacao
Nota
Parâmetros com asterisco ( * ) são obrigatórios
- Explicando a funcionalidade das options:
- Para atualização de tipos de variação, são aceitos arrays de objetos do tipo option e arrays de strings contendo o title de options (a serem criadas ou já existentes).No caso de array de objetos option, eles irão seguir as regras descritas em sua respectiva sessão.No caso de array de strings, elas serão validadas e relacionadas com o tipo de variação em questão.Caso informe no array strings que ainda não sejam opções, elas serão validadas, criadas e relacionadas com o tipo de variação.Caso informe um array sem strings que correspondam a opções que já estão relacionadas ao tipo de variação, elas serão removidas.
- Exemplo:
- Inseri um tipo de variação com as opções [“P”, “M”, “G”, “GG”].Fiz uma requisição de atualização, enviando no array options os valores [“P”, “M”, “G”].Nesse caso, a opção GG será removida.Inseri um tipo de variação com as opções [“P”, “M”, “G”, “GG”].Fiz uma requisição de atualização, enviando no array options os valores [“PP”, “P”, “M”, “G”, “GG”].Nesse caso, as opções [“P”, “M”, “G”, “GG”] serão mantidas, e a opção “PP” será criada e adicionada ao tipo de variação.
Exemplo de Requisição¶
{
"id": 1,
"title": "Cor",
"active": true,
"options":[
"azul", "verde", "branco", "preto"
]
}
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"type": {
"id": 1,
"title": "Cor",
"active": true,
"options": [
{
"id": 1,
"title": "azul",
"active": true,
"idType": 1
},
{
"id": 2,
"title": "verde",
"active": true,
"idType": 1
},
{
"id": 3,
"title": "branco",
"active": true,
"idType": 1
},
{
"id": 5,
"title": "preto",
"active": true,
"idType": 1
}
]
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é 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 todos os tipos de variações cadastrados em uma loja.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"type": [
{
"id": 1,
"title": "Cor",
"active": true,
"options": [
{
"id": 1,
"title": "azul",
"active": true,
"idType": 1
},
{
"id": 2,
"title": "verde",
"active": true,
"idType": 1
},
{
"id": 3,
"title": "branco",
"active": true,
"idType": 1
},
{
"id": 5,
"title": "preto",
"active": true,
"idType": 1
}
]
},
{
"id": 2,
"title": "Tamanho",
"active": true,
"options": [
{
"id": 6,
"title": "P",
"active": true,
"idType": 1
},
{
"id": 7,
"title": "M",
"active": true,
"idType": 1
},
{
"id": 8,
"title": "G",
"active": true,
"idType": 1
}
]
}
]
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Consultar tipo 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 da variação na URL, para retornar o tipo em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"type": {
"id": 1,
"title": "Cor",
"active": true,
"options": [
{
"id": 1,
"title": "azul",
"active": true,
"idType": 1
},
{
"id": 2,
"title": "verde",
"active": true,
"idType": 1
},
{
"id": 3,
"title": "branco",
"active": true,
"idType": 1
},
{
"id": 4,
"title": "rosa",
"active": true,
"idType": 1
}
]
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Excluir tipo 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 da variação na URL, para excluir o tipo em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"type": {
"id": 1,
"title": "Cor",
"active": true,
"options": [
{
"id": 1,
"title": "azul",
"active": true,
"idType": 1
},
{
"id": 2,
"title": "verde",
"active": true,
"idType": 1
},
{
"id": 3,
"title": "branco",
"active": true,
"idType": 1
},
{
"id": 4,
"title": "rosa",
"active": true,
"idType": 1
}
]
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Opção de Variação¶
Adicionar opção de variação¶
Referência¶
POST https://api.dezwork.com/v1/produtos/opcaoVariacao
| Parâmetros | Tipo | Descrição |
|---|---|---|
| title* | string | Nome/título da opção de variação |
| active | boolean | Opção de variação ativa? |
| idType* | int | ID do type da opção de variação |
Nota
Parâmetros com asterisco ( * ) são obrigatórios
Exemplo de Requisição¶
{
"title": "Amarelo",
"active": true,
"idType": 1
}
Resposta¶
Status 201: CREATED¶
{
"success": true,
"data": {
"variationOption": {
"id": 1,
"title": "Amarelo",
"active": true,
"idType": 1
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Atualizar opção de variação¶
Referência¶
PUT https://api.dezwork.com/v1/produtos/opcaoVariacao
Nota
Parâmetros com asterisco ( * ) são obrigatórios
Exemplo de Requisição¶
{
"id": 1,
"title": "Roxo",
"active": true,
"idType": 1
}
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"variationOption": {
"id": 1,
"title": "Roxo",
"active": true,
"idType": 1
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Consultar opções de variação¶
Referência¶
GET https://api.dezwork.com/v1/produtos/opcaoVariacao
Basta uma requisição GET simples para esse endpoint para retornar todas as opções de variações cadastradas em uma loja.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"variationOption": [
{
"id": 1,
"title": "Roxo",
"active": true,
"idType": 1
},
{
"id": 2,
"title": "Prata",
"active": true,
"idType": 1
},
{
"id": 3,
"title": "P",
"active": true,
"idType": 2
},
{
"id": 4,
"title": "G",
"active": true,
"idType": 2
}
]
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Consultar opção de variação por ID¶
Referência¶
GET https://api.dezwork.com/v1/produtos/opcaoVariacao/{id}
Basta uma requisição GET simples para esse endpoint, informando o ID da opção da variação na URL, para retornar a opção em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"variationOption": {
"id": 1,
"title": "Amarelo",
"active": true,
"idType": 1
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Excluir opção de variação¶
Referência¶
DELETE https://api.dezwork.com/v1/produtos/opcaoVariacao/{id}
Basta uma requisição DELETE simples para esse endpoint, informando o ID da opção da variação na URL, para excluir a opção em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"variationOption": {
"id": 1,
"title": "Amarelo",
"active": true,
"idType": 1
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}