ShipX API – Developer Access – User Guide

The ShipX API – Developer Access feature allows merchants and developers to integrate ShipX shipping rate services directly into their custom storefront experience. This feature provides API access that enables you to retrieve and display shipping rates outside of the default Shopify checkout process.

By using the ShipX API, you can track the shipping rate requests sent from ShipX to Shopify and display the calculated shipping rates on alternative storefront pages, such as the cart page or any other preferred location within your store.

Accessing the API Documentation

To access the ShipX API documentation, please follow these steps:

1. Log in to your Shopify Admin panel.

2. Open the ShipX app.

3. Navigate to Settings.

4. Select ShipX API – Developer Access.

This section contains the complete API documentation, including endpoint details, authentication requirements, request and response formats, and technical guidelines required for integration.

ShipX Rate API

The API is used to get shipping rates from Shipping Rates - ShipX. This API can integrate the third-party app with the Shipping Rates - ShipX app. API requires the JWT token. Please contact our support team to get the token.

URL

🔗

https://shipping-app.logbase.io/api/shipping/rates

Header

authorization: <<JWT Token>>
shopifydomain: <<ShopifyDomain Name>>

Request Payload

{
  "rate": {
    "destination": {
      "country": "",
      "postal_code": "",
      "province": "",
      "city": "",
      "name": "",
      "address1":"",
      "address2": "",
       "phone": ""
    },
   "origin": {
      "country": "",
      "postal_code": "",
      "province": "",
      "city": "",
      "name": "",
      "address1":"",
      "address2": "",
       "phone": ""
    },
    "items": [{
      "name": "",
      "sku": "",
      "quantity": ,
      "grams":, //Gram of single quantity
      "tags":  "", //Multiple values with comma separated
      "dimensions": { //Value in cm
	"length": ,
      	"width": ,
      	"height": 
      },
      "price":, //Unit price. If $10, value must be 1000 including 2 decimal points (10*100)
      "vendor": "",
      "properties": {},
      "product_id":,
      "variant_id": 
    }],
    "currency": "",
    "locale": ""
  }
}

Response

Success - 200
{
    "rates": [
        {
            "service_name": "",
            "total_price": , //rate is including 2 decimal points. Divide by 100 at display
            "description": "",
            "currency": "",
            "service_code": ""
        }
    ]
}


Unauthorized - 401
Bad Request - 400

Request Payload - Sample

{
    "rate": {
        "destination": {
            "country": "US",
            "postal_code": "90013",
            "province": "CA",
            "city": "Los Angeles",
            "name": "XXXX XXX",
            "address1": "433 S Spring St",
            "address2": "Suite 750",
            "phone": "XXXXXX"
        },
       "origin": {
            "country": "US",
            "postal_code": "10008",
            "province": "NY",
            "city": "New Yorj",
            "name": "XXXX XXX",
            "address1": "433 S Spring St",
            "address2": "Suite 750",
            "phone": "XXXXXX"
        },
        "items": [
            {
                "name": "XXXXXXXX",
                "sku": null,
                "quantity": 4,
                "grams": 12247,
                "price": 8999,
                "vendor": "XXXXX",
                "properties": {},
                "product_id": XXXXXX,
                "variant_id": XXXXXX
            },
            {
                "name": "XXXXXX",
                "sku": "",
                "quantity": 2,
                "grams": 1000,
                "price": 800,
                "vendor": "XXXX",
                "properties": {},
                "product_id": XXXXXX,
                "variant_id": XXXXXX
            }
        ],
        "currency": "USD",
        "locale": "en-US"
    }
}

Response - Sample

{
    "rates": [
        {
            "service_name": "Shipping Rate",
            "total_price": 1000,
            "description": "",
            "currency": "USD",
            "service_code": "Shipping Rate_1"
        }
    ]
}

Integration and JWT Token Process

After reviewing the documentation and completing the necessary backend development for your store, authentication credentials are required to begin testing.

Step 1: Request a Temporary JWT Token

Once your integration is ready for testing, please contact the ShipX support team. A temporary JWT token will be issued to allow you to authenticate API requests during the testing phase.

Step 2: Test the Integration

Use the temporary JWT token to verify that:

Shipping rate requests are processed successfully

Rates are returned correctly from ShipX

Rates are displayed properly on your chosen storefront page

Step 3: Submit a Demonstration

After successful testing, share a screen recording demonstrating the complete workflow, including rate retrieval and display on your storefront.

Step 4: Receive a Permanent JWT Token

Our team will review your submission. Once the integration is confirmed to be functioning correctly, a permanent JWT token will be issued for use in your production environment.

If you need further information or assistance, please contact our customer support.