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

Create Item Master

Create an item master.

Use this to introduce one item code before synchronizing its operational data and market prices.

Behaviour

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.

post
Authorizations
AuthorizationstringRequired

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

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
201

Created.

application/json
post/v1/item-masters
POST /v1/item-masters 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?