Versão 1
Versão 2
Versão 3
Products: Recurso para gerenciamento de produtos
POST
v3/products
Inserção de Produtos

Notas:

Os campos Sku Pai e Sku das especificações são campos inteiros não obrigatórios. É possível enviar o código desejado, ou pode-se enviar null. Caso não preenchido o sistema assume o próximo código sequencial disponível.
Existe também a opção de informar dados alfanuméricos no campo ref (referência).

Parâmetros de Entrada:

sku (opcional): sku do produto pai, não obrigatório.
name (obrigatório): Título do produto.
description (obrigatório): descrição detalhada do produto, campo texto.
status (obrigatório): enviar enabled ou disabled
price (obrigatório): é o preço de venda do produto
promotional_price (obrigatório): é o preço DE exemplo: promotional_price 129,00 price 99,90. Pode-se enviar o mesmo valor do campo price.
cost (obrigatório): custo do produto.
weight (obrigatório): peso bruto em kg
width, height, length (obrigatório): dimensões em cm do produto embalado
brand (obrigatório): marca
nbm (opcional): código fiscal do produto
model (opcional): modelo do produto
gender (opcional): Gênero
volumes (opcional): quantidade de volumes que compõem o produto
warrantyTime (opcional): Tempo de garantia em meses

Variations (obrigatório):
ref (opcional): código alfanumérico de referência do sku, que pode ser o sku da loja/integradora.
sku (opcional): código sku da variação
qty (opcional): quantidade em estoque
ean (opcional): código ean da variação
images (opcional): array de imagens referente ao sku.
      Specifications (opcional): As especificações do sku podem ser por exemplo: Cor, Voltagem, Sabor, Tamanho, Aro, Capacidade, etc.
Para produtos que não possuem variações, como por exemplo televisores, DVDs, etc. não é enviar dados das especificações.

Exemplo de um sku branco 110V:
"specifications": [{
                  "key": "Cor",
                  "value": "Branco"
               },
               {
                  "key": "Voltagem",
                  "value": "110V"
               }
            ]

Parâmetros de Retorno:

code: codigo do retorno
message: mensagem do retorno
sku: código pai
variations: array com dados de referência e sku que foram gravados.

Códigos de retorno:
0 - sucesso
1 - É permitido apenas campo inteiro para o SKU pai. O campo é não obrigatório. Caso não preenchido o sistema assume o proximo disponível.
2 - Campo SKU pai já existe
3 - Título do produto (name) tem que possuir no mínimo 20 caracteres.
4 - Descrição do produto (description) tem que possuir no mínimo 100 caracteres.
5 - O produto precisa ter pelo menos uma variação (variations). Caso o produto seja único basta não enviar dos dados das especificações (specifications)
6 - Valor {json->variations[x]->sku} não permitido. Apenas campo inteiro na variação do SKU. O campo é não obrigatório. Caso não preenchido o sistema assume o proximo disponível.
7 - Valor {json->variations[x]->sku} para o campo SKU variação já existe.
8 - Valor {json->variations[x]->ref} para o campo Referência (ref) na variação já existe.
9 - Valor {json->variations[x]->ean} para o campo ean na variação já existe.
10 - Combinações de especificação: {valores} não permitido.
11 - Valor não preenchido na especificação {json->variations[x]->ean->specifications[y]->key}.
12 - Valor preenchido para especificação vazia {json->variations[x]->ean->specifications[y]->value}.
13 - URL {url} é inválida.
14 - URL {url} é extensão inválida. Aceito apenas JPG.
15 - URL {url} As dimensões da foto tem ser iguais, ou seja, um quadro
16 - URL {url} Imagem possui {tamanho}px e é grande para ser processada. Aceito somente abaixo de 1200px
17 - URL {url} Imagem muito pequena. Aceito somente acima de 500px
18 - Campo price tem que ser numérico. exemplo: 1200.00
19 - Campo promotional_price tem que ser numérico. exemplo: 1200.00
20 - Campo cost tem que ser numérico. exemplo: 1200.00
21 - Campo promotional_price não pode ser menor que o campo price.
22 - Diferença de custo (cost) maior que 50 porcento.
23 - Campo peso (weight) tem que ser numérico entre 0.001 kg à 9999 kg.
24 - Campo Largura (width) tem que ser numérico entre 0.001 cm à 9999 cm.
25 - Campo Altura (height) tem que ser numérico entre 0.001 cm à 9999 cm.
26 - Campo profundidade (height) tem que ser numérico entre 0.001 cm à 9999 cm.
27 - Campo Marca (brand) obrigatório.
28 - Campo status aceito enabled ou disabled
29 - Tempo de garantia (warrantyTime) campo inteiro de 0 a 120 meses.
30 - Erro inesperado. Informe o JSON para a Precode.

