v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB
Commandes

Obtenir une liste d'articles vendus par une organisation

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><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/organizations/{organizationSlug}/items

Path parameters

organizationSlugstring required

The organization slug

Query parameters

fromstring date-time

First Date Filter

tostring date-time

End Date Filter (exclusive)

userSearchKeystring

Filter results on user or payer first name, last name or email

pageIndexinteger

The page of results to retrieve

pageSizeinteger

The number of items per page

continuationTokenstring

Continuation Token from which we wish to retrieve results

tierTypesHelloAssoApiV5CommonModelsEnumsTierType[]

The type of tiers Donation, Payment, Registration, Membership, MonthlyDonation, MonthlyPayment, OfflineDonation, Contribution, Bonus

itemStatesHelloAssoApiV5CommonModelsEnumsItemState[]

The item states

Available values:

  • Processed - The item is paid and is valid
  • Registered - The item has been registered manually by the organization and is valid
  • Unknown
  • Canceled - The item has been canceled, and is no longer valid
tierNamestring

The name of a tier

withDetailsboolean

Set to true to return CustomFields and Options

sortOrder'Asc' | 'Desc'

Sort organizations items by ascending or descending order. Default is descending

sortField'Date' | 'UpdateDate' | 'CreationDate'

Sort organizations items by a specific field (Date or UpdateDate). Default is date

Response

Success