Get favorite status by ids

Returns the favorite state for a list of object ids for the current workspace user.

POST/api/unstable/favorites/status

Returns the favorite state for a list of object ids for the current workspace user.

Request Body

application/json

objectHandle*string

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

Length1 <= length

Example"products"

objectIds*array<>

Object ids to resolve favorite state for.

Itemsitems <= 500

Example

[
  "product_123",
  "product_456"
]

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/unstable/favorites/status" \  -H "Content-Type: application/json" \  -d '{    "objectHandle": "products",    "objectIds": [      "product_123",      "product_456"    ]  }'

[
  {
    "objectId": "product_123",
    "isFavorite": true
  }
]

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Get favorite status by ids

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`