Products

List products

Retrieves information for products; products can be filtered within a date range and by product type. The response contains product information in a Product, up to 50 Products ordered by their modification date (modifiedOn), and supports dynamic cursors for pagination.

get/v2/commerce/products

Request

Base URL
https://api.squarespace.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/squarespace/apis/commerce-api/docs/v2/commerce/products/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

modifiedAfterstring

modifiedBeforestring

cursorstring

querystring

typestring[]

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Response

A paginated list of products.

Example response

{
  "pagination": {
    "hasNextPage": true,
    "nextPageCursor": "ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ",
    "nextPageUrl": "/v2/commerce/products?cursor=ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ"
  },
  "products": [
    {
      "pricing": {
        "basePrice": {
          "value": 49.99
        },
        "salePrice": {
          "value": 49.99
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.