GET
/
api
/
v2
/
platform
/
wished_items
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/wished_items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "1",
      "type": "wished_item",
      "attributes": {
        "quantity": 1,
        "created_at": "2022-11-08T19:36:01.546Z",
        "updated_at": "2022-11-08T19:36:01.546Z",
        "display_total": "$19.99",
        "display_price": "$19.99",
        "price": "19.99",
        "total": "19.99"
      },
      "relationships": {
        "variant": {
          "data": {
            "id": "301",
            "type": "variant"
          }
        }
      }
    },
    {
      "id": "2",
      "type": "wished_item",
      "attributes": {
        "quantity": 1,
        "created_at": "2022-11-08T19:36:01.616Z",
        "updated_at": "2022-11-08T19:36:01.616Z",
        "display_total": "$19.99",
        "display_price": "$19.99",
        "price": "19.99",
        "total": "19.99"
      },
      "relationships": {
        "variant": {
          "data": {
            "id": "303",
            "type": "variant"
          }
        }
      }
    },
    {
      "id": "3",
      "type": "wished_item",
      "attributes": {
        "quantity": 1,
        "created_at": "2022-11-08T19:36:01.685Z",
        "updated_at": "2022-11-08T19:36:01.685Z",
        "display_total": "$19.99",
        "display_price": "$19.99",
        "price": "19.99",
        "total": "19.99"
      },
      "relationships": {
        "variant": {
          "data": {
            "id": "305",
            "type": "variant"
          }
        }
      }
    },
    {
      "id": "4",
      "type": "wished_item",
      "attributes": {
        "quantity": 1,
        "created_at": "2022-11-08T19:36:01.752Z",
        "updated_at": "2022-11-08T19:36:01.752Z",
        "display_total": "$19.99",
        "display_price": "$19.99",
        "price": "19.99",
        "total": "19.99"
      },
      "relationships": {
        "variant": {
          "data": {
            "id": "307",
            "type": "variant"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 4,
    "total_count": 4,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/wished_items?page=1&per_page=&include=",
    "next": "http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/wished_items?include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

Response

200
application/vnd.api+json
Records returned
​
data
object[]
required
​
meta
object
required
​
links
object
required

Was this page helpful?

Suggest editsRaise issue
Update a Webhook SubscriberCreate a Wished Item