Consulta de Dados de Produto

Este endpoint é responsável por retornar dados gerais e comerciais do produto.

Método: GET

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:

https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/product?Sku=99999999988

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

• OK (200):

{
    "product": {
        "generalInformation": {
            "ean": "7892058116443",
            "marketplaceName": "CONNECT BL 20L 1.0 BLD Bayer S.a. - São Paulo/ Sp, 1x0L ",
            "brand": "Bayer S.a. - São Paulo/ Sp",
            "description": "Possui melhor residual contra o percevejo-marrom, o percevejo-da-soja e o percevejo-pequeno. Além de ser eficaz no momento da aplicação, Connect permanece protegendo a lavoura por mais dias do que os outros Inseticidass. Entre uma aplicação e outra, mais proteção para a sua lavoura e mais economia para você."
        },
        "categorization": {
            "category": "Defensivos",
            "subcategory": "Inseticidas"
        },
        "packingData": {
            "packQuantity": 1,
            "size": 0.000,
            "unitMeasurement": "L",
            "height": 0.00,
            "length": 0.00,
            "width": 0.00,
            "weight": 0.00
        },
        "images": [
            {
                "url": "https://satelital-resources-uat.s3.amazonaws.com/products\\fbf5f708-53f6-4538-98a7-10232ef627d9.png",
                "sequence": 1
            }
        ],
        "documents": [
            {
                "type": "9",
                "description": "Bula",
                "url": "https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/file?FileType=9&EntityId=2328"
            },
            {
                "type": "9",
                "description": "FE",
                "url": "https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/file?FileType=9&EntityId=2566"
            },
            {
                "type": "9",
                "description": "Fispq",
                "url": "https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/file?FileType=9&EntityId=2648"
            },
            {
                "type": "9",
                "description": "Rótulo",
                "url": "https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/file?FileType=9&EntityId=2791"
            }
        ],
        "supplierData": {
            "sku": "3995",
            "performanceAreas": [
                {
                    "description": "DEFAULT"
                }
            ],
            "stock": 10,
            "futureStock": 0,
            "available": true,
            "active": true,
            "originalPrice": 986.00,
            "bankSlipPrice": 986.00,
            "unitPrice": 1011.46,
            "status": "Aprovado",
            "marketplaceProductEnabled": true
        }
    }
}

Descrição das propriedades:

Nome da propriedade	Descrição	Tipo
product	Objeto de resposta	object
generalInformation	Objeto de resposta informações gerais	object
generalInformation.ean	Ean do produto	string
generalInformation.marketplaceName	Nome do produto formatado para o marketplace	string
generalInformation.brand	Marca do produto formatado no marketplace	string
generalInformation.description	Descrição do produto	string
categorization	Objeto de resposta categoria do produto	object
categorization.category	Nome da categoria	string
categorization.subcategory	Nome da subcategoria	string
packingData	Objeto de resposta dados da embalagem	object
packingData.packQuantity	Quantidade de produto por embalagem	int
packingData.size	Tamanho da embalagem	decimal
packingData.unitMeasurement	Unidade de mensuração	string
packingData.height	Altura da embalagem	decimal
packingData.length	Comprimento da embalagem	decimal
packingData.width	Largura da embalagem	decimal
packingData.weight	Peso da embalagem	decimal
images	Lista de imagens do produto	array
images.url	Url da imagem do produto	string
images.sequence	Sequência da imagem do produto	int
documents	Lista de documentos do produto	array
documents.type	Tipo do documento do produto	string
documents.description	Descrição do tipo de documento	string
documents.url	Url para acesso ao documento via endpoint get file	string
supplierData	Objeto de resposta relação fornecedor produto	object
supplierData.sku	Sku do produto	string
supplierData.stock	Estoque do sku/produto no marketplace	int
supplierData.available	Disponibilidade do produto no fornecedor, indica se o produto está disponível ou não	boolean
supplierData.active	Indica se o produto está ativo ou inativo no fornecedor	boolean
supplierData.originalPrice	Preço original do produto	decimal
supplierData.bankSlipPrice	Preço do produto com pagamento via boleto	decimal
supplierData.unitPrice	Preço do produto unitário, geralmente tem valor acrescentado de taxas administrativas	decimal
supplierData.status	Representa o status do produto no marketplace	boolean
supplierData.marketplaceProductEnabled	Indica se o produto está à venda no marketplace. Para esse status ser verdadeiro, o produto/sku deve cumprir todos os requisitos de cadastro	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:3995

2. Vamos usar o endpoint sem informar o sku

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, adicione o numero do SKU no campo de busca e clique em "Pesquisar".

4. Clique na linha do produto cadastrado e veja mais detalhes sobre o produto.