> 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/developers/models.md). # Models ## The PublicError object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"components":{"schemas":{"PublicError":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string"},"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.0.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}}}} ``` ## The CartsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CompaniesList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CompaniesMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CompaniesCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"paymentTerms":{"type":"string","minLength":1,"maxLength":255},"deliveryAddresses":{"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":{"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}}}} ``` ## The CompaniesDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CompaniesNotes object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"components":{"schemas":{"CompaniesNotes":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"noteId":{"type":"string"},"noteTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"noteContent":{"description":"Rich note content. Shape is note-defined (opaque)."},"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}}}} ``` ## The CompaniesMutation2 object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CompaniesPriceListsRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ContactsList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ContactsMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ContactsCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"phoneNumbers":{"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":{"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}}}} ``` ## The ContactsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GlobalOptionSetsList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GlobalOptionSetsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GlobalOptionSetsMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GlobalOptionSetsCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GlobalOptionSetsUpdateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GlobalOptionSetsOptionsRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GlobalOptionSetsOptionsRequest2 object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GlobalOptionSetsOptionsRemoveRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CollectionSetsList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CollectionSetsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CollectionSetsMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CollectionSetsCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CollectionSetsUpdateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CollectionSetsOptionSetsRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CollectionSetsOptionSetsRequest2 object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The CollectionSetsOptionSetsRemoveRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GalleriesList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GalleriesDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GalleriesMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GalleriesCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GalleriesUpdateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GalleriesItemsRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GalleriesItemsRequest2 object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The GalleriesItemsRemoveRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ItemMastersList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ItemMastersMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ItemMastersCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ItemMastersBulkResponse object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ItemMastersBulkRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ItemMastersDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The MarketCostPricesList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The MarketCostPricesBulkResponse object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The MarketCostPricesBulkRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The MarketCostPricesMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The MarketCostPricesCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The PriceListsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsUpdateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsProductsRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsProductsRequest2 object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsProductsRemoveRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsCompaniesRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsCompaniesRequest2 object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductGroupsCompaniesRemoveRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductCategoriesList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductCategoriesDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductCategoriesMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductCategoriesCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductCategoriesUpdateRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductCategoriesProductsRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductCategoriesProductsRequest2 object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductCategoriesProductsRemoveRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductsList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductsRelated object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The ProductsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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":[{"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."},"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}}}} ``` ## The QuotationsList object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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"}]},"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":{"anyOf":[{"type":"string"},{"type":"null"}]},"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}}}} ``` ## The QuotationsOwners object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The QuotationsSettings object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The QuotationsDetail object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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"}]},"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":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"blocks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"blockType":{"anyOf":[{"type":"string"},{"type":"null"}]},"products":{"type":"array","items":{"type":"object","properties":{"previewImage":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"},"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"}]},"salePrice":{"anyOf":[{"type":"number"},{"type":"null"}]},"regPrice":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["previewImage","notes","productId","configurationCode","type","variantCode","quantity","name","options","sku","salePrice","regPrice"],"additionalProperties":false}}},"required":["id","blockType","products"],"additionalProperties":false}}},"required":["id","title","blocks"],"additionalProperties":false}}},"required":["versionId","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}}}} ``` ## The QuotationsMutation object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The QuotationsStatusRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}]}}}} ``` ## The QuotationsMutation2 object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The QuotationsStageRequest object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"components":{"schemas":{"QuotationsStageRequest":{"type":"object","properties":{"stageId":{"type":"string","minLength":1,"maxLength":255}},"required":["stageId"],"additionalProperties":false}}}} ``` ## The QuotationsVersions object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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}}}} ``` ## The QuotationsVersions2 object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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."},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"blocks":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"blockType":{"anyOf":[{"type":"string"},{"type":"null"}]},"products":{"type":"array","items":{"type":"object","properties":{"previewImage":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"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"},"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"}]},"salePrice":{"anyOf":[{"type":"number"},{"type":"null"}]},"regPrice":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["previewImage","notes","productId","configurationCode","type","variantCode","quantity","name","options","sku","salePrice","regPrice"],"additionalProperties":false}}},"required":["id","blockType","products"],"additionalProperties":false}}},"required":["id","title","blocks"],"additionalProperties":false}}},"required":["versionId","status","createdAt","modifiedAt","groups"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}} ``` ## The QuotationsNotes object ```json {"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.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":{"description":"Opaque draft-content object."},"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}}}} ``` --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.mimeeq.com/developers/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.