Skip to content

Insert product

Request

Security
OAuth2(Required scopes: enrichment.write)
Bodyapplication/jsonrequired
externalIdstring^\S+$required

External ID of the product that is globally unique across the provided product data

Example:"DE01"
externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"EXTERNAL_CLIENT_ID"
productNumberstring

Number of the product as defined by the supplier

Example:"NO123"
typestring

Type of the product as defined in the company’s product master (e.g., Operating Supplies)

Example:"Operating Supplies"
groupstring

Group of the product as defined in the product master of the company

Example:"Electronics"
descriptionstring

Description of the product

Example:"A Laptop XP"
shortDescriptionstring

Shortened version of the product description

Example:"A great laptop"
manufacturerstring

Name of the product manufacturer

Example:"Corporation ABC"
unspscstring

Universal Product Code (UPC-A)

Example:"43211508"
eanstring

European Article Number (EAN-13)

Example:"4006381333931"
upcstring

Universal Product Code (UPC-A)

Example:"036000291452"
gtinstring

Global Trade Item Number (GTIN) according to GS1 standards. A globally unique identifier for trade items and products.

Example:"4006381333931"
baseUnitOfMeasurestring

The base unit in which the product is managed in the system

Example:"kg"
customsTariffNumberstring

Customs tariff number (HS/TARIC code) used for cross-border trade and customs

Example:"8471300000"
plantsArray of strings
statusstring

Current status of the product

Enum:"ACTIVE""INACTIVE""DISCONTINUED"
Example:"ACTIVE"
grossWeightnumber

Gross weight of the product including packaging

Example:2.5
netWeightnumber

Net weight of the product excluding packaging

Example:2.3
weightUnitstring

Unit for weight values

Example:"KG"
volumenumber

Volume of the product

Example:0.015
volumeUnitstring

Unit for volume values

Example:"M3"
salesOrganizationInfoArray of objects(productSalesOrganizationInfo)
customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:
{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}
curl -i -X POST \
  https://api.cloud.hypatos.ai/v2/enrichment/products \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "DE01",
    "externalClientId": "EXTERNAL_CLIENT_ID",
    "productNumber": "NO123",
    "type": "Operating Supplies",
    "group": "Electronics",
    "description": "A Laptop XP",
    "shortDescription": "A great laptop",
    "manufacturer": "Corporation ABC",
    "unspsc": "43211508",
    "ean": "4006381333931",
    "upc": "036000291452",
    "gtin": "4006381333931",
    "baseUnitOfMeasure": "kg",
    "customsTariffNumber": "8471300000",
    "plants": [
      "PLANT-001"
    ],
    "status": "ACTIVE",
    "grossWeight": 2.5,
    "netWeight": 2.3,
    "weightUnit": "KG",
    "volume": 0.015,
    "volumeUnit": "M3",
    "salesOrganizationInfo": [
      {
        "externalSalesOrganizationId": "1000",
        "distributionChannel": "2000",
        "division": "3000",
        "salesGroup": "4000",
        "salesOffice": "5000",
        "blockedForOrdering": true,
        "blockedForDelivery": false,
        "shippingAddresses": [
          "ADDR001",
          "ADDR002"
        ],
        "billingAddresses": [
          "ADDR003"
        ],
        "salesOrganizationCode": "SO001",
        "salesUnit": {
          "unitOfMeasure": "PK",
          "conversionFactorToBaseUnit": 1000,
          "description": "Package of 10 units"
        },
        "productGroup1": "ELECTRONICS",
        "productGroup2": "COMPUTERS",
        "productGroup3": "LAPTOPS",
        "productGroup4": "B2B_DIRECT",
        "productGroup5": "B2B_DIRECT",
        "productCategoryGroup": "STANDARD_GOOD"
      }
    ],
    "customFields": {
      "property1": "string",
      "property2": "string"
    },
    "customMetadata": {
      "someTopLevelProperty": "value1",
      "someNestedProperty": {
        "nestedProperty": "value2"
      },
      "someArrayProperty": [
        "value3",
        "value4"
      ]
    }
  }'

Responses

Successfully inserted

Bodyapplication/json
idstringrequired
Example:"3a429dc8-56d4-42ef-a4cf-2ebc9ad1ef38"
Response
{
  "id": "3a429dc8-56d4-42ef-a4cf-2ebc9ad1ef38"
}