Frete - Versão 1.0

Especificação para exposição de recurso Restful para consultas de frete no lojista.

Notas da versão

Versão inicial da especificação.

Frete

Recurso que deverá agrupar todas as operações de frete no lojista.

Consultar Frete

A implementação dessa operação deverá permitir a consulta do frete de um ou mais produtos para um CEP específico, de acordo com os parâmetros passados na URL.

URI

/freight/ (@GET)

Exemplo de Chamada

GET http://<dominio_lojista>/<uri_opcional>/freight/?skuId=98302,1|92837,2|2992,1&zipCode=01228000

Dados de Entrada

Campo Tipo Descrição Exemplo Obrigatório
skuId Texto Combinação de SKU ID do produto do Lojista e quantidade separados por virgula. Várias combinações podem ser passadas separadas por “|”. 98302,1|92837,2|2992,1 Sim
zipCode Texto CEP de entrega (1) (2) 01228000 Sim

1. Lembrando que um CEP pode iniciar com o dígito zero (“0”) pois se trata da região de São Paulo. Para maior definição da estrutura do CEP consulte http://www.correios.com.br/para-voce/precisa-de-ajuda/o-que-e-cep-e-por-que-usa-lo/estrutura-do-cep

2. Em caso de CEPs novos que surgirem na Empresa de Correios e Telégrafos é responsabilidade do lojista retornar o valor do frete adequado.

Dados de Saída

Campo Tipo Descrição Exemplo Obrigatório
freights Tipo Complexo Lista de entidades freight (caso não haja frete, deve ser enviado a lista vazia)   Sim
freights[]. skuIdOrigin Texto SKU ID do produto do lojista 92837 Sim
freights[].quantity Numérico Inteiro Quantidade utilizada para o cálculo 1 Sim
freights[].freightAmount Numérico Monetário, 2 casas decimais Valor do frete (1) 5.00 Sim
freights[].deliveryTime Numérico Inteiro Prazo de entrega em dias úteis (tempo de CD + prazo da transportadora + tempo de preparação do produto). 3 Sim
freights[].freightType Texto Tipo de frete (NORMAL,EXPRESSA, AGENDADA) (2) NORMAL Sim
freights[]
.scheduledFreightDateOptions
Tipo Complexo Lista de entidades scheduledFreightDateOption   Não
freights[]
.scheduledFreightDateOptions[]
.startDate
Data e Hora Data de inicio da opção 2013-01-04T17:43:59.082-02:00 Sim
freights[]
.scheduledFreightDateOptions[]
.endDate
Data e Hora Data de termino da opção 2013-01-04T17:43:59.082-02:00 Sim
freights[]
.scheduledFreightDateOptions[]
.availablePeriods
Lista de Textos Lista de períodos disponíveis (MANHA,TARDE,NOITE) separados por vírgula ["MANHA”, "TARDE"] Sim
freightAdditionalInfo Texto Informações adicionais da consulta de frete, como o código da transportadora. Transportadora XPTO Sim
sellerMpToken Texto Token de identificação do lojista no parceiro. Para garantir origem da informação. Deve ser utilizado o mesmo Auth-Token das chamadas à API. 8sjoAJjs93d7S63Sa98US72 Sim

1. Se for retornando o valor 0.00, será interpretado que é um frete grátis.

2. Apenas um registro deve ser retornado por tipo de entrega (NORMAL, EXPRESSA, AGENDADA). O criterio se é o valor mais barato ou a entrega mais rápida é do lojista.

Retorno da Operação

Adicionar o seguinte cabeçalho na resposta da operação:

Content-Type: application/json

Exemplo de Resposta


		
{
    "freights" :[{
                "skuIdOrigin":"92837",
                "quantity":1,
                "freightAmount":5.00,
                "deliveryTime":3,
                "freightType":"NORMAL"
         },
         {
                 "skuIdOrigin":"98302",
                "quantity":1,
                "freightAmount":19.00,
                "deliveryTime":3,
                "freightType":"NORMAL"
}],
    "freightAdditionalInfo":"Transportadora XPTO",
    "sellerMpToken":"8sjoAJjs93d7S63Sa98US72"
}

 

Português, Brasil