Métodos de Envio Externos

Importante: Esta é uma funcionalidade avançada que permite ligar qualquer método de envio à sua loja. Normalmente, um programador externo (ou a própria plataforma de envio) pode fazer esta integração.

Uma loja Jumpseller pode ser integrada com qualquer Método de Envio Externo à sua escolha. Basicamente, uma plataforma de envio que tenha uma API capaz de fornecer dados formatados em JSON pode ser integrada na sua loja Jumpseller. Se estiver interessado em fazer uma integração de um Método de Envio Externo, pode também consultar a documentação da API do Jumpseller.

Como Configurar

1. Preencha o URL de Callback com o endpoint da sua API que recebe as informações da nossa encomenda e devolve as taxas de envio adaptadas aos dados da nossa encomenda.

Importante: Alguns campos podem estar disponíveis apenas após a conclusão do checkout, pois alguns clientes são convidados e não temos todos os dados disponíveis em algumas etapas do processo (por exemplo, estimativa no ecrã do carrinho).

Exemplo da estrutura de dados que enviamos para o seu callback:

    {
      request: {
        from: {
          country: 'Chile',
          region: '12',
          region_name: 'Metropolitana'',
          municipality: '8261414',
          municipality_name: 'Providencia',
          city: 'Santiago',
          postal: '3453',
          name: 'John Smith',
          address: 'Avenida Nueva Providencia',
          complement: 'Depto 9',
          street_number: '4000'
          email: 'store@company.com',
          phone: '98379292',
          company: 'ABC Inc.'
        },
        to: {
          country: 'Chile'',
          region: '12',
          region_name: 'Metropolitana'',
          municipality: '8261414',
          municipality_name: 'Providencia',
          city: 'Santiago',
          postal: '3453',
          name: 'Client name',
          address: 'Client street',
          complement: 'Client complement',
          street_number: 'Client street number',
          email: 'client@email.com',
          phone: '94823432',
          company: 'Client Company name'
        },
        "products": [
          {
            "name": "Product A",
            "sku": "PKUA",
            "quantity": 1,
            "price": 2323,
            "product_id": 64,
            "variant_id": null,
            "weight": 1,
            "shipping_required": true,
            "tax": 278.76,
            "brand": "PKU"
          },
          {
            "name": "Product 2",
            "sku": "PKUB",
            "quantity": 1,
            "price": 232,
            "product_id": 63,
            "variant_id": null,
            "weight": 1,
            "shipping_required": true,
            "tax": 27.84,
            "brand": "PKU"
          },
          {
            "name": "Product 3",
            "sku": "PKUC",
            "quantity": 1,
            "price": 767,
            "product_id": 62,
            "variant_id": null,
            "weight": 1,
            "shipping_required": true,
            "tax": 92.0,
            "brand": "PKU"
          }
        ],
        package: {
          weight: 10,
          height: 2,
          width: 3,
          length: 18
        },
        unit_measurement: 'cm',
        weight_unit: 'kg',
        currency: 'CLP',
        locale: 'es',
        store_code: 'store-code',
        cart_id: '123321',
        order_id: '123',
        request_reference: "234234"
      }
    }

Importante: O campo “reference_id” é opcional e pode ser usado como referência para o cliente que solicita as estimativas de taxas, este reference_id será enviado de volta como “request_reference” em pedidos subsequentes. Os campos “rate_id” e “rate_description” também são opcionais e podem ser usados para manter uma referência às taxas persistidas. O parâmetro “rate_id” tem um limite de 191 caracteres e o parâmetro “rate_description” tem um limite de 512 caracteres. Estes “rate_id” e “rate_description” serão mostrados na API de encomendas uma vez concluída a encomenda.

Exemplo dos dados que esperamos do seu callback:

{
   "reference_id": "234234",
   "rates": [
       {
           "rate_id": "2948585",
           "rate_description": "12345678_465744098-12345678_465744098",
           "service_name": "service 1",
           "service_code": "S1",
           "total_price": "1595"
       },
       {
           "rate_id": "2948586",
           "rate_description": "123456242_465744111-12345342_465744673",
           "service_name": "service 2",
           "service_code": "S2",
           "total_price": "2234"
       },
       {
           "rate_id": "2948587",
           "rate_description": "43545678_955744098-34745678_891744098",
           "service_name": "service 3",
           "service_code": "S3",
           "total_price": "1586"
       }
   ]
}

2. Preencha o URL de Obter Serviços com o endpoint da sua API que devolve a lista de serviços disponíveis (transportadoras).

Este é um exemplo dos dados que esperamos que o seu endpoint devolva:

{
   "services": [
       {
           "service_name": "service 1",
           "service_code": "S1"
       },
       {
           "service_name": "service 2",
           "service_code": "S2"
       },
       {
           "service_name": "service 3",
           "service_code": "S3"
       }
   ]
}

3. Clique no botão Obter Serviços

4. Adicione um token de autorização (opcional, adiciona “Authorization: Bearer " aos cabeçalhos)

5. Ative os serviços que deseja usar na sua loja e altere os nomes se necessário.

6. Preencha os campos de Endereço no final do formulário.

7. Por fim, clique em Guardar e está concluído.

Agora pode ir às Opções de Envio no seu Painel de Administração e definir como deseja que apareça na página de checkout. Pode ativar/desativar métodos de envio externos a qualquer momento e pode alterar os seus nomes como desejar.

Como Obter a Taxa Selecionada da Encomenda

Se as taxas enviadas pela sua aplicação tiverem os campos “rate_id” ou “rate_description” definidos, então pode enviar um pedido à nossa API de encomendas e o id da taxa selecionada e a descrição da taxa aparecerão como “external_shipping_rate_id” e “external_shipping_rate_description” respetivamente.

Como Publicar

Assim que houver pelo menos 5 lojas Jumpseller a usar as suas estimativas de método de envio, pode solicitar ser listado publicamente como um dos Métodos de Envio disponíveis para todos os comerciantes. Se aprovado, o seu método de envio será listado no Painel de Administração do Jumpseller e na página pública de métodos de envio do Jumpseller.

Para solicitar uma listagem pública para o seu Gateway, envie um email para team@jumpseller.com com os seguintes detalhes:

1. Nome do método de envio.

2. Documentação sobre: como contratar, como configurar, como usar, secção de FAQ (opcional).

3. Lista de comerciantes Jumpseller que usam o seu método de envio.

4. Screencasts do processo de checkout mostrando as estimativas do seu método de envio a funcionar.

5. Logótipo: 110x66px em PNG transparente.

6. Será publicado no Painel de Administração juntamente com outras soluções de envio, com o seu próprio logótipo.

7. Para mais anúncios em newsletters e redes sociais e outras atividades de marketing, entre em contacto com partners@jumpseller.com