API Commandes

Consultez les commandes, mettez a jour les statuts et gerez les expeditions.

Endpoints

GET

/orders

orders:read

Obtenez une liste paginee de commandes. Supporte le filtrage par statut et plage de dates.

GET

/orders/:id

orders:read

Obtenez une commande avec tous les articles et details d'expedition.

PUT

/orders/:id/status

orders:write

Mettez a jour le statut d'une commande (ex. marquer comme expediee).

POST

/orders/:id/shipment

orders:write

Ajoutez des informations de suivi d'expedition a une commande.

Reference des Champs

Champ	Type	Obligatoire	Description
id	string	Non	Identifiant unique de la commande (lecture seule)
orderNumber	string	Non	Numero de commande lisible (lecture seule)
customerId	string	Non	ID client (absent pour les commandes invité)
status	string	Non	PENDING, CONFIRMED, PROCESSING, SHIPPED, DELIVERED, CANCELLED, REFUNDED
paymentStatus	string	Non	pending, paid, refunded, failed
paymentMethod	string	Non	Méthode de paiement utilisée (ex. stripe, cod)
total	integer	Non	Total en centimes (lecture seule)
items	OrderLine[]	Non	Tableau d'articles (lecture seule)
shippingAddress	Address	Non	Objet adresse de livraison
fulfillmentType	string	Non	shipping, pickup, delivery ou digital
createdAt	datetime	Non	Horodatage ISO 8601 (lecture seule)
updatedAt	datetime	Non	Horodatage ISO 8601 (lecture seule)

Parametres de Requete (Liste)

Champ	Type	Obligatoire	Description
page	integer	Non	Numero de page (defaut : 1)
limit	integer	Non	Elements par page (defaut : 20, max : 100)

Exemple

Lister les commandes recentes

bash

curl "https://api.mercozy.com/api/v1/external/orders?page=1&limit=10" \
  -H "X-API-Key: mk_live_your_key_here"

Mettre a jour le statut de commande

bash

curl -X PUT "https://api.mercozy.com/api/v1/external/orders/ord_abc123/status" \
  -H "X-API-Key: mk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "shipped"
  }'

Creer un suivi d'expedition

bash

curl -X POST "https://api.mercozy.com/api/v1/external/orders/ord_abc123/shipment" \
  -H "X-API-Key: mk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "carrier": "fedex",
    "trackingNumber": "7489236401",
    "trackingUrl": "https://www.fedex.com/track?id=7489236401"
  }'