Sign in

v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB
shop resource

Create shop resource

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

Path parameters

organizerIdstring objectId required

Resource identifier.

eventIdstring objectId required

Resource identifier.

Request body

namestring nullable
{"stackTrail":"components:schemas:shopCreate:properties:medias","oasType":"schema","type":"unknown","nullable":true}
descriptionstring nullable
shortDescriptionstring nullable
maxCountinteger nullable
{"stackTrail":"components:schemas:shopCreate:properties:formId","oasType":"schema","type":"unknown","nullable":true}
invoiceReferencePrefixstring nullable
{"stackTrail":"components:schemas:shopCreate:properties:contentIds","oasType":"schema","type":"unknown","nullable":true}
preferredLocale'fr' | 'en' | 'es' nullable
defaultLocale'fr' | 'en' | 'es' nullable
installmentsinteger[] nullable
localeDetailsobject nullable
{"stackTrail":"components:schemas:shopCreate:properties:legalId","oasType":"schema","type":"unknown","nullable":true}
needConfirmationboolean nullable
status'enabled' | 'disabled' | 'hidden' nullable
shopNamestring nullable
ticketOfficeLayout'list' | 'grid' | 'table' | 'noArea' nullable
categoriesstring[] nullable
slugstring nullable
orderExpirationDelaystring nullable
isMainboolean nullable

Example request

{
  "name": "x",
  "description": "string",
  "shortDescription": "string",
  "theme": {
    "dark": true,
    "primaryColor": "string",
    "secondaryColor": "string"
  },
  "invoiceReferencePrefix": "string",
  "preferredLocale": "fr",
  "defaultLocale": "fr",
  "installments": [
    2
  ],
  "salesDetails": {
    "orderConfirmationText": "string",
    "refundPolicy": "string",
    "terms": "string"
  },
  "needConfirmation": true,
  "status": "enabled",
  "shopName": "string",
  "ticketOfficeLayout": "list",
  "categories": [
    "eventLocations"
  ],
  "slug": "string",
  "orderExpirationDelay": "string",
  "referenceHandler": {
    "regex": "x",
    "hint": "x"
  },
  "isMain": true
}

Response

Success

namestring nullable
{"stackTrail":"components:schemas:shop:properties:medias","oasType":"schema","type":"unknown","nullable":true}
descriptionstring nullable
shortDescriptionstring nullable
maxCountinteger nullable
{"stackTrail":"components:schemas:shop:properties:formId","oasType":"schema","type":"unknown","nullable":true}
invoiceReferencePrefixstring nullable
{"stackTrail":"components:schemas:shop:properties:contentIds","oasType":"schema","type":"unknown","nullable":true}
preferredLocale'fr' | 'en' | 'es' nullable
defaultLocale'fr' | 'en' | 'es' nullable
installmentsinteger[] nullable
localeDetailsobject nullable
{"stackTrail":"components:schemas:shop:properties:legalId","oasType":"schema","type":"unknown","nullable":true}
needConfirmationboolean nullable
status'enabled' | 'disabled' | 'hidden' nullable
shopNamestring nullable
ticketOfficeLayout'list' | 'grid' | 'table' | 'noArea' nullable
categoriesstring[] nullable
slugstring nullable
orderExpirationDelaystring nullable
isMainboolean nullable
_idstring objectId required
_createdAtstring date-time required
_updatedAtstring date-time nullable
_referencestring nullable

Example response

{
  "name": "x",
  "description": "string",
  "shortDescription": "string",
  "theme": {
    "dark": true,
    "primaryColor": "string",
    "secondaryColor": "string"
  },
  "invoiceReferencePrefix": "string",
  "preferredLocale": "fr",
  "defaultLocale": "fr",
  "installments": [
    2
  ],
  "salesDetails": {
    "orderConfirmationText": "string",
    "refundPolicy": "string",
    "terms": "string"
  },
  "needConfirmation": true,
  "status": "enabled",
  "shopName": "string",
  "ticketOfficeLayout": "list",
  "categories": [
    "eventLocations"
  ],
  "slug": "string",
  "orderExpirationDelay": "string",
  "referenceHandler": {
    "regex": "x",
    "hint": "x"
  },
  "isMain": true,
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}