v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB
Commandes

Obtenir le détail d'un article contenu dans une commande

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>FormAdmin<br/>OrganizationAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> AccessTransactions<br/><br/>

get/items/{itemId}

Path parameters

itemIdinteger required

The item ID

Query parameters

withDetailsboolean

Set to true to return CustomFields and Options

Response

Success

namestring nullable
priceCategory'Fixed' | 'Pwyw' | 'Free'
minAmountinteger nullable

Minimum amount that was specified on the tier (in cents)

ticketUrlstring nullable

The Ticket Url

qrCodestring nullable

The item QrCode (for ticket scanning only)

membershipCardUrlstring nullable

The Membership Card Url

dayOfLevyinteger nullable

The day of levy for monthly donation only

tierDescriptionstring nullable

Tier description

tierIdinteger nullable
commentstring nullable
idinteger

ID of the Item

amountinteger

Total item Price in cents (after discount without extra options)

type'Donation' | 'Payment' | 'Registration' | 'Membership' | 'MonthlyDonation' | 'MonthlyPayment' | 'OfflineDonation' | 'Contribution' | 'Bonus' | 'Product'
initialAmountinteger nullable

The raw amount (without reduction)

state'Waiting' | 'Processed' | 'Registered' | 'Deleted' | 'Unknown' | 'Canceled' | 'Refused' | 'Abandoned'