S

Squarespace Commerce APIs Changelog

S

We've released the Discounts API to general availability. The Discounts API provides full

We've released the Discounts API to general availability. The Discounts API provides full create, read, update, delete and list (CRUDL) access to discounts configured for a Squarespace site. The Discounts API supports both OAuth and API key authentication. Generate a key with the Discounts permission (Read Only or Read and Write) to manage discounts without an OAuth integration. Check the Discount…

S

The Contacts API now supports authentication with an API key, in addition to OAuth. Genera

The Contacts API now supports authentication with an API key, in addition to OAuth. Generate a key with the Contacts permission (Read Only or Read and Write) to access contact records, address books, and marketing preferences without an OAuth integration. See Authentication and permissions for details on generating an API key and its permission levels. Payment Plans are now reflected in the Orders…

S

Squarespace has launched Payment Plans: sellers can offer eligible products with an initia

Squarespace has launched Payment Plans: sellers can offer eligible products with an initial deposit collected at checkout, followed by a series of installments charged automatically on a seller-defined schedule. Shoppers select between paying in full and choosing a payment plan on the product details page. Payment Plan orders surface through the existing Order and Transactions Document shapes, wit…

S

The retrieve all orders endpoint now accepts an optional paymentStates query parameter, a

The retrieve all orders endpoint now accepts an optional paymentStates query parameter, a comma-separated list of NOT_CHARGED, AUTHORIZED, PAID, REFUNDED, PENDING, FAILED, REFUND_PENDING, REFUND_FAILED, or PARTIALLY_PAID. If not specified, the endpoint defaults to NOT_CHARGED,AUTHORIZED,PAID,REFUNDED, which preserves the previous behavior. Pass PARTIALLY_PAID to include Payment Plan orders that ar…

S

The Order resource now exposes a paymentState field that reports the current payment state

The Order resource now exposes a paymentState field that reports the current payment state of the order, with values such as NOT_CHARGED, AUTHORIZED, PAID, PARTIALLY_PAID, PENDING, FAILED, REFUND_PENDING, REFUNDED, and REFUND_FAILED. The field can be used as the canonical source for an order's payment status, removing the need to infer it from individual transactions and refunds. Contact and addre…

S

We've released six new webhook topics for real-time contact and address book notifications

We've released six new webhook topics for real-time contact and address book notifications: Contact lifecycle — contact.create, contact.update, and contact.delete events fire when contacts are created, modified, or removed. Address book changes — address.create, address.update, and address.delete events fire when address book entries are added, changed, or removed from a contact. To start receivin…

S

We've released the Contacts API to general availability. The Contacts API provides full cr

We've released the Contacts API to general availability. The Contacts API provides full create, read, update, and delete (CRUD) access to the contacts associated with a Squarespace site — customers, mailing list subscribers, donors, and anyone else who has interacted with the site. Key capabilities include: Full CRUD operations on contact records, including name, email, locale, and marketing prefe…

S

We've released the Products API (v2) to general availability. The Products API v2 endpoint

We've released the Products API (v2) to general availability. The Products API v2 endpoints now also support Service, Gift Cards, and Download products, in addition to the Physical products already present in v1.0 and v1.2. Download products have some limitations. They do not support: Creating product Deleting product CRUD operations for variants as download products do not have variants. Check th…

S

We've released a new version of the Products API (v2) in beta. This version includes: Enha

We've released a new version of the Products API (v2) in beta. This version includes: Enhanced Product Type Support: v2 endpoints now support physical, service, gift card, and download products for most operations. Backward Compatibility: v1.0 and v1.1 endpoints remain fully supported. v2 endpoints are available at /v2/commerce/products/* and are marked as Beta. We recommend using v2 for new integ…

S

A new version of the Products API has been released. This version enables read-only access

A new version of the Products API has been released. This version enables read-only access to download products. Download products can now be retrieved by retrieve all products and retrieve specific products endpoints. A new query parameter type has been added to the retrieve all products endpoint, which filters results by products type. To learn more about the differences between physical and dow…