Ir para o conteúdo

Obter Produtos

GET https://freterapido.com/api/skus/products?token=[token_integração]&page=[pagina_atual]&perPage=[quantidade_sku_por_pagina]

Método responsável por retornar os SKUs cadastrados na Frete Rápido de acordo com os parâmetros da URL.

Envio:

Parâmetros da URL:

Nome Descrição Formato/Exemplo Obrigatório
token Token de integração do embarcador String *
tag Tag de detalhamento do volume String Opcional
sku SKU consultado String Opcional
onlyInvalids Apenas produtos inválidos Booleano Opcional
description Descrição do SKU Booleano Opcional
category Código da categoria do produto na Frete Rápido Numérico (inteiro) Opcional
page Página atual Numérico (Mínimo: 1) *
perPage Quantidade de SKUs por página Numérico (Máximo: 100) *
* Obrigatório

Resposta:

  • Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200 com a lista de produtos/SKUs.
Nome Descrição Formato/Exemplo Obrigatório
total Quantidade de SKUs retornados Numérico (inteiro) Sempre
products Lista de produtos/SKUs encontrados Array Sempre
 id Identificador do SKU na Frete Rápido String Sempre
 shipperCnpj CNPJ da empresa onde o SKU esta cadastrado String Sempre
 sku SKU do produto String Sempre
 active Se o SKU está ativo Booleano Sempre
 category Código da categoria na Frete Rápido Numérico (inteiro) Sempre
 description Descrição do SKU Booleano Sempre
 origin Origem que o SKU foi inserido String Sempre
 updatedAt Data da última atualização do produto Data / Hora: YYYY-MM-DD hh:mm:ss Sempre
 volumes Lista de volumes existentes no SKU Array Sempre
  description Descrição do volume String Sempre
  tag Tag do volume String Sempre
  amount Quantidade do volume Numérico (inteiro) Sempre
  width Largura unitária do volume em metros Numérico (float) Sempre
  height Altura unitária do volume em metros Numérico (float) Sempre
  length Comprimento unitário do volume em metros Numérico (float) Sempre
  weight Peso unitário do volume em Kg Numérico (float) Sempre
  price Preço unitário do volume Numérico (float) Sempre
  consolidate Pode consolidar Booleano Sempre
  overlaid Pode sobrepor Booleano Sempre
  rotate Pode rotacionar Booleano Sempre
 categoryDescription Descrição da categoria do produto Booleano Sempre 
{
        "total": 1,
        "products": [
            {
                "_id": "",
                "shipperCnpj": "",
                "sku": "",
                "active": true,
                "category": 0,
                "description": "",
                "origin": "",
                "updatedAt": "",
                "volumes": [
                    {
                        "description": "",
                        "tag": "",
                        "amount": 0,
                        "width": 0.0,
                        "height": 0.0,
                        "length": 0.0,
                        "weight": 0.0,
                        "price": 0.0,
                        "consolidate": true,
                        "overlaid": true,
                        "rotate": true
                    }
                ],
                "categoryDescription": ""
            }
        ]
    }
Voltar ao topo