Opções de frete para o Checkout.
Saiba mais sobre essa funcionalidade na documentação.
| TIPO DE FRETE | VALOR DO PARÂMETRO Shipping.Type | DESCRIÇÃO |
|---|---|---|
| Frete fixo | "FixedAmount" | Valor fixo enviado pelo lojista. Utilizado caso o Lojista possua um método de entrega próprio. |
| Frete grátis | "Free" | Não realiza cálculo de frete e exibe na tela transacional “Frete Grátis”. |
| Retirada na loja | "WithoutShippingPickUp" | Considerado Retirada na loja. |
| Não tem frete | "WithoutShipping" | Sem cobrança de frete (aplicável para serviços e produtos digitais). |
As opções para múltiplos fretes na categoria Correios devem ser selecionadas dentro das Configurações da Loja no site Cielo.
Confira os nós que formam as informações de frete:
Shipping
ShippingShipping é o nó base. É obrigatório na integração via API. Ele define os tipos de frete a serem utilizados
| PARÂMETRO | DESCRIÇÃO | TIPO | TAMANHO | OBRIGATÓRIO? |
|---|---|---|---|---|
Shipping.Type | Tipo do frete: FixedAmount Free WithoutShippingPickUp WithoutShipping | alfanumérico | 255 | Sim |
Shipping.SourceZipCode | CEP de origem do carrinho de compras. Obrigatório caso Shipping.Type seja “Correios”. | número | 8 | Condicional |
Shipping.TargetZipCode | CEP do endereço de entrega do comprador. | número | 8 | Não |
Shipping.Address
Shipping.AddressShipping.Address contém as informações do endereço de entrega. Não é obrigatório no contrato da API, mas sugerimos que esses dados sejam enviados se já foram recolhidos dentro do ambiente da loja. Se não foram recolhidos, a página de pagamento exibirá os campos de endereço para preenchimento pelo comprador.
| PARÂMETRO | DESCRIÇÃO | TIPO | TAMANHO | OBRIGATÓRIO? |
|---|---|---|---|---|
Shipping.Address.Street | Rua, avenida, travessa, etc, do endereço de entrega do comprador. | alfanumérico | 256 | Não* |
Shipping.Address.Number | Número do endereço de entrega do comprador. | alfanumérico | 8 | Não* |
Shipping.Address.Complement | Complemento do endereço de entrega do comprador. | alfanumérico | 14 | Não |
Shipping.Address.District | Bairro do endereço de entrega do comprador. | alfanumérico | 64 | Não* |
Shipping.Address.City | Cidade do endereço de entrega do comprador. | alfanumérico | 64 | Não* |
Shipping.Address.State | Estado (UF) do endereço de entrega do comprador. | alfanumérico | 2 | Não* |
*Não é obrigatório, mas recomendamos enviar.
Shipping.Services
Shipping.ServicesShipping.Services é usado para frete fixo, como serviços de frete contratados pela loja.
| PARÂMETRO | DESCRIÇÃO | TIPO | TAMANHO | OBRIGATÓRIO? |
|---|---|---|---|---|
Shipping.Services.Name | Nome do serviço de frete. | alfanumérico | 128 | Sim |
Shipping.Services.Price | Preço do serviço de frete em centavos. Ex: R$ 1,00 = 100. | número | 18 | Sim |
Shipping.Services.Deadline | Prazo de entrega (em dias). | número | 9 | Não |
Cálculo do frete dos Correios
Serviço de frete Correios indisponível no momento.
Caso uma requisição com essa opção de frete seja enviada, você receberá um retorno com erro 400 e a mensagem: "O serviço de frete por correios está indisponível." Caso utilize o serviço em seus links de pagamento ou páginas de checkout, altere o tipo de frete para as outras opções disponíveis.
O cálculo do frete é feito pela API dos Correios e pode ser de dois tipos:
- Frete com volume: exige que a loja informe as dimensões do pacote que será enviado com as mercadorias;
- Frete sem volume: considera apenas o peso do carrinho como base de cálculo para a entrega.
Para usar o frete com volume, envie o nó Shipping.Measures, seguindo as regras de integração via API REST.
Shipping.Measures: indica as medidas do pacote.
| PARÂMETRO | DESCRIÇÃO | TIPO | TAMANHO | OBRIGATÓRIO? |
|---|---|---|---|---|
Shipping.Package | Tipo de pacote: "Box": caixa "Rol": cilindro ou envelope. | alfanumérico | Inteiro | Sim |
Shipping.Length | Comprimento do pacote | número | Inteiro | Sim |
Shipping.Height | Altura do pacote enviado. Obrigatório caso Shipping.Package como "Box". | número | Inteiro | Condicional |
Shipping.Width | Largura do pacote. Obrigatório caso Shipping.Package seja "Box" ou "Rol". | número | Inteiro | Condicional |
Shipping.Diameter | Diâmetro do pacote. Obrigatório caso Shipping.Package como "Rol". | número | Inteiro | Condicional |
Importante
Para realizar o cálculo de frete via Correios é necessário respeitar as medidas definidas pelo contrato utilizado pelo lojista. Para mais informações sobre as dimensões e pesos permitidos, sugerimos que valide o contrato da loja em Termo de Condições de Prestação de Serviços de Encomendas Nacionais dos Correios.