Skip to main content
POST
/
api
/
v2
/
platform
/
wished_items
Create a Wished Item
curl --request POST \
  --url http://{defaultHost}/api/v2/platform/wished_items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "wished_item": {
    "wishlist_id": "<string>",
    "variant_id": "<string>",
    "quantity": 123
  }
}
'
{
  "data": {
    "id": "9",
    "type": "wished_item",
    "attributes": {
      "quantity": 1,
      "created_at": "2022-11-08T19:36:02.710Z",
      "updated_at": "2022-11-08T19:36:02.710Z",
      "display_total": "$19.99",
      "display_price": "$19.99",
      "price": "19.99",
      "total": "19.99"
    },
    "relationships": {
      "variant": {
        "data": {
          "id": "319",
          "type": "variant"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Body

application/json
​
wished_item
object
required

Response

Record created

​
data
object
required