Commandes

Obtenir des informations détaillées sur 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/orders/{orderId}

Request

  • Base URL
    https://api.helloasso.com/v5
  • URL
    https://api.helloasso.com/v5/orders/{orderId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.helloasso.com/oauth2/token

Path parameters

orderIdinteger required

The order ID

Query parameters

withFormDataboolean

Set to true to include form data in the response

checkPaymentsRefundEligibilityboolean

Set to true to check if payments are eligible to refund or not

Response

Success

idinteger

The ID of the Order

datestring date-time

Order creation date

formSlugstring nullable

FormSlug (lowercase name of the form without special characters)

formType'CrowdFunding' | 'Membership' | 'Event' | 'Donation' | 'PaymentForm' | 'Checkout' | 'Shop'
organizationNamestring nullable

The organization name.

organizationSlugstring nullable

OrganizationSlug (lowercase name of the organization without special characters)

organizationType'Association1901Rig' | 'Association1901Rup' | 'Association1901' | 'FondationRup' | 'FondDotation' | 'FondationSousEgide' | 'FondationScientifique' | 'FondationPartenariale' | 'FondationUniversitaire' | 'FondationHospitaliere' | 'Association1905' | 'Association1905Rup' | 'Entreprise' | 'Cooperative' | 'Etablissement' | 'Association1908' | 'Association1908Rig' | 'Association1908Rup' | 'AssociationMilitaire' | 'AssociationProprietaire' | 'Collectivités' | 'ComiteEntreprise' | 'CSE' | 'FabriqueEglise' | 'FondsPerenite' | 'GIE' | 'GIP' | 'MenseCuriale' | 'SCIC' | 'SCOP' | 'Autres' | 'EPA'
organizationIsUnderColucheLawboolean

Whether or not the organization is subject to the coluche law

checkoutIntentIdinteger nullable

Checkout intent Id if available

Changes

No recorded changes to this operation across all 1 revision of this API.