Support

External Shipping Methods

Integrate An External Shipping Method With Your Store

Important: This is an advanced feature that allows you to connect any shipping method with your store. Typically, an external web developer (or the shipping platform themselves) can do this integration.

A Jumpseller store can be integrated with any External Shipping Method of your choice. Basically, a shipping platform that has an API which can output JSON formatted data can be integrated into your Jumpseller store. If you are looking to do an integration of an External Shipping Method, you may also consult the Jumpseller API documentation.


How to Configure

1. Fill in the Callback URL with your API endpoint that receives our order information and returns shipping rates tailored to our order’s data.

Important: Some fields may only be available after the checkout is done, as some clients are guests and we don't have all the data available in some steps of the process (e.g. estimation on the cart screen).

Example of the data structure that we send to your callback:

    {
      request: {
        from: {
          country: ‘Chile’’,
          region: ‘Metropolitana’,
          municipality: ‘Providencia’,
          postal: ‘3453’,
          name: 'Store name',
          address: 'store street',
          email: 'store@email.com',
          phone: '98379292',
          company: 'Company name'
        },
        to: {
          country: ‘Chile’’,
          region: ‘Metropolitana’,
          municipality: ‘Providencia’,
          postal: ‘3453’,
          name: 'Client name',
          address: 'client street',
          email: 'client@email.com',
          phone: '94823432',
          company: 'Client Company name'
        },
        package: {
          weight: 10,
          height: 2,
          width: 3,
          length: 18
        },
unit_measurement: ‘cm’,
weight_unit: ‘kg’,
        currency: ’CLP’,
        locale: ‘es’
      }
    }

Example of the data that we expect from your callback:

{
   "rates": [
       {
           "service_name": "service 1",
           "service_code": "S1",
           "total_price": "1595"
       },
       {
           "service_name": "service 2",
           "service_code": "S2",
           "total_price": "2234"
       },
       {
           "service_name": "service 3",
           "service_code": "S3",
           "total_price": "1586"
       }
   ]
}

2. Fill in Fetch Services URL with your API endpoint that returns the list of available services (carriers).

This is an example of the data we expect your endpoint to return:

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

3. Click on the button Fetch Services

4. Add an authorization token (optional, it adds “Authorization: Bearer ” to the headers)

5. Toggle the services you wish to use on your store and change the names if you need.

6. Fill the Address fields at the end of the form.

7. Lastly, click on Save and you are done.

external shipping methods

Now you can go to the Shipping Options in your Admin Panel, and set how you want it to appear on the checkout page. You can enable/disable external shipping methods anytime and you can change their names to as you please.