How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Squarespace Orders API

The Squarespace Orders API provides access to order history for a Squarespace merchant site, supporting both one-time purchases and subscription orders. Developers can retrieve, create, and manage orders, as well as import orders from third-party sales channels into Squarespace.

This API exposes 8 operations across 6 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.squarespace.com, https://api.squarespace.com/1.0.

8 operations 6 paths 39 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://api.squarespace.com
https://api.squarespace.com/1.0
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Squarespace Orders API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (Authorization). It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Authenticate using an API key or OAuth access token. Include the token in the Authorization header as "Bearer YOURTOKEN".

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 8
GET
/1.0/commerce/orders
List orders
getOrders 8 params → 200400
POST
/1.0/commerce/orders
Create order
createOrder 3 params body → 201400409429
GET
/1.0/commerce/orders/{id}
Get order
getOrder 3 params → 200400404
POST
/1.0/commerce/orders/{id}/fulfillments
Fulfill order
fulfillOrder 3 params body → 204400404409
GET
/commerce/orders
Retrieve All Orders
listOrders 4 params → 200400401403429
POST
/commerce/orders
Create an Order
createOrder body → 200400401403429
GET
/commerce/orders/{orderId}
Retrieve a Specific Order
getOrder 1 param → 200401403404429
POST
/commerce/orders/{orderId}/fulfillments
Fulfill an Order
fulfillOrder 1 param body → 200400401403404429

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are Order (30 properties), CreateOrderRequest (20 properties), Order_2 (16 properties), LineItem (15 properties). Each schema is shown below with its type and property counts.

ShippingLine
object
Array of shipping line items; describes the shipping options chosen at checkout.
2 properties
OrderNote
object
Array of internal notes added to the order by the merchant.
1 property
CreateOrderRequest
object
20 properties 7 required
CreateDiscountLineRequest
object
Array of discount line items. Describes the promotions redeemed during checkout.
3 properties
OrderCreateLineItemType
string
Product type sold; values may be PHYSICALPRODUCT or CUSTOM.
TaxInterpretation
string
Indicates that lineItems.unitPricePaid includes tax. Values may be EXCLUSIVE or INCLUSIVE.
CreateLineItemRequest
object
Array of purchased line items; cannot be empty.
6 properties 3 required
OrderCreateFulfillmentStatus
string
Current fulfillment status of the order. Value may be PENDING or FULFILLED.
LineItem
object
Array of purchased line items; line items describe what product or product variant was purchased, how many of that item were purchased, and additional details.
15 properties
CreateOrderShipmentRequest
object
Array of shipping fulfillments; up to 100 entries. Describes shipment information for the order.
5 properties 4 required
ShopperFulfillmentNotificationBehavior
string
Indicates whether to send a fulfillment notification email to the customer. Value may be SEND or SKIP.
Fulfillment
object
Array of shipping fulfillments; describes shipment information for the order.
5 properties
Address
object
Customer's shipping address provided at checkout or, for recurring subscription orders, the customer's current mailing address.
9 properties
DiscountLine
object
Array of discount line items; describes the promotions redeemed during checkout.
4 properties
StandardErrorPayload
object
5 properties
MonetaryAmount
object
A monetary amount with currency code and decimal value.
2 properties
Order
object
30 properties
OrderFulfillmentRequest
object
2 properties
AddressRequest
object
Customer's shipping address.
9 properties
VariantOption
object
Array of variant options; represents variant choices made by the customer. Null for download and gift card products.
2 properties
FormItem
object
Array of form data submitted via the checkout page.
2 properties
CreateShippingLineRequest
object
Array of shipping line items. Describes the shipping options chosen at checkout. Currently accepts only one shipping entry.
2 properties 2 required
FulfillmentStatus
string
Current fulfillment status of the order. Value may be: PENDING, FULFILLED, or CANCELED.
OrderListResponse
object
2 properties
CreateOrderInventoryBehavior
string
Indicates whether to deduct stock quantity for the product variant upon Order creation. Values may be DEDUCT or SKIP. Defaults to SKIP.
PaymentState
string
Current state of payment for the order.
CreateOrderRequest_2
object
Request body for creating a new order
8 properties 5 required
Pagination
object
Pagination metadata included with list responses
3 properties
Shipment
object
Shipment details for a fulfillment record
5 properties
OrderTotals
object
Monetary totals for an order
6 properties
LineItem_2
object
A single product line in an order
10 properties
Fulfillment_2
object
A fulfillment record indicating that part or all of an order has shipped
5 properties
Address_2
object
A postal address for billing or shipping
9 properties
Error
object
Standard error response returned by the Squarespace API
4 properties
FormField
object
A custom form field submitted with an order
2 properties
Order_2
object
An order placed on a Squarespace merchant site
16 properties
Customization
object
A customization option applied to a line item
2 properties
Money
object
A monetary value with currency
2 properties
FulfillOrderRequest
object
Request body for marking order line items as fulfilled
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

squarespace-orders-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Squarespace Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.