v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB

product resource

Create product resource

post/v1/organizers/{organizerId}/events/{eventId}/products

Path parameters

organizerIdstring objectId required

Resource identifier.

eventIdstring objectId required

Resource identifier.

Request body

namestring

maxCountinteger nullable

{"stackTrail":"components:schemas:productCreate:properties:media","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:productCreate:properties:formId","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:productCreate:properties:emissionStartDate","oasType":"schema","type":"unknown","nullable":true}

defaultLocale'fr' | 'en' | 'es' nullable

localeDetailsobject nullable

needConfirmationboolean nullable

descriptionstring nullable

{"stackTrail":"components:schemas:productCreate:properties:contentIds","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:productCreate:properties:distributionRuleId","oasType":"schema","type":"unknown","nullable":true}

Example request

{
  "name": "string",
  "maxCount": -9007199254740991,
  "referenceHandler": {
    "regex": "x",
    "hint": "x"
  },
  "defaultLocale": "fr",
  "salesDetails": {
    "orderConfirmationText": "string",
    "refundPolicy": "string",
    "terms": "string"
  },
  "needConfirmation": true,
  "description": "string"
}

Response

Success

namestring required

maxCountinteger nullable

{"stackTrail":"components:schemas:product:properties:media","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:product:properties:formId","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:product:properties:emissionStartDate","oasType":"schema","type":"unknown","nullable":true}

defaultLocale'fr' | 'en' | 'es' nullable

localeDetailsobject nullable

needConfirmationboolean nullable

descriptionstring nullable

taxRatenumber required

type'ticket' | 'good' nullable

{"stackTrail":"components:schemas:product:properties:contentIds","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:product:properties:distributionRuleId","oasType":"schema","type":"unknown","nullable":true}

_idstring objectId required

_createdAtstring date-time required

_updatedAtstring date-time nullable

_referencestring nullable

Example response

{
  "name": "string",
  "maxCount": -9007199254740991,
  "referenceHandler": {
    "regex": "x",
    "hint": "x"
  },
  "defaultLocale": "fr",
  "salesDetails": {
    "orderConfirmationText": "string",
    "refundPolicy": "string",
    "terms": "string"
  },
  "needConfirmation": true,
  "description": "string",
  "type": "ticket",
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}