ConnectCloud Developers

Create the article in masterdata (tenant:masterdata:write)

POST /api/trade/v1/itsp/articles/create

Module: Trade · operationId: createArticle · Tag: ITSP · Auth: access token (Authorization: Bearer <accessToken>)

Creates the article with its supplier conditions in masterdata, using the caller's token. articleNumber (upper-case letters and digits, at most 25), title, searchTerm, productGroup (number of an existing product group), unit and fldSerienNrKz are required (400 with a German message). An article that exists exactly once already answers 409.

Request body

application/json (required)

  • articleNumber (string, required): Article number to create in masterdata. (max length 25)
  • fldSerienNrKz (boolean, nullable, required): Serial number tracked; required.
  • productGroup (string, required): Number of a masterdata product group.
  • salesPrice (number, required): Net sales price (VK); required, may be 0.
  • searchTerm (string, required): Search term (Suchbegriff) of the article. (max length 25)
  • shortDescription (string, required): Kurzbezeichnung (shortName in masterdata): required, single line, max. 80 characters. (max length 80)
  • unit (string, required): Unit of measure.
  • description (string): Beschreibung: long text without length limit.
  • ean (string): EAN (GTIN) of the article.
  • height (number): Height of the article.
  • length (number): Length of the article.
  • manufacturerName (string): Name of the manufacturer.
  • mpn (string): Manufacturer part number.
  • suppliers (array of object): Supplier offers to store with the article.
    • microtechAddressNo (integer, required): Address number of the supplier in masterdata.
    • currency (string): ISO 4217; EUR when empty.
    • isDefault (boolean): This supplier is the default supplier of the article.
    • purchasePrice (number): Net purchase price.
    • supplierArticleNumber (string): The distributor's article number.
  • title (string): Bezeichnung (name in masterdata): text of document lines, optional, max. 2000 characters. (max length 2000)
  • weight (number): Weight of the article.
  • width (number): Width of the article.

Example:

{
  "articleNumber": "LNVT14G5",
  "ean": "0197529876543",
  "fldSerienNrKz": true,
  "manufacturerName": "Lenovo",
  "mpn": "21MC0012GE",
  "productGroup": "120",
  "salesPrice": 1349,
  "searchTerm": "THINKPAD T14 G5",
  "shortDescription": "Lenovo ThinkPad T14 Gen 5 Ultra 7 32 GB 1 TB",
  "suppliers": [
    {
      "currency": "EUR",
      "isDefault": true,
      "microtechAddressNo": 70001,
      "purchasePrice": 1049,
      "supplierArticleNumber": "NL-T14G5-32"
    }
  ],
  "title": "Lenovo ThinkPad T14 Gen 5 – 14\" WUXGA IPS, Intel Core Ultra 7 155U, 32 GB RAM, 1 TB SSD, Windows 11 Pro",
  "unit": "Stk",
  "weight": 1.37
}

Responses

  • 201 Created (application/json)
  • 400 Error (application/json)
  • 401 No valid session or bearer token (no body).
  • 403 Masterdata refused the caller. (application/json)
  • 409 The article exists already. (application/json)
  • 502 A dependent service (DMS, masterdata, a distributor) failed or is unreachable. (application/json)
  • 503 The configuration store is not available. (application/json)

Fields of the 201 answer:

  • articleNumber (string): Article number created in masterdata.
  • id (string): Masterdata article id.
  • message (string): Message of masterdata.
  • status (string): Outcome of the creation (CREATED). (one of CREATED)

Example 201 answer:

{
  "articleNumber": "LNVT14G5",
  "id": "4b7d9f13-5e6a-4c8b-a1d2-3e4f5a6b7e15",
  "message": "Artikel LNVT14G5 angelegt.",
  "status": "CREATED"
}

Example request

curl -X POST 'https://api.mbcom.cloud/api/trade/v1/itsp/articles/create' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"articleNumber":"LNVT14G5","ean":"0197529876543","fldSerienNrKz":true,"manufacturerName":"Lenovo","mpn":"21MC0012GE","productGroup":"120","salesPrice":1349,"searchTerm":"THINKPAD T14 G5","shortDescription":"Lenovo ThinkPad T14 Gen 5 Ultra 7 32 GB 1 TB","suppliers":[{"currency":"EUR","isDefault":true,"microtechAddressNo":70001,"purchasePrice":1049,"supplierArticleNumber":"NL-T14G5-32"}],"title":"Lenovo ThinkPad T14 Gen 5 – 14\" WUXGA IPS, Intel Core Ultra 7 155U, 32 GB RAM, 1 TB SSD, Windows 11 Pro","unit":"Stk","weight":1.37}'

View as Markdown · Interactive reference · OpenAPI