> For the complete documentation index, see [llms.txt](https://ouvretaferme.gitbook.io/ouvretaferme/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation.md).

# Commercialisation

- [Boutique collective](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/boutique-collective.md): Ce qui ne concerne qu'une boutique tenue pour plusieurs producteurs : ceux qui y vendent et les rayons sous lesquels leurs produits apparaissent.
- [Producteurs](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/boutique-collective/producteurs.md): Les producteurs qui vendent sur une boutique collective. Celui qui la tient les voit tous et choisit sous quel libellé chacun apparaît ; un producteur ne voit que la sienne et y choisit son mode de règlement (paymentMethod), que lui seul reçoit. Rejoindre une boutique se fait avec un code d'invitation, hors API.
- [Rayons](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/boutique-collective/rayons.md): Les rayons d'une boutique collective, qui regroupent les catalogues de plusieurs producteurs sous un même intitulé. Réservés à qui tient la boutique.
- [Boutiques](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/boutiques.md): Votre boutique en ligne : ce qu'elle propose, quand vos clients commandent et où ils retirent.
- [Boutiques](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/boutiques/boutiques.md): Vos boutiques en ligne, celles que vous tenez comme celles que vous avez rejointes. Le champ role dit de quel côté vous êtes : propriétaire, vous la paramétrez ; participant, vous y vendez sans la modifier. Une boutique collective (shared) réunit les produits de plusieurs producteurs sur un même étal. Les e-mails de suivi et les clients autorisés (emailNewSale, emailEndDate, limitCustomers, limitGroups) ne sont rendus qu'au propriétaire, comme, sur une boutique collective, le groupage des produits et les étiquettes (sharedGroup, sharedExport).
- [Catalogues](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/boutiques/catalogues.md): Le rattachement d'un de vos catalogues à une boutique collective : c'est par là que vos produits arrivent sur l'étal commun. Un rattachement automatique suit les ventes à venir, un rattachement manuel ne vaut que pour celles que vous désignez.
- [Points de retrait](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/boutiques/points-de-retrait.md): Où vos clients récupèrent leur commande : un lieu de retrait, une tournée de livraison ou une expédition. Ils appartiennent à votre structure et se réutilisent d'une boutique à l'autre, chaque vente choisissant ceux qu'elle propose.
- [Ventes](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/boutiques/ventes.md): Les périodes pendant lesquelles vos clients commandent, et la date à laquelle ils sont livrés. Une boutique ouverte en permanence n'en a qu'une ; une boutique à fréquence en a autant que d'ouvertures. Sur une boutique collective, elles appartiennent à qui la tient.
- [Caisse enregistreuse](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/caisse-enregistreuse.md): La vente directe journée par journée : le marché, les articles proposés à l'étal ce jour-là et les ventes qui y sont encaissées.
- [Appareils](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/caisse-enregistreuse/appareils.md): Le service d'un appareil de caisse sur un marché, pris avant sa première vente et rendu quand il n'a plus rien à envoyer. La clé, un uuid v4 tiré par l'appareil, vaut pour un seul service : un appareil qui reprend un service en tire une nouvelle. Un service rendu ne se reprend pas. Un marché accepte au plus 10 services en même temps et 30 en tout. Une réponse 409 dit que rien n'a été enregistré et que la demande se renvoie telle quelle, après une attente et jamais aussitôt.
- [Articles](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/caisse-enregistreuse/articles.md): Les articles d'une vente encaissée en caisse. Chacun reprend un article proposé par le marché, dont il garde le nom et le prix affiché à l'étal : seule la quantité se saisit.
- [Caisse](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/caisse-enregistreuse/caisse.md): Une journée de vente directe : marché, vente à la ferme, tournée. Le marché porte les articles proposés ce jour-là avec leur prix, et ses totaux sont l'agrégat des ventes encaissées, pas la somme de ses articles.
- [Ventes](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/caisse-enregistreuse/ventes.md): Les ventes encaissées sur un marché. Le plus souvent anonymes, elles reprennent les articles proposés par le marché et n'entrent dans ses totaux qu'une fois payées. Un appareil de caisse qui a encaissé sans réseau envoie sa vente avec sa clé et son numéro sur l'appareil. Renvoyée, la même vente rend celle déjà créée et répond 200 au lieu de 201. Un numéro déjà reçu, renvoyé avec un autre maillon, rend aussi la première vente et répond 200, sans créer la seconde, et le gérant en est averti. Quand l'un des deux envois n'a pas de maillon, c'est l'heure de vente envoyée par l'appareil qui les compare, telle qu'il l'a envoyée. Un appareil qui n'envoie ni maillon ni heure de vente ne permet pas de voir qu'un numéro a servi deux fois. Un appareil envoie sous un service pris sur le marché. Sur un marché clos, terminé, facturé ou annulé, ou après le rendu du service, l'envoi ne devient pas une vente et la réponse est 202. Le serveur n'en garde, hors des totaux, que l'en-tête de la vente, c'est-à-dire la clé, le numéro, le maillon et l'heure de vente, et l'appareil conserve ses articles et ses règlements jusqu'à ce que l'API les reçoive. Une réponse 409 dit que la vente n'a pas été enregistrée et qu'elle se renvoie telle quelle, après une attente et jamais aussitôt. Une ferme école n'encaisse pas, ce que dit un code 412 avec l'erreur market\_school.
- [Catalogues de vente](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/catalogues-de-vente.md): Les catalogues de vente de votre structure et les prix qu'ils donnent à vos produits.
- [Catalogues](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/catalogues-de-vente/catalogues.md): Les catalogues de vente (marché privé ou marché professionnel) de votre structure, regroupant des offres sur vos produits.
- [Offres](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/catalogues-de-vente/offres.md): Le rattachement d'un produit à un catalogue (prix, limites de vente, promotion). Les offres composées (plusieurs produits assemblés) ne sont pas exposées par cette API.
- [Clients](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/clients.md): À qui vous vendez : vos clients, les groupes qui les segmentent et les prix que vous leur réservez.
- [Clients](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/clients/clients.md): Vos clients particuliers, professionnels et points de vente. La catégorie détermine les champs attendus : coordonnées de facturation et numéro de TVA pour un professionnel, identité seule pour un point de vente.
- [Configuration des ventes](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/clients/configuration-des-ventes.md): Les réglages des ventes de votre structure : taux de TVA proposés par défaut, adresse de facturation électronique, et pour une structure de production les paramètres de vente au marché. Une seule fiche par structure, en lecture seule.
- [Groupes de clients](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/clients/groupes-de-clients.md): Les groupes utilisés pour segmenter vos clients (tarifs, restrictions de vente).
- [Prix personnalisés](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/clients/prix-personnalises.md): Les prix que vous appliquez à un client ou à un groupe de clients sur un produit, en remplacement du prix du catalogue. Le prix de base ne sert qu'à afficher un prix barré.
- [Paniers](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/paniers.md): Ce que contiennent vos paniers : les compositions qui se succèdent dans le temps, et les produits qui remplissent chacune.
- [Compositions](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/paniers/compositions.md): Ce que contient un panier à partir d'une date donnée. Les compositions d'un même panier se succèdent sans se chevaucher, et la date de fin de chacune découle de la suivante. Modifier une composition change le contenu des ventes déjà livrées sur la période qu'elle couvre, ce qui n'est plus possible passé trente jours.
- [Ingrédients](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/paniers/ingredients.md): Le contenu d'une composition : un produit de votre catalogue, sa quantité et le prix qu'il représente dans le panier. À ne pas confondre avec le détail figé dans une vente, qui en est une copie répartie au prorata du prix payé et se lit sous la ligne de vente.
- [Produits](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/produits.md): Ce que vous vendez : vos produits, et les unités et les catégories qui les décrivent.
- [Catégories](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/produits/categories.md): Les catégories utilisées pour regrouper vos produits sur votre page d'administration et vos boutiques en ligne.
- [Mouvements de stock](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/produits/mouvements-de-stock.md): L'historique du stock d'un produit : ce qui a été posé ou ajouté, et le solde qui en résulte. Le produit est un filtre obligatoire, la table n'ayant d'index que sur lui. Les mouvements s'écrivent par les gestes de la ressource produit, qui recalculent le solde dans le même passage ; le dernier d'entre eux accompagne le produit sous stockLast.
- [Produits](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/produits/produits.md): Les produits proposés à la vente par votre structure.
- [Unités](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/produits/unites.md): Les unités de mesure utilisées pour vendre vos produits (kg, botte, barquette...). Seules les unités propres à votre structure sont rendues, pas le catalogue d'unités proposé par défaut à la création d'une structure.
- [Règlements](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/reglements.md): Comment vos clients vous règlent : les modes de règlement que vous acceptez, et ce qui a été encaissé sur vos ventes et vos factures.
- [Encaissements](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/reglements/encaissements.md): Ce qui a été encaissé, toutes ventes et factures confondues : montant, mode de règlement, état et date de règlement. En lecture seule, un règlement appartenant à la transaction qu'il solde : il se pose par les actions de la vente ou de la facture.
- [Modes de règlement](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/reglements/modes-de-reglement.md): Les modes de règlement acceptés par votre structure (espèces, carte, virement...), référencés par vos ventes, vos cahiers de caisse et vos écritures comptables. Seuls ceux que vous avez ajoutés vous-même peuvent être supprimés.
- [Ventes](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/ventes.md): Vos ventes et le détail des articles qu'elles portent.
- [Articles](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/ventes/articles.md): Les articles d'une vente. Un article porte un produit de votre catalogue, ou une désignation libre dont vous fixez la nature et le prix. Il garde le prix retenu au moment de la vente.
- [Ventes](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/ventes/ventes.md): Vos ventes, avec leurs articles et leur historique. Ses montants se recalculent à chaque changement d'article, et ses changements d'état (confirmer, livrer, annuler…) passent par les actions de la vente.
- [Commandes de boutique collective](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/commandes-de-boutique-collective.md): Les commandes passées sur une boutique collective, tenue pour plusieurs producteurs, vues par la structure qui la tient. Une commande n'a pas d'articles à elle : son contenu est réparti en autant de ventes que de producteurs concernés, et ses totaux en sont la somme.
- [Factures](https://ouvretaferme.gitbook.io/ouvretaferme/endpoints/commercialisation/factures.md): Vos factures. Une facture de solde regroupe des ventes livrées d'un même client ; une facture d'acompte s'adosse à un règlement encaissé d'avance. Elle ne se modifie pas une fois émise : elle se confirme, s'envoie, se relance, et se régénère si besoin.