Consulta Estoque de Produto

Este endpoint é responsável por retornar dados comerciais do produto, incluindo estoque, preço, preço à vista no boleto, disponibilidade e ativo.

Método: GET

URI do Endpoint: https://apigw-uat.satelital.com.br/orbia-marketplace-hub/v1/stock

Requisição e Tipos de Dados

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

Exemplo de Requisição:

https://apigw-uat.satelital.com.br/orbia-marketplace-hub/v1/stock?Sku=1234

Descrição das propriedades:

Nome da propriedade	Descrição	Tipo	Obrigatoriedade
Sku	Sku do produto	string	Required

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, 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:

• OK (200):

{
  "sku": "string",
  "sellPrice": 0,
  "bankSlipSellprice": 0,
  "available": true,
  "stockQuantity": 0,
  "forecastStockQuantity": 0,
  "active": true
}

Descrição das propriedades:

Nome da propriedade	Descrição	Tipo
sku	Sku do produto	string
sellPrice	Preço de venda do produto	decimal
bankSlipSellPrice	Preço de venda do produto com boleto	decimal
available	Disponibilidade do produto, indica se o produto está disponível para uso no marketplace	boolean
stockQuantity	Quantidade em estoque	int
forecastStockQuantity	Estoque futuro (não é usado)	int
active	Indica se o produto está ativo ou não no fornecedor	boolean

• Erro (400):

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

Como 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 GET e insira a URL do endpoint.

3. 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).

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.

Casos de Uso

1. Vamos recuperar as informações de estoque do SKU: SKU987480

2. Quando o SKU está sem valor na requisição

3. Quando o SKU não existe ou não pertence ao fornecedor

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 dados de stock 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 dos produtos cadastrados.

4. Clique na linha do produto cadastrado e vá até o bloco "Configurações de estoque".