Insert customer product

Request

Security

OAuth2(Required scopes: enrichment.write)

Bodyapplication/jsonrequired

externalIdstring^\S+$required

External id of the customer product that is globally unique across the provided customer product data

Example:"DE01-1000004711-CUST-ABC-4711"

externalClientIdstring

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

Example:"EXTERNAL_CLIENT_ID"

externalCustomerIdstring

External unique id of the customer in the source system

Example:"1000004711"

externalProductIdstring

Unique id of the product in the source system that links the customer product to the internal product master

Example:"DE01-MAT-000123"

customerProductNumberstring

Product number used by the customer to identify the product

Example:"CUST-ABC-4711"

unspscstring

United Nations Standard Products and Services Code of the product

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"

customsTariffNumberstring

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

Example:"8471300000"

customerProductDescriptionstring

Product description used by the customer

Example:"Laptop 14 inch business model"

salesOrganizationCodestring

Sales organization for which the customer product is valid

Example:"DE01"

distributionChannelstring

Distribution channel for sales

Example:"10"

divisionstring

Division under which the sales organization operates

Example:"00"

baseUnitOfMeasurestring

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

Example:"kg"

statusstring

Current status of the customer product

Example:"ACTIVE"

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/customer-products \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "DE01-1000004711-CUST-ABC-4711",
    "externalClientId": "EXTERNAL_CLIENT_ID",
    "externalCustomerId": "1000004711",
    "externalProductId": "DE01-MAT-000123",
    "customerProductNumber": "CUST-ABC-4711",
    "unspsc": "43211508",
    "ean": "4006381333931",
    "upc": "036000291452",
    "gtin": "4006381333931",
    "customsTariffNumber": "8471300000",
    "customerProductDescription": "Laptop 14 inch business model",
    "salesOrganizationCode": "DE01",
    "distributionChannel": "10",
    "division": "00",
    "baseUnitOfMeasure": "kg",
    "status": "ACTIVE",
    "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"
}