Link Search Menu Expand Document

Quick Start

In this part, we will learn how to:

  1. Get your API key
  2. Test your setup

Getting Your API Key


In order to use ShipBlu APIs, you need to generate an API key from your merchant account. Follow the below steps to generate your API key.

  1. Login to the merchant account

    Go to https://shipblu.com and click Sign In from the top-right corner. After that, click to loging and enter your merchant user credentials.

  2. Go to Account Settings

    After successfully logging in, click on the profile avatar and select Account Settings.

  3. Generate an API key

    Click (+) from the top right corner to generate an API key

    This will generate a new API key that you can use to interact with the API.

Test Your Setup

Let’s start by testing your setup using curl. Open the terminal and execute the following command to get your merchant account info:

$ curl -H 'Authorization: Api-Key <YOUR-API-KEY>' -X GET https://api.shipblu.com/api/v1/merchants/

Response

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": Number,
            "name": String,
            "store_url": String,
            "logo": String,
            "store_phone": String,
            "address": Object,
            "store_email": String,
            "status": String,
            "cash_processing_fees": Number,
            "cash_processing_fees_max": Number,
            "cash_processing_percentage": Number,
            "cash_processing_threshold": Number,
            "subscription": Object,
            "pickup_days": List,
            "billing_days": List,
            "pricing_lookup_delivery": Object,
            "pricing_lookup_return": Object,
            "pricing_lookup_exchange": Object,
            "pricing_lookup_cash_collection": Object,
            "pricing_lookup_rto": Object,
            "refunds_enabled": Boolean,
            "refunds_credit_limit": Number,
            "cash_balance": Number,
            "committed_volume": Number,
            "account_manager": Object,
            "sales": Object,
            "age": String,
            "force_scan_package_size_barcode": Boolean
        }
    ]
}

Congratulations! Your are all set for integrating your app with our API!

API Reference

Refer to our Tutorial or the API Reference for detailed API functionality.