Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Query Products

Returns a list of up to 100 products, given the provided paging, sorting and filtering.
See Stores Pagination for more information.

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

This endpoint requires the Read Products or the Manage Products permission scope.

POST

https://www.wixapis.com/stores/v1/products/query

Body Params

NAME
TYPE
DESCRIPTION
query

object

includeVariants

boolean

Whether variants should be included in the response.

includeHiddenProducts

boolean

Whether hidden products should be included in the response. Requires permissions to manage products.

Response Object

NAME
TYPE
DESCRIPTION
products

Array<object>

metadata

object

totalResults

integer

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Example 1

Request

curl

Copy Code
1curl -X POST \
2 'https://www.wixapis.com/stores/v1/products/query' \
3 --data-binary '{}' \
4 -H 'Content-Type: application/json' \
5 -H 'Authorization: <AUTH>'

Response

json

1
2{
3 "products": [
4 {
5 "id": "58fcbb51-ff87-08ff-d97b-646726676e4a",
6 "name": "webhook test",
7 "slug": "webhook-test",
8 "visible": true,
9 "productType": "physical",
10 "description": "<p>fasdf<\/p>",
11 "stock": {
12 "trackInventory": true,
13 "quantity": 0,
14 "inStock": false
15 },
16 "price": {
17 "currency": "ILS",
18 "price": 234,
19 "discountedPrice": 234,
20 "formatted": {
21 "price": "234.00 ₪",
22 "discountedPrice": "234.00 ₪"
23 }
24 },
25 "priceData": {
26 "currency": "ILS",
27 "price": 234,
28 "discountedPrice": 234,
29 "formatted": {
30 "price": "234.00 ₪",
31 "discountedPrice": "234.00 ₪"
32 }
33 },
34 "additionalInfoSections": [],
35 "ribbons": [{"text": "ribby"}],
36 "media": {"items": []},
37 "customTextFields": [],
38 "manageVariants": true,
39 "productOptions": [],
40 "productPageUrl": {
41 "base": "https://www.my-website.com/",
42 "path": "/product-page/webhook-test"
43 },
44 "numericId": "1567078000586000",
45 "inventoryItemId": "a70344ae-0078-f700-2684-9b98d99891b5",
46 "discount": {
47 "type": "NONE",
48 "value": 0
49 },
50 "collectionIds": [],
51 "variants": []
52 },
53 {
54 "id": "6507fd67-94e5-10af-73e4-d2167852d5bc",
55 "name": "digital product",
56 "slug": "digital-product",
57 "visible": true,
58 "productType": "digital",
59 "description": "",
60 "sku": "",
61 "weight": 0,
62 "stock": {
63 "trackInventory": false,
64 "inStock": true
65 },
66 "price": {
67 "currency": "ILS",
68 "price": 123,
69 "discountedPrice": 123,
70 "formatted": {
71 "price": "123.00 ₪",
72 "discountedPrice": "123.00 ₪"
73 }
74 },
75 "priceData": {
76 "currency": "ILS",
77 "price": 123,
78 "discountedPrice": 123,
79 "formatted": {
80 "price": "123.00 ₪",
81 "discountedPrice": "123.00 ₪"
82 }
83 },
84 "additionalInfoSections": [],
85 "ribbons": [],
86 "media": {"items": []},
87 "customTextFields": [],
88 "manageVariants": false,
89 "productOptions": [],
90 "productPageUrl": {
91 "base": "https://www.my-website.com/",
92 "path": "/product-page/digital-product"
93 },
94 "numericId": "1544009414325000",
95 "inventoryItemId": "9af80298-6b1a-ef50-8c1b-2de987ad2a43",
96 "discount": {
97 "type": "NONE",
98 "value": 0
99 },
100 "collectionIds": ["ae886d55-2572-eee8-b2c4-13219844b5e4"],
101 "variants": []
102 }
103 ],
104 "metadata": {
105 "items": 100,
106 "offset": 0
107 },
108 "totalResults": 2
109}
Example 2
Example 3
Example 4
Example 5