Méthode POST/partner/dispatch/shipments/{shipment_id}/close

Clore une commande B2B : elle a quitté l'entrepôt, ses unités restent rattachées. Droit dispatch:write.

Sur cette page

Vous déclarez que la commande a quitté l'entrepôt. Ses unités restent rattachées à la commande et au distributeur : c'est précisément ce que l'alerte lira plus tard. Plus aucune unité ne peut être ajoutée ni retirée. Le parcours complet est dans le guide Rattacher chaque unité à sa commande.

#Autorisation

Clef d'API dans l'en-tête Authorization, au format Bearer, avec le droit dispatch:write. Une clef sans ce droit reçoit un 403 dont le message nomme le droit manquant. L'offre de la marque de la clef doit comprendre l'accès API, et la marque de l'expédition doit être sur l'offre Conformité + Identité.

HTTP
Authorization: Bearer votre_clef

#Plafond d'appels

Le même que les autres routes partenaires : un compteur par clef et un compteur pour la somme des clefs de votre marque, 120 appels par fenêtre de 60 secondes par défaut. Chaque appel qui écrit prélève 1 unité du quota journalier de la clef, quel que soit le nombre d'unités qu'il porte.

#Requête d'exemple

curl
curl -i -X POST "https://api.sealtrust.io/v1/partner/dispatch/shipments/318/close" \
  -H "Authorization: Bearer st_live_0000000000000000000000000000000000000000000000"

#Réponse d'exemple

Code HTTP 200OK

Code HTTP 200, l'expédition avec status à closed et closed_at renseigné.

#Erreurs

CodeConditionQue faire
401Clef absente, mal formée ou inconnue.Envoyez Authorization: Bearer <votre clef> avec la clef entière.
403La clef n'a pas le droit dispatch:write. Message Missing required scopes: dispatch:write.Créez une clef qui porte ce droit.
403La marque est sur l'offre Conformité. detail.code vaut OFFER_EXCLUDES_IDENTITY et detail.feature vaut dispatch. Rien n'est enregistré.Passez à l'offre Conformité + Identité. Réessayer ne changera rien.
429Plafond de débit ou quota journalier atteint.Attendez le nombre de secondes de Retry-After, ou minuit en temps universel pour le quota.
404Aucune expédition de votre marque ne porte cet identifiant. Une expédition d'une autre marque répond exactement la même chose.Vérifiez l'id rendu à la création.
409L'expédition est déjà close ou annulée. detail.code vaut shipment_not_open.Rien à faire.

Votre réponse ouvre un courriel pré-rempli dans votre messagerie, à destination de contact@sealtrust.io. Vous le relisez avant de l'envoyer.

Proposer une correctionSignaler un problème