Informations d'une vente

Cette API permet d'obtenir les informations au sujet d'une vente (par exemple, obtenir son Status Document, et des informations complémentaires).

Deux variantes de cette API permettent d'obtenir la même information : à partir des informations nominatives de la vente (organisation, publication, numéro de transaction, nature, numéro de client), ou à partir de son jeton qui a été obtenu dans l'élément loan_url de la réponse JSON. La variante avec jeton ne permet pas d'obtenir les informations d'une vente dont la publication se situe sur un entrepôt distant.

Appel

Adresse :

avec customer_id et nature : /api/organisations/[:organisation_id]/publications/[:publication_id]/sales/[:transaction_id]?format=[:nature]&customer_id=[:customer_id]
avec sale_token : /api/organisations/[:organisation_id]/publications/[:publication_id]/sales/[:transaction_id]?sale_token=[:sale_token]

Méthode : GET

Sécurité : HTTP/BASIC (Nom d'utilisateur et mot de passe)

Paramètres

Paramètre	Obligatoire	Description
:organisation_id	Obligatoire	Numéro d'organisation. Fourni lors de l'inscription.
:publication_id	Obligatoire	Identifiant (ISBN, EAN) de la publication.
:transaction_id	Obligatoire	Numéro unique de la transaction / du panier d'achat. Plusieurs ventes avec le même numéro de transaction sont possibles, tant qu'il s'agit du même panier d'achat. Caractères alphanumériques seulement («-» et «_» aussi acceptés).
:nature	Optionnel	Format de la publication. Valeurs possibles : epub, pdf, proof, mobi, audio. Requis seulement si sale_token n'est pas fourni.
:customer_id	Optionnel	Identifiant du client lors de l'achat. Requis seulement si sale_token n'est pas fourni.
:sale_token	Optionnel	Numéro identifiant la transaction qui a été reçu lors de la déclaration de la vente, avec output=json sous loan_url : ...api/loans/:sale_token/activate

Réponses

Code HTTP	Valeur	Description
200	OK	Structure JSON fournissant les informations de la vente.
400
401	access_denied	Accès refusé à la ressource.
404	not_found	L'organisation ou la publication sont introuvables.
503	service_unavailable	Le serveur n'est pas disponible.