Sign in

v1

latestOpenAPI 3.0.32026-07-12254440.6 KB
Product Recommendation

updateProductRecommendation

Completly replace a specific product recommendation entity's properties by a given id and given payload

put/v1/product-recommendation/{productRecommendationId}

Path parameters

productRecommendationIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The product recommendation id

Request body

_schema'product_recommendation'
type'change' | 'cross-sell' | 'up-sell' required

Type of product recommendation

_tagsstring[] nullable
_purposestring[] nullable
_manifeststring[]

Manifest ID used to create/update the entity

__additionalobject nullable

Additional fields that are not part of the schema

Example request

{
  "source_price": {
    "$relation": [
      {
        "$relation": [
          {
            "entity_id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      }
    ]
  },
  "source_product": {
    "$relation": [
      {
        "$relation": [
          {
            "entity_id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      }
    ]
  },
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "__additional": {}
}

Response

Product recommendations request payload

_idstring uuid
_schema'product_recommendation' required
_orgstring required

Organization Id the entity belongs to

_tagsstring[] nullable
_titlestring
_created_atstring date-time
_updated_atstring date-time
type'change' | 'cross-sell' | 'up-sell' required

Type of product recommendation

_purposestring[] nullable
_manifeststring[]

Manifest ID used to create/update the entity

__additionalobject nullable

Additional fields that are not part of the schema

Example response

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_acl": {
    "view": [
      "org:456"
    ],
    "edit": [
      "org:456"
    ],
    "delete": [
      "org:456"
    ]
  },
  "source_price": {
    "$relation": [
      {
        "$relation": [
          {
            "entity_id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      }
    ]
  },
  "source_product": {
    "$relation": [
      {
        "$relation": [
          {
            "entity_id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      }
    ]
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "__additional": {}
}