For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update Item Master

Replace an item master with the supplied fields.

Read Get Item Master first and retain all required aliases and operational values in the replacement.

Behaviour

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.

put
Authorizations
AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Path parameters
itemMasterIdstringRequiredPattern: ^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}$
Body

Data schema used by Create Item Master (POST /v1/item-masters). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.

codestring · min: 1 · max: 255RequiredPattern: ^[./\\_\-\w]+$
deliveryTimeinteger · max: 9007199254740991Optional
m3numberOptional
weightnumberOptional
weightUnitstring · enumOptionalPossible values:
commerceIdstring · min: 1 · max: 255Optional
Responses
200

Successful response.

application/json
put/v1/item-masters/{itemMasterId}
PUT /v1/item-masters/{itemMasterId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "code": "text",
  "deliveryTime": 1,
  "m3": 1,
  "weight": 1,
  "weightUnit": "kg",
  "dimensions": {
    "width": 1,
    "depth": 1,
    "height": 1
  },
  "commerceId": "text",
  "aliasCodes": [
    {
      "companyId": "text",
      "companyName": "text",
      "aliasCode": "text"
    }
  ]
}
{
  "data": {
    "itemMasterId": "IM-123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "deliveryTime": 1,
    "m3": 1,
    "weight": 1,
    "weightUnit": "kg",
    "dimensions": {
      "width": 1,
      "depth": 1,
      "height": 1
    },
    "commerceId": "text",
    "createdAt": "text",
    "modifiedAt": "text",
    "aliasCodes": [
      {
        "companyId": "text",
        "companyName": "text",
        "aliasCode": "text"
      }
    ],
    "marketCostPrices": [
      {
        "market": "text",
        "quantity": 1,
        "cost": 1,
        "rrp": 1,
        "modifiedAt": "text"
      }
    ]
  }
}

Last updated

Was this helpful?