Skip to main content

BaseProduct

custom_revision stringrequired

This identifier is a lexographically ordered string used to identify the revision from client's side and used to track changes and avoid unintentional data overwriting such as repeated identical requests.

Example: 1729684717164
force_update boolean

Force update defines whether the data should be updated even in case the last update source happened by user action in Inspectorio Platform

domain Domain (string)

Possible values: [apparel]

Default value: apparel
custom_id CustomId (string)required

Unique Custom identifier for products in your system

entity_type EntityType (string)required

The type of entity to be updated, unique with the provided custom identifier

Possible values: [product, item]

name string

Name of the product

description string

Description of the product

status Status (string)required

Status of the product

Possible values: [active, inactive]

categories object[]

The lowest level reference to the hierarchies used to categorize the product. Only one value accepted per taxonomy (taxonomy_category_id)

  • Array [
    • taxonomy_custom_id stringrequired

    Custom Identifier of the Hierarchy for which you want to set a category

    Possible values: [product, merchandise, brand]

    custom_id stringrequired

    Custom Identifier of the Category within the Hierarchy

    Example: 540.120884014
  • ]
    • domain_attributes object

    Domain attributes for products natively supported by our Platform

    property name* string
    additional_attributes object

    Additional attributes for products which are not natively supported by our Platform which are configurable by the client

    property name* string
    contributions object[]
  • Array [
    • role ContributionRole (string)required

    This will be pre-defined by Inspectorio in the 1st phase. "provider" role will only have "read" permission to access the items' attributes / properties.

    Possible values: [producer, manufacturer]

    org_custom_id CustomId (string)required

    Local Organization ID or BP ID / Vendor ID of the item's provider (Vendor/Supplier)

    Example: S208
    product_custom_id CustomId (string)

    (Optional) The item ID from Vendor/Supplier's internal system if available (e.g. vendor/supplier article number)

  • ]
    • BaseProduct
    {
      "domain": "apparel",
      "custom_id": "string",
      "entity_type": "product",
      "name": "string",
      "description": "string",
      "status": "active",
      "categories": [
        {
          "taxonomy_custom_id": "product",
          "custom_id": 540.120884014
        }
      ],
      "domain_attributes": {
        "color": "Blue",
        "size": "XL",
        "origin_country": [
          "US",
          "CN"
        ]
      },
      "additional_attributes": {
        "business_unit": "US"
      },
      "contributions": [
        {
          "role": "producer",
          "org_custom_id": "S208",
          "product_custom_id": "string"
        }
      ],
      "custom_revision": 1729684717164,
      "force_update": true
    }