> 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.1.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.1.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.1.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.1.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-)."},"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.1.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-)."},"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.1.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.1.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-)."},"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.1.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.1.0"},"components":{"schemas":{"CompaniesMutation2":{"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-)."},"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 Update 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.1.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 Update 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.1.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-)."},"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.1.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-)."},"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.1.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.1.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-)."},"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 CustomerList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.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}},"required":["customerId","customerName","displayName","contact","logoUrl","languages","currencies","markets","priceRoundingType","publicPriceListGroups","theme"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List 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.1.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.1.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.1.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.1.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.1.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.1.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 CustomFieldsList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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.1.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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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.1.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.1.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.1.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.1.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.1.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.1.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 InvitationsList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.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.1.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.1.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":{"type":"string","minLength":2,"maxLength":10,"description":"Language code to translate localized fields to (falls back if unavailable)."}},"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.1.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.1.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.1.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.1.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.1.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.1.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-)."},"name":{"type":"string"},"displayName":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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."},"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.1.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-)."},"name":{"type":"string"},"displayName":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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."},"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"},"code":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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","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.1.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-)."},"name":{"type":"string"},"displayName":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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."},"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"},"code":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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","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.1.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"}},{"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.1.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"}},{"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.1.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"}]}},"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.1.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"}]}},"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.1.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.1.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-)."},"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.1.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-)."},"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.1.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-)."},"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.1.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-)."}}},"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.1.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.1.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-)."}}},"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.1.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-)."}}},"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.1.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-)."}}},"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.1.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-)."},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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.1.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-)."},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"autoplay":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"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.1.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-)."},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"autoplay":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"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.1.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":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"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.1.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.1.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":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"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.1.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":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string"},{"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.1.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.1.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-)."},"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.1.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-)."},"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.1.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.1.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.1.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.1.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-)."},"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.1.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-)."},"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost":{"anyOf":[{"type":"number","minimum":0,"description":"Cost price in the market currency."},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number","minimum":0,"description":"Recommended retail price in the market currency."},{"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.1.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.1.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","minimum":0,"description":"Cost price in the market currency."},"rrp":{"type":"number","minimum":0,"description":"Recommended retail price in the market currency."}},"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.1.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-)."}},"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.1.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","minimum":0,"description":"Cost price in the market currency."},"rrp":{"type":"number","minimum":0,"description":"Recommended retail price in the market currency."}},"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.1.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-)."},"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.1.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-)."},"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},{"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-)."},"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"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"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"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"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},{"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-)."},"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"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"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"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"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}]},{"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-)."}},"required":["priceListId"],"additionalProperties":false}]}},"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.1.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))$"},{"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])))$"}]},{"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))$"},{"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])))$"}]},{"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","minimum":0},"sale":{"type":"number","minimum":0}},"required":["priceCode","quantity","rrp","sale"],"additionalProperties":false}}},"required":["codes"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","market","calculation"],"additionalProperties":false},{"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))$"},{"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])))$"}]},{"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))$"},{"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])))$"}]},{"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":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","minLength":1,"maxLength":255},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","minLength":1,"maxLength":255},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","market","scope","selectedCustomers","selectedProducts","calculation"],"additionalProperties":false},{"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))$"},{"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])))$"}]},{"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))$"},{"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])))$"}]},{"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}$"},"calculation":{"type":"object","properties":{"costMultiplier":{"type":"number","minimum":0},"rrp":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","minLength":1,"maxLength":255},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","minLength":1,"maxLength":255},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","linkedPriceListId","calculation"],"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 PriceListsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.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-)."},"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},{"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-)."},"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"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"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"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"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},{"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-)."},"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"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"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"},{"type":"null"}]},"value":{"anyOf":[{"type":"number"},{"type":"null"}]},"rounding":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string"},{"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}]}},"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.1.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))$"},{"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])))$"}]},{"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))$"},{"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])))$"}]},{"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},{"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))$"},{"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])))$"}]},{"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))$"},{"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])))$"}]},{"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":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","minLength":1,"maxLength":255},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","minLength":1,"maxLength":255},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","market","scope","selectedCustomers","selectedProducts","calculation"],"additionalProperties":false},{"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))$"},{"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])))$"}]},{"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))$"},{"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])))$"}]},{"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}$"},"calculation":{"type":"object","properties":{"costMultiplier":{"type":"number","minimum":0},"rrp":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","minLength":1,"maxLength":255},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]},"sale":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"number"},"rounding":{"type":"object","properties":{"mode":{"type":"string","minLength":1,"maxLength":255},"increment":{"type":"number","minimum":0}},"required":["mode","increment"],"additionalProperties":false}},"required":["method","value","rounding"],"additionalProperties":false},{"type":"null"}]}},"required":["costMultiplier","rrp","sale"],"additionalProperties":false}},"required":["name","status","currency","validPeriod","isPromotional","mode","linkedPriceListId","calculation"],"additionalProperties":false}],"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.1.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","minimum":0},"sale":{"type":"number","minimum":0}},"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 ProductGroupsList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.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-)."},"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.1.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-)."},"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.1.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-)."},"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.1.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-)."}},"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-)."}}},"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.1.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.1.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-)."}}},"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.1.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-)."}}},"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.1.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-)."}}},"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.1.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-)."}}},"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.1.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-)."}}},"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.1.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-)."}}},"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.1.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-)."},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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.1.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-)."},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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.1.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-)."},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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.1.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-)."},{"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-)."}}},"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.1.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-)."},{"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.1.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-)."}}},"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.1.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-)."}}},"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.1.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-)."}}},"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.1.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-)."},"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.1.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.1.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-)."},"sourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"variantCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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},{"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}}],"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":{}},"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.1.0"},"components":{"schemas":{"FilesCreateRequest":{"type":"object","properties":{"type":{"type":"string","const":"directory"},"directoryPath":{"type":"string","maxLength":1024},"name":{"type":"string","minLength":1,"maxLength":1024}},"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.1.0"},"components":{"schemas":{"FilesList":{"type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"directory"},"directoryPath":{"type":"string"},"name":{"type":"string"},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","directoryPath","name","createdAt","modifiedAt"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string"},"directoryPath":{"type":"string"},"name":{"type":"string"},"extension":{"anyOf":[{"type":"string"},{"type":"null"}]},"mimeType":{"anyOf":[{"type":"string"},{"type":"null"}]},"sizeBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","assetId","directoryPath","name","extension","mimeType","sizeBytes","url","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 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.1.0"},"components":{"schemas":{"FilesRequest":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string","minLength":1,"maxLength":1024},"directoryPath":{"type":"string","maxLength":1024},"name":{"type":"string","minLength":1,"maxLength":1024}},"required":["type","assetId","directoryPath","name"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"directoryPath":{"type":"string","maxLength":1024},"name":{"type":"string","minLength":1,"maxLength":1024}},"required":["type","directoryPath","name"],"additionalProperties":false}],"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.1.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},"path":{"type":"string","maxLength":1024}},"required":["type","assetId","path"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"path":{"type":"string","maxLength":1024}},"required":["type","path"],"additionalProperties":false}]}}},"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 FilesMoveRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.0"},"components":{"schemas":{"FilesMoveRequest":{"type":"object","properties":{"targetDirectoryPath":{"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},"path":{"type":"string","maxLength":1024}},"required":["type","assetId","path"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"path":{"type":"string","maxLength":1024}},"required":["type","path"],"additionalProperties":false}]}}},"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.1.0"},"components":{"schemas":{"FilesCopyRequest":{"type":"object","properties":{"targetDirectoryPath":{"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},"path":{"type":"string","maxLength":1024}},"required":["type","assetId","path"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"path":{"type":"string","maxLength":1024}},"required":["type","path"],"additionalProperties":false}]}}},"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.1.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.1.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 FilesDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.0"},"components":{"schemas":{"FilesDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","const":"file"},"assetId":{"type":"string"},"directoryPath":{"type":"string"},"name":{"type":"string"},"extension":{"anyOf":[{"type":"string"},{"type":"null"}]},"mimeType":{"anyOf":[{"type":"string"},{"type":"null"}]},"sizeBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"revisionsNumber":{"type":"integer","minimum":0,"maximum":9007199254740991},"width":{"type":"integer","minimum":0,"maximum":9007199254740991},"height":{"type":"integer","minimum":0,"maximum":9007199254740991},"aspectRatio":{"type":"string","minLength":1}},"required":["type","assetId","directoryPath","name","extension","mimeType","sizeBytes","url","createdAt","modifiedAt"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Upload File (POST /v1/files/upload). 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.1.0"},"components":{"schemas":{"FilesDownload":{"type":"object","properties":{"data":{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"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.1.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},"path":{"type":"string","maxLength":1024}},"required":["type","assetId","path"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"directory"},"path":{"type":"string","maxLength":1024}},"required":["type","path"],"additionalProperties":false}]}}},"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.1.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-)."},"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.1.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.1.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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"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}}},"required":["stages","lostReasons"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by List 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 QuotationsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.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-)."},"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.1.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-)."},"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.1.0"},"components":{"schemas":{"QuotationsStatusRequest":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"OPEN"}},"required":["status"],"additionalProperties":false},{"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},{"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}],"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.1.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-)."},"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.1.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.1.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.1.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.1.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."}}}} ``` --- # 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=&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.