HEhelloasso
sellingItem resource

Get sellingItem resource

get/v1/organizers/{organizerId}/events/{eventId}/sellingItems/{sellingItemId}

Request

  • Base URL
    https://api.plusbilletterie.helloasso.com
  • URL
    https://api.plusbilletterie.helloasso.com/v1/organizers/{organizerId}/events/{eventId}/sellingItems/{sellingItemId}
  • Auth
    API key in header X-API-KEY

Path parameters

organizerIdstring objectId required

Resource identifier.

eventIdstring objectId required

Resource identifier.

sellingItemIdstring objectId required

Resource identifier.

Response

Success

namestring required
maxPerOrdernumber nullable
descriptionstring nullable
mediaunknown
linkIdunknown
categoryIdunknown
defaultLocale'fr' | 'en' | 'es' nullable
localeDetailsobject nullable
formIdunknown
maxCountinteger nullable

Nombre maximal de vente de cet objet. Null si illimité

status'enabled' | 'silent' | 'silentWithPrice' nullable

Statut de l'item de vente. enabled : visible et vendable, silent : Visible mais non vendable et affiché sans le prix, silentWithPrice : visible et non vendable affiché avec le prix.

_idstring objectId required
_createdAtstring date-time required
_updatedAtstring date-time nullable
_referencestring nullable

Example response

{
  "name": "x",
  "maxPerOrder": 1,
  "description": "string",
  "defaultLocale": "fr",
  "attendeeMessages": [
    {
      "provider": "steps",
      "message": "string",
      "rule": "selected"
    }
  ],
  "salesDetails": {
    "orderConfirmationText": "string",
    "refundPolicy": "string",
    "terms": "string"
  },
  "steps": [
    {
      "basePrice": -9007199254740991,
      "optional": true,
      "description": "string",
      "title": "string",
      "soldOut": true,
      "flavors": [
        {
          "quantity": -9007199254740991,
          "additionalPrice": -9007199254740991
        }
      ]
    }
  ],
  "priceModifiers": [
    {
      "rule": "fixed",
      "trigger": "sellingItemQuantity"
    }
  ],
  "maxCount": -9007199254740991,
  "status": "enabled",
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}

Changes

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