--- updatedAt: 2026-09-19T08:28:29.000Z agentTools: projectIndex: https://developers.deliverect.com/v3.0-ordering-experience/llms.txt --- # Update Basket - Group Customers ## Purpose Add, remove, or update the customer details within a group basket. {`

Patch Behaviour
Each patch will fully replace the curent basket customer details, to update or add new customers, retain the existing customer information.

`} # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Commerce API", "description": " Our Commerce API powers digital ordering via endpoints that provide store details, menu data, basket calculation and validation and provides a checkout flow to handle POS order injection.", "version": "1.0.0" }, "servers": [ { "url": "https://api.staging.deliverect.com" } ], "security": [ { "oauth2ClientCredentials": [] } ], "components": { "securitySchemes": { "oauth2ClientCredentials": { "type": "oauth2", "description": "Obtain an access token using the partner client ID and client secret. Send the returned token with each API request in the Authorization header as a Bearer token.", "flows": { "clientCredentials": { "tokenUrl": "/oauth/token", "scopes": {} } } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true, "oauth-options": { "useInsecureClientAuthentication": true } }, "x-readme-fauxas": true, "paths": { "/commerce/{accountId}/baskets/{basketId}/customers": { "patch": { "tags": [ "Endpoints" ], "summary": "Update Basket - Group Customers", "operationId": "commerce-channel-api-baskets-update-basket-customer-1", "parameters": [ { "name": "accountId", "in": "path", "schema": { "type": "string", "default": "668e4aa170efd23c474b2ad1" }, "required": true }, { "name": "basketId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "host", "guest" ] }, "name": { "type": "string" }, "companyName": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "externalId": { "type": "string" }, "tin": { "type": "string" }, "crmProfileId": { "type": "string" }, "id": { "type": "string", "description": "Internal customer ID, auto-generated when the customer is first added to the basket. Should be sent back on subsequent requests referencing the customer. " } }, "required": [ "role" ] } }, "examples": { "Sample Customers": { "value": [ { "id": "691327c5d367f4588f948201", "role": "host", "name": "John Doe", "companyName": "ACME", "phoneNumber": "+3211223344", "email": "john.doe@acme.com", "externalId": "crm-id-1234", "tin": "123456789" }, { "role": "guest", "name": "Patrick Doe", "companyName": "ACME", "phoneNumber": "+3211223344", "email": "patrick.doe@acme.com", "externalId": "crm-id-1235", "tin": "123456790" } ], "summary": "Sample Customers" } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "id": "6643782d0c1914c93a846834", "created": "2024-05-14T14:41:49.738000+00:00", "updated": "2024-05-14T14:41:49.754000+00:00", "deleted": false, "etag": "f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf", "accountId": "65c35d109a19b819b7cf78d8", "storeId": "65eee6a9984a1bc1b9637c59", "channelLinkId": "65eee6a9984a1bc1b9637c59", "channelOrderId": null, "channelOrderDisplayId": null, "currency": "EUR", "taxExclusive": false, "status": "open", "items": [ { "menuId": "62d7f77f64c95193cc29aa91", "plu": "STK-01", "name": "Delicious Steak Frites", "quantity": 2, "price": 1500, "gross": 3800, "taxes": [], "net": 3800, "subItems": [ { "customizationPlu": "MOD-01", "plu": "DRNK-01", "name": "Coca Cola", "quantity": 1, "price": 400, "subItems": [] } ], "discounts": [], "discountTotal": 0, "customerId": "691327c5d367f4588f948201" }, { "menuId": "62d7f77f64c95193cc29aa91", "plu": "STK-01", "name": "Delicious Steak Frites", "quantity": 1, "price": 1500, "gross": 1500, "taxes": [], "net": 1500, "subItems": [], "discounts": [], "discountTotal": 0, "customerId": "691327c5d367f4588f948202" } ], "payment": { "tips": [], "discountsTotal": 0, "taxTotal": 0, "tipTotal": 0, "total": 5300 }, "group": { "customers": [ { "id": "691327c5d367f4588f948201", "role": "host", "name": "John Doe", "companyName": "ACME", "phoneNumber": "+3211223344", "email": "john.doe@acme.com", "externalId": "crm-id-1234", "tin": "123456789" }, { "id": "691327c5d367f4588f948202", "role": "guest", "name": "Patrick Doe", "companyName": "ACME", "phoneNumber": "+3211223344", "email": "patrick.doe@acme.com", "externalId": "crm-id-1235", "tin": "123456790" } ] }, "customer": null, "fulfillment": { "type": "pickup" }, "taxes": [], "discounts": [] } } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6643782d0c1914c93a846834" }, "created": { "type": "string", "example": "2024-05-14T14:41:49.738000+00:00" }, "updated": { "type": "string", "example": "2024-05-14T14:41:49.754000+00:00" }, "deleted": { "type": "boolean", "example": false, "default": true }, "etag": { "type": "string", "example": "f4c8f20eeb23206c2bc8cf66c2843a6efaa3eaaf" }, "accountId": { "type": "string", "example": "65c35d109a19b819b7cf78d8" }, "storeId": { "type": "string", "example": "65eee6a9984a1bc1b9637c59" }, "channelLinkId": { "type": "string", "example": "65eee6a9984a1bc1b9637c59" }, "channelOrderId": {}, "channelOrderDisplayId": {}, "currency": { "type": "string", "example": "EUR" }, "taxExclusive": { "type": "boolean", "example": false, "default": true }, "status": { "type": "string", "example": "open" }, "items": { "type": "array", "items": { "type": "object", "properties": { "menuId": { "type": "string", "example": "62d7f77f64c95193cc29aa91" }, "plu": { "type": "string", "example": "STK-01" }, "name": { "type": "string", "example": "Delicious Steak Frites" }, "quantity": { "type": "integer", "example": 2, "default": 0 }, "price": { "type": "integer", "example": 1500, "default": 0 }, "gross": { "type": "integer", "example": 3800, "default": 0 }, "taxes": { "type": "array", "items": { "type": "object", "properties": {} } }, "net": { "type": "integer", "example": 3800, "default": 0 }, "subItems": { "type": "array", "items": { "type": "object", "properties": { "customizationPlu": { "type": "string", "example": "MOD-01" }, "plu": { "type": "string", "example": "DRNK-01" }, "name": { "type": "string", "example": "Coca Cola" }, "quantity": { "type": "integer", "example": 1, "default": 0 }, "price": { "type": "integer", "example": 400, "default": 0 }, "subItems": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "discounts": { "type": "array", "items": { "type": "object", "properties": {} } }, "discountTotal": { "type": "integer", "example": 0, "default": 0 }, "customerId": { "type": "string", "example": "691327c5d367f4588f948201" } } } }, "payment": { "type": "object", "properties": { "tips": { "type": "array", "items": { "type": "object", "properties": {} } }, "discountsTotal": { "type": "integer", "example": 0, "default": 0 }, "taxTotal": { "type": "integer", "example": 0, "default": 0 }, "tipTotal": { "type": "integer", "example": 0, "default": 0 }, "total": { "type": "integer", "example": 5300, "default": 0 } } }, "group": { "type": "object", "properties": { "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "691327c5d367f4588f948201" }, "role": { "type": "string", "example": "host" }, "name": { "type": "string", "example": "John Doe" }, "companyName": { "type": "string", "example": "ACME" }, "phoneNumber": { "type": "string", "example": "+3211223344" }, "email": { "type": "string", "example": "john.doe@acme.com" }, "externalId": { "type": "string", "example": "crm-id-1234" }, "tin": { "type": "string", "example": "123456789" } } } } } }, "customer": {}, "fulfillment": { "type": "object", "properties": { "type": { "type": "string", "example": "pickup" } } }, "taxes": { "type": "array", "items": { "type": "object", "properties": {} } }, "discounts": { "type": "array", "items": { "type": "object", "properties": {} } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } }, "examples": { "Insufficient permissions": { "summary": "Insufficient permissions", "value": { "code": "insufficient_permissions", "description": "" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } }, "examples": { "Basket not found": { "summary": "Basket not found", "value": { "error": "basket not found" } }, "Account not found": { "summary": "Account not found", "value": { "error": "account not found", "http_code": 404, "description": "account not found" } } } } } }, "409": { "description": "Conflict — a concurrent update to the basket was detected" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "context", "traceId" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "context": { "type": "object" }, "traceId": { "type": "string" } } }, "examples": { "Host customer required": { "summary": "Host customer required", "value": { "code": "host_customer_required", "message": "A Host customer is required for a group basket.", "context": {}, "traceId": "dd99710e721ad0c4379b8176acf37b56" } }, "Duplicate host customer": { "summary": "Duplicate host customer", "value": { "code": "duplicate_host_customer", "message": "A basket can only have one Host customer.", "context": {}, "traceId": "08c3d410dd9d1b7c498404f3d1a0e4de" } }, "New joiners deadline passed": { "summary": "New joiners deadline passed", "value": { "code": "new_joiners_deadline_passed", "message": "The deadline for new joiners has passed. You can no longer add new customers to the basket.", "context": { "deadline": "2026-09-02T11:00:00+00:00" }, "traceId": "d270ec2adf8e01df4b09a6220903afba" } }, "Participants limit exceeded": { "summary": "Participants limit exceeded", "value": { "code": "participants_limit_exceeded", "message": "Cannot add participant. Adding this participant would exceed the maximum of 10 participants.", "context": { "max": 10, "currentCount": 10 }, "traceId": "5d581255e3f39a39be31406213e3c2c6" } } } } } } } } } } } ```