shipink-logo-vector-svgDocumentation

API

Integrate Shipink into your own system using the REST API.

Shipink provides a REST API that lets you manage orders, shipments, carriers, and warehouses programmatically — without using the Shipink panel.

Get started immediately with our Postman Collection — all endpoints with example requests, ready to run.

Download Postman Collection

Import the .json file into Postman to explore and test the full API.

Environments

APISign Up
Productionhttps://api.shipink.ioapp.shipink.io/signup
Testhttps://api.dev.shipink.ioapp.dev.shipink.io/signup

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:

Card numberBankScheme
4029400000000001T. Vakıflar BankasıVisa
5200170000000008T. Vakıflar BankasıMastercard
6501700000000006T. Vakıflar BankasıTroy
5102210000000001Türk Ekonomi BankasıMastercard
5230340000000001Yapı Kredi BankasıMastercard

Real credit cards cannot be used in the test environment. You must use the Craftgate test cards listed above.

Main Flow

The typical integration follows these three 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 require a Bearer token in the Authorization header. Obtain a token by posting your Shipink credentials to POST /token.

Authorization: Bearer YOUR_ACCESS_TOKEN

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

How is this guide?

On this page