Squarespace - Get Orders

Description

This module allows querying orders from a Squarespace store. It can get a specific order by ID or list orders filtered by fulfillment status and dates.

Configuration

Required Credentials

• API Key: Squarespace API key

Parameters

Parameter	Type	Required	Description
credentials_id	credential	Yes	Squarespace credentials
order_id	string	No	Specific order ID
fulfillmentStatus	select	No	Status: PENDING, FULFILLED, CANCELED
modifiedAfter	string	No	Orders modified after (ISO 8601)
modifiedBefore	string	No	Orders modified before (ISO 8601)
cursor	string	No	Pagination cursor

Fulfillment Statuses

• PENDING: Order pending shipment
• FULFILLED: Fully shipped order
• CANCELED: Cancelled order

Output

{
  "success": true,
  "orders": [...],
  "count": 25,
  "hasNextPage": true,
  "nextCursor": "abc123...",
  "message": "25 orders retrieved"
}

Order Fields

• id: Order ID
• orderNumber: Visible order number
• createdOn: Creation date
• modifiedOn: Modification date
• fulfillmentStatus: Fulfillment status
• customerEmail: Customer email
• lineItems: Order products
• shippingAddress: Shipping address
• billingAddress: Billing address
• grandTotal: Order total
• subtotal: Subtotal
• shippingTotal: Shipping total
• taxTotal: Tax total

Usage Example

Get order by ID

{
  "order_id": "5f3e..."
}

Pending orders

{
  "fulfillmentStatus": "PENDING"
}

Last month’s orders

{
  "modifiedAfter": "2024-01-01T00:00:00Z",
  "modifiedBefore": "2024-01-31T23:59:59Z"
}

API Used

• Endpoint: GET /1.0/commerce/orders
• Documentation: Squarespace Orders API

Notes

• Orders cannot be modified directly via API
• To mark as shipped, use the CreateFulfillment module
• Prices are returned in the currency configured in the store
• The API includes full address and product information

Related Nodes

• SquarespaceCreateFulfillment - Mark order as shipped with tracking
• SquarespaceGetProducts - Get order product data
• SquarespaceGetProfiles - Get order customer profile
• SquarespaceGetTransactions - Get order payment transactions