Set favorite state

Explicitly marks an object as favorite or not favorite for the current workspace user.

PUT/api/favorites

Explicitly marks an object as favorite or not favorite for the current workspace user.

Request Body

application/json

Request payload for Set favorite state.

objectHandle*string

Object handle for the favorite operation. Currently only products are supported.

Length1 <= length

objectId*string

Object identifier to update.

Length1 <= length

isFavorite*boolean

Target favorite state for the object.

Exampletrue

[key: string]?never

Response Body

`application/json`

curl -X PUT "https://loading/api/favorites" \  -H "Content-Type: application/json" \  -d '{    "objectHandle": "products",    "objectId": "product_123",    "isFavorite": true  }'

{
  "objectHandle": "products",
  "objectId": "product_123",
  "isFavorite": true
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Set favorite state

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`