API

Use the REST API to create orders and shipments, check tracking status, and manage warehouses from your application.

Environments

Getting Started with the Test Environment

1. Sign up at app.dev.shipink.io/signup
2. Add a test credit card — the test environment uses Craftgate test cards. You can use any of the successful test card numbers listed there.
3. Get your token — use your test account credentials with POST /token on https://api.dev.shipink.io

Sample successful test cards:

Main Flow

After obtaining a token, follow these steps:

1. Create an order — register customer info and cart items
2. Create a shipment — generate a shipping label for that order
3. Track the shipment — monitor delivery status

Supporting endpoints:

• Rates — calculate shipping costs before creating a shipment
• Warehouses — manage sender addresses
• Address Book — manage saved recipient addresses
• Carriers — list carriers, services, and linked accounts

Authentication

All endpoints except POST /token require authentication. Send your Shipink credentials to POST /token, then include the returned token in the Authorization header of subsequent requests:

Authorization: Bearer YOUR_ACCESS_TOKEN

See the Token page for how to create and refresh tokens.