Getting started
Using Commerce APIs
Inventory API
Orders API
Overview
POST: Create an order
POST: Fulfill an order
GET: Retrieve all orders
GET: Retrieve a specific order
Products API
Overview
About product attributes
Managing attributes
POST: Create a product
POST: Create a product variant
POST: Upload a product image
GET: Retrieve all Store Pages
GET: Retrieve all products
GET: Retrieve specific products
GET: Product image upload status
POST: Assign a product image to variant
POST: Reorder a product image
POST: Update a product
POST: Update a product variant
POST: Update a product image
DEL: Delete a product
DEL: Delete a product variant
DEL: Delete a product image
Profiles API
Transactions API
Webhook Subscriptions API
Orders API overview
Current version: 1.0
For versioning details, read the Upgrade guide.
Use the Orders API to access the order history for a Squarespace merchant site. Orders can be one-time purchase orders and recurring orders generated by subscriptions. The Orders API can also import orders from third-party sales channels, mark orders as fulfilled, and trigger shipment notifications.
Note: Although they appear in Squarespace as orders, the Orders API does not provide access to donations. Instead, donation information can be accessed using the Transactions API.
API resources
The Orders API returns order information in Order resource objects.
Resource fields are described under Response example for each Orders API endpoint.
Further reading
- Become familiar with common commerce terms and how they're related to the API
- Obtain an API key or use OAuth
- Read the FAQ guide for answers to common questions