Produtos

Listagem de produtos

GET {url_base}/products

Serão retornados até 100 produtos por vez na paginação da listagem.

Query Parameters

Name	Type	Description
page*	Integer	Número da página que será retornada os dados dos produtos Utilizar os dados retorno da requisição para validar a quantidade total
sku	Array	Lista de SKUs de produtos que serão filtrados Repetir o parâmetro: ?sku=X0001&sku=X0002&sku...

Headers

Name	Type	Description
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com essa documentação Enviar "v1" como default
X-Api-Key*	String	Chave de API criada através da plataforma

Response

200: OK Produtos listados com sucesso

{
    "status": "Products found",
    "data": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "sku": "AAAAABBBBBCCCCC",
            "name": "PRODUTO DE TESTE"
        },
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "sku": "AAAAABBBBBCCCCC",
            "name": "PRODUTO DE TESTE"
        },
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "sku": "AAAAABBBBBCCCCC",
            "name": "PRODUTO DE TESTE"
        }
    ],
    "page": "1",
    "per_page": 100,
    "total": 3
}

401: Unauthorized Acesso não autorizado

Consulta de um produto específico

GET {url_base}/products/{id}

Path Parameters

Name	Type	Description
id*	String	ID único da Estoca para o produto cadastrado no catálogo da plataforma

Headers

Name	Type	Description
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com essa documentação Enviar "v1" como default
X-Api-Key*	String	Chave de API criada através da plataforma

Response

200: OK Produto encontrado com sucesso

{
    "status": "Product found",
    "data": {
        "id": "00000000-0000-0000-0000-000000000000",
        "external_id": "",
        "name": "PRODUTO DE TESTE",
        "price": "100.00",
        "sku": "AAAAABBBBBCCCCC",
        "barcode": "1234567891010",
        "description": "DESCRIÇÃO DE TESTE",
        "attributes": {
            "estoca_ncm": "00000000",
            "estoca_unit": "CX",
            "estoca_fiscal_origin": "0",
            "estoca_height": "0",
            "estoca_weight": "0.00",
            "estoca_width": "0",
            "estoca_depth": "0"
        }
    }
}

401: Unauthorized Acesso não autorizado

404: Not Found Produto não encontrado

{
    "status": "Product not found",
    "data": {}
}

Consulta de um produto específico pelo SKU

GET {url_base}/products/{sku}/external

Path Parameters

Name	Type	Description
id*	String	ID único da Estoca para o produto cadastrado no catálogo da plataforma

Headers

Name	Type	Description
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com essa documentação Enviar "v1" como default
X-Api-Key*	String	Chave de API criada através da plataforma

Response

200: OK Produto encontrado com sucesso

{
    "status": "Product found",
    "data": {
        "id": "00000000-0000-0000-0000-000000000000",
        "external_id": "",
        "name": "PRODUTO DE TESTE",
        "price": "100.00",
        "sku": "AAAAABBBBBCCCCC",
        "barcode": "1234567891010",
        "description": "DESCRIÇÃO DE TESTE",
        "attributes": {
            "estoca_ncm": "00000000",
            "estoca_unit": "CX",
            "estoca_fiscal_origin": "0",
            "estoca_height": "0",
            "estoca_weight": "0.00",
            "estoca_width": "0",
            "estoca_depth": "0"
        }
    }
}

401: Unauthorized Acesso não autorizado

404: Not Found Produto não encontrado

{
    "status": "Product not found",
    "data": {}
}

Criação de novo produto

POST {url_base}/products

Além dos parâmetros abaixo que são propriedades dentro catálogo da Estoca, o seu sistema também pode enviar parâmetros customizados que serão registrados como atributos dos produtos na nossa plataforma.

Headers

Name	Type	Description
X-Api-Key*	String	Chave de API criada através da plataforma
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com essa documentação Enviar "v1" como default

Request Body

Name	Type	Description
products.sku*	String	SKU do produto Deve ser único dentro do catálogo da plataforma
products.name*	String	Nome do produto
products.barcode	String	Código de barras do produto Deve ser único dentro do catálogo da plataforma
products.price*	String	Preço unitário do produto Formato: 0.00
products.ncm	String	NCM do produto, de acordo com a tabela vigente do SEFAZ
products.fiscal_origin	String	Código de operação fiscal do produto, de acordo com a tabela vigente do SEFAZ
products.external_id	String	ID único externo de referência para o produto
products.width	String	Largura do produto Formato: 0.00
products.height	String	Altura do produto Formato: 0.00
products.length	String	Comprimento do produto Formato: 0.00
products.weight	String	Peso do produto Formato: 0.00
products.description	String	Descrição em texto do produto
products	Array	Lista de objetos dos produtos

200: OK Produto criado com sucesso

{
    "status": "Products Created: [UUID('00000000-0000-0000-0000-000000000000')], UUID('00000000-0000-0000-0000-000000000000')]",
     "data": {
        "products": {
            "total_created": 2,
            "created": [
                "00000000-0000-0000-0000-000000000000",
                "00000000-0000-0000-0000-000000000000"
            ],
            "total_updated": 0,
            "updated": []
        },
        "attributes": {
            "total_created": 5,
            "created": [
                "00000000-0000-0000-0000-000000000000",
                "00000000-0000-0000-0000-000000000000",
                "00000000-0000-0000-0000-000000000000",
                "00000000-0000-0000-0000-000000000000",
                "00000000-0000-0000-0000-000000000000",
                "00000000-0000-0000-0000-000000000000"
            ],
            "total_updated": 0,
            "updated": []
        }
    }
}

401: Unauthorized Acesso não autorizado

500: Internal Server Error Erro no processamento de criação do produto

{
    "status": "Error message"
}

429: Too Many Requests Limite de requisições atingido

Atualização de um produto específico

PUT {url_base}/products

Além dos parâmetros abaixo que são propriedades dentro catálogo da Estoca, o seu sistema também pode enviar parâmetros customizados que serão registrados como atributos dos produtos na nossa plataforma.

Headers

Name	Type	Description
X-Api-Key*	String	Chave de API criada através da plataforma
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com essa documentação Enviar "v1" como default

Request Body

Name	Type	Description
products.sku*	String	SKU do produto Deve ser único dentro do catálogo da plataforma
products.name*	String	Nome do produto
products.barcode	String	Código de barras do produto Deve ser único dentro do catálogo da plataforma
products.price*	String	Preço unitário do produto Formato: 0.00
products.ncm	String	NCM do produto, de acordo com a tabela vigente do SEFAZ
products.fiscal_origin	String	Código de operação fiscal do produto, de acordo com a tabela vigente do SEFAZ
products.external_id	String	ID único externo de referência para o produto
products.width	String	Largura do produto Formato: 0.00
products.height	String	Altura do produto Formato: 0.00
products.length	String	Comprimento do produto Formato: 0.00
products.weight	String	Peso do produto Formato: 0.00
products.description	String	Descrição em texto do produto
products	Array	Lista de objetos dos produtos

200: OK Produto atualizado com sucesso

{
    "status": "Product Updated: [UUID('00000000-0000-0000-0000-000000000000')]"
}

401: Unauthorized Acesso não autorizado

500: Internal Server Error Erro no processamento de atualização do produto

{
    "status": "Error message"
}