Adicionar Produto à Fila de Processamento

Este endpoint é responsável por adicionar um novo produto à fila de processamento. Ele é usado quando um produto precisa ser registrado no sistema.

Método: POST

URI do Endpoint: https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/product

Requisição e Tipos de Dados

Tipo de Conteúdo da Requisição: application/json

Exemplo de Requisição:

{
  "ean": "string",
  "sku": "string",
  "name": "string",
  "description": "string",
  "brand": "string",
  "weight": 0,
  "length": 0,
  "width": 0,
  "height": 0,
  "price": 1,
  "available": true,
  "stockQuantity": 0,
  "forecastStockQuantity": 0,
  "active": true,
  "perfomanceAreaId": 1
}

Descrição das propriedades:

Nome da propriedade	Descrição	Tipo	Obrigatoriedade
ean	Código de barras do produto. Se não possuir essa informação, pode enviar o valor do sku nesse campo	string	Required
sku	Identificador único do produto	string	Required
name	Nome do produto	string	Required
description	Descrição do produto	string	Optional
brand	Marca do produto	string	Required
weight	Peso do produto	decimal	Required
length	Comprimento do produto	decimal	Required
width	Largura do produto	decimal	Required
height	Altura do produto	decimal	Required
price	Preço do produto	decimal	Required
avaliable	Status de disponibilidade do produto	boolean	Required
stockQuantity	Quantidade em estoque	int	Required
active	Status do produto no fornecedor, produto está ativo ou inativo	boolean	Required
perfomanceAreaId	Área de atuação do produto, se não passado, será considerado área de atuação DEFAULT com bandeira nacional	int	Optional

Respostas Possíveis

Códigos de Resposta e seus significados:

Status Code	Descrição	Observação	Corpo da resposta
200	Sucesso na operação.	Retorna em qualquer tipo de requisição com sucesso.	Sim
400	Bad Request: Erro de validação ou processamento da requisição.	Verifique o corpo da requisição.	Sim
401	Unauthorized: Autenticação necessária e não fornecida.	Verifique seu ClientId, ClientSecret e o Token enviado.	Não
403	Forbidden: A requisição foi autenticada, mas o usuário não tem permissões para a ação.	Verifique suas configurações de rede ou VPN.	Não
502	Bad Gateway: indica que ele, enquanto atuando como um servidor intermediário, recebeu uma resposta inválida do servidor para o qual a requisição foi encaminhada.	Verifique sua requisição	Não

Exemplos de Respostas:

• Erro (400):

{
  "statusCode": 0,
  "message": "string",
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Cómo Testar o Endpoint

Para testar este endpoint, você pode usar ferramentas como Postman ou cURL. Siga as instruções abaixo:

1. Abra o Postman.

2. Selecione o método POST e insira a URL do endpoint.

3. No corpo da requisição, insira o JSON do exemplo fornecido.

4. Envie a requisição e observe a resposta.

Importante

Para um teste bem-sucedido, certifique-se de que você tem as credenciais corretas (se necessário) e que o corpo da requisição está corretamente formatado conforme o exemplo.

Este documento serve como um guia básico para entender e testar o endpoint específico. Ajuste as seções conforme necessário para se adequar ao seu ambiente de negócios e práticas de desenvolvimento.

Atualização de Produto

Além de adicionar produtos, este endpoint também permite a atualização de produtos existentes. Ao enviar uma requisição para este endpoint com um sku que já existe no sistema, o serviço irá atualizar o preço e a quantidade em estoque do produto correspondente.

A atualização é restrita aos seguintes campos:

• price : Preço atualizado do produto (número).
• stockQuantity : Quantidade atualizada em estoque (número).
• perfomanceAreaId : Id da área de atuação do produto.
• avaliable :Status de disponibilidade do produto.
• active :Status do produto no fornecedor.

Etapas Pós-Inserção do Produto

Após a inserção ou atualização bem-sucedida de um produto via endpoint, há etapas adicionais de configuração necessárias antes que o produto possa ser disponibilizado para venda.

Controle de estoque

Durante a configuração da integração para o novo fornecedor, existe a configuração da flag “HasStockControl”. Essa flag tem a responsabilidade de definir se o hub controla ou não o estoque do produto em relação aos campos enviados.

Exemplo, caso a flag esteja com valor falso, não serão aplicadas as regras de zeramento de estoque.

Regra de zeramento:

Quando controlamos o estoque e qualquer uma das condições não for verdadeira, o estoque é zerado.

Nome da Propriedade	Valor	Descrição
avaliable	false	O produto não está disponível para venda.
active	false	O produto está inativo no fornecedor.
stockQuantity	<= 0	O produto está sem estoque ou esgotado.

Se qualquer uma dessas condições acontecerem, e o “HasStockControl” for verdadeiro, ao receber a requisição do produto será aplicado a regra de zeramento.

Casos de uso

1. Vamos adicionar um produto novo ao fornecedor.

2. Vamos atualizar um sku já cadastrado.

Como acessar no portal do parceiro

Observação

Todas as informações exibidas neste fluxo são apenas para consulta e não podem ser alteradas diretamente no portal.

Saiba como acessar aos registros dos produtos desde o Portal do Parceiro.

1. Faça login no "Portal Parceiro".
2. No menu, clique no botão "Produtos" e, em seguida, selecione "Ver produtos".
3. Na tela, você poderá visualizar uma lista detalhada dos produtos cadastrados.