> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/api/models.md).

# Models

## The PublicError object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"PublicError":{"description":"An API error response. Use code and the HTTP status to classify the failure, message and optional details for context, and requestId when reporting it. Edge firewall responses may omit requestId.","type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string","description":"Present on every error the API itself returns; absent when the edge firewall rejected the request."},"details":{"description":"Optional error-specific details (e.g. per-field validation reasons)."}}}}}}
```

## The CartsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CartsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"cartId":{"type":"string"},"status":{"type":"string","enum":["OPEN","SUBMITTED"]},"referenceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"contactId":{"anyOf":[{"type":"string"},{"type":"null"}]},"clientEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalValue":{"type":"number"},"totalAdditions":{"type":"number"},"finalPrice":{"type":"number"},"totalQuantity":{"type":"number"},"itemCount":{"type":"number"},"submissionData":{"anyOf":[{"type":"object","properties":{"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"customFields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["fullName","email","phone","companyName","address","notes","customFields"],"additionalProperties":false},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"submittedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 submission timestamp, or null while the cart is still open."}},"required":["cartId","status","referenceCode","contactId","clientEmail","currency","totalValue","totalAdditions","finalPrice","totalQuantity","itemCount","submissionData","createdAt","modifiedAt","submittedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Carts (GET /v1/carts). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CartsDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CartsDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"cartId":{"type":"string"},"status":{"type":"string","enum":["OPEN","SUBMITTED"]},"referenceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"contactId":{"anyOf":[{"type":"string"},{"type":"null"}]},"clientEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"totalValue":{"type":"number"},"totalAdditions":{"type":"number"},"finalPrice":{"type":"number"},"totalQuantity":{"type":"number"},"submissionData":{"anyOf":[{"type":"object","properties":{"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"customFields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["fullName","email","phone","companyName","address","notes","customFields"],"additionalProperties":false},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"submittedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 submission timestamp, or null while the cart is still open."},"companyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","properties":{"cartItemId":{"type":"string"},"productId":{"type":"string"},"productName":{"type":"string"},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"sku":{"anyOf":[{"type":"string"},{"type":"null"}]},"shortCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"configurationCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"type":"number"},"unitPrice":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"Parsed numeric price, or a string sentinel when the source value is unparseable."},"price":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"Parsed numeric price, or a string sentinel when the source value is unparseable."},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"link":{"anyOf":[{"type":"string"},{"type":"null"}]},"specification":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["cartItemId","productId","productName","variantCode","sku","shortCode","configurationCode","quantity","unitPrice","price","image","note","link","specification"],"additionalProperties":false}},"priceModifiers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"mode":{"type":"string","enum":["FIXED","PERCENTAGE"]},"modifierValue":{"type":"number"},"type":{"type":"string","enum":["ADDITION","DISCOUNT"]},"calculatedValue":{"type":"number"}},"required":["name","description","mode","modifierValue","type","calculatedValue"],"additionalProperties":false}}},"required":["cartId","status","referenceCode","contactId","clientEmail","currency","totalValue","totalAdditions","finalPrice","totalQuantity","submissionData","createdAt","modifiedAt","submittedAt","companyId","items","priceModifiers"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Cart (GET /v1/carts/{cartId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."},"companyNumericId":{"type":"number"},"companyName":{"type":"string"},"address":{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","city","postcode","country"],"additionalProperties":false},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"workNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"accountManagerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["companyId","companyNumericId","companyName","address","email","workNumber","currency","status","accountManagerId","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Companies (GET /v1/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string"},"currency":{"type":"string"}},"required":["companyId","status","companyName","currency"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Company (POST /v1/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesCreateRequest":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string","minLength":1,"maxLength":255},"currency":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"postcode":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false},"email":{"type":"string","minLength":1,"maxLength":255},"workNumber":{"type":"string","minLength":1,"maxLength":255},"accountManagerId":{"type":"string","pattern":"^USER-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"tags":{"description":"Up to 50 tags.","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"paymentTerms":{"type":"string","minLength":1,"maxLength":255},"deliveryAddresses":{"description":"Up to 50 delivery addresses.","maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"name":{"type":"string","minLength":1,"maxLength":255},"street":{"type":"string","minLength":1,"maxLength":255},"postcode":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","minLength":1,"maxLength":255},"companyName":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false}},"socials":{"description":"Up to 20 socials.","maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"type":{"type":"string","enum":["facebook","instagram","linkedin","twitter","pinterest","website","youtube","other"]},"address":{"type":"string","minLength":1,"maxLength":255}},"required":["type","address"],"additionalProperties":false}}},"required":["status","companyName","currency"],"additionalProperties":false,"description":"Data schema used by Create Company (POST /v1/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."},"companyNumericId":{"type":"number"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"companyName":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","city","postcode","country"],"additionalProperties":false},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"workNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountManagerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"accountManager":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"paymentTerms":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveryAddresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","street","postcode","country","companyName","city"],"additionalProperties":false}},"socials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["facebook","instagram","linkedin","twitter","pinterest","website","youtube","other"]},"address":{"type":"string"}},"required":["id","type","address"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"contactId":{"type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contactId","firstName","lastName"],"additionalProperties":false}},"priceLists":{"type":"array","items":{"type":"object","properties":{"priceListId":{"type":"string"},"priceListName":{"type":"string"},"status":{"type":"string"}},"required":["priceListId","priceListName","status"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["companyId","companyNumericId","status","companyName","currency","address","email","workNumber","accountManagerId","accountManager","tags","paymentTerms","deliveryAddresses","socials","contacts","priceLists","createdAt","modifiedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Company (GET /v1/companies/{companyId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesNotes object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesNotes":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"noteId":{"type":"string"},"noteTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"noteContent":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"attachments":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public file URL, or null when unavailable."},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["fileId","filePath","label"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["noteId","noteTitle","noteContent","attachments","createdAt","modifiedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Company Notes (GET /v1/companies/{companyId}/notes). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesMutation2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesMutation2":{"type":"object","properties":{"data":{"type":"object","properties":{"noteId":{"type":"string"},"noteTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"noteContent":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"attachments":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public file URL, or null when unavailable."},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["fileId","filePath","label"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["noteId","noteTitle","noteContent","attachments","createdAt","modifiedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Company Note (POST /v1/companies/{companyId}/notes). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesNotesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesNotesRequest":{"type":"object","properties":{"noteTitle":{"type":"string","minLength":1,"maxLength":255},"noteContent":{"description":"Plain note text, stored as a single paragraph; formatting made in the Mimeeq app is replaced. Omitted or null leaves the note without content. Responses return it as `{ html, text }`.","anyOf":[{"type":"string","maxLength":10000},{"type":"null"}]},"attachments":{"description":"The complete attachment list, at most 20. Omitted on an update keeps the stored attachments; an empty list removes them all.","maxItems":20,"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string","minLength":1,"maxLength":1024,"description":"A `fileId` returned by Upload Company Note Attachment for this company."}},"required":["fileId"],"additionalProperties":false}}},"required":["noteTitle"],"additionalProperties":false,"description":"Data schema used by Create Company Note (POST /v1/companies/{companyId}/notes). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesNotesAttachment object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesNotesAttachment":{"type":"object","properties":{"data":{"type":"object","properties":{"fileId":{"type":"string"},"filePath":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public file URL, or null when unavailable."},"label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["fileId","filePath","label"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Upload Company Note Attachment (POST /v1/companies/{companyId}/notes/attachments). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesMutation3 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesMutation3":{"type":"object","properties":{"data":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."},"priceLists":{"type":"array","items":{"type":"object","properties":{"priceListId":{"type":"string"},"priceListName":{"type":"string"},"status":{"type":"string"}},"required":["priceListId","priceListName","status"],"additionalProperties":false}}},"required":["companyId","priceLists"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Attach or Detach Company Price Lists (POST /v1/companies/{companyId}/price-lists). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompaniesPriceListsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompaniesPriceListsRequest":{"type":"object","properties":{"priceListIdsToAttach":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"priceListIdsToDelete":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}},"additionalProperties":false,"description":"Data schema used by Attach or Detach Company Price Lists (POST /v1/companies/{companyId}/price-lists). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ContactsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ContactsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"contactId":{"type":"string","pattern":"^CONT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Contact identifier (CONT-<uuid>)."},"contactNumericId":{"type":"number"},"firstName":{"type":"string"},"lastName":{"type":"string"},"companyId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["WORK","HOME","PRIVATE"]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","number"],"additionalProperties":false}},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["WORK","HOME","PRIVATE"]},"mail":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","mail"],"additionalProperties":false}},"isUserAssigned":{"type":"boolean"},"isInvited":{"type":"boolean","description":"Whether the contact has a pending or accepted invitation."},"lastActivityAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp of the last activity, or null."},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["contactId","contactNumericId","firstName","lastName","companyId","status","phoneNumbers","emails","isUserAssigned","isInvited","lastActivityAt","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Contacts (GET /v1/contacts). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ContactsMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ContactsMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"contactId":{"type":"string","pattern":"^CONT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Contact identifier (CONT-<uuid>)."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"firstName":{"type":"string"},"lastName":{"type":"string"},"companyId":{"type":"string"}},"required":["contactId","status","firstName","lastName","companyId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Contact (POST /v1/contacts). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ContactsCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ContactsCreateRequest":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"firstName":{"type":"string","minLength":1,"maxLength":255},"lastName":{"type":"string","minLength":1,"maxLength":255},"companyId":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"sameAsCompany":{"type":"boolean"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"postcode":{"type":"string","minLength":1,"maxLength":255},"country":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false},"tags":{"description":"Up to 50 tags.","maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"phoneNumbers":{"description":"Up to 20 phone numbers.","maxItems":20,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["WORK","HOME","PRIVATE"]},"number":{"type":"string","minLength":1,"maxLength":255}},"required":["type","number"],"additionalProperties":false}},"emails":{"description":"Up to 20 emails.","maxItems":20,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["WORK","HOME","PRIVATE"]},"mail":{"type":"string"}},"required":["type","mail"],"additionalProperties":false}},"linkedInAccount":{"type":"string","minLength":1,"maxLength":255},"position":{"type":"string","minLength":1,"maxLength":255},"reportsToId":{"type":"string","pattern":"^CONT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"required":["firstName","lastName","companyId"],"additionalProperties":false,"description":"Data schema used by Create Contact (POST /v1/contacts). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ContactsDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ContactsDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"contactId":{"type":"string","pattern":"^CONT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Contact identifier (CONT-<uuid>)."},"contactNumericId":{"type":"number"},"firstName":{"type":"string"},"lastName":{"type":"string"},"companyId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["WORK","HOME","PRIVATE"]},"number":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","number"],"additionalProperties":false}},"emails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["WORK","HOME","PRIVATE"]},"mail":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","mail"],"additionalProperties":false}},"isUserAssigned":{"type":"boolean"},"isInvited":{"type":"boolean","description":"Whether the contact has a pending or accepted invitation."},"lastActivityAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp of the last activity, or null."},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"sameAsCompany":{"type":"boolean"},"address":{"type":"object","properties":{"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["street","city","postcode","country"],"additionalProperties":false},"tags":{"type":"array","items":{"type":"string"}},"linkedInAccount":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"anyOf":[{"type":"string"},{"type":"null"}]},"reportsToId":{"anyOf":[{"type":"string"},{"type":"null"}]},"reportsToName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contactId","contactNumericId","firstName","lastName","companyId","status","phoneNumbers","emails","isUserAssigned","isInvited","lastActivityAt","createdAt","modifiedAt","sameAsCompany","address","tags","linkedInAccount","position","reportsToId","reportsToName"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Contact (GET /v1/contacts/{contactId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ContactsMutation2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ContactsMutation2":{"type":"object","properties":{"data":{"type":"object","properties":{"invitationId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Null when an existing Mimeeq user was given access directly."},"status":{"type":"string","enum":["INVITED","ASSIGNED"]}},"required":["invitationId","status"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Contact Portal Invitation (POST /v1/contacts/{contactId}/portal-invitation). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ContactsPortalInvitationRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ContactsPortalInvitationRequest":{"type":"object","properties":{"email":{"description":"Portal login. Defaults to the contact's first email.","type":"string"},"defaultUserLang":{"description":"Language code for the contact's portal user, one of the languages the Mimeeq app offers.","enum":["en","ar","af","am","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","arn","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az-az-cyrl","az-az-latn","ba","be","bg","bn-bd","bn-in","bo","br","bs-ba-cyrl","bs-ba-latn","ca","co","cs","cy","da","de-at","de-ch","de","de-li","de-lu","dsb","dv","el","en-029","en-au","en-bz","en-ca","en-gb","en-ie","en-in","en-jm","en-my","en-nz","en-ph","en-sg","en-tt","en-us","en-za","en-zw","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-us","es-uy","es-ve","et","eu","fa","fi","fil","fo","fr-be","fr-ca","fr-ch","fr","fr-lu","fr-mc","fy","ga","gd","gl","gsw","gu","ha-ng-latn","he","hi","hr-ba","hr","hsb","hu","hy","id","ig","ii","is","it-ch","it","iu-ca-cans","iu-ca-latn","ja","ka","kk","kl","km","kn","kok","ko","ky","lb","lo","lt","lv","mi","mk","ml","mn","mn-cn-mong","moh","mr","ms-bn","ms","mt","nb","ne","nl-be","nl","nn","nso","oc","or","pa","pl","prs","ps","pt-br","pt","rm","ro","ru","rw","sah","sa","se-fi","se-no","se","si","sk","sl","sma-no","sma-se","smj-no","smj-se","smn","sms","sq","sr-ba-cyrl","sr-cs-cyrl","sr-me-cyrl","sr-rs-cyrl","sr-ba-latn","sr-cs-latn","sr-me-latn","sr-rs-latn","sv-fi","sv-se","sw","syr","ta","te","tg-tj-cyrl","th","tk","tn","tr","tt","ug","uk","ur","uz-uz-cyrl","uz-uz-latn","vi","wo","xh","yo","zh","zh-hk","zh-mo","zh-sg","zh-tw","zu"],"type":"string"}},"additionalProperties":false,"description":"Data schema used by Create Contact Portal Invitation (POST /v1/contacts/{contactId}/portal-invitation). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerList":{"type":"object","properties":{"data":{"type":"object","properties":{"customerId":{"type":"string","pattern":"^CUST-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"customerName":{"type":"string"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"contact":{"type":"object","properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["address","city","postcode","country","phone","website"],"additionalProperties":false},"logoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"languages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"isDefault":{"type":"boolean"}},"required":["id","code","isDefault"],"additionalProperties":false}},"currencies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"name":{"type":"string"},"rate":{"type":"number"},"isDefault":{"type":"boolean"}},"required":["id","code","name","rate","isDefault"],"additionalProperties":false}},"markets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Configured market code."},"currencyId":{"type":"string"},"usedInMarketCostPrices":{"type":"boolean"}},"required":["id","currencyId","usedInMarketCostPrices"],"additionalProperties":false}},"priceRoundingType":{"type":"string"},"publicPriceListGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"priceListIds":{"type":"array","items":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"priceType":{"type":"string"},"vatType":{"type":"string","enum":["INCLUDED","EXCLUDED"]}},"required":["id","name","priceListIds","priceType","vatType"],"additionalProperties":false}},"theme":{"type":"object","properties":{"exportObjType":{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED_TO"]},"backgroundColor":{"type":"string"},"accentColor":{"type":"string"},"isWhiteButtonText":{"type":"boolean"},"hotSpots":{"type":"object","properties":{"color":{"type":"string"},"borderColor":{"type":"string"}},"additionalProperties":false},"groupStyle":{"type":"string"},"group":{"type":"object","properties":{"activeColor":{"type":"string"},"hoverColor":{"type":"string"},"openedGroupTextColor":{"type":"string","enum":["BLACK","WHITE"]},"hoverGroupTextColor":{"type":"string"}},"required":["openedGroupTextColor"],"additionalProperties":false},"quickIcons":{"type":"object","properties":{"mobile":{"type":"array","items":{"type":"string"}},"desktop":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"modularQuickIcons":{"type":"array","items":{"type":"string"}},"mesh":{"type":"object","properties":{"overlay":{"type":"string"}},"additionalProperties":false}},"required":["exportObjType","backgroundColor","accentColor","isWhiteButtonText","hotSpots","groupStyle","group","quickIcons","modularQuickIcons","mesh"],"additionalProperties":false},"licence":{"type":"object","properties":{"tier1Users":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}]},"max":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","max"],"additionalProperties":false},"tier2Users":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}]},"max":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","max"],"additionalProperties":false},"products":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Active products counted against the plan."},"inactive":{"anyOf":[{"type":"number"},{"type":"null"}]},"max":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","inactive","max"],"additionalProperties":false},"modularProducts":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Active products counted against the plan."},"inactive":{"anyOf":[{"type":"number"},{"type":"null"}]},"max":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","inactive","max"],"additionalProperties":false},"componentProducts":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Active products counted against the plan."},"inactive":{"anyOf":[{"type":"number"},{"type":"null"}]},"max":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","inactive","max"],"additionalProperties":false},"sharedProducts":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Active products counted against the plan."},"inactive":{"anyOf":[{"type":"number"},{"type":"null"}]},"max":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","inactive","max"],"additionalProperties":false},"extraParameters":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}]},"max":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","max"],"additionalProperties":false},"fileStorageBytes":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}]},"max":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","max"],"additionalProperties":false},"maxProductRevisions":{"anyOf":[{"type":"number"},{"type":"null"}]},"maxFileRevisions":{"anyOf":[{"type":"number"},{"type":"null"}]},"maxFileRevisionDays":{"anyOf":[{"type":"number"},{"type":"null"}]},"maxTempFilesStorageDays":{"anyOf":[{"type":"number"},{"type":"null"}]},"maxExternalFilesStorageDays":{"anyOf":[{"type":"number"},{"type":"null"}]},"maxTempTrashStorageDays":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["tier1Users","tier2Users","products","modularProducts","componentProducts","sharedProducts","extraParameters","fileStorageBytes","maxProductRevisions","maxFileRevisions","maxFileRevisionDays","maxTempFilesStorageDays","maxExternalFilesStorageDays","maxTempTrashStorageDays"],"additionalProperties":false,"description":"Plan limits with current consumption."}},"required":["customerId","customerName","displayName","contact","logoUrl","languages","currencies","markets","priceRoundingType","publicPriceListGroups","theme","licence"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Customer (GET /v1/customer). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"contact":{"type":"object","properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["address","city","postcode","country","phone","website"],"additionalProperties":false},"logoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}},"required":["displayName","contact","logoUrl"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Update Customer Contact (PUT /v1/customer/contact). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerContactRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerContactRequest":{"type":"object","properties":{"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"contact":{"type":"object","properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["address","city","postcode","country","phone","website"],"additionalProperties":false}},"required":["displayName","contact"],"additionalProperties":false,"description":"Data schema used by Update Customer Contact (PUT /v1/customer/contact). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerMutation2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerMutation2":{"type":"object","properties":{"data":{"type":"object","properties":{"languages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"isDefault":{"type":"boolean"}},"required":["id","code","isDefault"],"additionalProperties":false}}},"required":["languages"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Update Customer Languages (PUT /v1/customer/languages). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerLanguagesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerLanguagesRequest":{"type":"object","properties":{"languages":{"minItems":1,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"code":{"type":"string","minLength":2,"maxLength":10,"description":"Language code to translate localized fields to (falls back if unavailable)."},"isDefault":{"type":"boolean"}},"required":["id","code","isDefault"],"additionalProperties":false}}},"required":["languages"],"additionalProperties":false,"description":"Data schema used by Update Customer Languages (PUT /v1/customer/languages). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerMutation3 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerMutation3":{"type":"object","properties":{"data":{"type":"object","properties":{"currencies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"name":{"type":"string"},"rate":{"type":"number"},"isDefault":{"type":"boolean"}},"required":["id","code","name","rate","isDefault"],"additionalProperties":false}},"markets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Configured market code."},"currencyId":{"type":"string"},"usedInMarketCostPrices":{"type":"boolean"}},"required":["id","currencyId","usedInMarketCostPrices"],"additionalProperties":false}},"priceRoundingType":{"type":"string"},"publicPriceListGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"priceListIds":{"type":"array","items":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"priceType":{"type":"string"},"vatType":{"type":"string","enum":["INCLUDED","EXCLUDED"]}},"required":["id","name","priceListIds","priceType","vatType"],"additionalProperties":false}}},"required":["currencies","markets","priceRoundingType","publicPriceListGroups"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Update Customer Pricing (PUT /v1/customer/pricing). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerPricingRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerPricingRequest":{"type":"object","properties":{"currencies":{"minItems":1,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"code":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"rate":{"type":"number"},"isDefault":{"type":"boolean"}},"required":["id","code","name","rate","isDefault"],"additionalProperties":false}},"markets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"description":"Configured market code."},"currencyId":{"type":"string","minLength":1}},"required":["id","currencyId"],"additionalProperties":false}},"priceRoundingType":{"type":"string","enum":["BEFORE","AFTER"]},"publicPriceListGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"priceListIds":{"type":"array","items":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"priceType":{"type":"string","minLength":1,"maxLength":255},"vatType":{"type":"string","enum":["INCLUDED","EXCLUDED"]}},"required":["id","name","priceListIds","priceType","vatType"],"additionalProperties":false}}},"required":["currencies","markets","priceRoundingType","publicPriceListGroups"],"additionalProperties":false,"description":"Data schema used by Update Customer Pricing (PUT /v1/customer/pricing). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerDimensions object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerDimensions":{"type":"object","properties":{"data":{"type":"object","properties":{"showWidthDimensions":{"type":"boolean"},"showHeightDimensions":{"type":"boolean"},"showDepthDimensions":{"type":"boolean"},"lockDimensionPosition":{"type":"boolean"},"lineColour":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"pillStyle":{"type":"string","enum":["DARK","LIGHT","CUSTOM"]},"pillBackgroundColour":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"pillStrokeColour":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"pillTextColour":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"heightOnOppositeSide":{"type":"boolean"},"units":{"minItems":1,"type":"array","items":{"type":"object","properties":{"unit":{"type":"string","enum":["MM","CM","M","IN","FT","FT-IN"]},"precision":{"type":"integer","minimum":0,"maximum":9007199254740991},"isDefault":{"type":"boolean"}},"required":["unit","precision"],"additionalProperties":false}},"lineOffset":{"type":"number"},"horizontalDimensionsBelowProduct":{"type":"boolean"},"widthLabelPosition":{"type":"string","enum":["AUTO","ABOVE","BELOW","LEFT","RIGHT","OPPOSITE_SIDE"]},"heightLabelPosition":{"type":"string","enum":["AUTO","ABOVE","BELOW","LEFT","RIGHT","OPPOSITE_SIDE"]},"depthLabelPosition":{"type":"string","enum":["AUTO","ABOVE","BELOW","LEFT","RIGHT","OPPOSITE_SIDE"]}},"required":["showWidthDimensions","showHeightDimensions","showDepthDimensions","lockDimensionPosition","lineColour","pillStyle","heightOnOppositeSide","units","horizontalDimensionsBelowProduct"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Customer Dimensions (GET /v1/customer/dimensions). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerDimensionsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerDimensionsRequest":{"type":"object","properties":{"showWidthDimensions":{"type":"boolean"},"showHeightDimensions":{"type":"boolean"},"showDepthDimensions":{"type":"boolean"},"lockDimensionPosition":{"type":"boolean"},"lineColour":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"pillStyle":{"type":"string","enum":["DARK","LIGHT","CUSTOM"]},"pillBackgroundColour":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"pillStrokeColour":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"pillTextColour":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"heightOnOppositeSide":{"type":"boolean"},"units":{"minItems":1,"type":"array","items":{"type":"object","properties":{"unit":{"type":"string","enum":["MM","CM","M","IN","FT","FT-IN"]},"precision":{"type":"integer","minimum":0,"maximum":9007199254740991},"isDefault":{"type":"boolean"}},"required":["unit","precision"],"additionalProperties":false}},"lineOffset":{"type":"number"},"horizontalDimensionsBelowProduct":{"type":"boolean"},"widthLabelPosition":{"type":"string","enum":["AUTO","ABOVE","BELOW","LEFT","RIGHT","OPPOSITE_SIDE"]},"heightLabelPosition":{"type":"string","enum":["AUTO","ABOVE","BELOW","LEFT","RIGHT","OPPOSITE_SIDE"]},"depthLabelPosition":{"type":"string","enum":["AUTO","ABOVE","BELOW","LEFT","RIGHT","OPPOSITE_SIDE"]}},"required":["showWidthDimensions","showHeightDimensions","showDepthDimensions","lockDimensionPosition","lineColour","pillStyle","heightOnOppositeSide","units"],"additionalProperties":false,"description":"Data schema used by Update Customer Dimensions (PUT /v1/customer/dimensions). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The OptionSetFilter object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"OptionSetFilter":{"type":"object","properties":{"id":{"type":"string","minLength":1},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnail":{"description":"URL of the thumbnail, as GET or the Files operations return it; a new one must be a file in your media library.","anyOf":[{"type":"string"},{"type":"null"}]},"previewType":{"anyOf":[{"type":"string","enum":["THUMBNAIL","COLOUR","NO_PREVIEW"]},{"type":"null"}]},"positionType":{"anyOf":[{"type":"string","enum":["ASSIGNED_TO_PARENT","NO_PARENT"]},{"type":"null"}]},"hideInUi":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"expanded":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"children":{"type":"array","items":{"$ref":"#/components/schemas/OptionSetFilterChild"}}},"required":["id"],"additionalProperties":{}},"OptionSetFilterChild":{"type":"object","properties":{"id":{"type":"string","minLength":1},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnail":{"description":"URL of the thumbnail, as GET or the Files operations return it; a new one must be a file in your media library.","anyOf":[{"type":"string"},{"type":"null"}]},"previewType":{"anyOf":[{"type":"string","enum":["THUMBNAIL","COLOUR","NO_PREVIEW"]},{"type":"null"}]},"positionType":{"anyOf":[{"type":"string","enum":["ASSIGNED_TO_PARENT","NO_PARENT"]},{"type":"null"}]},"hideInUi":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"expanded":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"children":{"anyOf":[{"maxItems":0,"type":"array","items":{}},{"type":"null"}]}},"required":["id"],"additionalProperties":{}}}}}
```

## The OptionSetFilterChild object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"OptionSetFilterChild":{"type":"object","properties":{"id":{"type":"string","minLength":1},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnail":{"description":"URL of the thumbnail, as GET or the Files operations return it; a new one must be a file in your media library.","anyOf":[{"type":"string"},{"type":"null"}]},"previewType":{"anyOf":[{"type":"string","enum":["THUMBNAIL","COLOUR","NO_PREVIEW"]},{"type":"null"}]},"positionType":{"anyOf":[{"type":"string","enum":["ASSIGNED_TO_PARENT","NO_PARENT"]},{"type":"null"}]},"hideInUi":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"expanded":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"children":{"anyOf":[{"maxItems":0,"type":"array","items":{}},{"type":"null"}]}},"required":["id"],"additionalProperties":{}}}}}
```

## The CustomerWidgets object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerWidgets":{"type":"object","properties":{"data":{"type":"object","properties":{"thumbnailsWidget":{"type":"object","properties":{"columns":{"anyOf":[{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"string","const":"AUTO"}]},{"type":"null"}],"description":"Number of thumbnail columns on desktop."},"mobileColumns":{"anyOf":[{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"string","const":"AUTO"}]},{"type":"null"}],"description":"Number of thumbnail columns on mobile."},"showCaption":{"type":"boolean","description":"Show a caption under each thumbnail; captions appear only with fewer than 4 columns."},"showKeyline":{"type":"boolean","description":"Show a keyline around each thumbnail."},"imageStyle":{"anyOf":[{"type":"string","enum":["SQUARE","ROUND"]},{"type":"null"}],"description":"Shape of the thumbnail images."}},"required":["columns","mobileColumns","showCaption","showKeyline","imageStyle"],"additionalProperties":false},"filtersWidget":{"type":"object","properties":{"columns":{"anyOf":[{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"string","const":"AUTO"}]},{"type":"null"}],"description":"Number of thumbnail columns on desktop."},"mobileColumns":{"anyOf":[{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"string","const":"AUTO"}]},{"type":"null"}],"description":"Number of thumbnail columns on mobile."},"showCaption":{"type":"boolean","description":"Show a caption under each thumbnail; captions appear only with fewer than 4 columns."},"showKeyline":{"type":"boolean","description":"Show a keyline around each thumbnail."},"imageStyle":{"anyOf":[{"type":"string","enum":["SQUARE","ROUND"]},{"type":"null"}],"description":"Shape of the thumbnail images."},"filterWidgetType":{"anyOf":[{"type":"string","enum":["COMPACT","EXPANDED"]},{"type":"null"}],"description":"`EXPANDED` shows the filters open; on mobile it also hides the filter button."},"showThumbnailsSearch":{"type":"boolean","description":"Show a search over the thumbnails."},"showSearchInModal":{"type":"boolean","description":"Show a search field in the filters modal."},"showPersonalFilterBar":{"type":"boolean","description":"Show the personal filter bar."},"filterDisplayMode":{"anyOf":[{"type":"string","enum":["EXPANDABLE","ALWAYS_VISIBLE"]},{"type":"null"}],"description":"`EXPANDABLE` lets filter groups collapse; `ALWAYS_VISIBLE` keeps them open."},"defaultFilterState":{"anyOf":[{"type":"string","enum":["ALL_CLOSE","ALL_OPEN","FIRST_OPEN"]},{"type":"null"}],"description":"Which filter groups start open when `filterDisplayMode` is `EXPANDABLE`."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/OptionSetFilter"}}},"required":["columns","mobileColumns","showCaption","showKeyline","imageStyle","filterWidgetType","showThumbnailsSearch","showSearchInModal","showPersonalFilterBar","filterDisplayMode","defaultFilterState","filters"],"additionalProperties":false}},"required":["thumbnailsWidget","filtersWidget"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Customer Widgets (GET /v1/customer/widgets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"OptionSetFilter":{"type":"object","properties":{"id":{"type":"string","minLength":1},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnail":{"description":"URL of the thumbnail, as GET or the Files operations return it; a new one must be a file in your media library.","anyOf":[{"type":"string"},{"type":"null"}]},"previewType":{"anyOf":[{"type":"string","enum":["THUMBNAIL","COLOUR","NO_PREVIEW"]},{"type":"null"}]},"positionType":{"anyOf":[{"type":"string","enum":["ASSIGNED_TO_PARENT","NO_PARENT"]},{"type":"null"}]},"hideInUi":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"expanded":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"children":{"type":"array","items":{"$ref":"#/components/schemas/OptionSetFilterChild"}}},"required":["id"],"additionalProperties":{}},"OptionSetFilterChild":{"type":"object","properties":{"id":{"type":"string","minLength":1},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnail":{"description":"URL of the thumbnail, as GET or the Files operations return it; a new one must be a file in your media library.","anyOf":[{"type":"string"},{"type":"null"}]},"previewType":{"anyOf":[{"type":"string","enum":["THUMBNAIL","COLOUR","NO_PREVIEW"]},{"type":"null"}]},"positionType":{"anyOf":[{"type":"string","enum":["ASSIGNED_TO_PARENT","NO_PARENT"]},{"type":"null"}]},"hideInUi":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"expanded":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"children":{"anyOf":[{"maxItems":0,"type":"array","items":{}},{"type":"null"}]}},"required":["id"],"additionalProperties":{}}}}}
```

