--- updatedAt: 2026-02-04T17:17:16.000Z agentTools: projectIndex: https://dev.helloasso.com/llms.txt --- # Create movement resource # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Plus Billetterie API", "version": "1.0.0", "description": "Authentication: send your API key in the Authorization header using the format `X-API-KEY YOUR_API_KEY`.\n\nEach API key is tied to a single organization. A key cannot manage multiple organizations.\n\nAPI keys can be generated from the organization dashboard (Developer tab)." }, "tags": [ { "name": "movement resource", "description": "API endpoints for managing movement resources", "x-tag-schema": { "$ref": "#/components/schemas/movement" }, "x-tag-schema-example": { "type": "order" } } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/v1/organizers/{organizerId}/movements": { "post": { "tags": [ "movement resource" ], "summary": "Create movement resource", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/movement" } } } } }, "parameters": [ { "name": "organizerId", "in": "path", "required": true, "description": "Resource identifier.", "schema": { "type": "string", "format": "objectId" }, "example": "64b7f8b6f23a4a4f3d0a9b12" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/movementCreate" }, "example": { "type": "order" } } } } } } }, "components": { "schemas": { "movement": { "oneOf": [ { "type": "object", "properties": { "sellingItems": { "nullable": true, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "sellingItemId": { "nullable": true }, "formResponseId": { "nullable": true }, "products": { "nullable": true, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "formResponseId": { "nullable": true }, "productId": { "nullable": true }, "attendeeEmail": { "anyOf": [ { "nullable": true, "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "example": "user@example.com" }, { "type": "string", "enum": [ "" ], "example": "" } ] }, "seat": { "nullable": true, "type": "object", "properties": { "seatId": { "nullable": true }, "locationKey": { "nullable": true }, "areaSessionId": { "nullable": true }, "areaId": { "nullable": true } }, "additionalProperties": false } }, "additionalProperties": false } } }, "additionalProperties": false } }, "locale": { "nullable": true, "type": "string", "enum": [ "fr", "en", "es" ], "example": "fr" }, "clientReference": { "anyOf": [ { "nullable": true, "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "example": "user@example.com" }, { "type": "string", "enum": [ "" ], "example": "" } ] }, "clientDetails": { "nullable": true, "type": "object", "properties": { "firstName": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "lastName": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "address": { "nullable": true, "type": "object", "properties": { "city": { "type": "string", "minLength": 1, "example": "x" }, "country": { "default": "FR", "nullable": true, "type": "string", "minLength": 1 }, "postalCode": { "type": "string", "minLength": 1, "example": "x" }, "street": { "type": "string", "minLength": 1, "example": "x" }, "streetDetails": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "region": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "subRegion": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "name": { "nullable": true, "type": "string", "minLength": 1, "example": "x" } }, "required": [ "city", "country", "postalCode", "street" ], "additionalProperties": false }, "structure": { "nullable": true, "type": "object", "properties": { "type": { "default": "company", "type": "string", "enum": [ "company", "association" ] }, "companyNumber": { "type": "string", "example": "string" }, "name": { "type": "string", "example": "string" }, "email": { "nullable": true, "type": "string", "example": "string" }, "address": { "nullable": true, "type": "object", "properties": { "city": { "type": "string", "minLength": 1, "example": "x" }, "country": { "default": "FR", "nullable": true, "type": "string", "minLength": 1 }, "postalCode": { "type": "string", "minLength": 1, "example": "x" }, "street": { "type": "string", "minLength": 1, "example": "x" }, "streetDetails": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "region": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "subRegion": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "name": { "nullable": true, "type": "string", "minLength": 1, "example": "x" } }, "required": [ "city", "country", "postalCode", "street" ], "additionalProperties": false }, "phone": { "nullable": true, "type": "string", "example": "string" }, "website": { "nullable": true, "type": "string", "example": "string" }, "taxNumber": { "nullable": true, "type": "string", "example": "string" } }, "required": [ "type", "companyNumber", "name" ], "additionalProperties": false } }, "additionalProperties": false }, "eventId": {}, "formResponseId": { "nullable": true }, "resaleId": { "nullable": true }, "discountIds": { "nullable": true, "type": "array", "items": {} }, "shopSessionId": { "nullable": true }, "type": { "type": "string", "enum": [ "order" ], "example": "order" }, "status": { "nullable": true, "type": "string", "enum": [ "pending" ], "example": "pending" } }, "required": [ "eventId", "type" ], "additionalProperties": false, "title": "order" }, { "type": "object", "properties": { "eventId": { "nullable": true }, "_legalId": { "nullable": true }, "fixedAmount": { "nullable": true, "type": "number", "example": 0 }, "refundSellingItemsAmount": { "nullable": true, "type": "boolean", "example": true }, "percentageAmount": { "nullable": true, "type": "number", "minimum": 0, "maximum": 100, "example": 0 }, "query": { "type": "object", "properties": { "filters": { "nullable": true, "type": "array", "items": {} }, "filtersLogical": { "nullable": true, "type": "string", "enum": [ "$and", "$or", "$nor" ], "example": "$and" }, "limit": { "nullable": true, "anyOf": [ { "type": "number", "minimum": 0, "example": 0 }, { "type": "number", "enum": [ -1 ], "example": -1 } ] }, "skip": { "nullable": true, "type": "number", "minimum": 0, "example": 0 }, "sort": { "nullable": true, "type": "object", "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ], "example": "asc" } } }, "additionalProperties": false }, "reason": { "nullable": true, "type": "string", "enum": [ "duplicate", "fraud", "customerRequest", "merchantError", "productIssue", "technicalIssue", "promotionalAdjustment", "expired", "other" ], "example": "duplicate" }, "silent": { "nullable": true, "type": "boolean", "example": true }, "sellingItemPointers": { "nullable": true, "type": "array", "items": {} }, "sellingItemPointerType": { "nullable": true, "type": "string", "enum": [ "id", "key" ], "example": "id" }, "type": { "type": "string", "enum": [ "refund" ], "example": "refund" } }, "required": [ "query", "type" ], "additionalProperties": false, "title": "refund" }, { "type": "object", "properties": { "_amount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991, "example": 0 }, "_walletId": {}, "stripeBankAccount": { "nullable": true, "type": "object", "properties": { "stripeId": { "nullable": true, "type": "string", "example": "string" } }, "additionalProperties": false }, "type": { "type": "string", "enum": [ "withdrawal" ], "example": "withdrawal" } }, "required": [ "_amount", "_walletId", "type" ], "additionalProperties": false, "title": "withdrawal" } ], "properties": { "_id": { "type": "string", "format": "objectId", "example": "64b7f8b6f23a4a4f3d0a9b12" }, "_createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00.000Z" }, "_updatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T00:00:00.000Z" }, "_reference": { "type": "string", "nullable": true, "example": "string" } }, "required": [ "_id", "_createdAt" ] }, "movementCreate": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "order" ], "example": "order" }, "status": { "nullable": true, "type": "string", "enum": [ "pending" ], "example": "pending" }, "emailUpdates": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "to": { "nullable": true, "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "example": "user@example.com" }, "key": {}, "productKey": { "nullable": true }, "reason": { "default": "other", "type": "string", "enum": [ "typoCorrection", "customerRequest", "bounceHandling", "accountMigration", "other" ] } }, "required": [ "key", "reason" ], "additionalProperties": false } }, "productUpdates": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "to": {}, "key": {}, "productKey": { "nullable": true }, "reason": { "default": "other", "type": "string", "enum": [ "replacement", "upgrade", "downgrade", "outOfStock", "customerRequest", "other" ] } }, "required": [ "to", "key", "reason" ], "additionalProperties": false } }, "seatUpdates": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "to": { "type": "object", "properties": { "seatId": { "nullable": true } }, "additionalProperties": false }, "key": {}, "productKey": { "nullable": true }, "reason": { "default": "other", "type": "string", "enum": [ "customerRequest", "other" ] } }, "required": [ "to", "key", "reason" ], "additionalProperties": false } }, "invoiceUpdates": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "to": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "address": { "type": "string", "minLength": 1, "example": "x" }, "zipCode": { "type": "string", "minLength": 1, "example": "x" }, "city": { "type": "string", "minLength": 1, "example": "x" }, "country": { "type": "string", "minLength": 1, "example": "x" }, "taxId": { "nullable": true, "type": "string", "minLength": 1, "example": "x" } }, "required": [ "name", "address", "zipCode", "city", "country" ], "additionalProperties": false }, "key": {}, "reason": { "nullable": true, "type": "string", "minLength": 1, "example": "x" } }, "required": [ "to", "key" ], "additionalProperties": false } }, "sellingItems": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "products": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "formResponseId": { "nullable": true }, "productKey": {}, "status": { "nullable": true, "type": "string", "enum": [ "enabled", "pending", "disabled", "used", "resold", "refunded" ], "example": "enabled" } }, "required": [ "productKey" ], "additionalProperties": false } } }, "additionalProperties": false } } }, "required": [ "type" ], "additionalProperties": false, "title": "order" }, { "type": "object", "properties": { "eventId": { "nullable": true }, "_legalId": { "nullable": true }, "fixedAmount": { "nullable": true, "type": "number", "example": 0 }, "refundSellingItemsAmount": { "nullable": true, "type": "boolean", "example": true }, "percentageAmount": { "nullable": true, "type": "number", "minimum": 0, "maximum": 100, "example": 0 }, "query": { "type": "object", "properties": { "filters": { "nullable": true, "type": "array", "items": {} }, "filtersLogical": { "nullable": true, "type": "string", "enum": [ "$and", "$or", "$nor" ], "example": "$and" }, "limit": { "nullable": true, "anyOf": [ { "type": "number", "minimum": 0, "example": 0 }, { "type": "number", "enum": [ -1 ], "example": -1 } ] }, "skip": { "nullable": true, "type": "number", "minimum": 0, "example": 0 }, "sort": { "nullable": true, "type": "object", "additionalProperties": { "type": "string", "enum": [ "asc", "desc" ], "example": "asc" } } }, "additionalProperties": false }, "reason": { "nullable": true, "type": "string", "enum": [ "duplicate", "fraud", "customerRequest", "merchantError", "productIssue", "technicalIssue", "promotionalAdjustment", "expired", "other" ], "example": "duplicate" }, "silent": { "nullable": true, "type": "boolean", "example": true }, "sellingItemPointers": { "nullable": true, "type": "array", "items": {} }, "sellingItemPointerType": { "nullable": true, "type": "string", "enum": [ "id", "key" ], "example": "id" }, "type": { "type": "string", "enum": [ "refund" ], "example": "refund" } }, "required": [ "type" ], "additionalProperties": false, "title": "refund" }, { "type": "object", "properties": { "_amount": { "type": "integer", "exclusiveMinimum": true, "maximum": 9007199254740991, "example": 0 }, "_walletId": {}, "stripeBankAccount": { "nullable": true, "type": "object", "properties": { "stripeId": { "nullable": true, "type": "string", "example": "string" } }, "additionalProperties": false }, "type": { "type": "string", "enum": [ "withdrawal" ], "example": "withdrawal" } }, "required": [ "type" ], "additionalProperties": false, "title": "withdrawal" } ] } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "description": "Use the format `X-API-KEY YOUR_API_KEY`. Each key is tied to a single organization." } } }, "servers": [ { "url": "https://api.plusbilletterie.helloasso.com" } ], "x-readme": {} } ```