Aller au contenu
Boud’bOis, doc vendeurs
Outils

Commandes

Les commandes et retraits de l’entreprise.

Tous ces outils s’appellent en POST avec une clé bbv_. Ce sont aussi les outils du serveur MCP.

vendor_orders_list

Périmètre : lecture, clé read ou write.

Commandes contenant au moins une pièce de l’entreprise, sur une plage de dates (90 derniers jours par défaut), filtre par statut. Totaux HT et TTC de la part de l’entreprise. Paginé : limit, offset.

ParamètreTypeRequisDescription
fromstringnonDébut (date de commande), par défaut il y a 90 jours.
tostringnonFin incluse, par défaut aujourd’hui.
status"confirmed" | "ready" | "completed" | "cancelled"non
limitintegernonDéfaut : 100. Minimum 1. Maximum 500.
offsetintegernonDéfaut : 0. Minimum 0. Maximum 9007199254740991.
curl -X POST https://vendeurs.boudbois.fr/api/agent/tools/vendor_orders_list \
  -H "Authorization: Bearer $CLE" \
  -H "Content-Type: application/json" \
  -d '{}'

vendor_orders_get

Périmètre : lecture, clé read ou write.

Détail d’une commande par son numéro : client, retraits (id, date, statut, lieu), lignes, paiements, documents.

ParamètreTypeRequisDescription
numberintegerouiMinimum 1. Maximum 9007199254740991.
curl -X POST https://vendeurs.boudbois.fr/api/agent/tools/vendor_orders_get \
  -H "Authorization: Bearer $CLE" \
  -H "Content-Type: application/json" \
  -d '{
  "number": 1
}'

vendor_pickups_day

Périmètre : lecture, clé read ou write.

Retraits d’une journée (heure de Paris, aujourd’hui par défaut) : client, contact, lieu, pièces à charger, moyens de paiement.

ParamètreTypeRequisDescription
datestringnonJour (heure de Paris), par défaut aujourd’hui.
curl -X POST https://vendeurs.boudbois.fr/api/agent/tools/vendor_pickups_day \
  -H "Authorization: Bearer $CLE" \
  -H "Content-Type: application/json" \
  -d '{}'

vendor_pickups_close

Périmètre : écriture, clé write seulement.

Clôture un retrait (le client est passé) : decisions dit, pour chaque ligne non chargée, si on la retire de la commande ou si on la garde. Même effet que « Clôturer » sur la fiche commande.

ParamètreTypeRequisDescription
orderNumberintegerouiMinimum 1. Maximum 9007199254740991.
pickupIdstring (uuid)oui
decisionsobjectnonPour chaque ligne non chargée (id de ligne) : la retirer ou la garder. Défaut : {}.
curl -X POST https://vendeurs.boudbois.fr/api/agent/tools/vendor_pickups_close \
  -H "Authorization: Bearer $CLE" \
  -H "Content-Type: application/json" \
  -d '{
  "orderNumber": 1,
  "pickupId": "00000000-0000-0000-0000-000000000000"
}'

vendor_quotes_list

Périmètre : lecture, clé read ou write.

Devis de l’entreprise, filtre par statut (draft, sent, accepted, refused, expired, cancelled, converted).

ParamètreTypeRequisDescription
status"draft" | "sent" | "accepted" | "refused" | "expired" | "cancelled" | "converted"non
curl -X POST https://vendeurs.boudbois.fr/api/agent/tools/vendor_quotes_list \
  -H "Authorization: Bearer $CLE" \
  -H "Content-Type: application/json" \
  -d '{}'

vendor_quotes_get

Périmètre : lecture, clé read ou write.

Un devis par son numéro : client, lignes, totaux, statut, validité.

ParamètreTypeRequisDescription
numberstringouiAu moins 1 caractères. Au plus 40 caractères.
curl -X POST https://vendeurs.boudbois.fr/api/agent/tools/vendor_quotes_get \
  -H "Authorization: Bearer $CLE" \
  -H "Content-Type: application/json" \
  -d '{
  "number": "…"
}'