Pour les développeurs

API SwiftColis

Integrez SwiftColis a votre boutique en ligne ou application. API REST pour creer des colis, suivre les livraisons et gerer vos expeditions.

Obtenir une clé API Swagger UI

Authentification

Utilisez votre clé API pour authentifier vos requêtes

Clé API

Incluez votre clé dans l'en-tête de chaque requête

Header HTTP

x-api-key: votre_cle_api_ici

Conseil

Générez vos clés API depuis votre tableau de bord marchands. Chaque clé peut être limitée à certaines actions pour plus de sécurité.

Environment

Développement

localhost:4000

Environment

Production

api.swiftcolis.com

Endpoints

Tous les endpoints sont prefixés par /external/v1

POST/external/v1/colisAPI Key

Créer un colis

Crée un nouveau colis pour le marchand authentifié. Retourne l'ID du colis et le code de suivi.

Paramètres

Nom	Type	Exemple
`recipientName`*	string	Ahmed Trabelsi
`recipientPhone`*	string	+21698123456
`recipientAddress`*	string	15 Rue de la Paix, Tunis
`governorate`*	string	Tunis
`delegation`*	string	Tunis Médina
`codAmount`*	number	150.5
`description`	string	Colis电子产品

Réponse (201)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "trackingCode": "SC-A7B3K9",
  "recipientName": "Ahmed Trabelsi",
  "recipientPhone": "+21698123456",
  "recipientAddress": "15 Rue de la Paix, Tunis",
  "governorate": "Tunis",
  "delegation": "Tunis Médina",
  "codAmount": 150.5,
  "productPrice": 120.0,
  "deliveryFee": 30.5,
  "status": "in_pickup",
  "createdAt": "2026-04-10T14:30:00.000Z"
}

GET/external/v1/colisAPI Key

Liste des colis

Retourne la liste paginée des colis du marchand. Filtrez par statut, date ou client.

Paramètres

Nom	Type	Exemple
`skip`	number	0
`take`	number	20
`status`	string	delivered
`dateFrom`	string	2026-04-01
`dateTo`	string	2026-04-30

Réponse (200)

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "trackingCode": "SC-A7B3K9",
      "recipientName": "Ahmed Trabelsi",
      "status": "delivered",
      "codAmount": 150.5,
      "createdAt": "2026-04-10T14:30:00.000Z",
      "deliveredAt": "2026-04-12T10:15:00.000Z"
    }
  ],
  "total": 1,
  "skip": 0,
  "take": 20
}

GET/external/v1/colis/by-tracking/:trackingCodeAPI Key

Détails par code de suivi

Récupère les détails complets d'un colis via son code de suivi unique.

Paramètres

Nom	Type	Exemple
`trackingCode`*	string	SC-A7B3K9

Réponse (200)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "trackingCode": "SC-A7B3K9",
  "recipientName": "Ahmed Trabelsi",
  "recipientPhone": "+21698123456",
  "recipientAddress": "15 Rue de la Paix, Tunis",
  "governorate": "Tunis",
  "delegation": "Tunis Médina",
  "codAmount": 150.5,
  "productPrice": 120.0,
  "deliveryFee": 30.5,
  "status": "in_storage",
  "isPrepaid": false,
  "description": "电子产品",
  "createdAt": "2026-04-10T14:30:00.000Z"
}

Statuts de livraison

Les statuts possibles pour un colis dans notre système

En ramassagein_pickup

En stockagein_storage

En livraisonin_transit

Livrédelivered

Retournéreturned

Perdulost

Démarrage rapide

Intégrez SwiftColis en quelques minutes

Créez un compte marchand

Inscrivez-vous sur SwiftColis et accédez à votre tableau de bord.

Générez une clé API

Dans vos paramètres, créez une ou plusieurs clés API avec les permissions souhaitées.

Intégrez à votre système

Utilisez nos endpoints pour créer des colis automatiquement lors de vos ventes en ligne.

Commencer maintenant

Exemples de code

Intégrez en quelques lignes avec votre langage préféré

curl -X POST https://api.swiftcolis.com/external/v1/colis \
  -H "x-api-key: votre_cle_api" \
  -H "Content-Type: application/json" \
  -d '{
    "recipientName": "Ahmed Trabelsi",
    "recipientPhone": "+21698123456",
    "recipientAddress": "15 Rue de la Paix, Tunis",
    "governorate": "Tunis",
    "delegation": "Tunis Médina",
    "codAmount": 150.5,
    "description": "电子产品"
  }'

Prêt à commencer ?

Rejoignez le réseau SwiftColis

Des questions ? Notre équipe est là pour vous accompagner dans votre intégration.

Créer un compte gratuitement Contacter le support

Nom

Type

Exemple

recipientName*

string

Ahmed Trabelsi

recipientPhone*

string

+21698123456

recipientAddress*

string

15 Rue de la Paix, Tunis

governorate*

string

Tunis

delegation*

string

Tunis Médina

codAmount*

number

150.5

description

string

Colis电子产品

{ "id": "550e8400-e29b-41d4-a716-446655440000", "trackingCode": "SC-A7B3K9", "recipientName": "Ahmed Trabelsi", "recipientPhone": "+21698123456", "recipientAddress": "15 Rue de la Paix, Tunis", "governorate": "Tunis", "delegation": "Tunis Médina", "codAmount": 150.5, "productPrice": 120.0, "deliveryFee": 30.5, "status": "in_pickup", "createdAt": "2026-04-10T14:30:00.000Z" }

Nom

Type

Exemple

skip

number

take

number

status

string

delivered

dateFrom

string

2026-04-01

dateTo

string

2026-04-30

{ "data": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "trackingCode": "SC-A7B3K9", "recipientName": "Ahmed Trabelsi", "status": "delivered", "codAmount": 150.5, "createdAt": "2026-04-10T14:30:00.000Z", "deliveredAt": "2026-04-12T10:15:00.000Z" } ], "total": 1, "skip": 0, "take": 20 }

Nom

Type

Exemple

trackingCode*

string

SC-A7B3K9

curl -X POST https://api.swiftcolis.com/external/v1/colis \ -H "x-api-key: votre_cle_api" \ -H "Content-Type: application/json" \ -d '{ "recipientName": "Ahmed Trabelsi", "recipientPhone": "+21698123456", "recipientAddress": "15 Rue de la Paix, Tunis", "governorate": "Tunis", "delegation": "Tunis Médina", "codAmount": 150.5, "description": "电子产品" }'