userWantlist Query

Description

Retrieves a paginated list of items from a buyer's wantlist. A wantlist is a collection of items the buyer has marked as wanted. Results are sorted by creation date. Page size is fixed by the server.

query userWantlist($userRef: ID!, $page: Int!) {
  userWantlist(userRef: $userRef, page: $page) {
    pagination {
      limit
      count
      page
      pages
      hasMore
    }
    entries {
      _id
      id
      type
      incId
      uniqueId
      oldId
      created
      modified
      isForbiddenForSale
      handle
      path
      uri
      wants
      bitly
    }
    metadata {
      categories
      supplierCodes
      locations
    }
    stats {
      total
      stockCount
      listingsCount
    }
  }
}

Variables

{
    "userRef": "04ceb97d5713b5089a91f9c4",
    "page": 1
}

Response

{
    "userWantlist": {
        "pagination": {
            "limit": 20,
            "count": 10,
            "page": 1,
            "pages": 1,
            "hasMore": true
        },
        "entries": [
            {
                "_id": "5589b53ceb1d91170e489c78",
                "id": 1.23,
                "type": "ReleaseItem",
                "incId": 1.23,
                "uniqueId": "example",
                "oldId": 1.23,
                "created": 1763043915512,
                "modified": 1722334670722,
                "isForbiddenForSale": true,
                "handle": "example",
                "path": "/release/1763553751/release-artist-release-name",
                "uri": "https://www.my-common-ground-store.com/release/1763553751/release-artist-release-name",
                "wants": 42,
                "bitly": "example"
            }
        ],
        "metadata": {
            "categories": [
                "example"
            ],
            "supplierCodes": [
                "example"
            ],
            "locations": [
                "example"
            ]
        },
        "stats": {
            "total": 29.99,
            "stockCount": 1.23,
            "listingsCount": 1.23
        }
    }
}

Arguments

Name	Type	Description
userRef	ID!	Reference ID of the buyer to retrieve the wantlist for.
page	Int!	The requested page number.

Returns

Inventory!