## The CustomerWidgetsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerWidgetsRequest":{"type":"object","properties":{"thumbnailsWidget":{"type":"object","properties":{"columns":{"description":"Number of thumbnail columns on desktop.","anyOf":[{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"string","const":"AUTO"}]},{"type":"null"}]},"mobileColumns":{"description":"Number of thumbnail columns on mobile.","anyOf":[{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"string","const":"AUTO"}]},{"type":"null"}]},"showCaption":{"description":"Show a caption under each thumbnail; captions appear only with fewer than 4 columns.","type":"boolean"},"showKeyline":{"description":"Show a keyline around each thumbnail.","type":"boolean"},"imageStyle":{"description":"Shape of the thumbnail images.","anyOf":[{"type":"string","enum":["SQUARE","ROUND"]},{"type":"null"}]}},"additionalProperties":false},"filtersWidget":{"type":"object","properties":{"columns":{"description":"Number of thumbnail columns on desktop.","anyOf":[{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"string","const":"AUTO"}]},{"type":"null"}]},"mobileColumns":{"description":"Number of thumbnail columns on mobile.","anyOf":[{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"string","const":"AUTO"}]},{"type":"null"}]},"showCaption":{"description":"Show a caption under each thumbnail; captions appear only with fewer than 4 columns.","type":"boolean"},"showKeyline":{"description":"Show a keyline around each thumbnail.","type":"boolean"},"imageStyle":{"description":"Shape of the thumbnail images.","anyOf":[{"type":"string","enum":["SQUARE","ROUND"]},{"type":"null"}]},"filterWidgetType":{"description":"`EXPANDED` shows the filters open; on mobile it also hides the filter button.","anyOf":[{"type":"string","enum":["COMPACT","EXPANDED"]},{"type":"null"}]},"showThumbnailsSearch":{"description":"Show a search over the thumbnails.","type":"boolean"},"showSearchInModal":{"description":"Show a search field in the filters modal.","type":"boolean"},"showPersonalFilterBar":{"description":"Show the personal filter bar.","type":"boolean"},"filterDisplayMode":{"description":"`EXPANDABLE` lets filter groups collapse; `ALWAYS_VISIBLE` keeps them open.","anyOf":[{"type":"string","enum":["EXPANDABLE","ALWAYS_VISIBLE"]},{"type":"null"}]},"defaultFilterState":{"description":"Which filter groups start open when `filterDisplayMode` is `EXPANDABLE`.","anyOf":[{"type":"string","enum":["ALL_CLOSE","ALL_OPEN","FIRST_OPEN"]},{"type":"null"}]},"filters":{"type":"array","items":{"$ref":"#/components/schemas/OptionSetFilter"}}},"required":["filters"],"additionalProperties":false}},"required":["thumbnailsWidget","filtersWidget"],"additionalProperties":false,"description":"Data schema used by Update Customer Widgets (PUT /v1/customer/widgets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"OptionSetFilter":{"type":"object","properties":{"id":{"type":"string","minLength":1},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnail":{"description":"URL of the thumbnail, as GET or the Files operations return it; a new one must be a file in your media library.","anyOf":[{"type":"string"},{"type":"null"}]},"previewType":{"anyOf":[{"type":"string","enum":["THUMBNAIL","COLOUR","NO_PREVIEW"]},{"type":"null"}]},"positionType":{"anyOf":[{"type":"string","enum":["ASSIGNED_TO_PARENT","NO_PARENT"]},{"type":"null"}]},"hideInUi":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"expanded":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"children":{"type":"array","items":{"$ref":"#/components/schemas/OptionSetFilterChild"}}},"required":["id"],"additionalProperties":{}},"OptionSetFilterChild":{"type":"object","properties":{"id":{"type":"string","minLength":1},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"color":{"anyOf":[{"type":"string"},{"type":"null"}]},"thumbnail":{"description":"URL of the thumbnail, as GET or the Files operations return it; a new one must be a file in your media library.","anyOf":[{"type":"string"},{"type":"null"}]},"previewType":{"anyOf":[{"type":"string","enum":["THUMBNAIL","COLOUR","NO_PREVIEW"]},{"type":"null"}]},"positionType":{"anyOf":[{"type":"string","enum":["ASSIGNED_TO_PARENT","NO_PARENT"]},{"type":"null"}]},"hideInUi":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"expanded":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"children":{"anyOf":[{"maxItems":0,"type":"array","items":{}},{"type":"null"}]}},"required":["id"],"additionalProperties":{}}}}}
```

## The CustomerModularSceneAppearance object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerModularSceneAppearance":{"type":"object","properties":{"data":{"type":"object","properties":{"backgroundColorSource":{"type":"string","enum":["THEME_BACKGROUND","CUSTOM"]},"backgroundColor":{"description":"Required when `backgroundColorSource` is CUSTOM.","type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"outlineColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"ghostColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"},"canvasControls":{"type":"object","properties":{"shape":{"type":"string","enum":["CIRCLE","ROUNDED","SQUARE"]},"desktopSize":{"type":"string","enum":["SMALL","MEDIUM","LARGE"]},"mobileSize":{"type":"string","enum":["SMALL","MEDIUM","LARGE"]},"add":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"iconMode":{"type":"string","enum":["PREDEFINED","CUSTOM"]},"iconSymbol":{"type":"string","enum":["PLUS","PLUS_CIRCLE","PLUS_SQUARE","CHEVRON_SPREAD","ARROWS_MERGE","ARROWS_MIRROR","ARROWS_FIT","WARNING_MARK","WARNING_CIRCLE","WARNING_OCTAGON","WARNING_TRIANGLE","WARNING_SQUARE"]},"customIcon":{"description":"URL of the icon, as GET or the Files operations return it; the file must be in your media library. Required when `iconMode` is CUSTOM.","type":"string","minLength":1},"iconColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"border":{"type":"boolean"},"borderColor":{"description":"Required when `border` is true.","type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"}},"required":["backgroundColor","iconMode","iconSymbol","border"],"additionalProperties":false},"insert":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"iconMode":{"type":"string","enum":["PREDEFINED","CUSTOM"]},"iconSymbol":{"type":"string","enum":["PLUS","PLUS_CIRCLE","PLUS_SQUARE","CHEVRON_SPREAD","ARROWS_MERGE","ARROWS_MIRROR","ARROWS_FIT","WARNING_MARK","WARNING_CIRCLE","WARNING_OCTAGON","WARNING_TRIANGLE","WARNING_SQUARE"]},"customIcon":{"description":"URL of the icon, as GET or the Files operations return it; the file must be in your media library. Required when `iconMode` is CUSTOM.","type":"string","minLength":1},"iconColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"border":{"type":"boolean"},"borderColor":{"description":"Required when `border` is true.","type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"}},"required":["backgroundColor","iconMode","iconSymbol","border"],"additionalProperties":false},"warning":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"iconMode":{"type":"string","enum":["PREDEFINED","CUSTOM"]},"iconSymbol":{"type":"string","enum":["PLUS","PLUS_CIRCLE","PLUS_SQUARE","CHEVRON_SPREAD","ARROWS_MERGE","ARROWS_MIRROR","ARROWS_FIT","WARNING_MARK","WARNING_CIRCLE","WARNING_OCTAGON","WARNING_TRIANGLE","WARNING_SQUARE"]},"customIcon":{"description":"URL of the icon, as GET or the Files operations return it; the file must be in your media library. Required when `iconMode` is CUSTOM.","type":"string","minLength":1},"iconColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"border":{"type":"boolean"},"borderColor":{"description":"Required when `border` is true.","type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"}},"required":["backgroundColor","iconMode","iconSymbol","border"],"additionalProperties":false}},"required":["shape","desktopSize","mobileSize","add","insert","warning"],"additionalProperties":false}},"required":["backgroundColorSource","canvasControls"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Customer Modular Scene Appearance (GET /v1/customer/modular-scene-appearance). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerModularSceneAppearanceRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerModularSceneAppearanceRequest":{"type":"object","properties":{"backgroundColorSource":{"type":"string","enum":["THEME_BACKGROUND","CUSTOM"]},"backgroundColor":{"description":"Required when `backgroundColorSource` is CUSTOM.","type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"outlineColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"ghostColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"},"canvasControls":{"type":"object","properties":{"shape":{"type":"string","enum":["CIRCLE","ROUNDED","SQUARE"]},"desktopSize":{"type":"string","enum":["SMALL","MEDIUM","LARGE"]},"mobileSize":{"type":"string","enum":["SMALL","MEDIUM","LARGE"]},"add":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"iconMode":{"type":"string","enum":["PREDEFINED","CUSTOM"]},"iconSymbol":{"type":"string","enum":["PLUS","PLUS_CIRCLE","PLUS_SQUARE","CHEVRON_SPREAD","ARROWS_MERGE","ARROWS_MIRROR","ARROWS_FIT","WARNING_MARK","WARNING_CIRCLE","WARNING_OCTAGON","WARNING_TRIANGLE","WARNING_SQUARE"]},"customIcon":{"description":"URL of the icon, as GET or the Files operations return it; the file must be in your media library. Required when `iconMode` is CUSTOM.","type":"string","minLength":1},"iconColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"border":{"type":"boolean"},"borderColor":{"description":"Required when `border` is true.","type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"}},"required":["backgroundColor","iconMode","iconSymbol","border"],"additionalProperties":false},"insert":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"iconMode":{"type":"string","enum":["PREDEFINED","CUSTOM"]},"iconSymbol":{"type":"string","enum":["PLUS","PLUS_CIRCLE","PLUS_SQUARE","CHEVRON_SPREAD","ARROWS_MERGE","ARROWS_MIRROR","ARROWS_FIT","WARNING_MARK","WARNING_CIRCLE","WARNING_OCTAGON","WARNING_TRIANGLE","WARNING_SQUARE"]},"customIcon":{"description":"URL of the icon, as GET or the Files operations return it; the file must be in your media library. Required when `iconMode` is CUSTOM.","type":"string","minLength":1},"iconColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"border":{"type":"boolean"},"borderColor":{"description":"Required when `border` is true.","type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"}},"required":["backgroundColor","iconMode","iconSymbol","border"],"additionalProperties":false},"warning":{"type":"object","properties":{"backgroundColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"iconMode":{"type":"string","enum":["PREDEFINED","CUSTOM"]},"iconSymbol":{"type":"string","enum":["PLUS","PLUS_CIRCLE","PLUS_SQUARE","CHEVRON_SPREAD","ARROWS_MERGE","ARROWS_MIRROR","ARROWS_FIT","WARNING_MARK","WARNING_CIRCLE","WARNING_OCTAGON","WARNING_TRIANGLE","WARNING_SQUARE"]},"customIcon":{"description":"URL of the icon, as GET or the Files operations return it; the file must be in your media library. Required when `iconMode` is CUSTOM.","type":"string","minLength":1},"iconColor":{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},"border":{"type":"boolean"},"borderColor":{"description":"Required when `border` is true.","type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"}},"required":["backgroundColor","iconMode","iconSymbol","border"],"additionalProperties":false}},"required":["shape","desktopSize","mobileSize","add","insert","warning"],"additionalProperties":false}},"required":["backgroundColorSource","canvasControls"],"additionalProperties":false,"description":"Data schema used by Update Customer Modular Scene Appearance (PUT /v1/customer/modular-scene-appearance). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerPriceTypes object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerPriceTypes":{"type":"object","properties":{"data":{"type":"object","properties":{"internalUserTranslations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string","enum":["RRP","SALE","COST","BLANK"]},"label":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"isActive":{"type":"boolean"},"isDefaultPriceType":{"type":"boolean"}},"required":["id","type","label","isActive","isDefaultPriceType"],"additionalProperties":false}},"partnerUserDefaultSettings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string","enum":["RRP","SALE","COST","BLANK"]},"label":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"isActive":{"type":"boolean"},"isDefaultPriceType":{"type":"boolean"}},"required":["id","type","label","isActive","isDefaultPriceType"],"additionalProperties":false}}},"required":["internalUserTranslations","partnerUserDefaultSettings"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Customer Price Types (GET /v1/customer/price-types). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerPriceTypesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerPriceTypesRequest":{"type":"object","properties":{"internalUserTranslations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string","enum":["RRP","SALE","COST","BLANK"]},"label":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"isActive":{"type":"boolean"},"isDefaultPriceType":{"type":"boolean"}},"required":["id","type","label","isActive","isDefaultPriceType"],"additionalProperties":false}},"partnerUserDefaultSettings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string","enum":["RRP","SALE","COST","BLANK"]},"label":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"isActive":{"type":"boolean"},"isDefaultPriceType":{"type":"boolean"}},"required":["id","type","label","isActive","isDefaultPriceType"],"additionalProperties":false}}},"required":["internalUserTranslations","partnerUserDefaultSettings"],"additionalProperties":false,"description":"Data schema used by Update Customer Price Types (PUT /v1/customer/price-types). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CartPricingRule object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CartPricingRule":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"currency":{"type":"string","minLength":1},"scope":{"type":"string","enum":["ALL","PUBLIC","USER","COMPANY_GROUPS"]},"companyGroupIds":{"type":"array","items":{"type":"string","pattern":"^CG-[a-zA-Z0-9-]+$"}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"conditions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["CART_VALUE","CUSTOM_FIELD"]},"operator":{"type":"string","enum":["EQUAL","NOT_EQUAL","GREATER_THAN","LESS_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN_OR_EQUAL"]},"customFieldKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"string","minLength":1},{"type":"number"},{"type":"array","items":{"type":"string","minLength":1}}]}},"required":["type"],"additionalProperties":false}},"actionGroups":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","enum":["ALL","MIN","MAX"]},"type":{"type":"string","enum":["DISCOUNT","ADDITION"]},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"description":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"actions":{"type":"array","items":{"type":"object","properties":{"mode":{"type":"string","enum":["PERCENTAGE","FIXED"]},"value":{"type":"number"}},"required":["mode","value"],"additionalProperties":false}}},"required":["scope","type","name"],"additionalProperties":false}}},"required":["name"],"additionalProperties":false}}},"required":["id","name","currency","scope"],"additionalProperties":false}}}}
```

## The CustomerCart object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerCart":{"type":"object","properties":{"data":{"type":"object","properties":{"formSettings":{"type":"object","propertyNames":{"type":"string","minLength":1},"additionalProperties":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"position":{"description":"Order of the field on the submission form; lower positions come first.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["status"],"additionalProperties":false}},"forwardMails":{"type":"array","items":{"type":"object","properties":{"email":{"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,}$"},"isReplyTo":{"type":"boolean"}},"required":["email"],"additionalProperties":false}},"formOptions":{"type":"object","properties":{"autoCreateNewContact":{"type":"boolean"},"sendConfirmationEmailToSubmitter":{"type":"boolean"},"confirmEmailRequired":{"type":"boolean"}},"additionalProperties":false},"emailAndPdfLabels":{"type":"object","properties":{"contactDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"contactUs":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"discount":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"quantity":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"shortCode":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"sku":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"unitPrice":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"orderConfirmation":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"subTotal":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"totalPrice":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"visitWebsite":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"reference":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"productNote":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"viewOrder":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"page":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"pageOf":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"additionalProperties":false},"pricingRules":{"type":"array","items":{"$ref":"#/components/schemas/CartPricingRule"}},"mainSettings":{"type":"object","properties":{"submissionDisplayName":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"websiteUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"contactUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"viewOnlineUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["submissionDisplayName","logoUrl","websiteUrl","contactUrl","viewOnlineUrl"],"additionalProperties":false},"emailAndPdfContent":{"type":"object","properties":{"submitterSubject":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"receiverSubject":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"submitterHeader":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"receiverHeader":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"pdfHeader":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"submitterBody":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"receiverBody":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"pdfBody":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"submitterExitText":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"pdfExitText":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]}},"required":["submitterSubject","receiverSubject","submitterHeader","receiverHeader","pdfHeader","submitterBody","receiverBody","pdfBody","submitterExitText","pdfExitText"],"additionalProperties":false}},"required":["formSettings","forwardMails","formOptions","emailAndPdfLabels","pricingRules","mainSettings","emailAndPdfContent"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Customer Cart (GET /v1/customer/cart). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"CartPricingRule":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"currency":{"type":"string","minLength":1},"scope":{"type":"string","enum":["ALL","PUBLIC","USER","COMPANY_GROUPS"]},"companyGroupIds":{"type":"array","items":{"type":"string","pattern":"^CG-[a-zA-Z0-9-]+$"}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"conditions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["CART_VALUE","CUSTOM_FIELD"]},"operator":{"type":"string","enum":["EQUAL","NOT_EQUAL","GREATER_THAN","LESS_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN_OR_EQUAL"]},"customFieldKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"string","minLength":1},{"type":"number"},{"type":"array","items":{"type":"string","minLength":1}}]}},"required":["type"],"additionalProperties":false}},"actionGroups":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","enum":["ALL","MIN","MAX"]},"type":{"type":"string","enum":["DISCOUNT","ADDITION"]},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"description":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"actions":{"type":"array","items":{"type":"object","properties":{"mode":{"type":"string","enum":["PERCENTAGE","FIXED"]},"value":{"type":"number"}},"required":["mode","value"],"additionalProperties":false}}},"required":["scope","type","name"],"additionalProperties":false}}},"required":["name"],"additionalProperties":false}}},"required":["id","name","currency","scope"],"additionalProperties":false}}}}
```

## The CustomerCartRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerCartRequest":{"type":"object","properties":{"formSettings":{"type":"object","propertyNames":{"type":"string","minLength":1},"additionalProperties":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"position":{"description":"Order of the field on the submission form; lower positions come first.","type":"integer","minimum":0,"maximum":9007199254740991}},"required":["status"],"additionalProperties":false}},"forwardMails":{"type":"array","items":{"type":"object","properties":{"email":{"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,}$"},"isReplyTo":{"type":"boolean"}},"required":["email"],"additionalProperties":false}},"formOptions":{"type":"object","properties":{"autoCreateNewContact":{"type":"boolean"},"sendConfirmationEmailToSubmitter":{"type":"boolean"},"confirmEmailRequired":{"type":"boolean"}},"additionalProperties":false},"emailAndPdfLabels":{"type":"object","properties":{"contactDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"contactUs":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"discount":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"quantity":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"shortCode":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"sku":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"unitPrice":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"orderConfirmation":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"subTotal":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"totalPrice":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"visitWebsite":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"reference":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"productNote":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"viewOrder":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"page":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"pageOf":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"additionalProperties":false},"pricingRules":{"type":"array","items":{"$ref":"#/components/schemas/CartPricingRule"}},"mainSettings":{"type":"object","properties":{"submissionDisplayName":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"logoUrl":{"description":"URL of the email logo, as GET or the Files operations return it; the file must be in your media library. `null` removes the logo; omitted keeps it.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"websiteUrl":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"contactUrl":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"viewOnlineUrl":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"additionalProperties":false},"emailAndPdfContent":{"type":"object","properties":{"submitterSubject":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"receiverSubject":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"submitterHeader":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"receiverHeader":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"pdfHeader":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"submitterBody":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"receiverBody":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"pdfBody":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"submitterExitText":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"pdfExitText":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]}},"additionalProperties":false}},"required":["formSettings","forwardMails","formOptions","emailAndPdfLabels","pricingRules","mainSettings"],"additionalProperties":false,"description":"Data schema used by Update Customer Cart (PUT /v1/customer/cart). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"CartPricingRule":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"currency":{"type":"string","minLength":1},"scope":{"type":"string","enum":["ALL","PUBLIC","USER","COMPANY_GROUPS"]},"companyGroupIds":{"type":"array","items":{"type":"string","pattern":"^CG-[a-zA-Z0-9-]+$"}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"conditions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["CART_VALUE","CUSTOM_FIELD"]},"operator":{"type":"string","enum":["EQUAL","NOT_EQUAL","GREATER_THAN","LESS_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN_OR_EQUAL"]},"customFieldKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"string","minLength":1},{"type":"number"},{"type":"array","items":{"type":"string","minLength":1}}]}},"required":["type"],"additionalProperties":false}},"actionGroups":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","enum":["ALL","MIN","MAX"]},"type":{"type":"string","enum":["DISCOUNT","ADDITION"]},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"description":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},"actions":{"type":"array","items":{"type":"object","properties":{"mode":{"type":"string","enum":["PERCENTAGE","FIXED"]},"value":{"type":"number"}},"required":["mode","value"],"additionalProperties":false}}},"required":["scope","type","name"],"additionalProperties":false}}},"required":["name"],"additionalProperties":false}}},"required":["id","name","currency","scope"],"additionalProperties":false}}}}
```