Dados de Entrada:

{
   "product": {
      "sku": null,
      "name": "",
      "description": "",
      "status": "enabled",
      "price": 0,
      "promotional_price": 0,
      "cost": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "length": 0,
      "brand": "",
      "nbm": "",
      "model": "",
      "gender": "",
      "volumes": 0,
      "warrantyTime": 0,
      "variations": [{
            "ref": "",
            "sku": null,
            "qty": "0",
            "ean": "",
            "images": [
               "https://www.seudominio.com.br/..."
            ],
            "specifications": [{
                  "key": "",
                  "value": ""
               }
            ]
         }

      ]
   }
}

Dados JSON de Retorno:

{
   "code": 0,
   "message": "sucesso",
   "sku": 0,
   "variations": [{
      "ref": "",
      "sku": 0
   }]
}


Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v3/products/query/{codigo}/{tipo}
Consulta produto

Notas:

Retorna dados detalhado do produto

Parâmetros de Entrada:

O parâmetro tipo pode ser:

- sku: código sku da variação
- ref: código referência do variação
- group: código sku pai, ou seja, do agrupador do produto

No campo código informar o codigo a ser consultado.

Parâmetros de Retorno:

Dados de Entrada:

v2/products/query/{codigo}/sku
v2/products/query/{codigo}/ref
v2/products/query/{codigo}/group

Dados JSON de Retorno:

