Getting Started with Carrier Integration API

This page will help you get started with Carrier Integration API. You'll be up and running in a jiffy!

The carrier integration API allows carriers that are not natively supported to provide rating, shipping and tracking services to Fulfil merchants.

How it works

1. You provide a callback URL to the merchant with a username, password and an account_id
2. The merchant creates a new shipping carrier in Fulfil with the above info.
3. The endpoint rooted in the callback URL will be called with the following

Endpoints called back by Fulfil

GET /services to discover available services
POST /rates to fetch rates for an order or shipment
POST /label to provide a label
GET /track to provide tracking updates
POST /cancel to void label

Authentication

All requests will be authenticated with the provided username and password, provided as basic authentication in the requests.

Timeouts

To ensure Fulfil users have a consistent user experience, the Carrier API enforces timeouts to prevent indefinite blocking or hanging of the system waiting for responses back from the carrier.

All requests have a timeout limit of 10 seconds before the request is considered as failed.