Developer Guide

Developer Guide
Welcome to the ShipRateAPI Developer Guide

ShipRateAPI provides a REST API and first-party plugins for the major ecommerce platforms. This guide covers everything you need to get live carrier rates flowing through your store — from your first API call to advanced tag-based routing rules.

All API requests are authenticated with an x-api-key header. Keys are scoped per store and are generated from the ShipRateAPI admin portal. The base API is versioned at /api/v1/ — when versions change, the old version remains available for a minimum of 12 months.

Getting Started

Quick Start

Make your first API call in minutes

Authentication

API keys, headers, and security

Core API

API Reference

Request payload, response format, and errors

Tags & Routing

Tag products to control carrier routing

Platform Integrations

Magento 2

Install and configure the Composer extension

Shopify

Set up the Carrier Service app

BigCommerce

Register as a Real-Time Shipping provider

Features

Rate Types

Weight, price, flat, dimensional, configurable, and more

Quote Strategy

Return rates sorted cheapest-first or fastest-first

Coverage Scanner

Find missing rates and configuration issues across zones

Scheduling

Activate rate tables on a scheduled datetime window

Need help?

API Reference

The full OpenAPI spec is available via Swagger / API Reference.

Contact Support

Reach us via the contact page for integration support.