{
   "product": {
      "sku": 0
      "name": "",
      "description": "",
      "status": "enabled",
      "price": 0,
      "promotional_price": 0,
      "cost": 0,
      "weight": 0,
      "width": 0,
      "height": 0,
      "lenght": 0,
      "brand": "",
      "nbm": "",
      "model": "",
      "gender": "",
      "volumes": 0,
      "warrantyTime": 0,
      "variations": [{
            "ref": "",
            "sku": 0,
            "qty": "0",
            "ean": "",
            "images": [
               ""
            ],
            "specifications": [{
                  "key": "",
                  "value": ""
               }
            ]
         }

      ]
   }
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v3/products/status/{codigo}/{tipo}
Altera Status

Notas:

Parâmetros de Entrada:

O parâmetro tipo pode ser:
- sku: código sku da variação
- ref: código referência do variação
- group: código sku pai, ou seja, do agrupador do produto

No campo código informar o código.

Enviar no JSON o status: enabled ou disabled

Parâmetros de Retorno:

code: codigo do retorno
message: mensagem do retorno
sku: código pai
variations: array com dados de referência e sku que foram gravados.
status: situação da variação

Códigos de retorno:
0 - sucesso
28 - Campo status aceito enabled ou disabled

Dados de Entrada:

Filtro:
v2/products/status/{codigo}/sku
v2/products/status/{codigo}/ref
v2/products/status/{codigo}/group

JSON
{
"status": "disabled"
}

Dados JSON de Retorno:

{
   "code": 0,
   "message": "",
   "sku": 0,
   "variations": [
      {
         "ref": "",
         "sku": 0,
         "status": ""
      }
   ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v3/products/inventory
Atualiza Preço e estoque

Notas:

Atualiza preço, custo, prazo adicional de entrega e estoque por centro de distribuição.

Parâmetros de Entrada:

products (obrigatório) : array com a lista de produtos a ser atualizado
ref (opcional) (string): código alfanumérico de referência do sku, que pode ser o sku da loja/integradora.
sku (opcional) (inteiro): código sku da variação
é obrigatório a utilização do ref ou sku
promotional_price (obrigatório) (numérico): é o preço DE exemplo: promotional_price 129.00 price 99.90. Pode-se enviar o mesmo valor do campo price.
price (obrigatório): é o preço de venda do produto
cost (obrigatório)(numérico): custo do produto.
status (obrigatório): enviar enabled ou disabled
shippingTime (obrigatório) (inteiro): prazo adicional de entrega (prazo de expedição).

stock (obrigatório): array com a lista de estoques por centro de distribuição.
stores (obrigatório) (inteiro) código do centro de distribuição, caso não possua mais de um centro de distribuição enviar código 1
availableStock (obrigatório) (inteiro) : estoque disponível para venda.
realStock (obrigatório) (inteiro) : estoque real disponível no centro de distribuição. Quando informado o estoque real o sistema ignora o prazo adicional de entrega.

Parâmetros de Retorno:

products : array com a lista de produtos processados.
ref (opcional) (string): código alfanumérico de referência do sku, que pode ser o sku da loja/integradora.
sku (opcional) (inteiro): código sku da variação
return: array do retorno
code: Código do retorno
message: mensagem de retorno.

0 - sucesso
1 - É permitido apenas campo inteiro para o SKU.
2 - Informar o SKU ou a referência (REF).
3 - SKU ou REF não encontrado
4 - Campo price tem que ser numérico. exemplo: 1200.00
5 - Campo promotional_price tem que ser numérico. exemplo: 1200.00
6 - Campo cost tem que ser numérico. exemplo: 1200.00
7 - Campo promotional_price não pode ser menor que o campo price.
8 - Diferença de custo (cost) maior que 50 porcento.
9 - Novo preço possui uma diferença maior que 50 porcento do preço atual.
10 - Novo priceSite possui uma diferença maior que 50 porcento do price.
11 - Campo shippingTime tem que ser inteiro
12 - Campo status aceito enabled ou disabled
99 - Erro inesperado.

Dados de Entrada:

{
   "products": [{
      "ref": "",
      "sku": null,
      "promotional_price": 0,
      "price": 0,
      "priceSite": 0,
      "cost": 0,
      "shippingTime": 0,
      "status": "",
      "stock": [{
         "stores": 0,
         "availableStock": 0,
         "realStock": 0
      }]
   }]
}

Dados JSON de Retorno:

{
   "products": [
      {
         "ref": "",
         "sku": 0,
         "return": [
            {
               "code": 0,
               "message": ""
            }
         ]
      }
   ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
Order ERP: Recurso para gerenciamento de pedidos
GET
v3/orders
Fila

Notas:

Retorna o próximo pedido da fila.

Toda alteração de status do pedido o mesmo sempre entrará na fila novamente.

Parâmetros de Entrada:

Parâmetros de Retorno:

Dados de Entrada:

Dados JSON de Retorno:

{
   "updated_at": "",
   "total_ordered": 0,
   "tags": [],
   "sync_status": "",
   "status": {
      "type": "",
      "idType": "",
      "label": "",
      "code": ""
   },
   "shipping_method": "",
   "id_shipping_company": "",
   "shipping_cost": 0,
   "shipping_carrier": "",
   "shipping_address": {
      "street": "",
      "secondary_phone": "",
      "region": "",
      "reference": "",
      "postcode": "",
      "phone": "",
      "number": "",
      "neighborhood": "",
      "full_name": "",
      "detail": "",
      "country": "",
      "complement": "",
      "city": ""
   },
   "shipped_date": "",
   "shipments": [],
   "placed_at": "",
   "payments": [
      {
         "value": 0,
         "transaction_date": "",
         "status": "",
         "sefaz": {
            "type_integration": "",
            "payment_indicator": "",
            "name_payment": "",
            "name_card_issuer": "",
            "id_payment": "",
            "id_card_issuer": ""
         },
         "parcels": "",
         "method": "",
         "description": "",
         "card_issuer": "",
         "autorization_id": ""
      }
   ],
   "items": [
      {
         "special_price": 0,
         "shipping_cost": 0,
         "qty": "",
         "product_id": "",
         "original_price": 0,
         "discount_price": 0,
         "name": "",
         "id": "",
         "detail": "",
         "sku_precode": ""
      }
   ],
   "invoices": [],
   "interest": "0",
   "import_info": {
      "ss_name": "",
      "remote_id": "",
      "remote_code": ""
   },
   "estimated_delivery_shift": "",
   "estimated_delivery": "",
   "discount": "",
   "delivery_contract_type": "",
   "delivered_date": "",
   "customer": {
      "vat_number": "",
      "phones": [
         "",
         ""
      ],
      "name": "",
      "gender": "",
      "email": "",
      "date_of_birth": ""
   },
   "code": "",
   "channel": "",
   "calculation_type": "",
   "billing_address": {
      "street": "",
      "secondary_phone": "",
      "region": "",
      "reference": "",
      "postcode": "",
      "phone": "",
      "number": "",
      "neighborhood": "",
      "full_name": "",
      "detail": "",
      "country": "",
      "complement": "",
      "city": ""
   },
   "approved_date": "",
   "origin": "",
   "cod_partner": ""
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
DELETE
v3/orders/{pedido}
Deletar o pedido da fila

Notas:

Remove o pedido da fila

Parâmetros de Entrada:

pedido (obrigatório) (inteiro) número do pedido Precode.

Parâmetros de Retorno:

Code: Código do retorno que pode ser: complete, order_error
Label: campo de mensagem
Type: tipo SUCCESS ou ERROR

Dados de Entrada:

orders/{pedido}

Dados JSON de Retorno:

{
   "Code": "",
   "Label": "",
   "Type": ""
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v3/orders/query/{numeroPedido}
Consulta Pedido

Notas:

Parâmetros de Entrada:

Parâmetros de Retorno:

Dados de Entrada:

Dados JSON de Retorno:

{
   "updated_at": "",
   "total_ordered": 0,
   "tags": [],
   "sync_status": "",
   "status": {
      "type": "",
      "idType": "",
      "label": "",
      "code": ""
   },
   "shipping_method": "",
   "id_shipping_company": "",
   "shipping_cost": 0,
   "shipping_carrier": "",
   "shipping_address": {
      "street": "",
      "secondary_phone": "",
      "region": "",
      "reference": "",
      "postcode": "",
      "phone": "",
      "number": "",
      "neighborhood": "",
      "full_name": "",
      "detail": "",
      "country": "",
      "complement": "",
      "city": ""
   },
   "shipped_date": "",
   "shipments": [],
   "placed_at": "",
   "payments": [
      {
         "value": 0,
         "transaction_date": "",
         "status": "",
         "sefaz": {
            "type_integration": "",
            "payment_indicator": "",
            "name_payment": "",
            "name_card_issuer": "",
            "id_payment": "",
            "id_card_issuer": ""
         },
         "parcels": "",
         "method": "",
         "description": "",
         "card_issuer": "",
         "autorization_id": ""
      }
   ],
   "items": [
      {
         "special_price": 0,
         "shipping_cost": 0,
         "qty": "",
         "product_id": "",
         "original_price": 0,
         "discount_price": 0,
         "name": "",
         "id": "",
         "detail": "",
         "sku_precode": ""
      }
   ],
   "invoices": [],
   "interest": "0",
   "import_info": {
      "ss_name": "",
      "remote_id": "",
      "remote_code": ""
   },
   "estimated_delivery_shift": "",
   "estimated_delivery": "",
   "discount": "",
   "delivery_contract_type": "",
   "delivered_date": "",
   "customer": {
      "vat_number": "",
      "phones": [
         "",
         ""
      ],
      "name": "",
      "gender": "",
      "email": "",
      "date_of_birth": ""
   },
   "code": "",
   "channel": "",
   "calculation_type": "",
   "billing_address": {
      "street": "",
      "secondary_phone": "",
      "region": "",
      "reference": "",
      "postcode": "",
      "phone": "",
      "number": "",
      "neighborhood": "",
      "full_name": "",
      "detail": "",
      "country": "",
      "complement": "",
      "city": ""
   },
   "approved_date": "",
   "origin": "",
   "cod_partner": ""
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
POST
v3/orders/{numeroPedido}/pedidoerp
Informe Pedido ERP

Notas:

Informa o número do pedido no ERP

Parâmetros de Entrada:

pedidoerp: (obrigatório) (inteiro) número do pedido que foi gerado no ERP.
fp: (opcional) (inteiro) número do centro de distribuição
flf: (opcional) (inteiro) número da filial de faturamento

Parâmetros de Retorno:

Code: Código do retorno que pode ser: complete, order_error
Label: campo de mensagem
Type: tipo SUCCESS ou ERROR

Dados de Entrada:

{
   "pedidoerp": 0,
   "fp": 0,
   "flf": 0
}

Dados JSON de Retorno:

{
   "Code": "",
   "Label": "",
   "Type": ""
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
POST
v3/orders/{numeroPedido}/invoice
Invoice Pedido

Notas:

Informa que o pedido foi faturado.

Parâmetros de Entrada:

key: (obrigatório) número da chave da nota fiscal
url: (opcional) url para emissão da segunda via da nota fiscal, este campo é importante para que os atendentes e o bot possa enviar a segunda via da nota para o cliente quando o mesmo necessitar.

Parâmetros de Retorno:

Code: Código do retorno que pode ser: complete, order_error
Label: campo de mensagem
Type: tipo SUCCESS ou ERROR

Dados de Entrada:

{
   "invoice": {
      "key": "",
      "url": ""
      }
}

Dados JSON de Retorno:

{
   "Code": "",
   "Label": "",
   "Type": ""
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
POST
v3/orders/{numeroPedido}/shipments
Shipments Pedido

Notas:

Informa que o pedido foi coletado pela transportadora.
Para lojas que estão integradas com a Intelipost não é necessário a utilização deste endpoint, a baixa do pedido como em viagem e entrega é feita através da integração com a Intelipost.

Parâmetros de Entrada:

protocoloCorreio: (opcional) informar caso o ERP possua o protocolo dos correios, ou seja, é o ERP que gera a etiqueta dos correios.

Parâmetros de Retorno:

Code: Código do retorno que pode ser: complete, order_error
Label: campo de mensagem
Type: tipo SUCCESS ou ERROR

Dados de Entrada:

{
   "protocoloCorreio": ""
}

Dados JSON de Retorno:

{
   "Code": "",
   "Label": "",
   "Type": ""
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada