> 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/item-masters.md).

# Item Masters

Item master records and their market cost prices.

## List Item Masters

> List item masters. Optionally filter by a case-insensitive \`search\` over code. Results are cursor-paginated; use the opaque \`nextCursor\` until it is null.\
> \
> Requires the \`itemMasters:read\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Item Masters","description":"Item master records and their market cost prices."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"schemas":{"ItemMastersList":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"itemMasterId":{"type":"string","pattern":"^IM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Item master identifier (IM-<uuid>)."},"code":{"type":"string"},"deliveryTime":{"anyOf":[{"type":"number"},{"type":"null"}]},"m3":{"anyOf":[{"type":"number"},{"type":"null"}]},"weight":{"anyOf":[{"type":"number"},{"type":"null"}]},"weightUnit":{"type":"string","enum":["kg","lb"]},"dimensions":{"type":"object","properties":{"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["width","depth","height"],"additionalProperties":false},"commerceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["itemMasterId","code","deliveryTime","m3","weight","weightUnit","dimensions","commerceId","createdAt","modifiedAt"],"additionalProperties":false}},"page":{"type":"object","properties":{"limit":{"type":"number"},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for the next page, or null on the last page."}},"required":["limit","nextCursor"],"additionalProperties":false}},"required":["data","page"],"additionalProperties":false},"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)."}}}}},"paths":{"/v1/item-masters":{"get":{"summary":"List Item Masters","tags":["Item Masters"],"description":"List item masters. Optionally filter by a case-insensitive `search` over code. Results are cursor-paginated; use the opaque `nextCursor` until it is null.\n\nRequires the `itemMasters:read` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMastersList"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}}},"parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":5000}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1}}]}}}}
```

## Create Item Master

> Create an item master. The code is unique case-insensitively. When fields beyond \`code\` are sent, the service persists them in a follow-up update; the response is the item master as stored, so compare it with what you sent.\
> \
> Requires the \`itemMasters:write\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Item Masters","description":"Item master records and their market cost prices."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"schemas":{"ItemMastersMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"itemMasterId":{"type":"string","pattern":"^IM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Item master identifier (IM-<uuid>)."},"code":{"type":"string"},"deliveryTime":{"anyOf":[{"type":"number"},{"type":"null"}]},"m3":{"anyOf":[{"type":"number"},{"type":"null"}]},"weight":{"anyOf":[{"type":"number"},{"type":"null"}]},"weightUnit":{"type":"string","enum":["kg","lb"]},"dimensions":{"type":"object","properties":{"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["width","depth","height"],"additionalProperties":false},"commerceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"aliasCodes":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliasCode":{"type":"string"}},"required":["companyId","companyName","aliasCode"],"additionalProperties":false}},"marketCostPrices":{"type":"array","items":{"type":"object","properties":{"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["market","quantity","cost","rrp","modifiedAt"],"additionalProperties":false}}},"required":["itemMasterId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"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)."}}},"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}}},"paths":{"/v1/item-masters":{"post":{"summary":"Create Item Master","tags":["Item Masters"],"description":"Create an item master. The code is unique case-insensitively. When fields beyond `code` are sent, the service persists them in a follow-up update; the response is the item master as stored, so compare it with what you sent.\n\nRequires the `itemMasters:write` scope.","responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMastersMutation"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"409":{"description":"Conflict with the current state (e.g. the resource already exists).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMastersCreateRequest"}}}}}}}}
```

## Bulk upsert Item Masters

> Create or upsert up to 1000 item masters. \`CREATE\` skips existing codes, while \`UPSERT\` updates them. Alias codes are not accepted in bulk; inspect \`skippedCodes\`, \`invalidCodes\`, and the optional errors report.\
> \
> Requires the \`itemMasters:write\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Item Masters","description":"Item master records and their market cost prices."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"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},"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)."}}},"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}}},"paths":{"/v1/item-masters:bulk":{"post":{"summary":"Bulk upsert Item Masters","tags":["Item Masters"],"description":"Create or upsert up to 1000 item masters. `CREATE` skips existing codes, while `UPSERT` updates them. Alias codes are not accepted in bulk; inspect `skippedCodes`, `invalidCodes`, and the optional errors report.\n\nRequires the `itemMasters:write` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMastersBulkResponse"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMastersBulkRequest"}}}}}}}}
```

## Get Item Master

> Get an item master with its per-company alias codes and read-only market cost prices.\
> \
> Requires the \`itemMasters:read\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Item Masters","description":"Item master records and their market cost prices."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"schemas":{"ItemMastersDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"itemMasterId":{"type":"string","pattern":"^IM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Item master identifier (IM-<uuid>)."},"code":{"type":"string"},"deliveryTime":{"anyOf":[{"type":"number"},{"type":"null"}]},"m3":{"anyOf":[{"type":"number"},{"type":"null"}]},"weight":{"anyOf":[{"type":"number"},{"type":"null"}]},"weightUnit":{"type":"string","enum":["kg","lb"]},"dimensions":{"type":"object","properties":{"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["width","depth","height"],"additionalProperties":false},"commerceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"aliasCodes":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliasCode":{"type":"string"}},"required":["companyId","companyName","aliasCode"],"additionalProperties":false}},"marketCostPrices":{"type":"array","items":{"type":"object","properties":{"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["market","quantity","cost","rrp","modifiedAt"],"additionalProperties":false}}},"required":["itemMasterId","code","deliveryTime","m3","weight","weightUnit","dimensions","commerceId","createdAt","modifiedAt","aliasCodes","marketCostPrices"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"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)."}}}}},"paths":{"/v1/item-masters/{itemMasterId}":{"get":{"summary":"Get Item Master","tags":["Item Masters"],"description":"Get an item master with its per-company alias codes and read-only market cost prices.\n\nRequires the `itemMasters:read` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMastersDetail"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}}},"parameters":[{"name":"itemMasterId","in":"path","required":true,"schema":{"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}$"}}]}}}}
```

## Update Item Master

> Replace an item master with the supplied fields. Alias codes are a full replacement: an omitted or empty array removes existing aliases. Market cost prices are read-only.\
> \
> Requires the \`itemMasters:write\` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.0.0"},"tags":[{"name":"Item Masters","description":"Item master records and their market cost prices."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"schemas":{"ItemMastersDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"itemMasterId":{"type":"string","pattern":"^IM-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","description":"Item master identifier (IM-<uuid>)."},"code":{"type":"string"},"deliveryTime":{"anyOf":[{"type":"number"},{"type":"null"}]},"m3":{"anyOf":[{"type":"number"},{"type":"null"}]},"weight":{"anyOf":[{"type":"number"},{"type":"null"}]},"weightUnit":{"type":"string","enum":["kg","lb"]},"dimensions":{"type":"object","properties":{"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"depth":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["width","depth","height"],"additionalProperties":false},"commerceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 creation timestamp."},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."},"aliasCodes":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"string"},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliasCode":{"type":"string"}},"required":["companyId","companyName","aliasCode"],"additionalProperties":false}},"marketCostPrices":{"type":"array","items":{"type":"object","properties":{"market":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"rrp":{"anyOf":[{"type":"number"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 8601 last-modified timestamp."}},"required":["market","quantity","cost","rrp","modifiedAt"],"additionalProperties":false}}},"required":["itemMasterId","code","deliveryTime","m3","weight","weightUnit","dimensions","commerceId","createdAt","modifiedAt","aliasCodes","marketCostPrices"],"additionalProperties":false}},"required":["data"],"additionalProperties":false},"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)."}}},"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}}},"paths":{"/v1/item-masters/{itemMasterId}":{"put":{"summary":"Update Item Master","tags":["Item Masters"],"description":"Replace an item master with the supplied fields. Alias codes are a full replacement: an omitted or empty array removes existing aliases. Market cost prices are read-only.\n\nRequires the `itemMasters:write` scope.","responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMastersDetail"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"409":{"description":"Conflict with the current state (e.g. the resource already exists).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}}},"parameters":[{"name":"itemMasterId","in":"path","required":true,"schema":{"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}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMastersCreateRequest"}}}}}}}}
```


---

# 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/item-masters.md?ask=<question>&goal=<endgoal>
```

`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.