List Products & SKUs

GET

https://api.webflow.com/v2/sites/:site_id/products

GET

/v2/sites/:site_id/products

1 from webflow import Webflow
2 
3 client = Webflow(
4     access_token="YOUR_ACCESS_TOKEN",
5 )
6 client.products.list(
7     site_id="580e63e98c9a982ac9b8b741",
8 )

Try it

200listExample

1 {
2   "items": [
3     {
4       "product": {
5         "id": "580e63fc8c9a982ac9b8b745",
6         "cmsLocaleId": "653ad57de882f528b32e810e",
7         "lastPublished": "2023-03-17T18:47:35.560Z",
8         "lastUpdated": "2023-03-17T18:47:35.560Z",
9         "createdOn": "2023-03-17T18:47:35.560Z",
10         "isArchived": false,
11         "isDraft": false,
12         "fieldData": {
13           "name": "T-Shirt",
14           "slug": "t-shirt",
15           "description": "A plain cotton t-shirt.",
16           "shippable": true,
17           "sku-properties": [
18             {
19               "id": "Color",
20               "name": "Color",
21               "enum": [
22                 {
23                   "id": "royal-blue",
24                   "name": "Royal Blue",
25                   "slug": "royal-blue"
26                 }
27               ]
28             }
29           ],
30           "categories": [
31             "foo"
32           ],
33           "tax-category": "standard-taxable",
34           "default-sku": "foo",
35           "ec-product-type": "ff42fee0113744f693a764e3431a9cc2"
36         }
37       },
38       "skus": [
39         {
40           "id": "580e63fc8c9a982ac9b8b745",
41           "cmsLocaleId": "653ad57de882f528b32e810e",
42           "lastPublished": "2023-03-17T18:47:35.560Z",
43           "lastUpdated": "2023-03-17T18:47:35.560Z",
44           "createdOn": "2023-03-17T18:47:35.560Z",
45           "fieldData": {
46             "name": "Blue T-shirt",
47             "slug": "t-shirt-blue",
48             "price": {
49               "value": 2499,
50               "unit": "USD",
51               "currency": "USD"
52             },
53             "sku-values": {},
54             "compare-at-price": {
55               "value": 100,
56               "unit": "USD"
57             },
58             "ec-sku-billing-method": "one-time",
59             "ec-sku-subscription-plan": {
60               "interval": "day",
61               "frequency": 1,
62               "trial": 7,
63               "plans": [
64                 {
65                   "platform": "stripe",
66                   "id": "foo",
67                   "status": "active"
68                 }
69               ]
70             },
71             "track-inventory": false,
72             "quantity": 10,
73             "main-image": "https://www.example.com/image.jpg",
74             "sku": "1234567890",
75             "sku-properties": [
76               {
77                 "id": "Color",
78                 "name": "Color",
79                 "enum": [
80                   {
81                     "id": "royal-blue",
82                     "name": "Royal Blue",
83                     "slug": "royal-blue"
84                   }
85                 ]
86               }
87             ]
88           }
89         }
90       ]
91     }
92   ],
93   "pagination": {
94     "limit": 100,
95     "offset": 0,
96     "total": 100
97   }
98 }

Retrieve all products for a site.

Use limit and offset to page through all products with subsequent requests. All SKUs for each product will also be fetched and returned. The limit, offset and total values represent Products only and do not include any SKUs.

Required scope | ecommerce:read

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

Query parameters

offsetdoubleOptional

Offset used for pagination if the results have more than limit records

limitdoubleOptional

Maximum number of records to be returned (max limit: 100)

Response

Request was successful

itemslist of objectsOptional

List of Item objects within the Collection. Contains product and skus keys for each Item

paginationobjectOptional

Pagination object

List Products & SKUs

Path parameters

Headers

Query parameters

Response

Errors