## The CustomerMutation4 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerMutation4":{"type":"object","properties":{"data":{"type":"object","properties":{"exportObjType":{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED_TO"]},"backgroundColor":{"type":"string"},"accentColor":{"type":"string"},"isWhiteButtonText":{"type":"boolean"},"hotSpots":{"type":"object","properties":{"color":{"type":"string"},"borderColor":{"type":"string"}},"additionalProperties":false},"groupStyle":{"type":"string"},"group":{"type":"object","properties":{"activeColor":{"type":"string"},"hoverColor":{"type":"string"},"openedGroupTextColor":{"type":"string","enum":["BLACK","WHITE"]},"hoverGroupTextColor":{"type":"string"}},"required":["openedGroupTextColor"],"additionalProperties":false},"quickIcons":{"type":"object","properties":{"mobile":{"type":"array","items":{"type":"string"}},"desktop":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"modularQuickIcons":{"type":"array","items":{"type":"string"}},"mesh":{"type":"object","properties":{"overlay":{"type":"string"}},"additionalProperties":false}},"required":["exportObjType","backgroundColor","accentColor","isWhiteButtonText","hotSpots","groupStyle","group","quickIcons","modularQuickIcons","mesh"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Update Customer Theme (PUT /v1/customer/theme). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerThemeRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerThemeRequest":{"type":"object","properties":{"exportObjType":{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED_TO"]},"backgroundColor":{"type":"string","minLength":1},"accentColor":{"type":"string","minLength":1},"isWhiteButtonText":{"type":"boolean"},"hotSpots":{"type":"object","properties":{"color":{"type":"string","minLength":1},"borderColor":{"type":"string","minLength":1}},"additionalProperties":false},"groupStyle":{"type":"string"},"group":{"type":"object","properties":{"activeColor":{"type":"string","minLength":1},"hoverColor":{"type":"string","minLength":1},"openedGroupTextColor":{"type":"string","enum":["BLACK","WHITE"]},"hoverGroupTextColor":{"type":"string","minLength":1}},"required":["openedGroupTextColor"],"additionalProperties":false},"quickIcons":{"type":"object","properties":{"mobile":{"type":"array","items":{"type":"string"}},"desktop":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"modularQuickIcons":{"type":"array","items":{"type":"string"}},"mesh":{"type":"object","properties":{"overlay":{"type":"string","minLength":1}},"additionalProperties":false}},"required":["exportObjType","backgroundColor","accentColor","isWhiteButtonText","hotSpots","groupStyle","group","quickIcons","modularQuickIcons","mesh"],"additionalProperties":false,"description":"Data schema used by Update Customer Theme (PUT /v1/customer/theme). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerUsage object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerUsage":{"type":"object","properties":{"data":{"type":"object","properties":{"usageAlerts":{"type":"object","properties":{"predicted":{"type":"boolean"},"full":{"type":"boolean"},"custom":{"type":"boolean"},"customAlertValue":{"type":"number"}},"required":["predicted","full","custom"],"additionalProperties":false},"alertRecipientUserIds":{"type":"array","items":{"type":"string"}},"limits":{"type":"object","properties":{"currentMonthlyLimit":{"type":"number"},"configurators":{"type":"object","properties":{"current":{"type":"number"},"max":{"type":"number"},"inactive":{"type":"number"}},"required":["current","max","inactive"],"additionalProperties":false},"modularConfigurators":{"type":"object","properties":{"current":{"type":"number"},"max":{"type":"number"},"inactive":{"type":"number"}},"required":["current","max","inactive"],"additionalProperties":false},"modularComponents":{"type":"object","properties":{"current":{"type":"number"},"max":{"type":"number"},"inactive":{"type":"number"}},"required":["current","max","inactive"],"additionalProperties":false},"sharedConfigurators":{"type":"object","properties":{"current":{"type":"number"},"max":{"type":"number"},"inactive":{"type":"number"}},"required":["current","max","inactive"],"additionalProperties":false},"customFieldsAndSets":{"type":"object","properties":{"current":{"type":"number"},"max":{"type":"number"},"inactive":{"type":"number"}},"required":["current","max","inactive"],"additionalProperties":false},"partners":{"type":"object","properties":{"current":{"type":"number"},"max":{"type":"number"}},"required":["current","max"],"additionalProperties":false}},"required":["currentMonthlyLimit","configurators","modularConfigurators","modularComponents","sharedConfigurators","customFieldsAndSets","partners"],"additionalProperties":false}},"required":["usageAlerts","alertRecipientUserIds","limits"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Customer Usage (GET /v1/customer/usage). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomerSessions object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomerSessions":{"type":"object","properties":{"data":{"type":"object","properties":{"months":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string"},"standard":{"type":"number"},"modular":{"type":"number"},"total":{"type":"number"},"remaining":{"type":"number"},"extraUsed":{"type":"number"},"isModularMultiplier":{"type":"boolean"}},"required":["month","standard","modular","total","remaining","extraUsed","isModularMultiplier"],"additionalProperties":false}}},"required":["months"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Customer Sessions (GET /v1/customer/sessions). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomFieldsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomFieldsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parameterId":{"type":"string","pattern":"^PARAM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"resourceType":{"type":"string","enum":["OPTION_SET","CART","PRODUCT_DATA_GRID"],"description":"The resource whose records carry this custom field."},"key":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"type":{"type":"string","enum":["TEXT","NUMBER","TRANSLATABLE_TEXT","MULTI_LINE_TRANSLATABLE_TEXT","CHECKBOX","SINGLE_SELECT","MULTI_LINE_TEXT","FILE","META_OBJECT"]},"source":{"type":"string","enum":["SYSTEM","CUSTOM"]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"validationConfig":{"type":"object","properties":{"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"decimalPlaces":{"type":"integer","minimum":0,"maximum":9007199254740991},"regexExpression":{"type":"string"},"validationMessage":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"isRequired":{"type":"boolean"},"isUnique":{"type":"boolean"},"showOnFrontend":{"type":"boolean"}},"additionalProperties":false},"typeConfig":{"anyOf":[{"type":"object","properties":{"checkboxContent":{"type":"object","properties":{"showInFooter":{"type":"boolean"},"content":{},"checkedLabel":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"uncheckedLabel":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."}},"required":["content","checkedLabel","uncheckedLabel"],"additionalProperties":false},"selectOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"value":{"type":"string"}},"required":["id","name","value"],"additionalProperties":false}},"fileContent":{"type":"object","properties":{"fileLimit":{"type":"string","enum":["SINGLE_FILE","MULTIPLE_FILE"]},"minFiles":{"type":"number"},"maxFiles":{"type":"number"},"fileTypes":{"type":"object","properties":{"acceptAllFileTypes":{"type":"boolean"},"images":{"type":"boolean"},"videos":{"type":"boolean"},"documents":{"type":"boolean"},"archives":{"type":"boolean"}},"additionalProperties":false},"fileExceptions":{"type":"object","properties":{"allowAdditionalFileTypes":{"type":"array","items":{"type":"string"}},"blockSpecificFileTypes":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["fileLimit"],"additionalProperties":false},"metaObjectContent":{"type":"array","items":{"type":"object","properties":{"parameterId":{"type":"string","pattern":"^PARAM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"key":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9-_]+$"},"type":{"type":"string","enum":["TEXT","NUMBER","TRANSLATABLE_TEXT","MULTI_LINE_TRANSLATABLE_TEXT","CHECKBOX","SINGLE_SELECT","MULTI_LINE_TEXT","FILE"]},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"validationConfig":{"type":"object","properties":{"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"decimalPlaces":{"type":"integer","minimum":0,"maximum":9007199254740991},"regexExpression":{"type":"string"},"validationMessage":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"isRequired":{"type":"boolean"},"isUnique":{"type":"boolean"},"showOnFrontend":{"type":"boolean"}},"additionalProperties":false},"typeConfig":{"type":"object","properties":{"checkboxContent":{"type":"object","properties":{"showInFooter":{"type":"boolean"},"content":{},"checkedLabel":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"uncheckedLabel":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."}},"required":["content","checkedLabel","uncheckedLabel"],"additionalProperties":false},"selectOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"value":{"type":"string"}},"required":["id","name","value"],"additionalProperties":false}},"fileContent":{"type":"object","properties":{"fileLimit":{"type":"string","enum":["SINGLE_FILE","MULTIPLE_FILE"]},"minFiles":{"type":"number"},"maxFiles":{"type":"number"},"fileTypes":{"type":"object","properties":{"acceptAllFileTypes":{"type":"boolean"},"images":{"type":"boolean"},"videos":{"type":"boolean"},"documents":{"type":"boolean"},"archives":{"type":"boolean"}},"additionalProperties":false},"fileExceptions":{"type":"object","properties":{"allowAdditionalFileTypes":{"type":"array","items":{"type":"string"}},"blockSpecificFileTypes":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["fileLimit"],"additionalProperties":false}},"additionalProperties":false}},"required":["parameterId","key","type","name","validationConfig"],"additionalProperties":false}}},"additionalProperties":false},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["parameterId","resourceType","key","name","description","type","source","status","validationConfig","typeConfig","createdAt","modifiedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Custom Fields (GET /v1/custom-fields). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomFieldsMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomFieldsMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"parameterId":{"type":"string","pattern":"^PARAM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"resourceType":{"type":"string","enum":["OPTION_SET","CART","PRODUCT_DATA_GRID"],"description":"The resource whose records carry this custom field."},"key":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"type":{"type":"string","enum":["TEXT","NUMBER","TRANSLATABLE_TEXT","MULTI_LINE_TRANSLATABLE_TEXT","CHECKBOX","SINGLE_SELECT","MULTI_LINE_TEXT","FILE","META_OBJECT"]},"source":{"type":"string","enum":["SYSTEM","CUSTOM"]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"validationConfig":{"type":"object","properties":{"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"decimalPlaces":{"type":"integer","minimum":0,"maximum":9007199254740991},"regexExpression":{"type":"string"},"validationMessage":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"isRequired":{"type":"boolean"},"isUnique":{"type":"boolean"},"showOnFrontend":{"type":"boolean"}},"additionalProperties":false},"typeConfig":{"anyOf":[{"type":"object","properties":{"checkboxContent":{"type":"object","properties":{"showInFooter":{"type":"boolean"},"content":{},"checkedLabel":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"uncheckedLabel":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."}},"required":["content","checkedLabel","uncheckedLabel"],"additionalProperties":false},"selectOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"value":{"type":"string"}},"required":["id","name","value"],"additionalProperties":false}},"fileContent":{"type":"object","properties":{"fileLimit":{"type":"string","enum":["SINGLE_FILE","MULTIPLE_FILE"]},"minFiles":{"type":"number"},"maxFiles":{"type":"number"},"fileTypes":{"type":"object","properties":{"acceptAllFileTypes":{"type":"boolean"},"images":{"type":"boolean"},"videos":{"type":"boolean"},"documents":{"type":"boolean"},"archives":{"type":"boolean"}},"additionalProperties":false},"fileExceptions":{"type":"object","properties":{"allowAdditionalFileTypes":{"type":"array","items":{"type":"string"}},"blockSpecificFileTypes":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["fileLimit"],"additionalProperties":false},"metaObjectContent":{"type":"array","items":{"type":"object","properties":{"parameterId":{"type":"string","pattern":"^PARAM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"key":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9-_]+$"},"type":{"type":"string","enum":["TEXT","NUMBER","TRANSLATABLE_TEXT","MULTI_LINE_TRANSLATABLE_TEXT","CHECKBOX","SINGLE_SELECT","MULTI_LINE_TEXT","FILE"]},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"validationConfig":{"type":"object","properties":{"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"decimalPlaces":{"type":"integer","minimum":0,"maximum":9007199254740991},"regexExpression":{"type":"string"},"validationMessage":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"isRequired":{"type":"boolean"},"isUnique":{"type":"boolean"},"showOnFrontend":{"type":"boolean"}},"additionalProperties":false},"typeConfig":{"type":"object","properties":{"checkboxContent":{"type":"object","properties":{"showInFooter":{"type":"boolean"},"content":{},"checkedLabel":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"uncheckedLabel":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."}},"required":["content","checkedLabel","uncheckedLabel"],"additionalProperties":false},"selectOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"value":{"type":"string"}},"required":["id","name","value"],"additionalProperties":false}},"fileContent":{"type":"object","properties":{"fileLimit":{"type":"string","enum":["SINGLE_FILE","MULTIPLE_FILE"]},"minFiles":{"type":"number"},"maxFiles":{"type":"number"},"fileTypes":{"type":"object","properties":{"acceptAllFileTypes":{"type":"boolean"},"images":{"type":"boolean"},"videos":{"type":"boolean"},"documents":{"type":"boolean"},"archives":{"type":"boolean"}},"additionalProperties":false},"fileExceptions":{"type":"object","properties":{"allowAdditionalFileTypes":{"type":"array","items":{"type":"string"}},"blockSpecificFileTypes":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["fileLimit"],"additionalProperties":false}},"additionalProperties":false}},"required":["parameterId","key","type","name","validationConfig"],"additionalProperties":false}}},"additionalProperties":false},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["parameterId","resourceType","key","name","description","type","source","status","validationConfig","typeConfig","createdAt","modifiedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Custom Field (POST /v1/custom-fields). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomFieldsCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomFieldsCreateRequest":{"type":"object","properties":{"resourceType":{"type":"string","enum":["OPTION_SET","CART","PRODUCT_DATA_GRID"],"description":"The resource whose records carry this custom field."},"key":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9-_]+$"},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"description":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"type":{"type":"string","enum":["TEXT","NUMBER","TRANSLATABLE_TEXT","MULTI_LINE_TRANSLATABLE_TEXT","CHECKBOX","SINGLE_SELECT","MULTI_LINE_TEXT","FILE","META_OBJECT"]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"validationConfig":{"type":"object","properties":{"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"decimalPlaces":{"type":"integer","minimum":0,"maximum":9007199254740991},"regexExpression":{"type":"string"},"validationMessage":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"isRequired":{"type":"boolean"},"isUnique":{"type":"boolean"},"showOnFrontend":{"type":"boolean"}},"additionalProperties":false},"typeConfig":{"type":"object","properties":{"checkboxContent":{"type":"object","properties":{"showInFooter":{"type":"boolean"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"checkedLabel":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"uncheckedLabel":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["content","checkedLabel","uncheckedLabel"],"additionalProperties":false},"selectOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"value":{"type":"string","pattern":"^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$"}},"required":["name","value"],"additionalProperties":false}},"fileContent":{"type":"object","properties":{"fileLimit":{"type":"string","enum":["SINGLE_FILE","MULTIPLE_FILE"]},"minFiles":{"type":"number"},"maxFiles":{"type":"number"},"fileTypes":{"type":"object","properties":{"acceptAllFileTypes":{"type":"boolean"},"images":{"type":"boolean"},"videos":{"type":"boolean"},"documents":{"type":"boolean"},"archives":{"type":"boolean"}},"additionalProperties":false},"fileExceptions":{"type":"object","properties":{"allowAdditionalFileTypes":{"type":"array","items":{"type":"string"}},"blockSpecificFileTypes":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["fileLimit"],"additionalProperties":false},"metaObjectContent":{"type":"array","items":{"type":"object","properties":{"parameterId":{"type":"string","pattern":"^PARAM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"key":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9-_]+$"},"type":{"type":"string","enum":["TEXT","NUMBER","TRANSLATABLE_TEXT","MULTI_LINE_TRANSLATABLE_TEXT","CHECKBOX","SINGLE_SELECT","MULTI_LINE_TEXT","FILE"]},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"description":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"validationConfig":{"type":"object","properties":{"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"decimalPlaces":{"type":"integer","minimum":0,"maximum":9007199254740991},"regexExpression":{"type":"string"},"validationMessage":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"isRequired":{"type":"boolean"},"isUnique":{"type":"boolean"},"showOnFrontend":{"type":"boolean"}},"additionalProperties":false},"typeConfig":{"type":"object","properties":{"checkboxContent":{"type":"object","properties":{"showInFooter":{"type":"boolean"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"checkedLabel":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"uncheckedLabel":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["content","checkedLabel","uncheckedLabel"],"additionalProperties":false},"selectOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"value":{"type":"string","pattern":"^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$"}},"required":["name","value"],"additionalProperties":false}},"fileContent":{"type":"object","properties":{"fileLimit":{"type":"string","enum":["SINGLE_FILE","MULTIPLE_FILE"]},"minFiles":{"type":"number"},"maxFiles":{"type":"number"},"fileTypes":{"type":"object","properties":{"acceptAllFileTypes":{"type":"boolean"},"images":{"type":"boolean"},"videos":{"type":"boolean"},"documents":{"type":"boolean"},"archives":{"type":"boolean"}},"additionalProperties":false},"fileExceptions":{"type":"object","properties":{"allowAdditionalFileTypes":{"type":"array","items":{"type":"string"}},"blockSpecificFileTypes":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["fileLimit"],"additionalProperties":false}},"additionalProperties":false}},"required":["parameterId","key","type","name","validationConfig"],"additionalProperties":false}}},"additionalProperties":false}},"required":["resourceType","key","name","type","validationConfig"],"additionalProperties":false,"description":"Data schema used by Create Custom Field (POST /v1/custom-fields). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CustomFieldsUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CustomFieldsUpdateRequest":{"type":"object","properties":{"resourceType":{"type":"string","enum":["OPTION_SET","CART","PRODUCT_DATA_GRID"],"description":"The resource whose records carry this custom field."},"key":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9-_]+$"},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"description":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"type":{"type":"string","enum":["TEXT","NUMBER","TRANSLATABLE_TEXT","MULTI_LINE_TRANSLATABLE_TEXT","CHECKBOX","SINGLE_SELECT","MULTI_LINE_TEXT","FILE","META_OBJECT"]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"validationConfig":{"type":"object","properties":{"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"decimalPlaces":{"type":"integer","minimum":0,"maximum":9007199254740991},"regexExpression":{"type":"string"},"validationMessage":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"isRequired":{"type":"boolean"},"isUnique":{"type":"boolean"},"showOnFrontend":{"type":"boolean"}},"additionalProperties":false},"typeConfig":{"type":"object","properties":{"checkboxContent":{"type":"object","properties":{"showInFooter":{"type":"boolean"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"checkedLabel":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"uncheckedLabel":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["content","checkedLabel","uncheckedLabel"],"additionalProperties":false},"selectOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"value":{"type":"string","pattern":"^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$"}},"required":["name","value"],"additionalProperties":false}},"fileContent":{"type":"object","properties":{"fileLimit":{"type":"string","enum":["SINGLE_FILE","MULTIPLE_FILE"]},"minFiles":{"type":"number"},"maxFiles":{"type":"number"},"fileTypes":{"type":"object","properties":{"acceptAllFileTypes":{"type":"boolean"},"images":{"type":"boolean"},"videos":{"type":"boolean"},"documents":{"type":"boolean"},"archives":{"type":"boolean"}},"additionalProperties":false},"fileExceptions":{"type":"object","properties":{"allowAdditionalFileTypes":{"type":"array","items":{"type":"string"}},"blockSpecificFileTypes":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["fileLimit"],"additionalProperties":false},"metaObjectContent":{"type":"array","items":{"type":"object","properties":{"parameterId":{"type":"string","pattern":"^PARAM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"key":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9-_]+$"},"type":{"type":"string","enum":["TEXT","NUMBER","TRANSLATABLE_TEXT","MULTI_LINE_TRANSLATABLE_TEXT","CHECKBOX","SINGLE_SELECT","MULTI_LINE_TEXT","FILE"]},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"description":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"validationConfig":{"type":"object","properties":{"min":{"type":"number","minimum":0},"max":{"type":"number","minimum":0},"decimalPlaces":{"type":"integer","minimum":0,"maximum":9007199254740991},"regexExpression":{"type":"string"},"validationMessage":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"isRequired":{"type":"boolean"},"isUnique":{"type":"boolean"},"showOnFrontend":{"type":"boolean"}},"additionalProperties":false},"typeConfig":{"type":"object","properties":{"checkboxContent":{"type":"object","properties":{"showInFooter":{"type":"boolean"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"checkedLabel":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"uncheckedLabel":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["content","checkedLabel","uncheckedLabel"],"additionalProperties":false},"selectOptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"value":{"type":"string","pattern":"^[a-z0-9]+[a-z0-9-]*[a-z0-9]+$"}},"required":["name","value"],"additionalProperties":false}},"fileContent":{"type":"object","properties":{"fileLimit":{"type":"string","enum":["SINGLE_FILE","MULTIPLE_FILE"]},"minFiles":{"type":"number"},"maxFiles":{"type":"number"},"fileTypes":{"type":"object","properties":{"acceptAllFileTypes":{"type":"boolean"},"images":{"type":"boolean"},"videos":{"type":"boolean"},"documents":{"type":"boolean"},"archives":{"type":"boolean"}},"additionalProperties":false},"fileExceptions":{"type":"object","properties":{"allowAdditionalFileTypes":{"type":"array","items":{"type":"string"}},"blockSpecificFileTypes":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["fileLimit"],"additionalProperties":false}},"additionalProperties":false}},"required":["parameterId","key","type","name","validationConfig"],"additionalProperties":false}}},"additionalProperties":false}},"required":["resourceType","key","name","type","validationConfig"],"additionalProperties":false,"description":"Data schema used by Update Custom Field (PUT /v1/custom-fields/{parameterId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The UsersList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"UsersList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","pattern":"^USER-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"isBetaTester":{"type":"boolean"}},"required":["userId","firstName","lastName","email","status","isBetaTester"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Users (GET /v1/users). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The UsersDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"UsersDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"userId":{"type":"string","pattern":"^USER-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"isBetaTester":{"type":"boolean"}},"required":["userId","firstName","lastName","email","status","isBetaTester"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get User (GET /v1/users/{userId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The UsersMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"UsersMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"userId":{"type":"string","pattern":"^USER-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]}},"required":["userId","status"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Set User Status (PUT /v1/users/{userId}/status). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The UsersStatusRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"UsersStatusRequest":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]}},"required":["status"],"additionalProperties":false,"description":"Data schema used by Set User Status (PUT /v1/users/{userId}/status). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The UsersUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"UsersUpdateRequest":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255},"lastName":{"type":"string","minLength":1,"maxLength":255},"phoneNumber":{"description":"Omitted keeps the stored number; null clears it.","anyOf":[{"type":"string","minLength":1,"maxLength":50},{"type":"null"}]},"defaultUserLang":{"description":"The user's language in the Mimeeq app, one of the languages it offers; notifications are translated into it. Omitted keeps the stored language; a user without one is set to en.","enum":["en","ar","af","am","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","arn","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az-az-cyrl","az-az-latn","ba","be","bg","bn-bd","bn-in","bo","br","bs-ba-cyrl","bs-ba-latn","ca","co","cs","cy","da","de-at","de-ch","de","de-li","de-lu","dsb","dv","el","en-029","en-au","en-bz","en-ca","en-gb","en-ie","en-in","en-jm","en-my","en-nz","en-ph","en-sg","en-tt","en-us","en-za","en-zw","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-us","es-uy","es-ve","et","eu","fa","fi","fil","fo","fr-be","fr-ca","fr-ch","fr","fr-lu","fr-mc","fy","ga","gd","gl","gsw","gu","ha-ng-latn","he","hi","hr-ba","hr","hsb","hu","hy","id","ig","ii","is","it-ch","it","iu-ca-cans","iu-ca-latn","ja","ka","kk","kl","km","kn","kok","ko","ky","lb","lo","lt","lv","mi","mk","ml","mn","mn-cn-mong","moh","mr","ms-bn","ms","mt","nb","ne","nl-be","nl","nn","nso","oc","or","pa","pl","prs","ps","pt-br","pt","rm","ro","ru","rw","sah","sa","se-fi","se-no","se","si","sk","sl","sma-no","sma-se","smj-no","smj-se","smn","sms","sq","sr-ba-cyrl","sr-cs-cyrl","sr-me-cyrl","sr-rs-cyrl","sr-ba-latn","sr-cs-latn","sr-me-latn","sr-rs-latn","sv-fi","sv-se","sw","syr","ta","te","tg-tj-cyrl","th","tk","tn","tr","tt","ug","uk","ur","uz-uz-cyrl","uz-uz-latn","vi","wo","xh","yo","zh","zh-hk","zh-mo","zh-sg","zh-tw","zu"],"type":"string"}},"required":["firstName","lastName"],"additionalProperties":false,"description":"Data schema used by Update User (PUT /v1/users/{userId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The InvitationsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"InvitationsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"invitationId":{"type":"string","pattern":"^INV-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"email":{"type":"string"},"name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"defaultUserLang":{"anyOf":[{"type":"string"},{"type":"null"}]},"invitedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 invitation timestamp."}},"required":["invitationId","email","name","roles","defaultUserLang","invitedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Invitations (GET /v1/invitations). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The InvitationsMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"InvitationsMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"invitationId":{"anyOf":[{"type":"string","pattern":"^INV-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},{"type":"null"}]}},"required":["invitationId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Invitation (POST /v1/invitations). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The InvitationsCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"InvitationsCreateRequest":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string","minLength":1,"maxLength":255},"lastName":{"type":"string","minLength":1,"maxLength":255},"roleIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^ROLE-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"defaultUserLang":{"enum":["en","ar","af","am","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","arn","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az-az-cyrl","az-az-latn","ba","be","bg","bn-bd","bn-in","bo","br","bs-ba-cyrl","bs-ba-latn","ca","co","cs","cy","da","de-at","de-ch","de","de-li","de-lu","dsb","dv","el","en-029","en-au","en-bz","en-ca","en-gb","en-ie","en-in","en-jm","en-my","en-nz","en-ph","en-sg","en-tt","en-us","en-za","en-zw","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-us","es-uy","es-ve","et","eu","fa","fi","fil","fo","fr-be","fr-ca","fr-ch","fr","fr-lu","fr-mc","fy","ga","gd","gl","gsw","gu","ha-ng-latn","he","hi","hr-ba","hr","hsb","hu","hy","id","ig","ii","is","it-ch","it","iu-ca-cans","iu-ca-latn","ja","ka","kk","kl","km","kn","kok","ko","ky","lb","lo","lt","lv","mi","mk","ml","mn","mn-cn-mong","moh","mr","ms-bn","ms","mt","nb","ne","nl-be","nl","nn","nso","oc","or","pa","pl","prs","ps","pt-br","pt","rm","ro","ru","rw","sah","sa","se-fi","se-no","se","si","sk","sl","sma-no","sma-se","smj-no","smj-se","smn","sms","sq","sr-ba-cyrl","sr-cs-cyrl","sr-me-cyrl","sr-rs-cyrl","sr-ba-latn","sr-cs-latn","sr-me-latn","sr-rs-latn","sv-fi","sv-se","sw","syr","ta","te","tg-tj-cyrl","th","tk","tn","tr","tt","ug","uk","ur","uz-uz-cyrl","uz-uz-latn","vi","wo","xh","yo","zh","zh-hk","zh-mo","zh-sg","zh-tw","zu"],"description":"Language code for the invited user, one of the languages the Mimeeq app offers.","type":"string"}},"required":["email","firstName","lastName","roleIds","defaultUserLang"],"additionalProperties":false,"description":"Data schema used by Create Invitation (POST /v1/invitations). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The RolesList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"RolesList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"roleId":{"type":"string","pattern":"^ROLE-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"roleName":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"permissions":{"type":"array","items":{"type":"string"}}},"required":["roleId","roleName","status","permissions"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Roles (GET /v1/roles). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The RolesPermissions object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"RolesPermissions":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"},"group":{"type":"string"}},"required":["id","description","group"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Role Permissions (GET /v1/roles/permissions). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The RolesDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"RolesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"roleId":{"type":"string","pattern":"^ROLE-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"roleName":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"permissions":{"type":"array","items":{"type":"string"}},"userIds":{"type":"array","items":{"type":"string","pattern":"^USER-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 role creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 role last-modified timestamp."}},"required":["roleId","roleName","status","permissions","userIds","createdAt","modifiedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Role (POST /v1/roles). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The RolesCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"RolesCreateRequest":{"type":"object","properties":{"roleName":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"permissions":{"type":"array","items":{"type":"string","enum":["CONTACTS_VIEW","CONTACTS_CREATE_EDIT","CONTACTS_ASSIGN_TIER_2","COMPANIES_VIEW","COMPANIES_CREATE_EDIT","COMPANIES_MANAGE_NOTES","ORDERS_VIEW","ORDERS_CREATE_EDIT","CARTS_VIEW","QUOTATIONS_VIEW","QUOTATIONS_EDIT","PRODUCTS_OPTION_SETS_COLLECTIONS_VIEW","PRODUCTS_OPTION_SETS_COLLECTIONS_CREATE_EDIT","MEDIA_LIBRARY","GALLERIES","3D_MATERIALS","PRICING_ITEM_MASTER","PRICING_MCP_PRICE_LISTS","FULL_CUSTOMER_COMPANIES_ADD_PRICE_LISTS","CONTACTS_ADD_PERMISSIONS_TO_CONTACT","SETTINGS_USER_ROLES","AI_BILLING_MANAGE","SETTINGS_PRODUCT_CATEGORIES","SETTINGS_PRODUCT_GROUPS","SETTINGS_EMBED_TEMPLATES","SETTINGS_CUSTOM_UIS","SETTINGS_WEBHOOKS","SETTINGS_EXTRA_PARAMETERS","SETTINGS_COMPANY_GROUPS","MAIN_SETTINGS_NAME_ADDRESS","MAIN_SETTINGS_THEME","MAIN_SETTINGS_CURRENCIES","MAIN_SETTINGS_OPTION_SET_FILTERS","MAIN_SETTINGS_QUOTE_SETTINGS","MAIN_SETTINGS_LICENCES_VIEW","MAIN_SETTINGS_BASKET_CONFIG","MAIN_SETTINGS_ACCOUNT_SETTINGS","SETTINGS_ACCOUNT_DELETION_RIGHTS","MAIN_SETTINGS_DELETE_CUSTOMER","API_KEYS_MANAGE","MAIN_SETTINGS_LANGUAGES","MAIN_SETTINGS_PRICING","PRICING_RRP_VIEW","PRICING_SALE_VIEW","PRICING_COST_VIEW","PRICING_BLANK_VIEW","PRICING_COMPANY_EDIT","TRASH_PERMANENT_DELETION"]}},"userIds":{"type":"array","items":{"type":"string","pattern":"^USER-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}},"required":["roleName"],"additionalProperties":false,"description":"Data schema used by Create Role (POST /v1/roles). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The RolesUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"RolesUpdateRequest":{"type":"object","properties":{"roleName":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"permissions":{"type":"array","items":{"type":"string","enum":["CONTACTS_VIEW","CONTACTS_CREATE_EDIT","CONTACTS_ASSIGN_TIER_2","COMPANIES_VIEW","COMPANIES_CREATE_EDIT","COMPANIES_MANAGE_NOTES","ORDERS_VIEW","ORDERS_CREATE_EDIT","CARTS_VIEW","QUOTATIONS_VIEW","QUOTATIONS_EDIT","PRODUCTS_OPTION_SETS_COLLECTIONS_VIEW","PRODUCTS_OPTION_SETS_COLLECTIONS_CREATE_EDIT","MEDIA_LIBRARY","GALLERIES","3D_MATERIALS","PRICING_ITEM_MASTER","PRICING_MCP_PRICE_LISTS","FULL_CUSTOMER_COMPANIES_ADD_PRICE_LISTS","CONTACTS_ADD_PERMISSIONS_TO_CONTACT","SETTINGS_USER_ROLES","AI_BILLING_MANAGE","SETTINGS_PRODUCT_CATEGORIES","SETTINGS_PRODUCT_GROUPS","SETTINGS_EMBED_TEMPLATES","SETTINGS_CUSTOM_UIS","SETTINGS_WEBHOOKS","SETTINGS_EXTRA_PARAMETERS","SETTINGS_COMPANY_GROUPS","MAIN_SETTINGS_NAME_ADDRESS","MAIN_SETTINGS_THEME","MAIN_SETTINGS_CURRENCIES","MAIN_SETTINGS_OPTION_SET_FILTERS","MAIN_SETTINGS_QUOTE_SETTINGS","MAIN_SETTINGS_LICENCES_VIEW","MAIN_SETTINGS_BASKET_CONFIG","MAIN_SETTINGS_ACCOUNT_SETTINGS","SETTINGS_ACCOUNT_DELETION_RIGHTS","MAIN_SETTINGS_DELETE_CUSTOMER","API_KEYS_MANAGE","MAIN_SETTINGS_LANGUAGES","MAIN_SETTINGS_PRICING","PRICING_RRP_VIEW","PRICING_SALE_VIEW","PRICING_COST_VIEW","PRICING_BLANK_VIEW","PRICING_COMPANY_EDIT","TRASH_PERMANENT_DELETION"]}},"userIds":{"type":"array","items":{"type":"string","pattern":"^USER-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}},"additionalProperties":false,"description":"Data schema used by Update Role (PUT /v1/roles/{roleId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GlobalOptionSetsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GlobalOptionSetsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"optionSetId":{"type":"string","pattern":"^OPT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Global option set identifier (OPT-<uuid>)."},"name":{"type":"string"},"displayName":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"description":{"anyOf":[{"anyOf":[{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"title":"Single language"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"title":"All languages"}]},{"type":"null"}],"description":"Formatted description: one `{ html, text }` with `lang` (and on the list), a `{ language: { html, text } }` map otherwise; null when there is none."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"numberOfOptions":{"anyOf":[{"type":"number"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["optionSetId","name","displayName","description","status","numberOfOptions","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Global Option Sets (GET /v1/global-option-sets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GlobalOptionSetsDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GlobalOptionSetsDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"optionSetId":{"type":"string","pattern":"^OPT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Global option set identifier (OPT-<uuid>)."},"name":{"type":"string"},"displayName":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"description":{"anyOf":[{"anyOf":[{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"title":"Single language"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"title":"All languages"}]},{"type":"null"}],"description":"Formatted description: one `{ html, text }` with `lang` (and on the list), a `{ language: { html, text } }` map otherwise; null when there is none."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"numberOfOptions":{"anyOf":[{"type":"number"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"position":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Place of the option in the list, starting at 1. It matches the order of the `options` array."},"code":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"comment":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"priceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"fbPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"material3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"arMaterial3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCodeQuantity":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}],"description":"Quantity the `additionalPriceCode` applies to."},"filters":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque filter configuration: parameter id -> selected value ids. Structure is configuration-dependent."},{"type":"null"}]},"metafields":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque metafield map of customer-defined keys to values (string, number, or object)."},{"type":"null"}]},"src":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Absolute URL of the option image, resolved against the CDN."}},"required":["id","position","code","name","comment","priceCode","fbPriceCode","additionalPriceCode","material3dId","arMaterial3dId","additionalPriceCodeQuantity","filters","metafields","src"],"additionalProperties":false}}},"required":["optionSetId","name","displayName","description","status","numberOfOptions","createdAt","modifiedAt","tags","options"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Global Option Set (GET /v1/global-option-sets/{optionSetId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GlobalOptionSetsMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GlobalOptionSetsMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"optionSetId":{"type":"string","pattern":"^OPT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Global option set identifier (OPT-<uuid>)."},"name":{"type":"string"},"displayName":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"description":{"anyOf":[{"anyOf":[{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"title":"Single language"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"title":"All languages"}]},{"type":"null"}],"description":"Formatted description: one `{ html, text }` with `lang` (and on the list), a `{ language: { html, text } }` map otherwise; null when there is none."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"numberOfOptions":{"anyOf":[{"type":"number"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"position":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Place of the option in the list, starting at 1. It matches the order of the `options` array."},"code":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"comment":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"priceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"fbPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"material3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"arMaterial3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCodeQuantity":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}],"description":"Quantity the `additionalPriceCode` applies to."},"filters":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque filter configuration: parameter id -> selected value ids. Structure is configuration-dependent."},{"type":"null"}]},"metafields":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque metafield map of customer-defined keys to values (string, number, or object)."},{"type":"null"}]},"src":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Absolute URL of the option image, resolved against the CDN."}},"required":["id","position","code","name","comment","priceCode","fbPriceCode","additionalPriceCode","material3dId","arMaterial3dId","additionalPriceCodeQuantity","filters","metafields","src"],"additionalProperties":false}}},"required":["optionSetId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Global Option Set (POST /v1/global-option-sets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GlobalOptionSetsCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GlobalOptionSetsCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Option set name (internal, not localized)."},"displayName":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Display name, keyed by language code."},"description":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Description as plain text, keyed by language code. A language sent with the `text` Get Global Option Set answered keeps its stored formatting; any other text replaces it as unformatted text. An empty string removes that language."},{"type":"null"}]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"Client-supplied option id; reuse the stored id to update an existing option."},"code":{"type":"string","minLength":1,"maxLength":255},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"comment":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"priceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"fbPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"material3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"arMaterial3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCodeQuantity":{"anyOf":[{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"string","minLength":1}],"description":"Quantity the `additionalPriceCode` applies to."},{"type":"null"}]},"filters":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque filter configuration: parameter id -> selected value ids. Structure is configuration-dependent."},{"type":"null"}]},"metafields":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque metafield map of customer-defined keys to values (string, number, or object)."},{"type":"null"}]},"src":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["id","code","name"],"additionalProperties":false}}},"required":["name","displayName"],"additionalProperties":false,"description":"Data schema used by Create Global Option Set (POST /v1/global-option-sets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GlobalOptionSetsUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GlobalOptionSetsUpdateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Option set name (internal, not localized)."},"displayName":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Display name, keyed by language code."},"description":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Description as plain text, keyed by language code. A language sent with the `text` Get Global Option Set answered keeps its stored formatting; any other text replaces it as unformatted text. An empty string removes that language."},{"type":"null"}]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"additionalProperties":false,"description":"Data schema used by Update Global Option Set (PUT /v1/global-option-sets/{optionSetId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GlobalOptionSetsOptionsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GlobalOptionSetsOptionsRequest":{"type":"object","properties":{"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"Client-supplied option id; reuse the stored id to update an existing option."},"code":{"type":"string","minLength":1,"maxLength":255},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"comment":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"priceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"fbPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"material3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"arMaterial3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCodeQuantity":{"anyOf":[{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"string","minLength":1}],"description":"Quantity the `additionalPriceCode` applies to."},{"type":"null"}]},"filters":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque filter configuration: parameter id -> selected value ids. Structure is configuration-dependent."},{"type":"null"}]},"metafields":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque metafield map of customer-defined keys to values (string, number, or object)."},{"type":"null"}]},"src":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"position":{"description":"Place of the option in the list after the change, starting at 1; a position past the end puts it last. Options without a position fill the other places in their existing order.","type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","code","name"],"additionalProperties":false}}},"required":["options"],"additionalProperties":false,"description":"Data schema used by Update Global Option Set Options (PUT /v1/global-option-sets/{optionSetId}/options). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GlobalOptionSetsOptionsRequest2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GlobalOptionSetsOptionsRequest2":{"type":"object","properties":{"options":{"minItems":1,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"Client-supplied option id; reuse the stored id to update an existing option."},"code":{"type":"string","minLength":1,"maxLength":255},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"comment":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"priceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"fbPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"material3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"arMaterial3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCodeQuantity":{"anyOf":[{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"string","minLength":1}],"description":"Quantity the `additionalPriceCode` applies to."},{"type":"null"}]},"filters":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque filter configuration: parameter id -> selected value ids. Structure is configuration-dependent."},{"type":"null"}]},"metafields":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque metafield map of customer-defined keys to values (string, number, or object)."},{"type":"null"}]},"src":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"position":{"description":"Place of the option in the list after the change, starting at 1; a position past the end puts it last. Options without a position fill the other places in their existing order.","type":"integer","minimum":1,"maximum":9007199254740991}},"required":["id","code","name"],"additionalProperties":false}}},"required":["options"],"additionalProperties":false,"description":"Data schema used by Add or Update Global Option Set Options (POST /v1/global-option-sets/{optionSetId}/options). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GlobalOptionSetsOptionsRemoveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GlobalOptionSetsOptionsRemoveRequest":{"type":"object","properties":{"optionIds":{"minItems":1,"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"description":"Ids of the options to remove."}},"required":["optionIds"],"additionalProperties":false,"description":"Data schema used by Remove Global Option Set Options (POST /v1/global-option-sets/{optionSetId}/options:remove). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CollectionSetsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CollectionSetsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"collectionSetId":{"type":"string","pattern":"^MCS-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Collection set identifier (MCS-<uuid>)."},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["collectionSetId","name","status","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Collection Sets (GET /v1/collection-sets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CollectionSetsDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CollectionSetsDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"collectionSetId":{"type":"string","pattern":"^MCS-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Collection set identifier (MCS-<uuid>)."},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"optionSets":{"type":"array","items":{"type":"object","properties":{"optionSetId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["optionSetId","name","status"],"additionalProperties":false}}},"required":["collectionSetId","name","status","createdAt","modifiedAt","tags","optionSets"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Collection Set (GET /v1/collection-sets/{collectionSetId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CollectionSetsMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CollectionSetsMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"collectionSetId":{"type":"string","pattern":"^MCS-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Collection set identifier (MCS-<uuid>)."},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"optionSets":{"type":"array","items":{"type":"object","properties":{"optionSetId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["optionSetId","name","status"],"additionalProperties":false}}},"required":["collectionSetId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Collection Set (POST /v1/collection-sets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CollectionSetsCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CollectionSetsCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Collection set name."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"optionSetIds":{"type":"array","items":{"type":"string","pattern":"^OPT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Member option set identifier (OPT-<uuid>)."}}},"required":["name"],"additionalProperties":false,"description":"Data schema used by Create Collection Set (POST /v1/collection-sets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CollectionSetsUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CollectionSetsUpdateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Collection set name."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]}},"additionalProperties":false,"description":"Data schema used by Update Collection Set (PUT /v1/collection-sets/{collectionSetId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CollectionSetsOptionSetsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CollectionSetsOptionSetsRequest":{"type":"object","properties":{"optionSetIds":{"type":"array","items":{"type":"string","pattern":"^OPT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Member option set identifier (OPT-<uuid>)."}}},"required":["optionSetIds"],"additionalProperties":false,"description":"Data schema used by Update Collection Set Option Sets (PUT /v1/collection-sets/{collectionSetId}/option-sets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CollectionSetsOptionSetsRequest2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CollectionSetsOptionSetsRequest2":{"type":"object","properties":{"optionSetIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^OPT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Member option set identifier (OPT-<uuid>)."}}},"required":["optionSetIds"],"additionalProperties":false,"description":"Data schema used by Add Collection Set Option Sets (POST /v1/collection-sets/{collectionSetId}/option-sets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CollectionSetsOptionSetsRemoveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CollectionSetsOptionSetsRemoveRequest":{"type":"object","properties":{"optionSetIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^OPT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Member option set identifier (OPT-<uuid>)."}}},"required":["optionSetIds"],"additionalProperties":false,"description":"Data schema used by Remove Collection Set Option Sets (POST /v1/collection-sets/{collectionSetId}/option-sets:remove). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GalleriesList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GalleriesList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"galleryId":{"type":"string","pattern":"^GALL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Gallery identifier (GALL-<uuid>)."},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"numberOfItems":{"type":"number"},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["galleryId","name","numberOfItems","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Galleries (GET /v1/galleries). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GalleriesDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GalleriesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"galleryId":{"type":"string","pattern":"^GALL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Gallery identifier (GALL-<uuid>)."},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"numberOfItems":{"type":"number"},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"numColumns":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"mediaType":{"type":"string","enum":["IMAGE","VIDEO"]},"mediaSource":{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},"caption":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"fileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"loop":{"type":"boolean","description":"Loop the video; false when never set."},"autoplay":{"type":"boolean","description":"Start the video muted and playing; false when never set."}},"required":["id","mediaType","mediaSource","caption","fileId","filePath","url","loop","autoplay"],"additionalProperties":false}}},"required":["galleryId","name","numberOfItems","createdAt","modifiedAt","description","numColumns","items"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Gallery (GET /v1/galleries/{galleryId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GalleriesMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GalleriesMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"galleryId":{"type":"string","pattern":"^GALL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Gallery identifier (GALL-<uuid>)."},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"numberOfItems":{"type":"number"},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"numColumns":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"mediaType":{"type":"string","enum":["IMAGE","VIDEO"]},"mediaSource":{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},"caption":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"fileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"loop":{"type":"boolean","description":"Loop the video; false when never set."},"autoplay":{"type":"boolean","description":"Start the video muted and playing; false when never set."}},"required":["id","mediaType","mediaSource","caption","fileId","filePath","url","loop","autoplay"],"additionalProperties":false}}},"required":["galleryId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Gallery (POST /v1/galleries). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GalleriesCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GalleriesCreateRequest":{"type":"object","properties":{"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Gallery name, keyed by language code."},"description":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"numColumns":{"type":"string","minLength":1},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["IMAGE","VIDEO"]},"mediaSource":{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},"caption":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"fileId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"url":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"loop":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"autoplay":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["id","mediaType","mediaSource"],"additionalProperties":false}}},"required":["name"],"additionalProperties":false,"description":"Data schema used by Create Gallery (POST /v1/galleries). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GalleriesUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GalleriesUpdateRequest":{"type":"object","properties":{"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Gallery name, keyed by language code."},"description":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"numColumns":{"type":"string","minLength":1}},"additionalProperties":false,"description":"Data schema used by Update Gallery (PUT /v1/galleries/{galleryId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GalleriesItemsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GalleriesItemsRequest":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["IMAGE","VIDEO"]},"mediaSource":{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},"caption":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"fileId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"url":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"loop":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"autoplay":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["id","mediaType","mediaSource"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false,"description":"Data schema used by Update Gallery Items (PUT /v1/galleries/{galleryId}/items). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GalleriesItemsRequest2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GalleriesItemsRequest2":{"type":"object","properties":{"items":{"minItems":1,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["IMAGE","VIDEO"]},"mediaSource":{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},"caption":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"fileId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"url":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"loop":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"autoplay":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["id","mediaType","mediaSource"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false,"description":"Data schema used by Add or Update Gallery Items (POST /v1/galleries/{galleryId}/items). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The GalleriesItemsRemoveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"GalleriesItemsRemoveRequest":{"type":"object","properties":{"itemIds":{"minItems":1,"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"description":"Ids of the items to remove, as returned in the gallery detail."}},"required":["itemIds"],"additionalProperties":false,"description":"Data schema used by Remove Gallery Items (POST /v1/galleries/{galleryId}/items:remove). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ItemMastersList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ItemMastersList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"itemMasterId":{"type":"string","pattern":"^IM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Item master identifier (IM-<uuid>)."},"code":{"type":"string"},"deliveryTime":{"anyOf":[{"type":"number"},{"type":"null"}]},"m3":{"anyOf":[{"type":"number"},{"type":"null"}]},"weight":{"anyOf":[{"type":"number"},{"type":"null"}]},"weightUnit":{"type":"string","enum":["kg","lb"]},"dimensions":{"type":"object","properties":{"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["width","depth","height"],"additionalProperties":false},"commerceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["itemMasterId","code","deliveryTime","m3","weight","weightUnit","dimensions","commerceId","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Item Masters (GET /v1/item-masters). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ItemMastersMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ItemMastersMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"itemMasterId":{"type":"string","pattern":"^IM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Item master identifier (IM-<uuid>)."},"code":{"type":"string"},"deliveryTime":{"anyOf":[{"type":"number"},{"type":"null"}]},"m3":{"anyOf":[{"type":"number"},{"type":"null"}]},"weight":{"anyOf":[{"type":"number"},{"type":"null"}]},"weightUnit":{"type":"string","enum":["kg","lb"]},"dimensions":{"type":"object","properties":{"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["width","depth","height"],"additionalProperties":false},"commerceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"aliasCodes":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliasCode":{"type":"string"}},"required":["companyId","companyName","aliasCode"],"additionalProperties":false}},"marketCostPrices":{"type":"array","items":{"type":"object","properties":{"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["market","quantity","cost","rrp","modifiedAt"],"additionalProperties":false}}},"required":["itemMasterId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Item Master (POST /v1/item-masters). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ItemMastersCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ItemMastersCreateRequest":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[./\\\\_\\-\\w]+$"},"deliveryTime":{"type":"integer","minimum":0,"maximum":9007199254740991},"m3":{"type":"number","minimum":0},"weight":{"type":"number","minimum":0},"weightUnit":{"type":"string","enum":["kg","lb"]},"dimensions":{"type":"object","properties":{"width":{"type":"number","minimum":0},"depth":{"type":"number","minimum":0},"height":{"type":"number","minimum":0}},"additionalProperties":false},"commerceId":{"type":"string","minLength":1,"maxLength":255},"aliasCodes":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"companyName":{"type":"string","minLength":1,"maxLength":255},"aliasCode":{"type":"string","minLength":1,"maxLength":255}},"required":["companyId","aliasCode"],"additionalProperties":false}}},"required":["code"],"additionalProperties":false,"description":"Data schema used by Create Item Master (POST /v1/item-masters). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ItemMastersBulkResponse object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ItemMastersBulkResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"existingCount":{"type":"number","description":"Records already stored for the customer before the import."},"added":{"type":"number"},"updated":{"type":"number"},"processed":{"type":"number"},"skippedCodes":{"type":"array","items":{"type":"string"},"description":"Codes skipped because they already exist (CREATE mode; UPSERT updates them)."},"invalidCodes":{"type":"array","items":{"type":"string"},"description":"Codes rejected by validation."},"errorsFileUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"URL of a generated errors report, or null."}},"required":["existingCount","added","updated","processed","skippedCodes","invalidCodes","errorsFileUrl"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Bulk upsert Item Masters (POST /v1/item-masters:bulk). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ItemMastersBulkRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ItemMastersBulkRequest":{"type":"object","properties":{"mode":{"default":"CREATE","type":"string","enum":["CREATE","UPSERT"]},"items":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[./\\\\_\\-\\w]+$"},"deliveryTime":{"type":"integer","minimum":0,"maximum":9007199254740991},"m3":{"type":"number","minimum":0},"weight":{"type":"number","minimum":0},"weightUnit":{"type":"string","enum":["kg","lb"]},"dimensions":{"type":"object","properties":{"width":{"type":"number","minimum":0},"depth":{"type":"number","minimum":0},"height":{"type":"number","minimum":0}},"additionalProperties":false},"commerceId":{"type":"string","minLength":1,"maxLength":255}},"required":["code"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false,"description":"Data schema used by Bulk upsert Item Masters (POST /v1/item-masters:bulk). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ItemMastersDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ItemMastersDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"itemMasterId":{"type":"string","pattern":"^IM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Item master identifier (IM-<uuid>)."},"code":{"type":"string"},"deliveryTime":{"anyOf":[{"type":"number"},{"type":"null"}]},"m3":{"anyOf":[{"type":"number"},{"type":"null"}]},"weight":{"anyOf":[{"type":"number"},{"type":"null"}]},"weightUnit":{"type":"string","enum":["kg","lb"]},"dimensions":{"type":"object","properties":{"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["width","depth","height"],"additionalProperties":false},"commerceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"aliasCodes":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliasCode":{"type":"string"}},"required":["companyId","companyName","aliasCode"],"additionalProperties":false}},"marketCostPrices":{"type":"array","items":{"type":"object","properties":{"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["market","quantity","cost","rrp","modifiedAt"],"additionalProperties":false}}},"required":["itemMasterId","code","deliveryTime","m3","weight","weightUnit","dimensions","commerceId","createdAt","modifiedAt","aliasCodes","marketCostPrices"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Item Master (GET /v1/item-masters/{itemMasterId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The MarketCostPricesList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"MarketCostPricesList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"marketCostPriceId":{"type":"string","pattern":"^MCP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Market cost price identifier (MCP-<uuid>)."},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost":{"anyOf":[{"type":"number","description":"Cost price in the market currency. Can be negative."},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number","description":"Recommended retail price in the market currency. Can be negative."},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Currency symbol derived from the market."},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["marketCostPriceId","market","code","quantity","cost","rrp","currency","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."},"truncated":{"type":"boolean","description":"True when this query matched at least as many records as the API can return in one go, so records matching it may exist beyond the last page and paging to `nextCursor: null` would not reach them. Narrow the result set with `search` to bring them into range."},"totalRecords":{"type":"number","description":"Total market cost prices stored for your customer. Always the stored total, unaffected by `search` and `market`, so it is not the size of a filtered result set."}},"required":["limit","nextCursor","truncated","totalRecords"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Market Cost Prices (GET /v1/market-cost-prices). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The MarketCostPricesBulkResponse object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"MarketCostPricesBulkResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"existingCount":{"type":"number","description":"Records already stored for the customer before the import."},"added":{"type":"number"},"updated":{"type":"number","description":"Existing rows re-written (UPSERT). Currently includes rows re-sent unchanged."},"unchanged":{"type":"number","description":"Existing rows re-sent with no change. Reserved: currently always 0 (such rows are counted under `updated`) until server-side change detection ships."},"processed":{"type":"number"},"invalidCodes":{"type":"array","items":{"type":"string"},"description":"Full codes rejected by validation."},"skippedCodes":{"type":"array","items":{"type":"string"},"description":"Full codes skipped because they already exist (CREATE mode; UPSERT updates them)."}},"required":["existingCount","added","updated","unchanged","processed","invalidCodes","skippedCodes"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Bulk upsert Market Cost Prices (POST /v1/market-cost-prices:bulk). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The MarketCostPricesBulkRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"MarketCostPricesBulkRequest":{"type":"object","properties":{"mode":{"default":"CREATE","description":"CREATE adds only (existing full codes are skipped); UPSERT updates them.","type":"string","enum":["CREATE","UPSERT"]},"items":{"minItems":1,"maxItems":5000,"type":"array","items":{"type":"object","properties":{"market":{"type":"string","minLength":1,"maxLength":255,"description":"Market the price applies to, as configured for the customer."},"code":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[./\\\\_\\-\\w]+$","description":"Product/variant code."},"quantity":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Quantity tier the price applies to (integer ≥ 0)."},"cost":{"type":"number","description":"Cost price in the market currency. Can be negative."},"rrp":{"type":"number","description":"Recommended retail price in the market currency. Can be negative."}},"required":["market","code","quantity","cost"],"additionalProperties":false},"description":"1–5000 items."}},"required":["items"],"additionalProperties":false,"description":"Data schema used by Bulk upsert Market Cost Prices (POST /v1/market-cost-prices:bulk). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The MarketCostPricesMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"MarketCostPricesMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"marketCostPriceId":{"type":"string","pattern":"^MCP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Market cost price identifier (MCP-<uuid>)."}},"required":["marketCostPriceId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Market Cost Price (POST /v1/market-cost-prices). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The MarketCostPricesCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"MarketCostPricesCreateRequest":{"type":"object","properties":{"market":{"type":"string","minLength":1,"maxLength":255,"description":"Market the price applies to, as configured for the customer."},"code":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[./\\\\_\\-\\w]+$","description":"Product/variant code."},"quantity":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Quantity tier the price applies to (integer ≥ 0)."},"cost":{"type":"number","description":"Cost price in the market currency. Can be negative."},"rrp":{"type":"number","description":"Recommended retail price in the market currency. Can be negative."}},"required":["market","code","quantity","cost"],"additionalProperties":false,"description":"Data schema used by Create Market Cost Price (POST /v1/market-cost-prices). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The PriceListsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"PriceListsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","enum":["FIXED","CALCULATED","LINKED"]},"market":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","createdAt","modifiedAt","mode","market"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Price Lists (GET /v1/price-lists). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The PriceListsMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"PriceListsMutation":{"type":"object","properties":{"data":{"anyOf":[{"oneOf":[{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"type":"string"}},"required":["companyId","companyName"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","const":"FIXED"},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"calculation":{"type":"object","properties":{"costMultiplier":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["costMultiplier"],"additionalProperties":false},"body":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"object","properties":{"priceCode":{"type":"string"},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number"},{"type":"null"}]},"sale":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["priceCode","quantity","rrp","sale"],"additionalProperties":false}}},"required":["codes"],"additionalProperties":false}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","companies","createdAt","modifiedAt","mode","market","calculation","body"],"additionalProperties":false,"title":"Fixed price list"},{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"type":"string"}},"required":["companyId","companyName"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","const":"CALCULATED"},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"anyOf":[{"type":"string"},{"type":"null"}]},"selectedCustomers":{"type":"array","items":{"type":"string"}},"selectedProducts":{"type":"array","items":{"type":"string"}},"calculation":{"type":"object","properties":{"costMultiplier":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string","const":"RRP_MULTIPLIER","description":"RRP is the price-code RRP multiplied by `value`."},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string","const":"RRP_DISCOUNT","description":"Sale price is the RRP reduced by `value` percent."},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","companies","createdAt","modifiedAt","mode","market","scope","selectedCustomers","selectedProducts","calculation"],"additionalProperties":false,"title":"Calculated price list"},{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"type":"string"}},"required":["companyId","companyName"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","const":"LINKED"},"linkedPriceListId":{"anyOf":[{"type":"string"},{"type":"null"}]},"calculation":{"type":"object","properties":{"costMultiplier":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string","const":"RRP_MULTIPLIER","description":"RRP is the price-code RRP multiplied by `value`."},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string","const":"RRP_DISCOUNT","description":"Sale price is the RRP reduced by `value` percent."},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","companies","createdAt","modifiedAt","mode","linkedPriceListId","calculation"],"additionalProperties":false,"title":"Linked price list"}],"title":"Price list"},{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Price list identifier (PL-<uuid>)."}},"required":["priceListId"],"additionalProperties":false,"title":"Price list ID only"}]}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Price List (POST /v1/price-lists). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The PriceListsCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"PriceListsCreateRequest":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"currency":{"type":"string","minLength":1,"maxLength":255},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]},{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"mode":{"type":"string","const":"FIXED"},"market":{"type":"string","minLength":1,"maxLength":255},"calculation":{"type":"object","properties":{"costMultiplier":{"type":"number","minimum":0}},"required":["costMultiplier"],"additionalProperties":false},"body":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"object","properties":{"priceCode":{"type":"string","minLength":1,"maxLength":255},"quantity":{"type":"integer","minimum":0,"maximum":9007199254740991},"rrp":{"type":"number"},"sale":{"type":"number"}},"required":["priceCode","quantity","rrp","sale"],"additionalProperties":false}}},"required":["codes"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","market","calculation"],"additionalProperties":false,"title":"Fixed price list"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"currency":{"type":"string","minLength":1,"maxLength":255},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]},{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"mode":{"type":"string","const":"CALCULATED"},"market":{"type":"string","minLength":1,"maxLength":255},"scope":{"type":"string","enum":["ALL","SELECTED_CUSTOMERS","SELECTED_PRODUCTS"]},"selectedCustomers":{"type":"array","items":{"type":"string","pattern":"^CUST-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"selectedProducts":{"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"calculation":{"type":"object","properties":{"costMultiplier":{"type":"number","minimum":0},"rrp":{"type":"object","properties":{"method":{"type":"string","const":"RRP_MULTIPLIER","description":"RRP is the price-code RRP multiplied by `value`."},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},"sale":{"type":"object","properties":{"method":{"type":"string","const":"RRP_DISCOUNT","description":"Sale price is the RRP reduced by `value` percent."},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","market","scope","selectedCustomers","selectedProducts","calculation"],"additionalProperties":false,"title":"Calculated price list"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"currency":{"type":"string","minLength":1,"maxLength":255},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]},{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"mode":{"type":"string","const":"LINKED"},"linkedPriceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"A `FIXED` price list to take prices from."},"calculation":{"type":"object","properties":{"costMultiplier":{"type":"number","minimum":0},"rrp":{"type":"object","properties":{"method":{"type":"string","const":"RRP_MULTIPLIER","description":"RRP is the price-code RRP multiplied by `value`."},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},"sale":{"type":"object","properties":{"method":{"type":"string","const":"RRP_DISCOUNT","description":"Sale price is the RRP reduced by `value` percent."},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","linkedPriceListId","calculation"],"additionalProperties":false,"title":"Linked price list"}],"description":"Data schema used by Create Price List (POST /v1/price-lists). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The PriceListsDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"PriceListsDetail":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"type":"string"}},"required":["companyId","companyName"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","const":"FIXED"},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"calculation":{"type":"object","properties":{"costMultiplier":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["costMultiplier"],"additionalProperties":false},"body":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"object","properties":{"priceCode":{"type":"string"},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number"},{"type":"null"}]},"sale":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["priceCode","quantity","rrp","sale"],"additionalProperties":false}}},"required":["codes"],"additionalProperties":false}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","companies","createdAt","modifiedAt","mode","market","calculation","body"],"additionalProperties":false,"title":"Fixed price list"},{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"type":"string"}},"required":["companyId","companyName"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","const":"CALCULATED"},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"scope":{"anyOf":[{"type":"string"},{"type":"null"}]},"selectedCustomers":{"type":"array","items":{"type":"string"}},"selectedProducts":{"type":"array","items":{"type":"string"}},"calculation":{"type":"object","properties":{"costMultiplier":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string","const":"RRP_MULTIPLIER","description":"RRP is the price-code RRP multiplied by `value`."},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string","const":"RRP_DISCOUNT","description":"Sale price is the RRP reduced by `value` percent."},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","companies","createdAt","modifiedAt","mode","market","scope","selectedCustomers","selectedProducts","calculation"],"additionalProperties":false,"title":"Calculated price list"},{"type":"object","properties":{"priceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Price list identifier (PL-<uuid>)."},"priceListName":{"type":"string"},"status":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"companies":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"type":"string"}},"required":["companyId","companyName"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"mode":{"type":"string","const":"LINKED"},"linkedPriceListId":{"anyOf":[{"type":"string"},{"type":"null"}]},"calculation":{"type":"object","properties":{"costMultiplier":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string","const":"RRP_MULTIPLIER","description":"RRP is the price-code RRP multiplied by `value`."},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"anyOf":[{"type":"string","const":"RRP_DISCOUNT","description":"Sale price is the RRP reduced by `value` percent."},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},{"type":"null"}]},"increment":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["priceListId","priceListName","status","currency","validPeriod","isPromotional","companies","createdAt","modifiedAt","mode","linkedPriceListId","calculation"],"additionalProperties":false,"title":"Linked price list"}]}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Price List (GET /v1/price-lists/{priceListId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The PriceListsUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"PriceListsUpdateRequest":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"currency":{"type":"string","minLength":1,"maxLength":255},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]},{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"mode":{"type":"string","const":"FIXED"},"market":{"type":"string","minLength":1,"maxLength":255},"calculation":{"type":"object","properties":{"costMultiplier":{"type":"number","minimum":0}},"required":["costMultiplier"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","market","calculation"],"additionalProperties":false,"title":"Fixed price list"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"currency":{"type":"string","minLength":1,"maxLength":255},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]},{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"mode":{"type":"string","const":"CALCULATED"},"market":{"type":"string","minLength":1,"maxLength":255},"scope":{"type":"string","enum":["ALL","SELECTED_CUSTOMERS","SELECTED_PRODUCTS"]},"selectedCustomers":{"type":"array","items":{"type":"string","pattern":"^CUST-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"selectedProducts":{"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"calculation":{"type":"object","properties":{"costMultiplier":{"type":"number","minimum":0},"rrp":{"type":"object","properties":{"method":{"type":"string","const":"RRP_MULTIPLIER","description":"RRP is the price-code RRP multiplied by `value`."},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},"sale":{"type":"object","properties":{"method":{"type":"string","const":"RRP_DISCOUNT","description":"Sale price is the RRP reduced by `value` percent."},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","market","scope","selectedCustomers","selectedProducts","calculation"],"additionalProperties":false,"title":"Calculated price list"},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"currency":{"type":"string","minLength":1,"maxLength":255},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]},{"anyOf":[{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","title":"Date-time"},{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","title":"Date"}]},{"type":"null"}]}]},"isPromotional":{"type":"boolean"},"mode":{"type":"string","const":"LINKED"},"linkedPriceListId":{"type":"string","pattern":"^PL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"A `FIXED` price list to take prices from."},"calculation":{"type":"object","properties":{"costMultiplier":{"type":"number","minimum":0},"rrp":{"type":"object","properties":{"method":{"type":"string","const":"RRP_MULTIPLIER","description":"RRP is the price-code RRP multiplied by `value`."},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},"sale":{"type":"object","properties":{"method":{"type":"string","const":"RRP_DISCOUNT","description":"Sale price is the RRP reduced by `value` percent."},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","enum":["ROUND","ROUND_UP","ROUND_DOWN"]},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","linkedPriceListId","calculation"],"additionalProperties":false,"title":"Linked price list"}],"description":"Data schema used by Update Price List (PUT /v1/price-lists/{priceListId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The PriceListsPricesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"PriceListsPricesRequest":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"object","properties":{"priceCode":{"type":"string","minLength":1,"maxLength":255},"quantity":{"type":"integer","minimum":0,"maximum":9007199254740991},"rrp":{"type":"number"},"sale":{"type":"number"}},"required":["priceCode","quantity","rrp","sale"],"additionalProperties":false}}},"required":["codes"],"additionalProperties":false,"description":"Data schema used by Update Price List Prices (PUT /v1/price-lists/{priceListId}/prices). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompanyGroupsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompanyGroupsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"companyGroupId":{"type":"string","pattern":"^CG-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company group identifier (CG-<uuid>)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"canExport3d":{"type":"boolean"}},"required":["companyGroupId","name","status","canExport3d"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Company Groups (GET /v1/company-groups). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompanyGroupsDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompanyGroupsDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"companyGroupId":{"type":"string","pattern":"^CG-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company group identifier (CG-<uuid>)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"canExport3d":{"type":"boolean"},"companyIds":{"type":"array","items":{"type":"string"},"description":"Companies in the group."}},"required":["companyGroupId","name","status","canExport3d","companyIds"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Company Group (GET /v1/company-groups/{companyGroupId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompanyGroupsMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompanyGroupsMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"companyGroupId":{"type":"string","pattern":"^CG-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company group identifier (CG-<uuid>)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"canExport3d":{"type":"boolean"},"companyIds":{"type":"array","items":{"type":"string"},"description":"Companies in the group."}},"required":["companyGroupId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Company Group (POST /v1/company-groups). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompanyGroupsCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompanyGroupsCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Company group name."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"canExport3d":{"type":"boolean","description":"Lets the group's companies export 3D models where the customer's export setting leaves it to company groups. Defaults to true."},"companyIds":{"type":"array","items":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."}}},"required":["name"],"additionalProperties":false,"description":"Data schema used by Create Company Group (POST /v1/company-groups). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompanyGroupsUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompanyGroupsUpdateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Company group name."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"canExport3d":{"type":"boolean","description":"Lets the group's companies export 3D models where the customer's export setting leaves it to company groups. Defaults to true."}},"additionalProperties":false,"description":"Data schema used by Update Company Group (PUT /v1/company-groups/{companyGroupId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompanyGroupsCompaniesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompanyGroupsCompaniesRequest":{"type":"object","properties":{"companyIds":{"type":"array","items":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."}}},"required":["companyIds"],"additionalProperties":false,"description":"Data schema used by Update Company Group Companies (PUT /v1/company-groups/{companyGroupId}/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompanyGroupsCompaniesRequest2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompanyGroupsCompaniesRequest2":{"type":"object","properties":{"companyIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."}}},"required":["companyIds"],"additionalProperties":false,"description":"Data schema used by Add Company Group Companies (POST /v1/company-groups/{companyGroupId}/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The CompanyGroupsCompaniesRemoveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"CompanyGroupsCompaniesRemoveRequest":{"type":"object","properties":{"companyIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."}}},"required":["companyIds"],"additionalProperties":false,"description":"Data schema used by Remove Company Group Companies (POST /v1/company-groups/{companyGroupId}/companies:remove). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"productGroupId":{"type":"string","pattern":"^PG-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product group identifier (PG-<uuid>)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["SHARED","EMBED"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"numberOfProducts":{"type":"number"},"numberOfCompanies":{"type":"number","description":"Connected companies — applies to SHARED groups only; always 0 for EMBED."}},"required":["productGroupId","name","type","status","numberOfProducts","numberOfCompanies"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Product Groups (GET /v1/product-groups). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"productGroupId":{"type":"string","pattern":"^PG-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product group identifier (PG-<uuid>)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["SHARED","EMBED"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"numberOfProducts":{"type":"number"},"numberOfCompanies":{"type":"number","description":"Connected companies — applies to SHARED groups only; always 0 for EMBED."},"manualSort":{"type":"boolean","description":"Whether products are sorted manually. Defaults to true."},"companyIds":{"type":"array","items":{"type":"string"},"description":"Connected company ids — applies to SHARED groups only; always empty for EMBED."},"connectedProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["productId","name","status"],"additionalProperties":false}}},"required":["productGroupId","name","type","status","numberOfProducts","numberOfCompanies","manualSort","companyIds","connectedProducts"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Product Group (GET /v1/product-groups/{productGroupId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"productGroupId":{"type":"string","pattern":"^PG-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product group identifier (PG-<uuid>)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["SHARED","EMBED"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"numberOfProducts":{"type":"number"},"numberOfCompanies":{"type":"number","description":"Connected companies — applies to SHARED groups only; always 0 for EMBED."},"manualSort":{"type":"boolean","description":"Whether products are sorted manually. Defaults to true."},"companyIds":{"type":"array","items":{"type":"string"},"description":"Connected company ids — applies to SHARED groups only; always empty for EMBED."},"connectedProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["productId","name","status"],"additionalProperties":false}}},"required":["productGroupId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Product Group (POST /v1/product-groups). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Product group name."},"type":{"type":"string","enum":["SHARED","EMBED"],"description":"SHARED (shareable with companies) or EMBED."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"manualSort":{"type":"boolean"},"productIds":{"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."}},"companyIds":{"type":"array","items":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."}}},"required":["name","type"],"additionalProperties":false,"description":"Data schema used by Create Product Group (POST /v1/product-groups). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsUpdateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Product group name."},"manualSort":{"type":"boolean"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]}},"additionalProperties":false,"description":"Data schema used by Update Product Group (PUT /v1/product-groups/{productGroupId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsProductsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsProductsRequest":{"type":"object","properties":{"productIds":{"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."}}},"required":["productIds"],"additionalProperties":false,"description":"Data schema used by Update Product Group Products (PUT /v1/product-groups/{productGroupId}/products). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsProductsRequest2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsProductsRequest2":{"type":"object","properties":{"productIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."}}},"required":["productIds"],"additionalProperties":false,"description":"Data schema used by Add Product Group Products (POST /v1/product-groups/{productGroupId}/products). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsProductsRemoveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsProductsRemoveRequest":{"type":"object","properties":{"productIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."}}},"required":["productIds"],"additionalProperties":false,"description":"Data schema used by Remove Product Group Products (POST /v1/product-groups/{productGroupId}/products:remove). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsCompaniesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsCompaniesRequest":{"type":"object","properties":{"companyIds":{"type":"array","items":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."}}},"required":["companyIds"],"additionalProperties":false,"description":"Data schema used by Update Product Group Companies (PUT /v1/product-groups/{productGroupId}/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsCompaniesRequest2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsCompaniesRequest2":{"type":"object","properties":{"companyIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."}}},"required":["companyIds"],"additionalProperties":false,"description":"Data schema used by Add Product Group Companies (POST /v1/product-groups/{productGroupId}/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductGroupsCompaniesRemoveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductGroupsCompaniesRemoveRequest":{"type":"object","properties":{"companyIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Company identifier (COMP-<uuid>)."}}},"required":["companyIds"],"additionalProperties":false,"description":"Data schema used by Remove Product Group Companies (POST /v1/product-groups/{productGroupId}/companies:remove). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductCategoriesList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductCategoriesList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"productCategoryId":{"type":"string","pattern":"^PC-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product category identifier (PC-<uuid>)."},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"parentProductCategoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"numberOfProducts":{"type":"number"}},"required":["productCategoryId","name","code","status","parentProductCategoryId","numberOfProducts"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Product Categories (GET /v1/product-categories). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductCategoriesDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductCategoriesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"productCategoryId":{"type":"string","pattern":"^PC-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product category identifier (PC-<uuid>)."},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"parentProductCategoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"numberOfProducts":{"type":"number"},"products":{"type":"array","items":{"type":"string"}}},"required":["productCategoryId","name","code","status","parentProductCategoryId","numberOfProducts","products"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Product Category (GET /v1/product-categories/{productCategoryId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductCategoriesMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductCategoriesMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"productCategoryId":{"type":"string","pattern":"^PC-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product category identifier (PC-<uuid>)."},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"parentProductCategoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"numberOfProducts":{"type":"number"},"products":{"type":"array","items":{"type":"string"}}},"required":["productCategoryId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Product Category (POST /v1/product-categories). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductCategoriesCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductCategoriesCreateRequest":{"type":"object","properties":{"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Category name, keyed by language code."},"code":{"type":"string","minLength":1,"maxLength":255,"description":"Unique category code within the account."},"parentProductCategoryId":{"anyOf":[{"type":"string","pattern":"^PC-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product category identifier (PC-<uuid>)."},{"type":"null"}]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"productIds":{"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."}}},"required":["name","code"],"additionalProperties":false,"description":"Data schema used by Create Product Category (POST /v1/product-categories). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductCategoriesUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductCategoriesUpdateRequest":{"type":"object","properties":{"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Category name, keyed by language code."},"code":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"parentProductCategoryId":{"anyOf":[{"type":"string","pattern":"^PC-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product category identifier (PC-<uuid>)."},{"type":"null"}]}},"additionalProperties":false,"description":"Data schema used by Update Product Category (PUT /v1/product-categories/{productCategoryId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductCategoriesProductsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductCategoriesProductsRequest":{"type":"object","properties":{"productIds":{"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."}}},"required":["productIds"],"additionalProperties":false,"description":"Data schema used by Update Product Category Products (PUT /v1/product-categories/{productCategoryId}/products). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductCategoriesProductsRequest2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductCategoriesProductsRequest2":{"type":"object","properties":{"productIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."}}},"required":["productIds"],"additionalProperties":false,"description":"Data schema used by Add Product Category Products (POST /v1/product-categories/{productCategoryId}/products). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductCategoriesProductsRemoveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductCategoriesProductsRemoveRequest":{"type":"object","properties":{"productIds":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."}}},"required":["productIds"],"additionalProperties":false,"description":"Data schema used by Remove Product Category Products (POST /v1/product-categories/{productCategoryId}/products:remove). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"visibility":{"type":"boolean"},"privacy":{"anyOf":[{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED_TO"]},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["2D","3D"]},{"type":"null"}]},"mode":{"anyOf":[{"type":"string","enum":["STANDARD","VARIANT","MODULAR","COMPONENT"]},{"type":"null"}]},"variantType":{"anyOf":[{"type":"string","enum":["STANDARD","HYBRID"]},{"type":"null"}]},"previewImage":{"anyOf":[{"type":"string"},{"type":"null"}]},"isOwn":{"type":"boolean"},"isSharedWithOthers":{"type":"boolean"},"isBroken":{"type":"boolean"},"owner":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownerCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["productId","variantCode","name","displayName","status","visibility","privacy","type","mode","variantType","previewImage","isOwn","isSharedWithOthers","isBroken","owner","ownerCode","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Products (GET /v1/products). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductsRelated object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductsRelated":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"productId":{"anyOf":[{"type":"string"},{"type":"null"}]},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"mode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["productId","variantCode","name","status","mode"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Related Products (GET /v1/products/{productId}/related). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ProductsDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ProductsDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"productId":{"type":"string","pattern":"^PROD-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Product identifier (PROD-<uuid>)."},"sourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"displayName":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"description":{"anyOf":[{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"title":"Single language"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"title":"All languages"}],"description":"One rendered description when lang is set; otherwise descriptions by language."},"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"manufacturer":{"anyOf":[{"type":"string"},{"type":"null"}]},"designer":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"visibility":{"type":"boolean"},"privacy":{"anyOf":[{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED_TO"]},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["2D","3D"]},{"type":"null"}]},"mode":{"anyOf":[{"type":"string","enum":["STANDARD","VARIANT","MODULAR","COMPONENT"]},{"type":"null"}]},"variantType":{"anyOf":[{"type":"string","enum":["STANDARD","HYBRID"]},{"type":"null"}]},"previewImage":{"anyOf":[{"type":"string"},{"type":"null"}]},"categoryIds":{"type":"array","items":{}},"companyGroupIds":{"type":"array","items":{}},"productGroupIds":{"type":"array","items":{}},"tags":{"type":"array","items":{}},"isOwn":{"type":"boolean"},"isSharedWithOthers":{"type":"boolean"},"isBroken":{"type":"boolean"},"owner":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownerCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"sharingSettings":{},"modularSettings":{},"optionSets":{"type":"array","items":{}},"groups":{"type":"array","items":{}},"groupContainers":{"type":"array","items":{}},"groupsPreview":{},"businessLogic":{"type":"array","items":{}},"pricing":{},"bom":{"type":"array","items":{}},"bundleSettings":{},"sceneSettings":{},"models3dUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"meshesUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"animationGroupsUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"components3d":{"type":"array","items":{}},"products":{"type":"array","items":{}},"connectedProducts":{"type":"array","items":{}},"priceListsInScope":{"type":"array","items":{"type":"object","properties":{"priceListId":{"type":"string","description":"Price list identifier (PL-<uuid>), for Get Price List."},"priceListName":{"anyOf":[{"type":"string"},{"type":"null"}]},"mode":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Always `CALCULATED_TOP_LEVEL`."},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"validPeriod":{"type":"array","prefixItems":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"anyOf":[{"type":"string"},{"type":"null"}]}],"description":"Start and end of the validity period, as ISO 8601 timestamps; null when unbounded."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`ACTIVE` or `INACTIVE`."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The list currency's symbol from your account's currencies, such as `€` or `PLN`; null when the currency is not among them."}},"required":["priceListId","priceListName","mode","market","validPeriod","status","currency"],"additionalProperties":false},"description":"Calculated price lists (mode `CALCULATED_TOP_LEVEL`) whose scope covers this product: lists for all products, for your own products (or for shared products, on a shared copy), and lists that name this product or the account it is shared from. Lists are matched by scope only, not by the product's price codes, so `FIXED` lists never appear here, and inactive or expired lists are included: check `status` and `validPeriod`. To see which `FIXED` lists hold the product's price codes, read their rows with Get Price List."},"sharingTab":{"type":"array","items":{}},"tabs":{"type":"array","items":{}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["productId","sourceId","variantCode","name","displayName","description","brand","manufacturer","designer","status","visibility","privacy","type","mode","variantType","previewImage","categoryIds","companyGroupIds","productGroupIds","tags","isOwn","isSharedWithOthers","isBroken","owner","ownerCode","sharingSettings","modularSettings","optionSets","groups","groupContainers","groupsPreview","businessLogic","pricing","bom","bundleSettings","sceneSettings","models3dUrl","meshesUrl","animationGroupsUrl","components3d","products","connectedProducts","priceListsInScope","sharingTab","tabs","createdAt","modifiedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Product (GET /v1/products/{productId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesCreateRequest":{"type":"object","properties":{"type":{"type":"string","const":"directory","description":"Only directories can be created; upload files with Upload File."},"directoryPath":{"description":"Existing directory to create the new one in. The root when omitted.","type":"string","maxLength":1024},"name":{"type":"string","minLength":1,"maxLength":1024,"description":"Name of the new directory. A single name, without slashes."}},"required":["type","name"],"additionalProperties":false,"description":"Data schema used by Create Directory (POST /v1/files). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesList":{"type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"directory"},"directoryPath":{"type":"string","description":"Path of the directory itself, without leading or trailing slashes, for example `IMAGES/Chairs`. Pass it as `directoryPath` to List Files to open it."},"name":{"type":"string","description":"Directory name, the last segment of its path."},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the directory was created."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the directory was last changed."}},"required":["type","directoryPath","name","createdAt","modifiedAt"],"additionalProperties":false,"title":"Directory"},{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string","description":"File identifier. Together with `directoryPath` it addresses the file in other Files operations."},"directoryPath":{"type":"string","description":"Directory that contains the file, without leading or trailing slashes, for example `IMAGES/Chairs`; `/` for the root. Every Files operation returns it this way."},"name":{"type":"string","description":"File name, including its extension."},"extension":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Lower-case extension without the dot, for example `png`."},"mimeType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type derived from the extension; `null` for an extension it does not know."},"sizeBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"File size in bytes."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public CDN URL of the file. Use it wherever Mimeeq expects a media-library file, for example product images."},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the file was uploaded."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the file was last changed."}},"required":["type","assetId","directoryPath","name","extension","mimeType","sizeBytes","url","createdAt","modifiedAt"],"additionalProperties":false,"title":"File"}]}},"page":{"type":"object","properties":{"limit":{"type":"number","description":"Page size used for this response."},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pass as `cursor` to get the next page; `null` on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Files (GET /v1/files). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesRequest":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string","minLength":1,"maxLength":1024,"description":"The file `assetId`, as returned by List Files, Search Files or Get File Details."},"directoryPath":{"description":"Directory that contains the file, for example `IMAGES/Chairs`. Empty or `/` for the root.","type":"string","maxLength":1024},"name":{"type":"string","minLength":1,"maxLength":1024,"description":"New file name, including its extension. The file keeps its `assetId` and `url`."}},"required":["type","assetId","directoryPath","name"],"additionalProperties":false,"title":"File"},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"directoryPath":{"description":"Path of the directory to rename, for example `IMAGES/Chairs`.","type":"string","maxLength":1024},"name":{"type":"string","minLength":1,"maxLength":1024,"description":"New directory name. A single name, without slashes."}},"required":["type","directoryPath","name"],"additionalProperties":false,"title":"Directory"}],"description":"Data schema used by Rename File or Directory (PATCH /v1/files). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesRequest2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesRequest2":{"type":"object","properties":{"items":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string","minLength":1,"maxLength":1024,"description":"The file `assetId`, as returned by List Files, Search Files or Get File Details."},"path":{"description":"Directory that contains the file, for example `IMAGES/Chairs`. Empty or `/` for the root.","type":"string","maxLength":1024}},"required":["type","assetId","path"],"additionalProperties":false,"title":"File"},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"path":{"description":"Path of the directory to delete, for example `IMAGES/Chairs`.","type":"string","maxLength":1024}},"required":["type","path"],"additionalProperties":false,"title":"Directory"}]},"description":"Files and directories to delete. Each may be listed once."}},"required":["items"],"additionalProperties":false,"description":"Data schema used by Delete File (DELETE /v1/files). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string","description":"File identifier. Together with `directoryPath` it addresses the file in other Files operations."},"directoryPath":{"type":"string","description":"Directory that contains the file, without leading or trailing slashes, for example `IMAGES/Chairs`; `/` for the root. Every Files operation returns it this way."},"name":{"type":"string","description":"File name, including its extension."},"extension":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Lower-case extension without the dot, for example `png`."},"mimeType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type derived from the extension; `null` for an extension it does not know."},"sizeBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"File size in bytes."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public CDN URL of the file. Use it wherever Mimeeq expects a media-library file, for example product images."},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the file was uploaded."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the file was last changed."},"revisionsNumber":{"description":"Number of revisions recorded for the file. Can be higher than the length of `revisions`.","type":"integer","minimum":0,"maximum":9007199254740991},"revisions":{"type":"array","items":{"type":"object","properties":{"revisionId":{"type":"string","description":"Pass as `revisionId` to Revert File to Revision."},"number":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Revision number, counting up from 1 in the order the revisions were saved."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"URL of the file content as it was in this revision."},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When this revision was saved."}},"required":["revisionId","number","url","createdAt"],"additionalProperties":false},"description":"Earlier versions of the file that can still be restored, oldest first."},"width":{"description":"Image width in pixels. Present for images.","type":"integer","minimum":0,"maximum":9007199254740991},"height":{"description":"Image height in pixels. Present for images.","type":"integer","minimum":0,"maximum":9007199254740991},"aspectRatio":{"description":"Image aspect ratio as width to height, for example `100 : 97`. Present for images.","type":"string","minLength":1}},"required":["type","assetId","directoryPath","name","extension","mimeType","sizeBytes","url","createdAt","modifiedAt","revisions"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Revert File to Revision (POST /v1/files/revert). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesRevertRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesRevertRequest":{"type":"object","properties":{"assetId":{"type":"string","minLength":1,"maxLength":1024,"description":"The file `assetId`, as returned by List Files, Search Files or Get File Details."},"directoryPath":{"description":"Directory that contains the file. Empty or `/` for the root.","type":"string","maxLength":1024},"revisionId":{"type":"string","minLength":1,"maxLength":1024,"description":"A `revisionId` from the file `revisions` in Get File Details."}},"required":["assetId","directoryPath","revisionId"],"additionalProperties":false,"description":"Data schema used by Revert File to Revision (POST /v1/files/revert). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesMoveRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesMoveRequest":{"type":"object","properties":{"targetDirectoryPath":{"description":"Existing directory to put the items in, for example `IMAGES/Archive`. Empty or `/` for the root.","type":"string","maxLength":1024},"items":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string","minLength":1,"maxLength":1024,"description":"The file `assetId`, as returned by List Files, Search Files or Get File Details."},"path":{"description":"Directory that contains the file, for example `IMAGES/Chairs`. Empty or `/` for the root.","type":"string","maxLength":1024}},"required":["type","assetId","path"],"additionalProperties":false,"title":"File"},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"path":{"description":"Path of the directory, for example `IMAGES/Chairs`. Its contents go with it.","type":"string","maxLength":1024}},"required":["type","path"],"additionalProperties":false,"title":"Directory"}]},"description":"Files and directories to transfer. They may come from different directories."}},"required":["targetDirectoryPath","items"],"additionalProperties":false,"description":"Data schema used by Move Files or Directories (POST /v1/files/move). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesCopyRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesCopyRequest":{"type":"object","properties":{"targetDirectoryPath":{"description":"Existing directory to put the items in, for example `IMAGES/Archive`. Empty or `/` for the root.","type":"string","maxLength":1024},"items":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string","minLength":1,"maxLength":1024,"description":"The file `assetId`, as returned by List Files, Search Files or Get File Details."},"path":{"description":"Directory that contains the file, for example `IMAGES/Chairs`. Empty or `/` for the root.","type":"string","maxLength":1024}},"required":["type","assetId","path"],"additionalProperties":false,"title":"File"},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"path":{"description":"Path of the directory, for example `IMAGES/Chairs`. Its contents go with it.","type":"string","maxLength":1024}},"required":["type","path"],"additionalProperties":false,"title":"Directory"}]},"description":"Files and directories to transfer. They may come from different directories."}},"required":["targetDirectoryPath","items"],"additionalProperties":false,"description":"Data schema used by Copy Files or Directories (POST /v1/files/copy). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesPodAssets object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesPodAssets":{"type":"object","properties":{"data":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Signed URL of the ZIP with the configuration PoD artwork, valid for 24 hours."}},"required":["url"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Download PoD Assets (POST /v1/files/pod-assets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesPodAssetsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesPodAssetsRequest":{"type":"object","properties":{"shortCode":{"type":"string","minLength":1,"maxLength":10,"pattern":"^[A-Za-z0-9_-]+$","description":"Short code of the selected product configuration (for example `EUGMAF`), as returned in `shortCode` on cart items. Letters, digits, hyphens and underscores, up to 10 characters."}},"required":["shortCode"],"additionalProperties":false,"description":"Data schema used by Download PoD Assets (POST /v1/files/pod-assets). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesDownload object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesDownload":{"type":"object","properties":{"data":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Signed URL of the ZIP, valid for 24 hours."}},"required":["url"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Download Files as ZIP (POST /v1/files/download). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The FilesDownloadRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"FilesDownloadRequest":{"type":"object","properties":{"items":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string","minLength":1,"maxLength":1024,"description":"The file `assetId`, as returned by List Files, Search Files or Get File Details."},"path":{"description":"Directory that contains the file, for example `IMAGES/Chairs`. Empty or `/` for the root.","type":"string","maxLength":1024}},"required":["type","assetId","path"],"additionalProperties":false,"title":"File"},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"path":{"description":"Path of the directory to include with all its contents, for example `IMAGES/Chairs`.","type":"string","maxLength":1024}},"required":["type","path"],"additionalProperties":false,"title":"Directory"}]},"description":"Files and directories to put in the ZIP. Each may be listed once."}},"required":["items"],"additionalProperties":false,"description":"Data schema used by Download Files as ZIP (POST /v1/files/download). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"quotationId":{"type":"string","pattern":"^QUOT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Quotation identifier (QUOT-<uuid>)."},"quotationName":{"anyOf":[{"type":"string"},{"type":"null"}]},"quotationNumber":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"status":{"type":"string","enum":["OPEN","WON","LOST"]},"stageId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Raw configured stage identifier, or null when unset."},"stageName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Resolved stage name, or null when unset/unconfigured."},"ownerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Current quotation metadata price; use version.pricing.total for the selected version."},"currentVersionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"numOfVersions":{"anyOf":[{"type":"number"},{"type":"null"}]},"validUntil":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."},"expectedClose":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."},"paymentTerms":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"lostReasonId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Raw configured lost-reason identifier, or null when unset."},"lostReasonName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Resolved lost-reason name, or null when unset/unconfigured."},"lostComment":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"isPrivate":{"type":"boolean"},"company":{"type":"object","properties":{"companyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"workNumber":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["companyId","companyName","country","city","street","postcode","email","workNumber"],"additionalProperties":false},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["quotationId","quotationName","quotationNumber","status","stageId","stageName","ownerId","currency","price","currentVersionId","numOfVersions","validUntil","expectedClose","paymentTerms","language","lostReasonId","lostReasonName","lostComment","isPrivate","company","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List Quotations (GET /v1/quotations). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsOwners object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsOwners":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownerName":{"type":"string"}},"required":["userId","firstName","lastName","ownerName"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Quotation Owners (GET /v1/quotations/owners). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsSettings object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsSettings":{"type":"object","properties":{"data":{"type":"object","properties":{"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"chance":{"type":"number"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."}},"required":["id","chance","name"],"additionalProperties":false}},"lostReasons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."}},"required":["id","name"],"additionalProperties":false}},"settings":{"type":"object","properties":{"numberOfValidUntilDays":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Days a quote is valid for; null when unset."},"numberOfExpirationDays":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Days until a quote expires; null when unset."},"widgetType":{"type":"string","enum":["LARGE","COMPACT"]},"clientView":{"type":"object","properties":{"allowDownload":{"type":"boolean"},"allowChat":{"type":"boolean"},"showDiscounts":{"type":"boolean"},"show360":{"type":"boolean"},"showAR":{"type":"boolean"},"allowImageDownload360":{"type":"boolean"}},"required":["allowDownload","allowChat","showDiscounts","show360","showAR","allowImageDownload360"],"additionalProperties":false},"quoteHeader":{"type":"object","properties":{"showIntroduction":{"type":"boolean"},"showYourCompanyName":{"type":"boolean"},"showName":{"type":"boolean"},"showCompanyName":{"type":"boolean"},"showAddress":{"type":"boolean"},"showContactNumber":{"type":"boolean"},"showWebsite":{"type":"boolean"},"showEmail":{"type":"boolean"},"showReceiverCompany":{"type":"boolean"},"showRecipientName":{"type":"boolean"},"showDeliveryAddress":{"type":"boolean"},"showCompanyAddress":{"type":"boolean"}},"required":["showIntroduction","showYourCompanyName","showName","showCompanyName","showAddress","showContactNumber","showWebsite","showEmail","showReceiverCompany","showRecipientName","showDeliveryAddress","showCompanyAddress"],"additionalProperties":false},"quoteSummary":{"type":"object","properties":{"showDescription":{"type":"boolean"},"showGroupTable":{"type":"boolean"},"showPaymentTerms":{"type":"boolean"},"overrideVatMessage":{"type":"boolean"},"vatMessage":{"anyOf":[{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},{"type":"null"}]}},"required":["showDescription","showGroupTable","showPaymentTerms","overrideVatMessage","vatMessage"],"additionalProperties":false},"conditionsPDF":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Original file name."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Absolute URL of the file on the CDN."}},"required":["id","label","url"],"additionalProperties":false},{"type":"null"}]},"description":"Conditions PDF per language code."}},"required":["numberOfValidUntilDays","numberOfExpirationDays","clientView","quoteHeader","quoteSummary","conditionsPDF"],"additionalProperties":false}},"required":["stages","lostReasons","settings"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Quotation Settings (GET /v1/quotations/settings). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsSettingsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsSettingsRequest":{"type":"object","properties":{"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"chance":{"type":"number","minimum":0,"maximum":100},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["chance","name"],"additionalProperties":false}},"lostReasons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"required":["name"],"additionalProperties":false}},"settings":{"description":"Display and validity settings. Omit to keep the stored ones.","type":"object","properties":{"numberOfValidUntilDays":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Days a quote is valid for; null when unset."},"numberOfExpirationDays":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"description":"Days until a quote expires; null when unset."},"widgetType":{"type":"string","enum":["LARGE","COMPACT"]},"clientView":{"type":"object","properties":{"allowDownload":{"type":"boolean"},"allowChat":{"type":"boolean"},"showDiscounts":{"type":"boolean"},"show360":{"type":"boolean"},"showAR":{"type":"boolean"},"allowImageDownload360":{"type":"boolean"}},"additionalProperties":false},"quoteHeader":{"type":"object","properties":{"showIntroduction":{"type":"boolean"},"showYourCompanyName":{"type":"boolean"},"showName":{"type":"boolean"},"showCompanyName":{"type":"boolean"},"showAddress":{"type":"boolean"},"showContactNumber":{"type":"boolean"},"showWebsite":{"type":"boolean"},"showEmail":{"type":"boolean"},"showReceiverCompany":{"type":"boolean"},"showRecipientName":{"type":"boolean"},"showDeliveryAddress":{"type":"boolean"},"showCompanyAddress":{"type":"boolean"}},"additionalProperties":false},"quoteSummary":{"type":"object","properties":{"showDescription":{"type":"boolean"},"showGroupTable":{"type":"boolean"},"showPaymentTerms":{"type":"boolean"},"overrideVatMessage":{"type":"boolean"},"vatMessage":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]}},"additionalProperties":false},"conditionsPDF":{"type":"object","propertyNames":{"type":"string","minLength":1},"additionalProperties":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string","minLength":1,"description":"URL of a PDF, Word (.doc) or plain-text file in your media library, as GET or the Files operations return it."}},"required":["url"],"additionalProperties":false},{"type":"null"}]},"description":"Conditions PDF per language code; replaces the stored files. `null` removes a language’s file; omitted keeps the stored files."}},"required":["numberOfValidUntilDays","numberOfExpirationDays","clientView","quoteHeader","quoteSummary"],"additionalProperties":false}},"required":["stages","lostReasons"],"additionalProperties":false,"description":"Data schema used by Update Quotation Settings (PUT /v1/quotations/settings). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"quotationId":{"type":"string","pattern":"^QUOT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Quotation identifier (QUOT-<uuid>)."},"quotationName":{"anyOf":[{"type":"string"},{"type":"null"}]},"quotationNumber":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"status":{"type":"string","enum":["OPEN","WON","LOST"]},"stageId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Raw configured stage identifier, or null when unset."},"stageName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Resolved stage name, or null when unset/unconfigured."},"ownerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Current quotation metadata price; use version.pricing.total for the selected version."},"currentVersionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"numOfVersions":{"anyOf":[{"type":"number"},{"type":"null"}]},"validUntil":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."},"expectedClose":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."},"paymentTerms":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"lostReasonId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Raw configured lost-reason identifier, or null when unset."},"lostReasonName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Resolved lost-reason name, or null when unset/unconfigured."},"lostComment":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"isPrivate":{"type":"boolean"},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"owner":{"type":"object","properties":{"ownerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["ownerId","firstName","lastName","email","phoneNumber"],"additionalProperties":false},"shortCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"addresses":{"type":"array","items":{},"description":"Quotation addresses; shape is quotation-defined (opaque)."},"contactId":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"version":{"type":"object","properties":{"versionId":{"type":"string"},"summary":{"type":"object","properties":{"description":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Complete formatted summary, including any payment, bank, and delivery text entered on the quote."}},"required":["description"],"additionalProperties":false},"introduction":{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Complete formatted introduction."}},"required":["title","description"],"additionalProperties":false},"pricing":{"type":"object","properties":{"products":{"type":"object","properties":{"salePrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sale total for included products."},"regPrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regular total for included products."},"totalQuantity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sum of included product row quantities across the version."},"discountPercentage":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Discount against the products regular total, in percentage points."}},"required":["salePrice","regPrice","totalQuantity","discountPercentage"],"additionalProperties":false},"additional":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fixedAmount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Signed fixed charge; null for percentage charges."},"percentageOfProductsTotal":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage points applied to the products sale total; null for fixed charges."},"adjustmentAmount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Signed amount added to the subtotal; percentages use the products sale total as their base."}},"required":["name","fixedAmount","percentageOfProductsTotal","adjustmentAmount"],"additionalProperties":false}},"subtotal":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Products plus additional selling charges, before final discount."},"finalDiscount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Amount subtracted from the subtotal."},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Authoritative selling total for this quotation version."}},"required":["products","additional","subtotal","finalDiscount","total"],"additionalProperties":false},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Formatted group description."},"pricing":{"type":"object","properties":{"salePrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Selling total for included rows in this group."},"regPrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regular total for included rows in this group."},"totalQuantity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sum of included product row quantities in this group."},"discountPercentage":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Discount against the group regular total, in percentage points."}},"required":["salePrice","regPrice","totalQuantity","discountPercentage"],"additionalProperties":false},"settings":{"type":"object","properties":{"hideTitle":{"type":"boolean"},"newPage":{"type":"boolean","description":"Start this group on a new PDF page."}},"required":["hideTitle","newPage"],"additionalProperties":false},"blocks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"blockType":{"anyOf":[{"type":"string"},{"type":"null"}]},"selectedLineId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Selected quotation row id in a PRODUCT_MULTI block."},"newPage":{"type":"boolean","description":"Page-break preference stored on the block."},"content":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Formatted text-block content in quotation order; empty strings when the block has no text."},"products":{"type":"array","items":{"type":"object","properties":{"lineId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique quotation row id, distinct from catalogue productId."},"parentLineId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Parent quotation row id for a child row."},"optional":{"type":"boolean","description":"Whether this quotation row is optional."},"selectedOptional":{"type":"boolean","description":"Whether an optional row is selected."},"previewImage":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Formatted product description, separate from notes."},"productId":{"anyOf":[{"type":"string"},{"type":"null"}]},"configurationCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"options":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"hideOnSpecification":{"type":"boolean","description":"Omit this option from the customer-facing specification when true."},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"previewImage":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","hideOnSpecification","value","previewImage"],"additionalProperties":false}},"sku":{"anyOf":[{"type":"string"},{"type":"null"}]},"unitSalePrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Selling price per unit, before any one-time line charge."},"unitRegPrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regular price per unit."},"oneTimeCharge":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Charge applied once to the line and included in both salePrice and regPrice."},"salePrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Selling total for the entire quotation row."},"regPrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regular total for the entire quotation row."}},"required":["lineId","parentLineId","optional","selectedOptional","previewImage","notes","description","productId","configurationCode","type","variantCode","quantity","name","options","sku","unitSalePrice","unitRegPrice","oneTimeCharge","salePrice","regPrice"],"additionalProperties":false}},"gallery":{"anyOf":[{"type":"object","properties":{"numOfColumns":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"items":{"type":"array","items":{"type":"object","properties":{"mediaType":{"anyOf":[{"type":"string","enum":["IMAGE","VIDEO"]},{"type":"null"}]},"mediaSource":{"anyOf":[{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},{"type":"null"}]},"fileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Absolute media URL; null if the item has no file path or URL."},"caption":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoplay":{"type":"boolean"},"loop":{"type":"boolean"}},"required":["mediaType","mediaSource","fileId","url","caption","autoplay","loop"],"additionalProperties":false},"description":"Gallery media in display order."}},"required":["numOfColumns","items"],"additionalProperties":false},{"type":"null"}]},"documents":{"type":"array","items":{"type":"object","properties":{"fileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"directoryPath":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Source directory for resolving file details."}},"required":["fileId","directoryPath"],"additionalProperties":false}}},"required":["id","blockType","selectedLineId","newPage","content","products","gallery","documents"],"additionalProperties":false}}},"required":["id","title","description","pricing","settings","blocks"],"additionalProperties":false}}},"required":["versionId","summary","introduction","pricing","groups"],"additionalProperties":false}},"required":["quotationId","quotationName","quotationNumber","status","stageId","stageName","ownerId","currency","price","currentVersionId","numOfVersions","validUntil","expectedClose","paymentTerms","language","lostReasonId","lostReasonName","lostComment","isPrivate","createdAt","modifiedAt","owner","shortCode","addresses","contactId","companyId","version"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Quotation (GET /v1/quotations/{quotationId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"quotationId":{"type":"string","pattern":"^QUOT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Quotation identifier (QUOT-<uuid>)."},"status":{"type":"string","enum":["OPEN","WON","LOST"]}},"required":["quotationId","status"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Set Quotation Status (POST /v1/quotations/{quotationId}/status). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsStatusRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsStatusRequest":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"OPEN"}},"required":["status"],"additionalProperties":false,"title":"Open"},{"type":"object","properties":{"status":{"type":"string","const":"WON"},"versionId":{"type":"string","pattern":"^VERSION_\\d+$"},"acceptedByName":{"type":"string","minLength":1,"maxLength":255},"acceptNotes":{"type":"string","maxLength":5000}},"required":["status","versionId","acceptedByName"],"additionalProperties":false,"title":"Won"},{"type":"object","properties":{"status":{"type":"string","const":"LOST"},"lostReasonId":{"type":"string","minLength":1,"maxLength":255},"lostComment":{"type":"string","maxLength":5000}},"required":["status","lostReasonId"],"additionalProperties":false,"title":"Lost"}],"description":"Data schema used by Set Quotation Status (POST /v1/quotations/{quotationId}/status). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsMutation2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsMutation2":{"type":"object","properties":{"data":{"type":"object","properties":{"quotationId":{"type":"string","pattern":"^QUOT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Quotation identifier (QUOT-<uuid>)."},"stageId":{"type":"string"},"stageName":{"type":"string"}},"required":["quotationId","stageId","stageName"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Set Quotation Stage (POST /v1/quotations/{quotationId}/stage). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsStageRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsStageRequest":{"type":"object","properties":{"stageId":{"type":"string","minLength":1,"maxLength":255}},"required":["stageId"],"additionalProperties":false,"description":"Data schema used by Set Quotation Stage (POST /v1/quotations/{quotationId}/stage). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsVersions object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsVersions":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string"},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."}},"required":["versionId","status","createdAt","modifiedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Quotation Versions (GET /v1/quotations/{quotationId}/versions). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsVersions2 object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsVersions2":{"type":"object","properties":{"data":{"type":"object","properties":{"versionId":{"type":"string"},"status":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."},"summary":{"type":"object","properties":{"description":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Complete formatted summary, including any payment, bank, and delivery text entered on the quote."}},"required":["description"],"additionalProperties":false},"introduction":{"type":"object","properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Complete formatted introduction."}},"required":["title","description"],"additionalProperties":false},"pricing":{"type":"object","properties":{"products":{"type":"object","properties":{"salePrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sale total for included products."},"regPrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regular total for included products."},"totalQuantity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sum of included product row quantities across the version."},"discountPercentage":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Discount against the products regular total, in percentage points."}},"required":["salePrice","regPrice","totalQuantity","discountPercentage"],"additionalProperties":false},"additional":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"fixedAmount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Signed fixed charge; null for percentage charges."},"percentageOfProductsTotal":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percentage points applied to the products sale total; null for fixed charges."},"adjustmentAmount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Signed amount added to the subtotal; percentages use the products sale total as their base."}},"required":["name","fixedAmount","percentageOfProductsTotal","adjustmentAmount"],"additionalProperties":false}},"subtotal":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Products plus additional selling charges, before final discount."},"finalDiscount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Amount subtracted from the subtotal."},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Authoritative selling total for this quotation version."}},"required":["products","additional","subtotal","finalDiscount","total"],"additionalProperties":false},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Formatted group description."},"pricing":{"type":"object","properties":{"salePrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Selling total for included rows in this group."},"regPrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regular total for included rows in this group."},"totalQuantity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Sum of included product row quantities in this group."},"discountPercentage":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Discount against the group regular total, in percentage points."}},"required":["salePrice","regPrice","totalQuantity","discountPercentage"],"additionalProperties":false},"settings":{"type":"object","properties":{"hideTitle":{"type":"boolean"},"newPage":{"type":"boolean","description":"Start this group on a new PDF page."}},"required":["hideTitle","newPage"],"additionalProperties":false},"blocks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"blockType":{"anyOf":[{"type":"string"},{"type":"null"}]},"selectedLineId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Selected quotation row id in a PRODUCT_MULTI block."},"newPage":{"type":"boolean","description":"Page-break preference stored on the block."},"content":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Formatted text-block content in quotation order; empty strings when the block has no text."},"products":{"type":"array","items":{"type":"object","properties":{"lineId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique quotation row id, distinct from catalogue productId."},"parentLineId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Parent quotation row id for a child row."},"optional":{"type":"boolean","description":"Whether this quotation row is optional."},"selectedOptional":{"type":"boolean","description":"Whether an optional row is selected."},"previewImage":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"description":"Formatted product description, separate from notes."},"productId":{"anyOf":[{"type":"string"},{"type":"null"}]},"configurationCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}]},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"options":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"hideOnSpecification":{"type":"boolean","description":"Omit this option from the customer-facing specification when true."},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"previewImage":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","hideOnSpecification","value","previewImage"],"additionalProperties":false}},"sku":{"anyOf":[{"type":"string"},{"type":"null"}]},"unitSalePrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Selling price per unit, before any one-time line charge."},"unitRegPrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regular price per unit."},"oneTimeCharge":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Charge applied once to the line and included in both salePrice and regPrice."},"salePrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Selling total for the entire quotation row."},"regPrice":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Regular total for the entire quotation row."}},"required":["lineId","parentLineId","optional","selectedOptional","previewImage","notes","description","productId","configurationCode","type","variantCode","quantity","name","options","sku","unitSalePrice","unitRegPrice","oneTimeCharge","salePrice","regPrice"],"additionalProperties":false}},"gallery":{"anyOf":[{"type":"object","properties":{"numOfColumns":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"items":{"type":"array","items":{"type":"object","properties":{"mediaType":{"anyOf":[{"type":"string","enum":["IMAGE","VIDEO"]},{"type":"null"}]},"mediaSource":{"anyOf":[{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},{"type":"null"}]},"fileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Absolute media URL; null if the item has no file path or URL."},"caption":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoplay":{"type":"boolean"},"loop":{"type":"boolean"}},"required":["mediaType","mediaSource","fileId","url","caption","autoplay","loop"],"additionalProperties":false},"description":"Gallery media in display order."}},"required":["numOfColumns","items"],"additionalProperties":false},{"type":"null"}]},"documents":{"type":"array","items":{"type":"object","properties":{"fileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"directoryPath":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Source directory for resolving file details."}},"required":["fileId","directoryPath"],"additionalProperties":false}}},"required":["id","blockType","selectedLineId","newPage","content","products","gallery","documents"],"additionalProperties":false}}},"required":["id","title","description","pricing","settings","blocks"],"additionalProperties":false}}},"required":["versionId","status","createdAt","modifiedAt","summary","introduction","pricing","groups"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Quotation Version (GET /v1/quotations/{quotationId}/versions/{versionId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The QuotationsNotes object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"QuotationsNotes":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"noteId":{"anyOf":[{"type":"string"},{"type":"null"}]},"noteTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"noteContent":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"attachments":{"type":"array","items":{"type":"object","properties":{"fileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["fileId","label","filePath"],"additionalProperties":false}},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 timestamp."}},"required":["noteId","noteTitle","noteContent","attachments","createdAt","modifiedAt"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List Quotation Notes (GET /v1/quotations/{quotationId}/notes). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The ScenesList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ScenesList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"sceneId":{"type":"string","pattern":"^SCEN-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"3D scene identifier (SCEN-<uuid>)."},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["sceneId","name","status","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List 3D Scenes (GET /v1/scenes). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The SceneConfiguration object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"SceneConfiguration":{"type":"object","properties":{"clearColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Background colour, optionally with alpha; null for a transparent background. An embed's own background colour takes precedence."},"environmentIntensity":{"type":"number","description":"How strongly the environment texture lights the product. Used only with an environment texture. Default: `1`."},"useLegacyLightingIntensityMode":{"type":"boolean","description":"Use the older lighting algorithm. The editor offers to switch a scene to the new one; a scene never switched uses the old one. Default: `true`."},"camera":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Camera id the editor assigns."},"name":{"type":"string","description":"Camera name, unique within the scene: the viewer tells cameras apart by name. Default: `\"MainCamera\"`."},"isEnabled":{"type":"boolean","description":"Whether the camera is in use; the scene opens on the first enabled camera. Default: `true`."},"isLocked":{"type":"boolean","description":"Locks the camera in the editor; locking also turns shopper camera controls off. Default: `false`."},"disableCameraControls":{"type":"boolean","description":"Stop shoppers rotating, zooming and panning this camera. Always on for a locked camera. Default: `false`."},"position":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Camera position as [x, y, z], in scene units. With target, this sets where the camera starts. Default: `[-5,1,-5]`."},"target":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Point the camera looks at and orbits, as [x, y, z]. Default: `[0,0,0]`."},"alpha":{"type":"number","description":"Horizontal orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`."},"beta":{"type":"number","description":"Vertical orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`."},"radius":{"type":"number","description":"Distance from the target, in scene units. The viewer recalculates it from position and target. Default: `10`."},"isOrtho":{"type":"boolean","description":"Use an orthographic instead of a perspective camera. Default: `false`."},"fov":{"type":"number","description":"Field of view, in degrees (0–180 in the editor). Perspective cameras only. Default: `30`."},"orthoTop":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Top edge of the orthographic view, in scene units. 0 counts as unset."},"orthoBottom":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Bottom edge of the orthographic view, in scene units. 0 counts as unset."},"orthoLeft":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Left edge of the orthographic view, in scene units. 0 counts as unset."},"orthoRight":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Right edge of the orthographic view, in scene units. 0 counts as unset."},"minZ":{"type":"number","description":"Nearest distance the camera draws, in scene units. Default: `0.1`."},"maxZ":{"type":"number","description":"Farthest distance the camera draws, in scene units. Default: `500`."},"useAlphaLimit":{"type":"boolean","description":"Apply lowerAlphaLimit and upperAlphaLimit. Off lets the camera turn all the way round. Default: `true`."},"lowerAlphaLimit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Lowest horizontal angle, in degrees; null for no lower limit."},"upperAlphaLimit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Highest horizontal angle, in degrees; null for no upper limit."},"useBetaLimit":{"type":"boolean","description":"Apply lowerBetaLimit and upperBetaLimit. Off allows -180 to 180 degrees. Default: `true`."},"lowerBetaLimit":{"type":"number","description":"Smallest vertical angle, in degrees from straight above: how close to overhead the camera can go. Default: `1`."},"upperBetaLimit":{"type":"number","description":"Largest vertical angle, in degrees from straight above; 90 is level with the target. Default: `89`."},"lowerRadiusLimit":{"type":"number","description":"Closest the shopper can zoom, in scene units. 0 counts as unset. Default: `1`."},"upperRadiusLimit":{"type":"number","description":"Farthest the shopper can zoom, in scene units. 0 counts as unset. Default: `200`."},"inertia":{"type":"number","description":"How long the camera keeps moving after the shopper lets go, 0–1. 0 counts as unset. Default: `0.9`."},"speed":{"type":"number","description":"Camera movement speed. 0 counts as unset. Default: `2`."},"useAutoRotationBehavior":{"type":"boolean","description":"Rotate around the target on its own while the shopper is idle. Default: `false`."},"idleRotationSpeed":{"type":"number","description":"Auto-rotation speed (0–5 in the editor). 0 counts as unset. Default: `0.05`."},"idleRotationWaitTime":{"type":"number","description":"Idle time before auto-rotation starts, in milliseconds. 0 counts as unset. Default: `2000`."},"idleRotationSpinupTime":{"type":"number","description":"Time auto-rotation takes to reach full speed, in milliseconds. 0 counts as unset. Default: `2000`."},"zoomStopsAnimation":{"type":"boolean","description":"Stop auto-rotation when the shopper zooms. Default: `false`."},"useBouncingBehavior":{"type":"boolean","description":"Bounce the camera back when it reaches a zoom limit. Default: `false`."},"useFramingBehavior":{"type":"boolean","description":"Zoom the camera to fit the product. Default: `false`."},"radiusScale":{"type":"number","description":"Scale applied to the framing distance; used with useFramingBehavior. 0 counts as unset. Default: `0.66`."},"framingTime":{"type":"number","description":"How long the framing zoom takes, in milliseconds; used with useFramingBehavior. Default: `0`."},"useNaturalPinchZoom":{"type":"boolean","description":"On touch screens, make the pinch zoom follow how far the fingers spread. Default: `false`."},"preventScroll":{"type":"boolean","description":"Turn off zooming with the mouse wheel and pinch, so the page scrolls instead. Default: `false`."},"zoomSensitivity":{"type":"number","description":"How sensitive zooming is, from 0.25 to 2. Default: `1`."},"collision":{"type":"boolean","description":"Stop the camera passing through objects that check collisions, such as the ground. Default: `true`."},"collisionRadius":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Size of the camera for collisions, as [x, y, z] in scene units; used with collision. Default: `[0.2,0.2,0.2]`."},"limitTarget":{"minItems":6,"maxItems":6,"type":"array","items":{"type":"number"},"description":"Box the target is kept inside when the shopper pans, as [maxX, minX, maxY, minY, maxZ, minZ] in scene units. The default lets the target move only between heights 0 and 1. Default: `[0,0,1,0,0,0]`."},"manualPanningSensibility":{"type":"boolean","description":"Use panningSensibility. Off derives it from the zoom distance (5000 ÷ distance). Default: `false`."},"panningSensibility":{"type":"number","description":"Panning sensibility used with manualPanningSensibility; higher values pan slower. Default: `1000`."}},"required":["id","name","isEnabled","isLocked","disableCameraControls","position","target","alpha","beta","radius","isOrtho","fov","orthoTop","orthoBottom","orthoLeft","orthoRight","minZ","maxZ","useAlphaLimit","lowerAlphaLimit","upperAlphaLimit","useBetaLimit","lowerBetaLimit","upperBetaLimit","lowerRadiusLimit","upperRadiusLimit","inertia","speed","useAutoRotationBehavior","idleRotationSpeed","idleRotationWaitTime","idleRotationSpinupTime","zoomStopsAnimation","useBouncingBehavior","useFramingBehavior","radiusScale","framingTime","useNaturalPinchZoom","preventScroll","zoomSensitivity","collision","collisionRadius","limitTarget","manualPanningSensibility","panningSensibility"],"additionalProperties":false},"description":"Cameras; the scene opens on the first enabled one."},"light":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Light id the editor assigns."},"name":{"type":"string","description":"Light name. Default: `\"Light\"`."},"type":{"type":"string","enum":["DIRECTIONAL","SPOT","POINT","HEMISPHERIC"],"description":"DIRECTIONAL: parallel rays, like sunlight. SPOT: a cone. POINT: shines every way from one point. HEMISPHERIC: soft light from all around. Default: `\"DIRECTIONAL\"`."},"isEnabled":{"type":"boolean","description":"Whether the light is on. Default: `true`."},"intensity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Light strength (0–5 in the editor). Required: the viewer has no default."},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Light colour; null for white."},"specularColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour of the highlights; null uses color, or white."},"groundColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour lighting surfaces from below. HEMISPHERIC lights only."},"position":{"anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}],"description":"Light position as [x, y, z], in scene units; null places it at the camera's position. Not used by HEMISPHERIC lights."},"direction":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Direction as [x, y, z]. The viewer replaces it by pointing the light from position to target. Default: `[0,0,0]`."},"target":{"anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}],"description":"Point the light shines at, as [x, y, z]. Required: the viewer cannot load the scene without it."},"angle":{"type":"number","description":"Cone width, in radians (the editor shows degrees). SPOT lights only. Default: `0`."},"innerAngle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Width of the fully lit inner cone, in radians. SPOT lights only. 0 counts as unset."},"exponent":{"type":"number","description":"How fast the light fades from the centre of the cone (0–10 in the editor). SPOT lights only. Default: `0`."},"radius":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the light source, in scene units; larger softens shadows."},"shadowEnabled":{"type":"boolean","description":"Whether the light casts shadows. Default: `true`."},"autoCalcShadowZBounds":{"type":"boolean","description":"Fit shadowMinZ and shadowMaxZ to the scene automatically. DIRECTIONAL lights only. Default: `false`."},"autoUpdateExtends":{"type":"boolean","description":"Refit the shadow area as objects move. DIRECTIONAL lights only, and only once autoCalcShadowZBounds is saved. Default: `false`."},"shadowMinZ":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Nearest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights."},"shadowMaxZ":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Farthest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights."},"falloffType":{"type":"string","enum":["DEFAULT","GLTF","PHYSICAL","STANDARD"],"description":"Formula for how the light fades with distance. Default: `\"DEFAULT\"`."},"intensityMode":{"type":"string","enum":["AUTOMATIC","LUMINOUS_POWER","LUMINOUS_INTENSITY","ILLUMINANCE","LUMINANCE"],"description":"Physical unit intensity is measured in. AUTOMATIC picks the usual one for the light type. Default: `\"AUTOMATIC\"`."}},"required":["id","name","type","isEnabled","intensity","color","specularColor","groundColor","position","direction","target","angle","innerAngle","exponent","radius","shadowEnabled","autoCalcShadowZBounds","autoUpdateExtends","shadowMinZ","shadowMaxZ","falloffType","intensityMode"],"additionalProperties":false},"description":"Lights, on top of the environment texture."},"ground":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Show a ground surface under the product. Default: `false`."},"receiveShadows":{"type":"boolean","description":"Show shadows on the ground. Default: `true`."},"checkCollisions":{"type":"boolean","description":"Stop a camera with collision on from passing through the ground. Default: `true`."},"alpha":{"type":"number","description":"Ground opacity, 0–1. Default: `1`."},"useAlphaFromDiffuseTexture":{"type":"boolean","description":"Take transparency from the ground texture's alpha channel. Default: `true`."},"diffuseColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ground colour. A product's floor colour takes precedence."},"specularColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour of the highlights."},"ambientColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour in shade."},"emissiveColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour the ground gives off regardless of light."},"specularPower":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Highlight sharpness; higher values give smaller, sharper highlights."},"grid":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Draw a grid in place of the ground surface; the ground then shows even when not enabled. Default: `false`."},"opacity":{"type":"number","description":"Grid opacity, 0–1. 0 counts as unset. Default: `1`."},"gridRatio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Distance between grid lines, in scene units."},"majorUnitFrequency":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Draw every nth line as a major line."},"minorUnitVisibility":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Visibility of the minor lines, 0–1."},"backFaceCulling":{"type":"boolean","description":"Hide the grid when seen from below. Default: `false`."},"mainColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour between the lines. A product's floor colour takes precedence."},"lineColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Line colour; null for light grey (#C1BCBC)."}},"required":["isEnabled","opacity","gridRatio","majorUnitFrequency","minorUnitVisibility","backFaceCulling","mainColor","lineColor"],"additionalProperties":false,"description":"Grid drawn on the ground."}},"required":["enabled","receiveShadows","checkCollisions","alpha","useAlphaFromDiffuseTexture","diffuseColor","specularColor","ambientColor","emissiveColor","specularPower","grid"],"additionalProperties":false,"description":"Ground surface under the product."},"boundingBox":{"type":"object","properties":{"diffuseColor":{"type":"string","description":"Face colour. Default: `\"#808080\"`."},"specularColor":{"type":"string","description":"Colour of the highlights. Default: `\"#000000\"`."},"emissiveColor":{"type":"string","description":"Colour the faces give off regardless of light. Default: `\"#FFFFFF\"`."},"alpha":{"type":"number","description":"Face opacity, 0–1; at 0 only the edges show. Default: `0`."},"disableLighting":{"type":"boolean","description":"Draw the faces unaffected by the scene lights. Default: `true`."},"backFaceCulling":{"type":"boolean","description":"Hide the faces seen from inside the box. Default: `true`."},"showBackLines":{"type":"boolean","description":"Also draw the edges behind the product. Default: `false`."},"size":{"type":"number","description":"Edge length of the box when created, in scene units. Default: `1`."},"edgesWidth":{"type":"number","description":"Edge line width. Default: `1`."},"edgesColor":{"type":"string","description":"Edge colour, with alpha. Default: `\"#000000B3\"`."}},"required":["diffuseColor","specularColor","emissiveColor","alpha","disableLighting","backFaceCulling","showBackLines","size","edgesWidth","edgesColor"],"additionalProperties":false,"description":"Look of the box the viewer keeps around the product's bounds; it stays hidden until a feature shows it."}},"required":["clearColor","environmentIntensity","useLegacyLightingIntensityMode","camera","light","ground","boundingBox"],"additionalProperties":false,"description":"The 3D editor's scene setup: background, environment strength, lighting mode, cameras, lights, ground and bounding box. A field never saved reads as the value the 3D viewer uses for it, or null when the viewer has no fixed value."}}}}
```

## The ScenesDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ScenesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"sceneId":{"type":"string","pattern":"^SCEN-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"3D scene identifier (SCEN-<uuid>)."},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Plain text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"By language"}]},{"type":"null"}],"description":"Description, as stored: plain text or a `{ language: text }` map."},"defaultMaterialId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Default 3D material (DMAT-<uuid>), applied to model parts that have no material of their own."},"environmentTexture":{"anyOf":[{"type":"object","properties":{"path":{"type":"string","description":"Media-library path of the texture file."},"url":{"type":"string","description":"Absolute URL of the texture file, resolved against the CDN."}},"required":["path","url"],"additionalProperties":false},{"type":"null"}],"description":"Environment texture the scene reflects and is lit by; null when none."},"intensity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Brightness of the environment texture. Used only with an environment texture, and stored as 1 when a write leaves a textured scene without it; null when never set."},"contrast":{"type":"number","description":"Image contrast; 1 when never set."},"brightness":{"type":"number","description":"Image brightness (exposure); 1 when never set."},"rotation":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Rotation of the environment texture around the vertical axis, in degrees. Used only with an environment texture, and stored as 0 when a write leaves a textured scene without it; null when never set."},"sliderType":{"anyOf":[{"type":"string","enum":["NONE","SIDE","DOWN"]},{"type":"null"}],"description":"Stored with the scene; the current Mimeeq apps do not use it."},"sliderStyle":{"anyOf":[{"type":"string","enum":["ROUND","SQUARE"]},{"type":"null"}],"description":"Stored with the scene; the current Mimeeq apps do not use it."},"configuration":{"$ref":"#/components/schemas/SceneConfiguration"},"connectedProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","description":"Product identifier (PROD-<uuid>), for Get Product."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The product's variant code (its prefix)."},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]}},"required":["productId","name","variantCode","status"],"additionalProperties":false},"description":"Products that use this scene; a scene with any cannot be deleted. Read-only."}},"required":["sceneId","name","status","description","defaultMaterialId","environmentTexture","intensity","contrast","brightness","rotation","sliderType","sliderStyle","configuration","connectedProducts"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get 3D Scene (GET /v1/scenes/{sceneId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"SceneConfiguration":{"type":"object","properties":{"clearColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Background colour, optionally with alpha; null for a transparent background. An embed's own background colour takes precedence."},"environmentIntensity":{"type":"number","description":"How strongly the environment texture lights the product. Used only with an environment texture. Default: `1`."},"useLegacyLightingIntensityMode":{"type":"boolean","description":"Use the older lighting algorithm. The editor offers to switch a scene to the new one; a scene never switched uses the old one. Default: `true`."},"camera":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Camera id the editor assigns."},"name":{"type":"string","description":"Camera name, unique within the scene: the viewer tells cameras apart by name. Default: `\"MainCamera\"`."},"isEnabled":{"type":"boolean","description":"Whether the camera is in use; the scene opens on the first enabled camera. Default: `true`."},"isLocked":{"type":"boolean","description":"Locks the camera in the editor; locking also turns shopper camera controls off. Default: `false`."},"disableCameraControls":{"type":"boolean","description":"Stop shoppers rotating, zooming and panning this camera. Always on for a locked camera. Default: `false`."},"position":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Camera position as [x, y, z], in scene units. With target, this sets where the camera starts. Default: `[-5,1,-5]`."},"target":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Point the camera looks at and orbits, as [x, y, z]. Default: `[0,0,0]`."},"alpha":{"type":"number","description":"Horizontal orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`."},"beta":{"type":"number","description":"Vertical orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`."},"radius":{"type":"number","description":"Distance from the target, in scene units. The viewer recalculates it from position and target. Default: `10`."},"isOrtho":{"type":"boolean","description":"Use an orthographic instead of a perspective camera. Default: `false`."},"fov":{"type":"number","description":"Field of view, in degrees (0–180 in the editor). Perspective cameras only. Default: `30`."},"orthoTop":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Top edge of the orthographic view, in scene units. 0 counts as unset."},"orthoBottom":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Bottom edge of the orthographic view, in scene units. 0 counts as unset."},"orthoLeft":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Left edge of the orthographic view, in scene units. 0 counts as unset."},"orthoRight":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Right edge of the orthographic view, in scene units. 0 counts as unset."},"minZ":{"type":"number","description":"Nearest distance the camera draws, in scene units. Default: `0.1`."},"maxZ":{"type":"number","description":"Farthest distance the camera draws, in scene units. Default: `500`."},"useAlphaLimit":{"type":"boolean","description":"Apply lowerAlphaLimit and upperAlphaLimit. Off lets the camera turn all the way round. Default: `true`."},"lowerAlphaLimit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Lowest horizontal angle, in degrees; null for no lower limit."},"upperAlphaLimit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Highest horizontal angle, in degrees; null for no upper limit."},"useBetaLimit":{"type":"boolean","description":"Apply lowerBetaLimit and upperBetaLimit. Off allows -180 to 180 degrees. Default: `true`."},"lowerBetaLimit":{"type":"number","description":"Smallest vertical angle, in degrees from straight above: how close to overhead the camera can go. Default: `1`."},"upperBetaLimit":{"type":"number","description":"Largest vertical angle, in degrees from straight above; 90 is level with the target. Default: `89`."},"lowerRadiusLimit":{"type":"number","description":"Closest the shopper can zoom, in scene units. 0 counts as unset. Default: `1`."},"upperRadiusLimit":{"type":"number","description":"Farthest the shopper can zoom, in scene units. 0 counts as unset. Default: `200`."},"inertia":{"type":"number","description":"How long the camera keeps moving after the shopper lets go, 0–1. 0 counts as unset. Default: `0.9`."},"speed":{"type":"number","description":"Camera movement speed. 0 counts as unset. Default: `2`."},"useAutoRotationBehavior":{"type":"boolean","description":"Rotate around the target on its own while the shopper is idle. Default: `false`."},"idleRotationSpeed":{"type":"number","description":"Auto-rotation speed (0–5 in the editor). 0 counts as unset. Default: `0.05`."},"idleRotationWaitTime":{"type":"number","description":"Idle time before auto-rotation starts, in milliseconds. 0 counts as unset. Default: `2000`."},"idleRotationSpinupTime":{"type":"number","description":"Time auto-rotation takes to reach full speed, in milliseconds. 0 counts as unset. Default: `2000`."},"zoomStopsAnimation":{"type":"boolean","description":"Stop auto-rotation when the shopper zooms. Default: `false`."},"useBouncingBehavior":{"type":"boolean","description":"Bounce the camera back when it reaches a zoom limit. Default: `false`."},"useFramingBehavior":{"type":"boolean","description":"Zoom the camera to fit the product. Default: `false`."},"radiusScale":{"type":"number","description":"Scale applied to the framing distance; used with useFramingBehavior. 0 counts as unset. Default: `0.66`."},"framingTime":{"type":"number","description":"How long the framing zoom takes, in milliseconds; used with useFramingBehavior. Default: `0`."},"useNaturalPinchZoom":{"type":"boolean","description":"On touch screens, make the pinch zoom follow how far the fingers spread. Default: `false`."},"preventScroll":{"type":"boolean","description":"Turn off zooming with the mouse wheel and pinch, so the page scrolls instead. Default: `false`."},"zoomSensitivity":{"type":"number","description":"How sensitive zooming is, from 0.25 to 2. Default: `1`."},"collision":{"type":"boolean","description":"Stop the camera passing through objects that check collisions, such as the ground. Default: `true`."},"collisionRadius":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Size of the camera for collisions, as [x, y, z] in scene units; used with collision. Default: `[0.2,0.2,0.2]`."},"limitTarget":{"minItems":6,"maxItems":6,"type":"array","items":{"type":"number"},"description":"Box the target is kept inside when the shopper pans, as [maxX, minX, maxY, minY, maxZ, minZ] in scene units. The default lets the target move only between heights 0 and 1. Default: `[0,0,1,0,0,0]`."},"manualPanningSensibility":{"type":"boolean","description":"Use panningSensibility. Off derives it from the zoom distance (5000 ÷ distance). Default: `false`."},"panningSensibility":{"type":"number","description":"Panning sensibility used with manualPanningSensibility; higher values pan slower. Default: `1000`."}},"required":["id","name","isEnabled","isLocked","disableCameraControls","position","target","alpha","beta","radius","isOrtho","fov","orthoTop","orthoBottom","orthoLeft","orthoRight","minZ","maxZ","useAlphaLimit","lowerAlphaLimit","upperAlphaLimit","useBetaLimit","lowerBetaLimit","upperBetaLimit","lowerRadiusLimit","upperRadiusLimit","inertia","speed","useAutoRotationBehavior","idleRotationSpeed","idleRotationWaitTime","idleRotationSpinupTime","zoomStopsAnimation","useBouncingBehavior","useFramingBehavior","radiusScale","framingTime","useNaturalPinchZoom","preventScroll","zoomSensitivity","collision","collisionRadius","limitTarget","manualPanningSensibility","panningSensibility"],"additionalProperties":false},"description":"Cameras; the scene opens on the first enabled one."},"light":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Light id the editor assigns."},"name":{"type":"string","description":"Light name. Default: `\"Light\"`."},"type":{"type":"string","enum":["DIRECTIONAL","SPOT","POINT","HEMISPHERIC"],"description":"DIRECTIONAL: parallel rays, like sunlight. SPOT: a cone. POINT: shines every way from one point. HEMISPHERIC: soft light from all around. Default: `\"DIRECTIONAL\"`."},"isEnabled":{"type":"boolean","description":"Whether the light is on. Default: `true`."},"intensity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Light strength (0–5 in the editor). Required: the viewer has no default."},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Light colour; null for white."},"specularColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour of the highlights; null uses color, or white."},"groundColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour lighting surfaces from below. HEMISPHERIC lights only."},"position":{"anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}],"description":"Light position as [x, y, z], in scene units; null places it at the camera's position. Not used by HEMISPHERIC lights."},"direction":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Direction as [x, y, z]. The viewer replaces it by pointing the light from position to target. Default: `[0,0,0]`."},"target":{"anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}],"description":"Point the light shines at, as [x, y, z]. Required: the viewer cannot load the scene without it."},"angle":{"type":"number","description":"Cone width, in radians (the editor shows degrees). SPOT lights only. Default: `0`."},"innerAngle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Width of the fully lit inner cone, in radians. SPOT lights only. 0 counts as unset."},"exponent":{"type":"number","description":"How fast the light fades from the centre of the cone (0–10 in the editor). SPOT lights only. Default: `0`."},"radius":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the light source, in scene units; larger softens shadows."},"shadowEnabled":{"type":"boolean","description":"Whether the light casts shadows. Default: `true`."},"autoCalcShadowZBounds":{"type":"boolean","description":"Fit shadowMinZ and shadowMaxZ to the scene automatically. DIRECTIONAL lights only. Default: `false`."},"autoUpdateExtends":{"type":"boolean","description":"Refit the shadow area as objects move. DIRECTIONAL lights only, and only once autoCalcShadowZBounds is saved. Default: `false`."},"shadowMinZ":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Nearest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights."},"shadowMaxZ":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Farthest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights."},"falloffType":{"type":"string","enum":["DEFAULT","GLTF","PHYSICAL","STANDARD"],"description":"Formula for how the light fades with distance. Default: `\"DEFAULT\"`."},"intensityMode":{"type":"string","enum":["AUTOMATIC","LUMINOUS_POWER","LUMINOUS_INTENSITY","ILLUMINANCE","LUMINANCE"],"description":"Physical unit intensity is measured in. AUTOMATIC picks the usual one for the light type. Default: `\"AUTOMATIC\"`."}},"required":["id","name","type","isEnabled","intensity","color","specularColor","groundColor","position","direction","target","angle","innerAngle","exponent","radius","shadowEnabled","autoCalcShadowZBounds","autoUpdateExtends","shadowMinZ","shadowMaxZ","falloffType","intensityMode"],"additionalProperties":false},"description":"Lights, on top of the environment texture."},"ground":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Show a ground surface under the product. Default: `false`."},"receiveShadows":{"type":"boolean","description":"Show shadows on the ground. Default: `true`."},"checkCollisions":{"type":"boolean","description":"Stop a camera with collision on from passing through the ground. Default: `true`."},"alpha":{"type":"number","description":"Ground opacity, 0–1. Default: `1`."},"useAlphaFromDiffuseTexture":{"type":"boolean","description":"Take transparency from the ground texture's alpha channel. Default: `true`."},"diffuseColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ground colour. A product's floor colour takes precedence."},"specularColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour of the highlights."},"ambientColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour in shade."},"emissiveColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour the ground gives off regardless of light."},"specularPower":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Highlight sharpness; higher values give smaller, sharper highlights."},"grid":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Draw a grid in place of the ground surface; the ground then shows even when not enabled. Default: `false`."},"opacity":{"type":"number","description":"Grid opacity, 0–1. 0 counts as unset. Default: `1`."},"gridRatio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Distance between grid lines, in scene units."},"majorUnitFrequency":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Draw every nth line as a major line."},"minorUnitVisibility":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Visibility of the minor lines, 0–1."},"backFaceCulling":{"type":"boolean","description":"Hide the grid when seen from below. Default: `false`."},"mainColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour between the lines. A product's floor colour takes precedence."},"lineColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Line colour; null for light grey (#C1BCBC)."}},"required":["isEnabled","opacity","gridRatio","majorUnitFrequency","minorUnitVisibility","backFaceCulling","mainColor","lineColor"],"additionalProperties":false,"description":"Grid drawn on the ground."}},"required":["enabled","receiveShadows","checkCollisions","alpha","useAlphaFromDiffuseTexture","diffuseColor","specularColor","ambientColor","emissiveColor","specularPower","grid"],"additionalProperties":false,"description":"Ground surface under the product."},"boundingBox":{"type":"object","properties":{"diffuseColor":{"type":"string","description":"Face colour. Default: `\"#808080\"`."},"specularColor":{"type":"string","description":"Colour of the highlights. Default: `\"#000000\"`."},"emissiveColor":{"type":"string","description":"Colour the faces give off regardless of light. Default: `\"#FFFFFF\"`."},"alpha":{"type":"number","description":"Face opacity, 0–1; at 0 only the edges show. Default: `0`."},"disableLighting":{"type":"boolean","description":"Draw the faces unaffected by the scene lights. Default: `true`."},"backFaceCulling":{"type":"boolean","description":"Hide the faces seen from inside the box. Default: `true`."},"showBackLines":{"type":"boolean","description":"Also draw the edges behind the product. Default: `false`."},"size":{"type":"number","description":"Edge length of the box when created, in scene units. Default: `1`."},"edgesWidth":{"type":"number","description":"Edge line width. Default: `1`."},"edgesColor":{"type":"string","description":"Edge colour, with alpha. Default: `\"#000000B3\"`."}},"required":["diffuseColor","specularColor","emissiveColor","alpha","disableLighting","backFaceCulling","showBackLines","size","edgesWidth","edgesColor"],"additionalProperties":false,"description":"Look of the box the viewer keeps around the product's bounds; it stays hidden until a feature shows it."}},"required":["clearColor","environmentIntensity","useLegacyLightingIntensityMode","camera","light","ground","boundingBox"],"additionalProperties":false,"description":"The 3D editor's scene setup: background, environment strength, lighting mode, cameras, lights, ground and bounding box. A field never saved reads as the value the 3D viewer uses for it, or null when the viewer has no fixed value."}}}}
```

## The ScenesMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ScenesMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"sceneId":{"type":"string","pattern":"^SCEN-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"3D scene identifier (SCEN-<uuid>)."},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Plain text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"By language"}]},{"type":"null"}],"description":"Description, as stored: plain text or a `{ language: text }` map."},"defaultMaterialId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Default 3D material (DMAT-<uuid>), applied to model parts that have no material of their own."},"environmentTexture":{"anyOf":[{"type":"object","properties":{"path":{"type":"string","description":"Media-library path of the texture file."},"url":{"type":"string","description":"Absolute URL of the texture file, resolved against the CDN."}},"required":["path","url"],"additionalProperties":false},{"type":"null"}],"description":"Environment texture the scene reflects and is lit by; null when none."},"intensity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Brightness of the environment texture. Used only with an environment texture, and stored as 1 when a write leaves a textured scene without it; null when never set."},"contrast":{"type":"number","description":"Image contrast; 1 when never set."},"brightness":{"type":"number","description":"Image brightness (exposure); 1 when never set."},"rotation":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Rotation of the environment texture around the vertical axis, in degrees. Used only with an environment texture, and stored as 0 when a write leaves a textured scene without it; null when never set."},"sliderType":{"anyOf":[{"type":"string","enum":["NONE","SIDE","DOWN"]},{"type":"null"}],"description":"Stored with the scene; the current Mimeeq apps do not use it."},"sliderStyle":{"anyOf":[{"type":"string","enum":["ROUND","SQUARE"]},{"type":"null"}],"description":"Stored with the scene; the current Mimeeq apps do not use it."},"configuration":{"$ref":"#/components/schemas/SceneConfiguration"},"connectedProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","description":"Product identifier (PROD-<uuid>), for Get Product."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The product's variant code (its prefix)."},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]}},"required":["productId","name","variantCode","status"],"additionalProperties":false},"description":"Products that use this scene; a scene with any cannot be deleted. Read-only."}},"required":["sceneId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create 3D Scene (POST /v1/scenes). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"SceneConfiguration":{"type":"object","properties":{"clearColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Background colour, optionally with alpha; null for a transparent background. An embed's own background colour takes precedence."},"environmentIntensity":{"type":"number","description":"How strongly the environment texture lights the product. Used only with an environment texture. Default: `1`."},"useLegacyLightingIntensityMode":{"type":"boolean","description":"Use the older lighting algorithm. The editor offers to switch a scene to the new one; a scene never switched uses the old one. Default: `true`."},"camera":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Camera id the editor assigns."},"name":{"type":"string","description":"Camera name, unique within the scene: the viewer tells cameras apart by name. Default: `\"MainCamera\"`."},"isEnabled":{"type":"boolean","description":"Whether the camera is in use; the scene opens on the first enabled camera. Default: `true`."},"isLocked":{"type":"boolean","description":"Locks the camera in the editor; locking also turns shopper camera controls off. Default: `false`."},"disableCameraControls":{"type":"boolean","description":"Stop shoppers rotating, zooming and panning this camera. Always on for a locked camera. Default: `false`."},"position":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Camera position as [x, y, z], in scene units. With target, this sets where the camera starts. Default: `[-5,1,-5]`."},"target":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Point the camera looks at and orbits, as [x, y, z]. Default: `[0,0,0]`."},"alpha":{"type":"number","description":"Horizontal orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`."},"beta":{"type":"number","description":"Vertical orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`."},"radius":{"type":"number","description":"Distance from the target, in scene units. The viewer recalculates it from position and target. Default: `10`."},"isOrtho":{"type":"boolean","description":"Use an orthographic instead of a perspective camera. Default: `false`."},"fov":{"type":"number","description":"Field of view, in degrees (0–180 in the editor). Perspective cameras only. Default: `30`."},"orthoTop":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Top edge of the orthographic view, in scene units. 0 counts as unset."},"orthoBottom":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Bottom edge of the orthographic view, in scene units. 0 counts as unset."},"orthoLeft":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Left edge of the orthographic view, in scene units. 0 counts as unset."},"orthoRight":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Right edge of the orthographic view, in scene units. 0 counts as unset."},"minZ":{"type":"number","description":"Nearest distance the camera draws, in scene units. Default: `0.1`."},"maxZ":{"type":"number","description":"Farthest distance the camera draws, in scene units. Default: `500`."},"useAlphaLimit":{"type":"boolean","description":"Apply lowerAlphaLimit and upperAlphaLimit. Off lets the camera turn all the way round. Default: `true`."},"lowerAlphaLimit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Lowest horizontal angle, in degrees; null for no lower limit."},"upperAlphaLimit":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Highest horizontal angle, in degrees; null for no upper limit."},"useBetaLimit":{"type":"boolean","description":"Apply lowerBetaLimit and upperBetaLimit. Off allows -180 to 180 degrees. Default: `true`."},"lowerBetaLimit":{"type":"number","description":"Smallest vertical angle, in degrees from straight above: how close to overhead the camera can go. Default: `1`."},"upperBetaLimit":{"type":"number","description":"Largest vertical angle, in degrees from straight above; 90 is level with the target. Default: `89`."},"lowerRadiusLimit":{"type":"number","description":"Closest the shopper can zoom, in scene units. 0 counts as unset. Default: `1`."},"upperRadiusLimit":{"type":"number","description":"Farthest the shopper can zoom, in scene units. 0 counts as unset. Default: `200`."},"inertia":{"type":"number","description":"How long the camera keeps moving after the shopper lets go, 0–1. 0 counts as unset. Default: `0.9`."},"speed":{"type":"number","description":"Camera movement speed. 0 counts as unset. Default: `2`."},"useAutoRotationBehavior":{"type":"boolean","description":"Rotate around the target on its own while the shopper is idle. Default: `false`."},"idleRotationSpeed":{"type":"number","description":"Auto-rotation speed (0–5 in the editor). 0 counts as unset. Default: `0.05`."},"idleRotationWaitTime":{"type":"number","description":"Idle time before auto-rotation starts, in milliseconds. 0 counts as unset. Default: `2000`."},"idleRotationSpinupTime":{"type":"number","description":"Time auto-rotation takes to reach full speed, in milliseconds. 0 counts as unset. Default: `2000`."},"zoomStopsAnimation":{"type":"boolean","description":"Stop auto-rotation when the shopper zooms. Default: `false`."},"useBouncingBehavior":{"type":"boolean","description":"Bounce the camera back when it reaches a zoom limit. Default: `false`."},"useFramingBehavior":{"type":"boolean","description":"Zoom the camera to fit the product. Default: `false`."},"radiusScale":{"type":"number","description":"Scale applied to the framing distance; used with useFramingBehavior. 0 counts as unset. Default: `0.66`."},"framingTime":{"type":"number","description":"How long the framing zoom takes, in milliseconds; used with useFramingBehavior. Default: `0`."},"useNaturalPinchZoom":{"type":"boolean","description":"On touch screens, make the pinch zoom follow how far the fingers spread. Default: `false`."},"preventScroll":{"type":"boolean","description":"Turn off zooming with the mouse wheel and pinch, so the page scrolls instead. Default: `false`."},"zoomSensitivity":{"type":"number","description":"How sensitive zooming is, from 0.25 to 2. Default: `1`."},"collision":{"type":"boolean","description":"Stop the camera passing through objects that check collisions, such as the ground. Default: `true`."},"collisionRadius":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Size of the camera for collisions, as [x, y, z] in scene units; used with collision. Default: `[0.2,0.2,0.2]`."},"limitTarget":{"minItems":6,"maxItems":6,"type":"array","items":{"type":"number"},"description":"Box the target is kept inside when the shopper pans, as [maxX, minX, maxY, minY, maxZ, minZ] in scene units. The default lets the target move only between heights 0 and 1. Default: `[0,0,1,0,0,0]`."},"manualPanningSensibility":{"type":"boolean","description":"Use panningSensibility. Off derives it from the zoom distance (5000 ÷ distance). Default: `false`."},"panningSensibility":{"type":"number","description":"Panning sensibility used with manualPanningSensibility; higher values pan slower. Default: `1000`."}},"required":["id","name","isEnabled","isLocked","disableCameraControls","position","target","alpha","beta","radius","isOrtho","fov","orthoTop","orthoBottom","orthoLeft","orthoRight","minZ","maxZ","useAlphaLimit","lowerAlphaLimit","upperAlphaLimit","useBetaLimit","lowerBetaLimit","upperBetaLimit","lowerRadiusLimit","upperRadiusLimit","inertia","speed","useAutoRotationBehavior","idleRotationSpeed","idleRotationWaitTime","idleRotationSpinupTime","zoomStopsAnimation","useBouncingBehavior","useFramingBehavior","radiusScale","framingTime","useNaturalPinchZoom","preventScroll","zoomSensitivity","collision","collisionRadius","limitTarget","manualPanningSensibility","panningSensibility"],"additionalProperties":false},"description":"Cameras; the scene opens on the first enabled one."},"light":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Light id the editor assigns."},"name":{"type":"string","description":"Light name. Default: `\"Light\"`."},"type":{"type":"string","enum":["DIRECTIONAL","SPOT","POINT","HEMISPHERIC"],"description":"DIRECTIONAL: parallel rays, like sunlight. SPOT: a cone. POINT: shines every way from one point. HEMISPHERIC: soft light from all around. Default: `\"DIRECTIONAL\"`."},"isEnabled":{"type":"boolean","description":"Whether the light is on. Default: `true`."},"intensity":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Light strength (0–5 in the editor). Required: the viewer has no default."},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Light colour; null for white."},"specularColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour of the highlights; null uses color, or white."},"groundColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour lighting surfaces from below. HEMISPHERIC lights only."},"position":{"anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}],"description":"Light position as [x, y, z], in scene units; null places it at the camera's position. Not used by HEMISPHERIC lights."},"direction":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Direction as [x, y, z]. The viewer replaces it by pointing the light from position to target. Default: `[0,0,0]`."},"target":{"anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}],"description":"Point the light shines at, as [x, y, z]. Required: the viewer cannot load the scene without it."},"angle":{"type":"number","description":"Cone width, in radians (the editor shows degrees). SPOT lights only. Default: `0`."},"innerAngle":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Width of the fully lit inner cone, in radians. SPOT lights only. 0 counts as unset."},"exponent":{"type":"number","description":"How fast the light fades from the centre of the cone (0–10 in the editor). SPOT lights only. Default: `0`."},"radius":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Size of the light source, in scene units; larger softens shadows."},"shadowEnabled":{"type":"boolean","description":"Whether the light casts shadows. Default: `true`."},"autoCalcShadowZBounds":{"type":"boolean","description":"Fit shadowMinZ and shadowMaxZ to the scene automatically. DIRECTIONAL lights only. Default: `false`."},"autoUpdateExtends":{"type":"boolean","description":"Refit the shadow area as objects move. DIRECTIONAL lights only, and only once autoCalcShadowZBounds is saved. Default: `false`."},"shadowMinZ":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Nearest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights."},"shadowMaxZ":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Farthest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights."},"falloffType":{"type":"string","enum":["DEFAULT","GLTF","PHYSICAL","STANDARD"],"description":"Formula for how the light fades with distance. Default: `\"DEFAULT\"`."},"intensityMode":{"type":"string","enum":["AUTOMATIC","LUMINOUS_POWER","LUMINOUS_INTENSITY","ILLUMINANCE","LUMINANCE"],"description":"Physical unit intensity is measured in. AUTOMATIC picks the usual one for the light type. Default: `\"AUTOMATIC\"`."}},"required":["id","name","type","isEnabled","intensity","color","specularColor","groundColor","position","direction","target","angle","innerAngle","exponent","radius","shadowEnabled","autoCalcShadowZBounds","autoUpdateExtends","shadowMinZ","shadowMaxZ","falloffType","intensityMode"],"additionalProperties":false},"description":"Lights, on top of the environment texture."},"ground":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Show a ground surface under the product. Default: `false`."},"receiveShadows":{"type":"boolean","description":"Show shadows on the ground. Default: `true`."},"checkCollisions":{"type":"boolean","description":"Stop a camera with collision on from passing through the ground. Default: `true`."},"alpha":{"type":"number","description":"Ground opacity, 0–1. Default: `1`."},"useAlphaFromDiffuseTexture":{"type":"boolean","description":"Take transparency from the ground texture's alpha channel. Default: `true`."},"diffuseColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Ground colour. A product's floor colour takes precedence."},"specularColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour of the highlights."},"ambientColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour in shade."},"emissiveColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour the ground gives off regardless of light."},"specularPower":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Highlight sharpness; higher values give smaller, sharper highlights."},"grid":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Draw a grid in place of the ground surface; the ground then shows even when not enabled. Default: `false`."},"opacity":{"type":"number","description":"Grid opacity, 0–1. 0 counts as unset. Default: `1`."},"gridRatio":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Distance between grid lines, in scene units."},"majorUnitFrequency":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Draw every nth line as a major line."},"minorUnitVisibility":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Visibility of the minor lines, 0–1."},"backFaceCulling":{"type":"boolean","description":"Hide the grid when seen from below. Default: `false`."},"mainColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Colour between the lines. A product's floor colour takes precedence."},"lineColor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Line colour; null for light grey (#C1BCBC)."}},"required":["isEnabled","opacity","gridRatio","majorUnitFrequency","minorUnitVisibility","backFaceCulling","mainColor","lineColor"],"additionalProperties":false,"description":"Grid drawn on the ground."}},"required":["enabled","receiveShadows","checkCollisions","alpha","useAlphaFromDiffuseTexture","diffuseColor","specularColor","ambientColor","emissiveColor","specularPower","grid"],"additionalProperties":false,"description":"Ground surface under the product."},"boundingBox":{"type":"object","properties":{"diffuseColor":{"type":"string","description":"Face colour. Default: `\"#808080\"`."},"specularColor":{"type":"string","description":"Colour of the highlights. Default: `\"#000000\"`."},"emissiveColor":{"type":"string","description":"Colour the faces give off regardless of light. Default: `\"#FFFFFF\"`."},"alpha":{"type":"number","description":"Face opacity, 0–1; at 0 only the edges show. Default: `0`."},"disableLighting":{"type":"boolean","description":"Draw the faces unaffected by the scene lights. Default: `true`."},"backFaceCulling":{"type":"boolean","description":"Hide the faces seen from inside the box. Default: `true`."},"showBackLines":{"type":"boolean","description":"Also draw the edges behind the product. Default: `false`."},"size":{"type":"number","description":"Edge length of the box when created, in scene units. Default: `1`."},"edgesWidth":{"type":"number","description":"Edge line width. Default: `1`."},"edgesColor":{"type":"string","description":"Edge colour, with alpha. Default: `\"#000000B3\"`."}},"required":["diffuseColor","specularColor","emissiveColor","alpha","disableLighting","backFaceCulling","showBackLines","size","edgesWidth","edgesColor"],"additionalProperties":false,"description":"Look of the box the viewer keeps around the product's bounds; it stays hidden until a feature shows it."}},"required":["clearColor","environmentIntensity","useLegacyLightingIntensityMode","camera","light","ground","boundingBox"],"additionalProperties":false,"description":"The 3D editor's scene setup: background, environment strength, lighting mode, cameras, lights, ground and bounding box. A field never saved reads as the value the 3D viewer uses for it, or null when the viewer has no fixed value."}}}}
```

## The SceneConfigurationInput object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"SceneConfigurationInput":{"type":"object","properties":{"clearColor":{"description":"Background colour, optionally with alpha; null for a transparent background. An embed's own background colour takes precedence.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"},{"type":"null"}]},"environmentIntensity":{"description":"How strongly the environment texture lights the product. Used only with an environment texture. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"useLegacyLightingIntensityMode":{"description":"Use the older lighting algorithm. The editor offers to switch a scene to the new one; a scene never switched uses the old one. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"camera":{"description":"Cameras; the scene opens on the first enabled one.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"description":"Camera id the editor assigns.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"name":{"description":"Camera name, unique within the scene: the viewer tells cameras apart by name. Default: `\"MainCamera\"`.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"isEnabled":{"description":"Whether the camera is in use; the scene opens on the first enabled camera. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"isLocked":{"description":"Locks the camera in the editor; locking also turns shopper camera controls off. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"disableCameraControls":{"description":"Stop shoppers rotating, zooming and panning this camera. Always on for a locked camera. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"position":{"description":"Camera position as [x, y, z], in scene units. With target, this sets where the camera starts. Default: `[-5,1,-5]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"target":{"description":"Point the camera looks at and orbits, as [x, y, z]. Default: `[0,0,0]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"alpha":{"description":"Horizontal orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`.","anyOf":[{"type":"number"},{"type":"null"}]},"beta":{"description":"Vertical orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`.","anyOf":[{"type":"number"},{"type":"null"}]},"radius":{"description":"Distance from the target, in scene units. The viewer recalculates it from position and target. Default: `10`.","anyOf":[{"type":"number"},{"type":"null"}]},"isOrtho":{"description":"Use an orthographic instead of a perspective camera. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"fov":{"description":"Field of view, in degrees (0–180 in the editor). Perspective cameras only. Default: `30`.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoTop":{"description":"Top edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoBottom":{"description":"Bottom edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoLeft":{"description":"Left edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoRight":{"description":"Right edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"minZ":{"description":"Nearest distance the camera draws, in scene units. Default: `0.1`.","anyOf":[{"type":"number"},{"type":"null"}]},"maxZ":{"description":"Farthest distance the camera draws, in scene units. Default: `500`.","anyOf":[{"type":"number"},{"type":"null"}]},"useAlphaLimit":{"description":"Apply lowerAlphaLimit and upperAlphaLimit. Off lets the camera turn all the way round. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"lowerAlphaLimit":{"description":"Lowest horizontal angle, in degrees; null for no lower limit.","anyOf":[{"type":"number"},{"type":"null"}]},"upperAlphaLimit":{"description":"Highest horizontal angle, in degrees; null for no upper limit.","anyOf":[{"type":"number"},{"type":"null"}]},"useBetaLimit":{"description":"Apply lowerBetaLimit and upperBetaLimit. Off allows -180 to 180 degrees. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"lowerBetaLimit":{"description":"Smallest vertical angle, in degrees from straight above: how close to overhead the camera can go. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"upperBetaLimit":{"description":"Largest vertical angle, in degrees from straight above; 90 is level with the target. Default: `89`.","anyOf":[{"type":"number"},{"type":"null"}]},"lowerRadiusLimit":{"description":"Closest the shopper can zoom, in scene units. 0 counts as unset. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"upperRadiusLimit":{"description":"Farthest the shopper can zoom, in scene units. 0 counts as unset. Default: `200`.","anyOf":[{"type":"number"},{"type":"null"}]},"inertia":{"description":"How long the camera keeps moving after the shopper lets go, 0–1. 0 counts as unset. Default: `0.9`.","anyOf":[{"type":"number"},{"type":"null"}]},"speed":{"description":"Camera movement speed. 0 counts as unset. Default: `2`.","anyOf":[{"type":"number"},{"type":"null"}]},"useAutoRotationBehavior":{"description":"Rotate around the target on its own while the shopper is idle. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"idleRotationSpeed":{"description":"Auto-rotation speed (0–5 in the editor). 0 counts as unset. Default: `0.05`.","anyOf":[{"type":"number"},{"type":"null"}]},"idleRotationWaitTime":{"description":"Idle time before auto-rotation starts, in milliseconds. 0 counts as unset. Default: `2000`.","anyOf":[{"type":"number"},{"type":"null"}]},"idleRotationSpinupTime":{"description":"Time auto-rotation takes to reach full speed, in milliseconds. 0 counts as unset. Default: `2000`.","anyOf":[{"type":"number"},{"type":"null"}]},"zoomStopsAnimation":{"description":"Stop auto-rotation when the shopper zooms. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"useBouncingBehavior":{"description":"Bounce the camera back when it reaches a zoom limit. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"useFramingBehavior":{"description":"Zoom the camera to fit the product. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"radiusScale":{"description":"Scale applied to the framing distance; used with useFramingBehavior. 0 counts as unset. Default: `0.66`.","anyOf":[{"type":"number"},{"type":"null"}]},"framingTime":{"description":"How long the framing zoom takes, in milliseconds; used with useFramingBehavior. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"useNaturalPinchZoom":{"description":"On touch screens, make the pinch zoom follow how far the fingers spread. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"preventScroll":{"description":"Turn off zooming with the mouse wheel and pinch, so the page scrolls instead. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"zoomSensitivity":{"description":"How sensitive zooming is, from 0.25 to 2. Default: `1`.","anyOf":[{"type":"number","minimum":0.25,"maximum":2},{"type":"null"}]},"collision":{"description":"Stop the camera passing through objects that check collisions, such as the ground. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"collisionRadius":{"description":"Size of the camera for collisions, as [x, y, z] in scene units; used with collision. Default: `[0.2,0.2,0.2]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"limitTarget":{"description":"Box the target is kept inside when the shopper pans, as [maxX, minX, maxY, minY, maxZ, minZ] in scene units. The default lets the target move only between heights 0 and 1. Default: `[0,0,1,0,0,0]`.","anyOf":[{"minItems":6,"maxItems":6,"type":"array","items":{"type":"number"}},{"type":"null"}]},"manualPanningSensibility":{"description":"Use panningSensibility. Off derives it from the zoom distance (5000 ÷ distance). Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"panningSensibility":{"description":"Panning sensibility used with manualPanningSensibility; higher values pan slower. Default: `1000`.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false}},{"type":"null"}]},"light":{"description":"Lights, on top of the environment texture.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"description":"Light id the editor assigns.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"name":{"description":"Light name. Default: `\"Light\"`.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"type":{"description":"DIRECTIONAL: parallel rays, like sunlight. SPOT: a cone. POINT: shines every way from one point. HEMISPHERIC: soft light from all around. Default: `\"DIRECTIONAL\"`.","anyOf":[{"type":"string","enum":["DIRECTIONAL","SPOT","POINT","HEMISPHERIC"]},{"type":"null"}]},"isEnabled":{"description":"Whether the light is on. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"intensity":{"type":"number","description":"Light strength (0–5 in the editor). Required: the viewer has no default."},"color":{"description":"Light colour; null for white.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularColor":{"description":"Colour of the highlights; null uses color, or white.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"groundColor":{"description":"Colour lighting surfaces from below. HEMISPHERIC lights only.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"position":{"description":"Light position as [x, y, z], in scene units; null places it at the camera's position. Not used by HEMISPHERIC lights.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"direction":{"description":"Direction as [x, y, z]. The viewer replaces it by pointing the light from position to target. Default: `[0,0,0]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"target":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Point the light shines at, as [x, y, z]. Required: the viewer cannot load the scene without it."},"angle":{"description":"Cone width, in radians (the editor shows degrees). SPOT lights only. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"innerAngle":{"description":"Width of the fully lit inner cone, in radians. SPOT lights only. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"description":"How fast the light fades from the centre of the cone (0–10 in the editor). SPOT lights only. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"radius":{"description":"Size of the light source, in scene units; larger softens shadows.","anyOf":[{"type":"number"},{"type":"null"}]},"shadowEnabled":{"description":"Whether the light casts shadows. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"autoCalcShadowZBounds":{"description":"Fit shadowMinZ and shadowMaxZ to the scene automatically. DIRECTIONAL lights only. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"autoUpdateExtends":{"description":"Refit the shadow area as objects move. DIRECTIONAL lights only, and only once autoCalcShadowZBounds is saved. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"shadowMinZ":{"description":"Nearest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights.","anyOf":[{"type":"number"},{"type":"null"}]},"shadowMaxZ":{"description":"Farthest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights.","anyOf":[{"type":"number"},{"type":"null"}]},"falloffType":{"description":"Formula for how the light fades with distance. Default: `\"DEFAULT\"`.","anyOf":[{"type":"string","enum":["DEFAULT","GLTF","PHYSICAL","STANDARD"]},{"type":"null"}]},"intensityMode":{"description":"Physical unit intensity is measured in. AUTOMATIC picks the usual one for the light type. Default: `\"AUTOMATIC\"`.","anyOf":[{"type":"string","enum":["AUTOMATIC","LUMINOUS_POWER","LUMINOUS_INTENSITY","ILLUMINANCE","LUMINANCE"]},{"type":"null"}]}},"required":["intensity","target"],"additionalProperties":false}},{"type":"null"}]},"ground":{"description":"Ground surface under the product.","anyOf":[{"type":"object","properties":{"enabled":{"description":"Show a ground surface under the product. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"receiveShadows":{"description":"Show shadows on the ground. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"checkCollisions":{"description":"Stop a camera with collision on from passing through the ground. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"alpha":{"description":"Ground opacity, 0–1. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"useAlphaFromDiffuseTexture":{"description":"Take transparency from the ground texture's alpha channel. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"diffuseColor":{"description":"Ground colour. A product's floor colour takes precedence.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularColor":{"description":"Colour of the highlights.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"ambientColor":{"description":"Colour in shade.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"emissiveColor":{"description":"Colour the ground gives off regardless of light.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularPower":{"description":"Highlight sharpness; higher values give smaller, sharper highlights.","anyOf":[{"type":"number"},{"type":"null"}]},"grid":{"description":"Grid drawn on the ground.","anyOf":[{"type":"object","properties":{"isEnabled":{"description":"Draw a grid in place of the ground surface; the ground then shows even when not enabled. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"opacity":{"description":"Grid opacity, 0–1. 0 counts as unset. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"gridRatio":{"description":"Distance between grid lines, in scene units.","anyOf":[{"type":"number"},{"type":"null"}]},"majorUnitFrequency":{"description":"Draw every nth line as a major line.","anyOf":[{"type":"number"},{"type":"null"}]},"minorUnitVisibility":{"description":"Visibility of the minor lines, 0–1.","anyOf":[{"type":"number"},{"type":"null"}]},"backFaceCulling":{"description":"Hide the grid when seen from below. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"mainColor":{"description":"Colour between the lines. A product's floor colour takes precedence.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"lineColor":{"description":"Line colour; null for light grey (#C1BCBC).","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"boundingBox":{"description":"Look of the box the viewer keeps around the product's bounds; it stays hidden until a feature shows it.","anyOf":[{"type":"object","properties":{"diffuseColor":{"description":"Face colour. Default: `\"#808080\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularColor":{"description":"Colour of the highlights. Default: `\"#000000\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"emissiveColor":{"description":"Colour the faces give off regardless of light. Default: `\"#FFFFFF\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"alpha":{"description":"Face opacity, 0–1; at 0 only the edges show. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"disableLighting":{"description":"Draw the faces unaffected by the scene lights. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"backFaceCulling":{"description":"Hide the faces seen from inside the box. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"showBackLines":{"description":"Also draw the edges behind the product. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"size":{"description":"Edge length of the box when created, in scene units. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"edgesWidth":{"description":"Edge line width. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"edgesColor":{"description":"Edge colour, with alpha. Default: `\"#000000B3\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false,"description":"The whole scene configuration. It replaces the stored one: a field you leave out or send as null is unset, and the scene then uses its default. Keys the API does not describe stay as stored, except inside camera and light entries, which are stored exactly as sent."}}}}
```

## The ScenesCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ScenesCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Scene name."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Plain text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"By language"}]},{"type":"null"}]},"defaultMaterialId":{"description":"Default 3D material (DMAT-<uuid>), applied to model parts that have no material of their own. Send null to remove it.","anyOf":[{"type":"string","pattern":"^DMAT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},{"type":"null"}]},"environmentTexturePath":{"description":"Media-library path of the environment texture file, or its URL on this environment's CDN. Must name one of your media-library files; a URL on any other host is rejected. Send null to remove the texture.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"intensity":{"description":"Brightness of the environment texture. Used only with an environment texture, and stored as 1 when a write leaves a textured scene without it; null when never set. Send null to unset it.","anyOf":[{"type":"number"},{"type":"null"}]},"contrast":{"description":"Image contrast; 1 when never set. Send null to unset it.","anyOf":[{"type":"number"},{"type":"null"}]},"brightness":{"description":"Image brightness (exposure); 1 when never set. Send null to unset it.","anyOf":[{"type":"number"},{"type":"null"}]},"rotation":{"description":"Rotation of the environment texture around the vertical axis, in degrees. Used only with an environment texture, and stored as 0 when a write leaves a textured scene without it; null when never set. Send null to unset it.","anyOf":[{"type":"number"},{"type":"null"}]},"sliderType":{"description":"Stored with the scene; the current Mimeeq apps do not use it.","type":"string","enum":["NONE","SIDE","DOWN"]},"sliderStyle":{"description":"Stored with the scene; the current Mimeeq apps do not use it.","type":"string","enum":["ROUND","SQUARE"]},"configuration":{"description":"Replaces the whole scene configuration; null unsets it. Omit it to keep it.","anyOf":[{"$ref":"#/components/schemas/SceneConfigurationInput"},{"type":"null"}]}},"required":["name"],"additionalProperties":false,"description":"Data schema used by Create 3D Scene (POST /v1/scenes). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"SceneConfigurationInput":{"type":"object","properties":{"clearColor":{"description":"Background colour, optionally with alpha; null for a transparent background. An embed's own background colour takes precedence.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"},{"type":"null"}]},"environmentIntensity":{"description":"How strongly the environment texture lights the product. Used only with an environment texture. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"useLegacyLightingIntensityMode":{"description":"Use the older lighting algorithm. The editor offers to switch a scene to the new one; a scene never switched uses the old one. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"camera":{"description":"Cameras; the scene opens on the first enabled one.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"description":"Camera id the editor assigns.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"name":{"description":"Camera name, unique within the scene: the viewer tells cameras apart by name. Default: `\"MainCamera\"`.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"isEnabled":{"description":"Whether the camera is in use; the scene opens on the first enabled camera. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"isLocked":{"description":"Locks the camera in the editor; locking also turns shopper camera controls off. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"disableCameraControls":{"description":"Stop shoppers rotating, zooming and panning this camera. Always on for a locked camera. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"position":{"description":"Camera position as [x, y, z], in scene units. With target, this sets where the camera starts. Default: `[-5,1,-5]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"target":{"description":"Point the camera looks at and orbits, as [x, y, z]. Default: `[0,0,0]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"alpha":{"description":"Horizontal orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`.","anyOf":[{"type":"number"},{"type":"null"}]},"beta":{"description":"Vertical orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`.","anyOf":[{"type":"number"},{"type":"null"}]},"radius":{"description":"Distance from the target, in scene units. The viewer recalculates it from position and target. Default: `10`.","anyOf":[{"type":"number"},{"type":"null"}]},"isOrtho":{"description":"Use an orthographic instead of a perspective camera. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"fov":{"description":"Field of view, in degrees (0–180 in the editor). Perspective cameras only. Default: `30`.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoTop":{"description":"Top edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoBottom":{"description":"Bottom edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoLeft":{"description":"Left edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoRight":{"description":"Right edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"minZ":{"description":"Nearest distance the camera draws, in scene units. Default: `0.1`.","anyOf":[{"type":"number"},{"type":"null"}]},"maxZ":{"description":"Farthest distance the camera draws, in scene units. Default: `500`.","anyOf":[{"type":"number"},{"type":"null"}]},"useAlphaLimit":{"description":"Apply lowerAlphaLimit and upperAlphaLimit. Off lets the camera turn all the way round. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"lowerAlphaLimit":{"description":"Lowest horizontal angle, in degrees; null for no lower limit.","anyOf":[{"type":"number"},{"type":"null"}]},"upperAlphaLimit":{"description":"Highest horizontal angle, in degrees; null for no upper limit.","anyOf":[{"type":"number"},{"type":"null"}]},"useBetaLimit":{"description":"Apply lowerBetaLimit and upperBetaLimit. Off allows -180 to 180 degrees. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"lowerBetaLimit":{"description":"Smallest vertical angle, in degrees from straight above: how close to overhead the camera can go. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"upperBetaLimit":{"description":"Largest vertical angle, in degrees from straight above; 90 is level with the target. Default: `89`.","anyOf":[{"type":"number"},{"type":"null"}]},"lowerRadiusLimit":{"description":"Closest the shopper can zoom, in scene units. 0 counts as unset. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"upperRadiusLimit":{"description":"Farthest the shopper can zoom, in scene units. 0 counts as unset. Default: `200`.","anyOf":[{"type":"number"},{"type":"null"}]},"inertia":{"description":"How long the camera keeps moving after the shopper lets go, 0–1. 0 counts as unset. Default: `0.9`.","anyOf":[{"type":"number"},{"type":"null"}]},"speed":{"description":"Camera movement speed. 0 counts as unset. Default: `2`.","anyOf":[{"type":"number"},{"type":"null"}]},"useAutoRotationBehavior":{"description":"Rotate around the target on its own while the shopper is idle. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"idleRotationSpeed":{"description":"Auto-rotation speed (0–5 in the editor). 0 counts as unset. Default: `0.05`.","anyOf":[{"type":"number"},{"type":"null"}]},"idleRotationWaitTime":{"description":"Idle time before auto-rotation starts, in milliseconds. 0 counts as unset. Default: `2000`.","anyOf":[{"type":"number"},{"type":"null"}]},"idleRotationSpinupTime":{"description":"Time auto-rotation takes to reach full speed, in milliseconds. 0 counts as unset. Default: `2000`.","anyOf":[{"type":"number"},{"type":"null"}]},"zoomStopsAnimation":{"description":"Stop auto-rotation when the shopper zooms. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"useBouncingBehavior":{"description":"Bounce the camera back when it reaches a zoom limit. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"useFramingBehavior":{"description":"Zoom the camera to fit the product. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"radiusScale":{"description":"Scale applied to the framing distance; used with useFramingBehavior. 0 counts as unset. Default: `0.66`.","anyOf":[{"type":"number"},{"type":"null"}]},"framingTime":{"description":"How long the framing zoom takes, in milliseconds; used with useFramingBehavior. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"useNaturalPinchZoom":{"description":"On touch screens, make the pinch zoom follow how far the fingers spread. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"preventScroll":{"description":"Turn off zooming with the mouse wheel and pinch, so the page scrolls instead. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"zoomSensitivity":{"description":"How sensitive zooming is, from 0.25 to 2. Default: `1`.","anyOf":[{"type":"number","minimum":0.25,"maximum":2},{"type":"null"}]},"collision":{"description":"Stop the camera passing through objects that check collisions, such as the ground. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"collisionRadius":{"description":"Size of the camera for collisions, as [x, y, z] in scene units; used with collision. Default: `[0.2,0.2,0.2]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"limitTarget":{"description":"Box the target is kept inside when the shopper pans, as [maxX, minX, maxY, minY, maxZ, minZ] in scene units. The default lets the target move only between heights 0 and 1. Default: `[0,0,1,0,0,0]`.","anyOf":[{"minItems":6,"maxItems":6,"type":"array","items":{"type":"number"}},{"type":"null"}]},"manualPanningSensibility":{"description":"Use panningSensibility. Off derives it from the zoom distance (5000 ÷ distance). Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"panningSensibility":{"description":"Panning sensibility used with manualPanningSensibility; higher values pan slower. Default: `1000`.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false}},{"type":"null"}]},"light":{"description":"Lights, on top of the environment texture.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"description":"Light id the editor assigns.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"name":{"description":"Light name. Default: `\"Light\"`.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"type":{"description":"DIRECTIONAL: parallel rays, like sunlight. SPOT: a cone. POINT: shines every way from one point. HEMISPHERIC: soft light from all around. Default: `\"DIRECTIONAL\"`.","anyOf":[{"type":"string","enum":["DIRECTIONAL","SPOT","POINT","HEMISPHERIC"]},{"type":"null"}]},"isEnabled":{"description":"Whether the light is on. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"intensity":{"type":"number","description":"Light strength (0–5 in the editor). Required: the viewer has no default."},"color":{"description":"Light colour; null for white.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularColor":{"description":"Colour of the highlights; null uses color, or white.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"groundColor":{"description":"Colour lighting surfaces from below. HEMISPHERIC lights only.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"position":{"description":"Light position as [x, y, z], in scene units; null places it at the camera's position. Not used by HEMISPHERIC lights.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"direction":{"description":"Direction as [x, y, z]. The viewer replaces it by pointing the light from position to target. Default: `[0,0,0]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"target":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Point the light shines at, as [x, y, z]. Required: the viewer cannot load the scene without it."},"angle":{"description":"Cone width, in radians (the editor shows degrees). SPOT lights only. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"innerAngle":{"description":"Width of the fully lit inner cone, in radians. SPOT lights only. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"description":"How fast the light fades from the centre of the cone (0–10 in the editor). SPOT lights only. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"radius":{"description":"Size of the light source, in scene units; larger softens shadows.","anyOf":[{"type":"number"},{"type":"null"}]},"shadowEnabled":{"description":"Whether the light casts shadows. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"autoCalcShadowZBounds":{"description":"Fit shadowMinZ and shadowMaxZ to the scene automatically. DIRECTIONAL lights only. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"autoUpdateExtends":{"description":"Refit the shadow area as objects move. DIRECTIONAL lights only, and only once autoCalcShadowZBounds is saved. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"shadowMinZ":{"description":"Nearest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights.","anyOf":[{"type":"number"},{"type":"null"}]},"shadowMaxZ":{"description":"Farthest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights.","anyOf":[{"type":"number"},{"type":"null"}]},"falloffType":{"description":"Formula for how the light fades with distance. Default: `\"DEFAULT\"`.","anyOf":[{"type":"string","enum":["DEFAULT","GLTF","PHYSICAL","STANDARD"]},{"type":"null"}]},"intensityMode":{"description":"Physical unit intensity is measured in. AUTOMATIC picks the usual one for the light type. Default: `\"AUTOMATIC\"`.","anyOf":[{"type":"string","enum":["AUTOMATIC","LUMINOUS_POWER","LUMINOUS_INTENSITY","ILLUMINANCE","LUMINANCE"]},{"type":"null"}]}},"required":["intensity","target"],"additionalProperties":false}},{"type":"null"}]},"ground":{"description":"Ground surface under the product.","anyOf":[{"type":"object","properties":{"enabled":{"description":"Show a ground surface under the product. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"receiveShadows":{"description":"Show shadows on the ground. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"checkCollisions":{"description":"Stop a camera with collision on from passing through the ground. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"alpha":{"description":"Ground opacity, 0–1. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"useAlphaFromDiffuseTexture":{"description":"Take transparency from the ground texture's alpha channel. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"diffuseColor":{"description":"Ground colour. A product's floor colour takes precedence.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularColor":{"description":"Colour of the highlights.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"ambientColor":{"description":"Colour in shade.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"emissiveColor":{"description":"Colour the ground gives off regardless of light.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularPower":{"description":"Highlight sharpness; higher values give smaller, sharper highlights.","anyOf":[{"type":"number"},{"type":"null"}]},"grid":{"description":"Grid drawn on the ground.","anyOf":[{"type":"object","properties":{"isEnabled":{"description":"Draw a grid in place of the ground surface; the ground then shows even when not enabled. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"opacity":{"description":"Grid opacity, 0–1. 0 counts as unset. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"gridRatio":{"description":"Distance between grid lines, in scene units.","anyOf":[{"type":"number"},{"type":"null"}]},"majorUnitFrequency":{"description":"Draw every nth line as a major line.","anyOf":[{"type":"number"},{"type":"null"}]},"minorUnitVisibility":{"description":"Visibility of the minor lines, 0–1.","anyOf":[{"type":"number"},{"type":"null"}]},"backFaceCulling":{"description":"Hide the grid when seen from below. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"mainColor":{"description":"Colour between the lines. A product's floor colour takes precedence.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"lineColor":{"description":"Line colour; null for light grey (#C1BCBC).","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"boundingBox":{"description":"Look of the box the viewer keeps around the product's bounds; it stays hidden until a feature shows it.","anyOf":[{"type":"object","properties":{"diffuseColor":{"description":"Face colour. Default: `\"#808080\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularColor":{"description":"Colour of the highlights. Default: `\"#000000\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"emissiveColor":{"description":"Colour the faces give off regardless of light. Default: `\"#FFFFFF\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"alpha":{"description":"Face opacity, 0–1; at 0 only the edges show. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"disableLighting":{"description":"Draw the faces unaffected by the scene lights. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"backFaceCulling":{"description":"Hide the faces seen from inside the box. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"showBackLines":{"description":"Also draw the edges behind the product. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"size":{"description":"Edge length of the box when created, in scene units. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"edgesWidth":{"description":"Edge line width. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"edgesColor":{"description":"Edge colour, with alpha. Default: `\"#000000B3\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false,"description":"The whole scene configuration. It replaces the stored one: a field you leave out or send as null is unset, and the scene then uses its default. Keys the API does not describe stay as stored, except inside camera and light entries, which are stored exactly as sent."}}}}
```

## The ScenesUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"ScenesUpdateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Scene name."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"description":{"anyOf":[{"anyOf":[{"type":"string","title":"Plain text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"By language"}]},{"type":"null"}]},"defaultMaterialId":{"description":"Default 3D material (DMAT-<uuid>), applied to model parts that have no material of their own. Send null to remove it.","anyOf":[{"type":"string","pattern":"^DMAT-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},{"type":"null"}]},"environmentTexturePath":{"description":"Media-library path of the environment texture file, or its URL on this environment's CDN. Must name one of your media-library files; a URL on any other host is rejected. Send null to remove the texture.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"intensity":{"description":"Brightness of the environment texture. Used only with an environment texture, and stored as 1 when a write leaves a textured scene without it; null when never set. Send null to unset it.","anyOf":[{"type":"number"},{"type":"null"}]},"contrast":{"description":"Image contrast; 1 when never set. Send null to unset it.","anyOf":[{"type":"number"},{"type":"null"}]},"brightness":{"description":"Image brightness (exposure); 1 when never set. Send null to unset it.","anyOf":[{"type":"number"},{"type":"null"}]},"rotation":{"description":"Rotation of the environment texture around the vertical axis, in degrees. Used only with an environment texture, and stored as 0 when a write leaves a textured scene without it; null when never set. Send null to unset it.","anyOf":[{"type":"number"},{"type":"null"}]},"sliderType":{"description":"Stored with the scene; the current Mimeeq apps do not use it.","type":"string","enum":["NONE","SIDE","DOWN"]},"sliderStyle":{"description":"Stored with the scene; the current Mimeeq apps do not use it.","type":"string","enum":["ROUND","SQUARE"]},"configuration":{"description":"Replaces the whole scene configuration; null unsets it. Omit it to keep it.","anyOf":[{"$ref":"#/components/schemas/SceneConfigurationInput"},{"type":"null"}]}},"additionalProperties":false,"description":"Data schema used by Update 3D Scene (PUT /v1/scenes/{sceneId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."},"SceneConfigurationInput":{"type":"object","properties":{"clearColor":{"description":"Background colour, optionally with alpha; null for a transparent background. An embed's own background colour takes precedence.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"},{"type":"null"}]},"environmentIntensity":{"description":"How strongly the environment texture lights the product. Used only with an environment texture. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"useLegacyLightingIntensityMode":{"description":"Use the older lighting algorithm. The editor offers to switch a scene to the new one; a scene never switched uses the old one. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"camera":{"description":"Cameras; the scene opens on the first enabled one.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"description":"Camera id the editor assigns.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"name":{"description":"Camera name, unique within the scene: the viewer tells cameras apart by name. Default: `\"MainCamera\"`.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"isEnabled":{"description":"Whether the camera is in use; the scene opens on the first enabled camera. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"isLocked":{"description":"Locks the camera in the editor; locking also turns shopper camera controls off. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"disableCameraControls":{"description":"Stop shoppers rotating, zooming and panning this camera. Always on for a locked camera. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"position":{"description":"Camera position as [x, y, z], in scene units. With target, this sets where the camera starts. Default: `[-5,1,-5]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"target":{"description":"Point the camera looks at and orbits, as [x, y, z]. Default: `[0,0,0]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"alpha":{"description":"Horizontal orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`.","anyOf":[{"type":"number"},{"type":"null"}]},"beta":{"description":"Vertical orbit angle, in radians. The viewer recalculates it from position and target. Default: `1.5707963267948966`.","anyOf":[{"type":"number"},{"type":"null"}]},"radius":{"description":"Distance from the target, in scene units. The viewer recalculates it from position and target. Default: `10`.","anyOf":[{"type":"number"},{"type":"null"}]},"isOrtho":{"description":"Use an orthographic instead of a perspective camera. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"fov":{"description":"Field of view, in degrees (0–180 in the editor). Perspective cameras only. Default: `30`.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoTop":{"description":"Top edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoBottom":{"description":"Bottom edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoLeft":{"description":"Left edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"orthoRight":{"description":"Right edge of the orthographic view, in scene units. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"minZ":{"description":"Nearest distance the camera draws, in scene units. Default: `0.1`.","anyOf":[{"type":"number"},{"type":"null"}]},"maxZ":{"description":"Farthest distance the camera draws, in scene units. Default: `500`.","anyOf":[{"type":"number"},{"type":"null"}]},"useAlphaLimit":{"description":"Apply lowerAlphaLimit and upperAlphaLimit. Off lets the camera turn all the way round. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"lowerAlphaLimit":{"description":"Lowest horizontal angle, in degrees; null for no lower limit.","anyOf":[{"type":"number"},{"type":"null"}]},"upperAlphaLimit":{"description":"Highest horizontal angle, in degrees; null for no upper limit.","anyOf":[{"type":"number"},{"type":"null"}]},"useBetaLimit":{"description":"Apply lowerBetaLimit and upperBetaLimit. Off allows -180 to 180 degrees. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"lowerBetaLimit":{"description":"Smallest vertical angle, in degrees from straight above: how close to overhead the camera can go. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"upperBetaLimit":{"description":"Largest vertical angle, in degrees from straight above; 90 is level with the target. Default: `89`.","anyOf":[{"type":"number"},{"type":"null"}]},"lowerRadiusLimit":{"description":"Closest the shopper can zoom, in scene units. 0 counts as unset. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"upperRadiusLimit":{"description":"Farthest the shopper can zoom, in scene units. 0 counts as unset. Default: `200`.","anyOf":[{"type":"number"},{"type":"null"}]},"inertia":{"description":"How long the camera keeps moving after the shopper lets go, 0–1. 0 counts as unset. Default: `0.9`.","anyOf":[{"type":"number"},{"type":"null"}]},"speed":{"description":"Camera movement speed. 0 counts as unset. Default: `2`.","anyOf":[{"type":"number"},{"type":"null"}]},"useAutoRotationBehavior":{"description":"Rotate around the target on its own while the shopper is idle. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"idleRotationSpeed":{"description":"Auto-rotation speed (0–5 in the editor). 0 counts as unset. Default: `0.05`.","anyOf":[{"type":"number"},{"type":"null"}]},"idleRotationWaitTime":{"description":"Idle time before auto-rotation starts, in milliseconds. 0 counts as unset. Default: `2000`.","anyOf":[{"type":"number"},{"type":"null"}]},"idleRotationSpinupTime":{"description":"Time auto-rotation takes to reach full speed, in milliseconds. 0 counts as unset. Default: `2000`.","anyOf":[{"type":"number"},{"type":"null"}]},"zoomStopsAnimation":{"description":"Stop auto-rotation when the shopper zooms. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"useBouncingBehavior":{"description":"Bounce the camera back when it reaches a zoom limit. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"useFramingBehavior":{"description":"Zoom the camera to fit the product. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"radiusScale":{"description":"Scale applied to the framing distance; used with useFramingBehavior. 0 counts as unset. Default: `0.66`.","anyOf":[{"type":"number"},{"type":"null"}]},"framingTime":{"description":"How long the framing zoom takes, in milliseconds; used with useFramingBehavior. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"useNaturalPinchZoom":{"description":"On touch screens, make the pinch zoom follow how far the fingers spread. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"preventScroll":{"description":"Turn off zooming with the mouse wheel and pinch, so the page scrolls instead. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"zoomSensitivity":{"description":"How sensitive zooming is, from 0.25 to 2. Default: `1`.","anyOf":[{"type":"number","minimum":0.25,"maximum":2},{"type":"null"}]},"collision":{"description":"Stop the camera passing through objects that check collisions, such as the ground. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"collisionRadius":{"description":"Size of the camera for collisions, as [x, y, z] in scene units; used with collision. Default: `[0.2,0.2,0.2]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"limitTarget":{"description":"Box the target is kept inside when the shopper pans, as [maxX, minX, maxY, minY, maxZ, minZ] in scene units. The default lets the target move only between heights 0 and 1. Default: `[0,0,1,0,0,0]`.","anyOf":[{"minItems":6,"maxItems":6,"type":"array","items":{"type":"number"}},{"type":"null"}]},"manualPanningSensibility":{"description":"Use panningSensibility. Off derives it from the zoom distance (5000 ÷ distance). Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"panningSensibility":{"description":"Panning sensibility used with manualPanningSensibility; higher values pan slower. Default: `1000`.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false}},{"type":"null"}]},"light":{"description":"Lights, on top of the environment texture.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"description":"Light id the editor assigns.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"name":{"description":"Light name. Default: `\"Light\"`.","anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"type":{"description":"DIRECTIONAL: parallel rays, like sunlight. SPOT: a cone. POINT: shines every way from one point. HEMISPHERIC: soft light from all around. Default: `\"DIRECTIONAL\"`.","anyOf":[{"type":"string","enum":["DIRECTIONAL","SPOT","POINT","HEMISPHERIC"]},{"type":"null"}]},"isEnabled":{"description":"Whether the light is on. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"intensity":{"type":"number","description":"Light strength (0–5 in the editor). Required: the viewer has no default."},"color":{"description":"Light colour; null for white.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularColor":{"description":"Colour of the highlights; null uses color, or white.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"groundColor":{"description":"Colour lighting surfaces from below. HEMISPHERIC lights only.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"position":{"description":"Light position as [x, y, z], in scene units; null places it at the camera's position. Not used by HEMISPHERIC lights.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"direction":{"description":"Direction as [x, y, z]. The viewer replaces it by pointing the light from position to target. Default: `[0,0,0]`.","anyOf":[{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"}},{"type":"null"}]},"target":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"number"},"description":"Point the light shines at, as [x, y, z]. Required: the viewer cannot load the scene without it."},"angle":{"description":"Cone width, in radians (the editor shows degrees). SPOT lights only. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"innerAngle":{"description":"Width of the fully lit inner cone, in radians. SPOT lights only. 0 counts as unset.","anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"description":"How fast the light fades from the centre of the cone (0–10 in the editor). SPOT lights only. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"radius":{"description":"Size of the light source, in scene units; larger softens shadows.","anyOf":[{"type":"number"},{"type":"null"}]},"shadowEnabled":{"description":"Whether the light casts shadows. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"autoCalcShadowZBounds":{"description":"Fit shadowMinZ and shadowMaxZ to the scene automatically. DIRECTIONAL lights only. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"autoUpdateExtends":{"description":"Refit the shadow area as objects move. DIRECTIONAL lights only, and only once autoCalcShadowZBounds is saved. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"shadowMinZ":{"description":"Nearest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights.","anyOf":[{"type":"number"},{"type":"null"}]},"shadowMaxZ":{"description":"Farthest distance from the light that casts shadows, in scene units. Not used by HEMISPHERIC lights.","anyOf":[{"type":"number"},{"type":"null"}]},"falloffType":{"description":"Formula for how the light fades with distance. Default: `\"DEFAULT\"`.","anyOf":[{"type":"string","enum":["DEFAULT","GLTF","PHYSICAL","STANDARD"]},{"type":"null"}]},"intensityMode":{"description":"Physical unit intensity is measured in. AUTOMATIC picks the usual one for the light type. Default: `\"AUTOMATIC\"`.","anyOf":[{"type":"string","enum":["AUTOMATIC","LUMINOUS_POWER","LUMINOUS_INTENSITY","ILLUMINANCE","LUMINANCE"]},{"type":"null"}]}},"required":["intensity","target"],"additionalProperties":false}},{"type":"null"}]},"ground":{"description":"Ground surface under the product.","anyOf":[{"type":"object","properties":{"enabled":{"description":"Show a ground surface under the product. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"receiveShadows":{"description":"Show shadows on the ground. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"checkCollisions":{"description":"Stop a camera with collision on from passing through the ground. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"alpha":{"description":"Ground opacity, 0–1. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"useAlphaFromDiffuseTexture":{"description":"Take transparency from the ground texture's alpha channel. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"diffuseColor":{"description":"Ground colour. A product's floor colour takes precedence.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularColor":{"description":"Colour of the highlights.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"ambientColor":{"description":"Colour in shade.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"emissiveColor":{"description":"Colour the ground gives off regardless of light.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularPower":{"description":"Highlight sharpness; higher values give smaller, sharper highlights.","anyOf":[{"type":"number"},{"type":"null"}]},"grid":{"description":"Grid drawn on the ground.","anyOf":[{"type":"object","properties":{"isEnabled":{"description":"Draw a grid in place of the ground surface; the ground then shows even when not enabled. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"opacity":{"description":"Grid opacity, 0–1. 0 counts as unset. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"gridRatio":{"description":"Distance between grid lines, in scene units.","anyOf":[{"type":"number"},{"type":"null"}]},"majorUnitFrequency":{"description":"Draw every nth line as a major line.","anyOf":[{"type":"number"},{"type":"null"}]},"minorUnitVisibility":{"description":"Visibility of the minor lines, 0–1.","anyOf":[{"type":"number"},{"type":"null"}]},"backFaceCulling":{"description":"Hide the grid when seen from below. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"mainColor":{"description":"Colour between the lines. A product's floor colour takes precedence.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"lineColor":{"description":"Line colour; null for light grey (#C1BCBC).","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"boundingBox":{"description":"Look of the box the viewer keeps around the product's bounds; it stays hidden until a feature shows it.","anyOf":[{"type":"object","properties":{"diffuseColor":{"description":"Face colour. Default: `\"#808080\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"specularColor":{"description":"Colour of the highlights. Default: `\"#000000\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"emissiveColor":{"description":"Colour the faces give off regardless of light. Default: `\"#FFFFFF\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"},{"type":"null"}]},"alpha":{"description":"Face opacity, 0–1; at 0 only the edges show. Default: `0`.","anyOf":[{"type":"number"},{"type":"null"}]},"disableLighting":{"description":"Draw the faces unaffected by the scene lights. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"backFaceCulling":{"description":"Hide the faces seen from inside the box. Default: `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"showBackLines":{"description":"Also draw the edges behind the product. Default: `false`.","anyOf":[{"type":"boolean"},{"type":"null"}]},"size":{"description":"Edge length of the box when created, in scene units. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"edgesWidth":{"description":"Edge line width. Default: `1`.","anyOf":[{"type":"number"},{"type":"null"}]},"edgesColor":{"description":"Edge colour, with alpha. Default: `\"#000000B3\"`.","anyOf":[{"type":"string","pattern":"^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false,"description":"The whole scene configuration. It replaces the stored one: a field you leave out or send as null is unset, and the scene then uses its default. Keys the API does not describe stay as stored, except inside camera and light entries, which are stored exactly as sent."}}}}
```

## The Templates3dList object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"Templates3dList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"templateId":{"type":"string","pattern":"^TPL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"3D template identifier (TPL-<uuid>)."},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["templateId","name","status","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false,"description":"Data schema used by List 3D Templates (GET /v1/3d-templates). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The Templates3dDetail object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"Templates3dDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"templateId":{"type":"string","pattern":"^TPL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"3D template identifier (TPL-<uuid>)."},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"blocks":{"type":"array","items":{"type":"object","properties":{"blockId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["DOCUMENT","GALLERY","TEXT"]},"text":{"anyOf":[{"anyOf":[{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"title":"Single language"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"title":"All languages"}]},{"type":"null"}],"description":"Formatted block text: one `{ html, text }` with `lang`, a `{ language: { html, text } }` map without it; null when the block has none."},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"directoryPath":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","directoryPath"],"additionalProperties":false}},"gallery":{"anyOf":[{"type":"object","properties":{"numColumns":{"type":"number","description":"Columns of the gallery grid, 1–4. The viewer shows at most 2 on phones. 4 when never set."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"mediaType":{"type":"string","enum":["IMAGE","VIDEO"]},"mediaSource":{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},"caption":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"fileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"loop":{"type":"boolean","description":"Loop the video; false when never set."},"autoplay":{"type":"boolean","description":"Start the video muted and playing; false when never set."}},"required":["id","mediaType","mediaSource","caption","fileId","filePath","url","loop","autoplay"],"additionalProperties":false}}},"required":["numColumns","items"],"additionalProperties":false},{"type":"null"}]}},"required":["blockId","name","type","text","documents","gallery"],"additionalProperties":false}},"connectedProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","description":"Product identifier (PROD-<uuid>), for Get Product."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]}},"required":["productId","name","status"],"additionalProperties":false},"description":"Products whose hotspots use the template. While it is not empty the template cannot be deleted."}},"required":["templateId","name","status","createdAt","modifiedAt","blocks","connectedProducts"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get 3D Template (GET /v1/3d-templates/{templateId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The Templates3dMutation object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"Templates3dMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"templateId":{"type":"string","pattern":"^TPL-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"3D template identifier (TPL-<uuid>)."},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"blocks":{"type":"array","items":{"type":"object","properties":{"blockId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["DOCUMENT","GALLERY","TEXT"]},"text":{"anyOf":[{"anyOf":[{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false,"title":"Single language"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"html":{"type":"string","description":"Draft.js content rendered as HTML."},"text":{"type":"string","description":"Plain text extracted from Draft.js blocks."}},"required":["html","text"],"additionalProperties":false},"title":"All languages"}]},{"type":"null"}],"description":"Formatted block text: one `{ html, text }` with `lang`, a `{ language: { html, text } }` map without it; null when the block has none."},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"directoryPath":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","directoryPath"],"additionalProperties":false}},"gallery":{"anyOf":[{"type":"object","properties":{"numColumns":{"type":"number","description":"Columns of the gallery grid, 1–4. The viewer shows at most 2 on phones. 4 when never set."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"mediaType":{"type":"string","enum":["IMAGE","VIDEO"]},"mediaSource":{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},"caption":{"anyOf":[{"anyOf":[{"type":"string","title":"Translated text"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"title":"All languages"}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"fileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"loop":{"type":"boolean","description":"Loop the video; false when never set."},"autoplay":{"type":"boolean","description":"Start the video muted and playing; false when never set."}},"required":["id","mediaType","mediaSource","caption","fileId","filePath","url","loop","autoplay"],"additionalProperties":false}}},"required":["numColumns","items"],"additionalProperties":false},{"type":"null"}]}},"required":["blockId","name","type","text","documents","gallery"],"additionalProperties":false}},"connectedProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","description":"Product identifier (PROD-<uuid>), for Get Product."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]}},"required":["productId","name","status"],"additionalProperties":false},"description":"Products whose hotspots use the template. While it is not empty the template cannot be deleted."}},"required":["templateId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create 3D Template (POST /v1/3d-templates). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The Templates3dCreateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"Templates3dCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Template name, unique (case-insensitively) among your 3D templates."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"blocks":{"type":"array","items":{"type":"object","properties":{"blockId":{"type":"string","minLength":1,"maxLength":255,"description":"Client-supplied block id (a UUID); reuse the stored id to keep a block."},"name":{"type":"string","minLength":1,"maxLength":255},"type":{"type":"string","enum":["DOCUMENT","GALLERY","TEXT"]},"text":{"description":"Block text as plain text, keyed by language code (TEXT blocks). A language sent with the `text` Get 3D Template answered keeps its stored formatting; any other text replaces it as unformatted text. An empty string removes that language.","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"documents":{"description":"Attached documents (DOCUMENT blocks).","type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"Media-library file id of the document (the file's `assetId` in the Files API)."},"directoryPath":{"description":"Media-library directory holding the file; omit it or send null for the root directory.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id"],"additionalProperties":false}},"gallery":{"description":"Media gallery (GALLERY blocks).","anyOf":[{"type":"object","properties":{"numColumns":{"description":"Columns of the gallery grid, 1–4. The viewer shows at most 2 on phones. Omit it for 4.","type":"integer","minimum":1,"maximum":4},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["IMAGE","VIDEO"]},"mediaSource":{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},"caption":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"fileId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"url":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"loop":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"autoplay":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["id","mediaType","mediaSource"],"additionalProperties":false}}},"additionalProperties":false},{"type":"null"}]}},"required":["blockId","name","type"],"additionalProperties":false}}},"required":["name"],"additionalProperties":false,"description":"Data schema used by Create 3D Template (POST /v1/3d-templates). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```

## The Templates3dUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.2.0"},"components":{"schemas":{"Templates3dUpdateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Template name, unique (case-insensitively) among your 3D templates."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"blocks":{"type":"array","items":{"type":"object","properties":{"blockId":{"type":"string","minLength":1,"maxLength":255,"description":"Client-supplied block id (a UUID); reuse the stored id to keep a block."},"name":{"type":"string","minLength":1,"maxLength":255},"type":{"type":"string","enum":["DOCUMENT","GALLERY","TEXT"]},"text":{"description":"Block text as plain text, keyed by language code (TEXT blocks). A language sent with the `text` Get 3D Template answered keeps its stored formatting; any other text replaces it as unformatted text. An empty string removes that language.","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"documents":{"description":"Attached documents (DOCUMENT blocks).","type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"Media-library file id of the document (the file's `assetId` in the Files API)."},"directoryPath":{"description":"Media-library directory holding the file; omit it or send null for the root directory.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id"],"additionalProperties":false}},"gallery":{"description":"Media gallery (GALLERY blocks).","anyOf":[{"type":"object","properties":{"numColumns":{"description":"Columns of the gallery grid, 1–4. The viewer shows at most 2 on phones. Omit it for 4.","type":"integer","minimum":1,"maximum":4},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["IMAGE","VIDEO"]},"mediaSource":{"type":"string","enum":["CUSTOM","MEDIA_LIBRARY"]},"caption":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]}},{"type":"null"}]},"fileId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"filePath":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"url":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"loop":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"autoplay":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["id","mediaType","mediaSource"],"additionalProperties":false}}},"additionalProperties":false},{"type":"null"}]}},"required":["blockId","name","type"],"additionalProperties":false}}},"additionalProperties":false,"description":"Data schema used by Update 3D Template (PUT /v1/3d-templates/{templateId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ."}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/api/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
