Squarespace
App · 25 actions
Run your Squarespace store: list, import and fulfill orders, change stock, create and update products and their variants and images, keep contacts in step, and read payments. Start workflows on new orders, fulfilled orders, new contacts and low stock.
Actions
| Action | What it does |
|---|---|
| Add product image | Add a JPEG, PNG or GIF image to a product and wait for Squarespace to process it. |
| Add variant | Add a variant to a product, such as another size, with its own SKU, price and stock. |
| Change stock | Add to or take off a variant's stock, set it to a number, or make it unlimited. |
| Create contact | Add a person to your site's contacts, optionally subscribed to your marketing emails. |
| Create product | Create a physical product or a service on a store page, with its first variant's SKU, price and stock. |
| Delete contact | Delete a contact from your site. |
| Delete product | Delete a product with its variants and images. |
| Delete variant | Delete one variant of a product. |
| Find contacts | Find the people your site knows (customers, mailing list subscribers and donors) by name or email, newest first or by what they've spent. |
| Fulfill order | Mark an order fulfilled, optionally with a shipment's carrier and tracking, and email the customer that it's on its way. |
| Get contact | Get one contact with their name, email and marketing email choice. |
| Get order | Get one order with its items, totals, addresses, payment state and shipments. |
| Get product | Get one product with its variants, prices, stock and images. |
| Get site info | Get the Squarespace site the connection uses: its title, address, currency, language and time zone. |
| Get stock levels | Get how many are in stock of up to 50 product variants. |
| Get transactions | Get up to 50 payment records by their ids. |
| Import order | Add an order placed on another sales channel, such as a marketplace, to your Squarespace orders. |
| List orders | List up to 50 orders at a time, oldest change first, filtered by fulfillment, payment, when they changed or customer. |
| List products | List up to 50 products at a time with their variants, prices, stock and images, optionally of one kind or changed in a window. |
| List stock levels | List up to 50 product variants at a time with their SKU and how many are in stock. |
| List store pages | List the site's store pages, the pages products are sold on, with their ids for 'Create product'. |
| List transactions | List up to 50 payment records at a time, one per order or donation, with payments, refunds, fees and taxes. |
| Update contact | Change a contact's name or email, or subscribe or unsubscribe them from marketing emails. |
| Update product | Change a product's name, description, URL slug, tags or visibility. |
| Update variant | Change a variant's SKU, price, sale or options. |
Add product image
Add a JPEG, PNG or GIF image to a product and wait for Squarespace to process it. The file's name becomes the image's alt text.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
- Image
imagetextRequired - Upload a file, pick one from an earlier step, or paste a link to one. JPEG, PNG or GIF, ideally under 500 KB.
Outputs
imageobject- A product image
image_idtext- The new image's id
product_idtext- The product
statustext- READY, or PROCESSING when Squarespace is still working on it
Example output
{
"image": {
"altText": "tote",
"availableFormats": [
"100w",
"300w",
"500w",
"750w",
"1000w"
],
"id": "5f2a1c0de4b0a1b2c3d4e5f6",
"orderIndex": 0,
"url": "https://images.squarespace-cdn.com/content/v1/tote.jpg"
},
"image_id": "5f2a1c0de4b0a1b2c3d4e5f6",
"product_id": "565c8f3da7c8a3cf71d5fd0a",
"status": "READY"
}Add variant
Add a variant to a product, such as another size, with its own SKU, price and stock. The product needs options (such as Size) to have more than one variant.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
- SKU
skutextRequired - Your code for this variant, up to 60 characters. Must be unique.
- Price
pricenumberRequired - The regular price, such as 24.50, in your store's currency.At least 0.
- This variant's options
variant_optionsobject - A choice for each of the product's options, such as Size: Large.
- Sale price
sale_pricenumber - Put it on sale at this price. Leave empty for no sale.At least 0.
- Stock
stocknumber - How many you have. Leave empty for unlimited stock.From 0 to 1000000.
Outputs
product_idtext- The product the variant belongs to
variantobject- A product variant
Example output
{
"product_id": "565c8f3da7c8a3cf71d5fd0a",
"variant": {
"attributes": {
"Size": "Small"
},
"id": "d2b1c0a9-8f7e-4d6c-b5a4-938271605f4e",
"pricing": {
"basePrice": {
"currency": "USD",
"value": "24.50"
},
"onSale": false,
"salePrice": {
"currency": "USD",
"value": "0.00"
}
},
"sku": "TOTE-SM",
"stock": {
"quantity": 12,
"unlimited": false
}
}
}Change stock
Add to or take off a variant's stock, set it to a number, or make it unlimited. Returns the new stock level.
Inputs
- Variant
variant_idtextRequired - The product variant. Pick one, or give its id.
- Change
changetextRequired - What to do to the stock.One of:
add(Add to stock),remove(Take off stock),set(Set stock to),unlimited(Make stock unlimited). - Quantity
quantitynumber - How many to add, take off or set the stock to.Only when Change is Add to stock, Take off stock or Set stock to. From 0 to 1000000.
Outputs
adjustedtrue/false- Always true once the stock is changed
itemobject- A variant's stock
variant_idtext- The variant changed
Example output
{
"adjusted": true,
"item": {
"descriptor": "Linen tote bag [Large]",
"isUnlimited": false,
"quantity": 12,
"sku": "SQ3381024",
"variantId": "88c16ee4-547b-445e-a392-bded9991ae30"
},
"variant_id": "88c16ee4-547b-445e-a392-bded9991ae30"
}Create contact
Add a person to your site's contacts, optionally subscribed to your marketing emails.
Inputs
- Email
emailtextRequired - Their email address. No two contacts can share one.
- First name
first_nametextRequired - Their first name.
- Last name
last_nametextRequired - Their last name.
- Subscribe to marketing emails
accepts_marketingtrue/false - Add them to your mailing list. Only with their consent.Default:
false. - Language
localetext - Their language and region, such as en-US. Defaults to your site's.
Outputs
contactobject- The contact
Example output
{
"contact": {
"createdOn": "2026-10-15T09:00:00Z",
"firstName": "Jane",
"id": "64a7e3d2c8f1b95e30a14d2b",
"lastName": "Doe",
"locale": "en-US",
"primaryEmail": {
"acceptsMarketing": {
"acceptsMarketing": true,
"joinedOn": "2026-10-15T09:00:00Z",
"leftOn": null
},
"createdOn": "2026-10-15T09:00:00Z",
"email": "jane.doe@example.com"
}
}
}Create product
Create a physical product or a service on a store page, with its first variant's SKU, price and stock. New products are hidden unless made visible.
Inputs
- Store page
store_page_idtextRequired - The store page to add it to.
- Name
nametextRequired - The product's name, up to 200 characters.
- SKU
skutextRequired - Your code for this variant, up to 60 characters. Must be unique.
- Price
pricenumberRequired - The regular price, such as 24.50, in your store's currency.At least 0.
- Kind
product_typetext - A physical product to ship, or a service.One of:
PHYSICAL(Physical product (default)),SERVICE. - Description
descriptiontext - The product's description. HTML works.
- Sale price
sale_pricenumber - Put it on sale at this price. Leave empty for no sale.At least 0.
- Stock
stocknumber - How many you have. Leave empty for unlimited stock.From 0 to 1000000.
- Option names
option_nameslist - What its variants will differ by, such as Size or Color, up to 6. Needed to add more variants later.
- This variant's options
variant_optionsobject - A choice for each of the product's options, such as Size: Large.
- URL slug
url_slugtext - The end of the product's page address, such as linen-tote. Leave empty for one made from the name.
- Tags
tagslist - Words to group and search products by.
- Visibility
visibilitytext - Whether shoppers can see and buy it. New products are hidden.One of:
visible(Visible: on sale in the store),hidden.
Outputs
productobject- The product
Example output
{
"product": {
"createdOn": "2026-10-01T12:00:00Z",
"description": "<p>A sturdy linen tote.</p>",
"id": "565c8f3da7c8a3cf71d5fd0a",
"images": [],
"isVisible": true,
"modifiedOn": "2026-10-20T12:00:00Z",
"name": "Linen tote bag",
"storePageId": "5e8b7a6c5d4e3f2a1b0c9d8e",
"tags": [
"bags"
],
"type": "PHYSICAL",
"url": "https://example.squarespace.com/shop/p/linen-tote-bag",
"urlSlug": "linen-tote-bag",
"variantAttributes": [
"Size"
],
"variants": [
{
"attributes": {
"Size": "Large"
},
"id": "88c16ee4-547b-445e-a392-bded9991ae30",
"pricing": {
"basePrice": {
"currency": "USD",
"value": "24.50"
},
"onSale": false,
"salePrice": {
"currency": "USD",
"value": "0.00"
}
},
"sku": "SQ3381024",
"stock": {
"quantity": 12,
"unlimited": false
}
}
]
}
}Delete contact
Delete a contact from your site.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'Find contacts', or an order's customer id.
Outputs
contact_idtext- The contact deleted
deletedtrue/false- Always true once deleted
Example output
{
"contact_id": "64a7e3d2c8f1b95e30a14d2b",
"deleted": true
}Delete product
Delete a product with its variants and images.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
product_idtext- The product deleted
Example output
{
"deleted": true,
"product_id": "565c8f3da7c8a3cf71d5fd0a"
}Delete variant
Delete one variant of a product. A product's only variant can't be deleted; delete the product instead.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
- Variant
variant_idtextRequired - The product's variant. Pick one, or give its id.
Outputs
deletedtrue/false- Always true once deleted
product_idtext- The product
variant_idtext- The variant deleted
Example output
{
"deleted": true,
"product_id": "565c8f3da7c8a3cf71d5fd0a",
"variant_id": "d2b1c0a9-8f7e-4d6c-b5a4-938271605f4e"
}Find contacts
Find the people your site knows (customers, mailing list subscribers and donors) by name or email, newest first or by what they've spent.
Inputs
- Name or email
searchtext - Only contacts whose name or email contains this.
- Who
grouptext - Everyone, or only customers, subscribers or donors.One of:
everyone(Everyone (default)),customers(Customers who have ordered),subscribers(Mailing list subscribers),donors. - Order
sorttext - Which come first.One of:
newest(Newest first (default)),oldest(Oldest first),last_order(Most recent order first),most_spent(Most spent first). - How many
page_sizenumber - How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
- Next page
cursortext - The 'next_cursor' an earlier run of this step gave, to get the page after it. The page keeps that run's filters.
Outputs
contactslist- The contacts
countnumber- How many on this page
has_moretrue/false- True when there are more after this page
next_cursortext- Give this as the Next page field to get the next page; empty on the last one
Example output
{
"contacts": [
{
"createdOn": "2026-10-15T09:00:00Z",
"firstName": "Jane",
"id": "64a7e3d2c8f1b95e30a14d2b",
"lastName": "Doe",
"locale": "en-US",
"primaryEmail": {
"acceptsMarketing": {
"acceptsMarketing": true,
"joinedOn": "2026-10-15T09:00:00Z",
"leftOn": null
},
"createdOn": "2026-10-15T09:00:00Z",
"email": "jane.doe@example.com"
}
}
],
"count": 1,
"has_more": false,
"next_cursor": ""
}Fulfill order
Mark an order fulfilled, optionally with a shipment's carrier and tracking, and email the customer that it's on its way.
Inputs
- Order ID
order_idtextRequired - The order's id, from 'List orders' or an earlier step.
- Carrier
carrier_nametext - Who's delivering it, such as USPS. Leave empty to send no shipment.
- Tracking number
tracking_numbertext - The carrier's tracking number. Needed with a carrier.
- Service
servicetext - The carrier's service, such as Priority Mail. Defaults to Standard.
- Tracking link
tracking_urltext - The page where the customer can track it.
- Shipped at
ship_datedate and time - When it was shipped. Defaults to now.
- Email the customer
notify_customertrue/false - Send the customer Squarespace's shipping email.Default:
true.
Outputs
fulfilledtrue/false- Always true once the order is fulfilled
orderobject- The order
order_idtext- The order fulfilled
Example output
{
"fulfilled": true,
"order": {
"billingAddress": {
"address1": "459 Broadway",
"address2": null,
"city": "New York",
"countryCode": "US",
"firstName": "Bob",
"lastName": "Loblaw",
"phone": "5553334444",
"postalCode": "10003",
"state": "NY"
},
"channel": "web",
"channelName": null,
"createdOn": "2026-10-20T15:58:07.187Z",
"customerEmail": "bob@example.com",
"customerId": "585d498fdee9f31a60284a38",
"discountTotal": {
"currency": "USD",
"value": "0.00"
},
"externalOrderReference": null,
"fulfilledOn": "2026-10-21T09:00:00Z",
"fulfillmentStatus": "FULFILLED",
"fulfillments": [
{
"carrierName": "USPS",
"service": "Priority Mail",
"shipDate": "2026-10-21T09:00:00Z",
"trackingNumber": "9400111899223197428490",
"trackingUrl": null
}
],
"grandTotal": {
"currency": "USD",
"value": "58.35"
},
"id": "585d498fdee9f31a60284a37",
"lineItems": [
{
"id": "585d4975dee9f31a60284a16",
"imageUrl": null,
"lineItemType": "PHYSICAL_PRODUCT",
"productId": "565c8f3da7c8a3cf71d5fd0a",
"productName": "Linen tote bag",
"quantity": 2,
"sku": "SQ3381024",
"unitPricePaid": {
"currency": "USD",
"value": "24.50"
},
"variantId": "88c16ee4-547b-445e-a392-bded9991ae30",
"variantOptions": [
{
"optionName": "Size",
"value": "Large"
}
]
}
],
"modifiedOn": "2026-10-20T16:02:11.022Z",
"orderNumber": "1004",
"paymentState": "PAID",
"priceTaxInterpretation": "EXCLUSIVE",
"refundedTotal": {
"currency": "USD",
"value": "0.00"
},
"shippingAddress": {
"address1": "459 Broadway",
"address2": null,
"city": "New York",
"countryCode": "US",
"firstName": "Bob",
"lastName": "Loblaw",
"phone": "5553334444",
"postalCode": "10003",
"state": "NY"
},
"shippingLines": [
{
"amount": {
"currency": "USD",
"value": "5.00"
},
"method": "UPS Ground"
}
],
"shippingTotal": {
"currency": "USD",
"value": "5.00"
},
"subtotal": {
"currency": "USD",
"value": "49.00"
},
"taxTotal": {
"currency": "USD",
"value": "4.35"
},
"testmode": false
},
"order_id": "585d498fdee9f31a60284a37"
}Get contact
Get one contact with their name, email and marketing email choice.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'Find contacts', or an order's customer id.
Outputs
contactobject- The contact
Example output
{
"contact": {
"createdOn": "2026-10-15T09:00:00Z",
"firstName": "Jane",
"id": "64a7e3d2c8f1b95e30a14d2b",
"lastName": "Doe",
"locale": "en-US",
"primaryEmail": {
"acceptsMarketing": {
"acceptsMarketing": true,
"joinedOn": "2026-10-15T09:00:00Z",
"leftOn": null
},
"createdOn": "2026-10-15T09:00:00Z",
"email": "jane.doe@example.com"
}
}
}Get order
Get one order with its items, totals, addresses, payment state and shipments.
Inputs
- Order ID
order_idtextRequired - The order's id, from 'List orders' or an earlier step.
Outputs
orderobject- The order
Example output
{
"order": {
"billingAddress": {
"address1": "459 Broadway",
"address2": null,
"city": "New York",
"countryCode": "US",
"firstName": "Bob",
"lastName": "Loblaw",
"phone": "5553334444",
"postalCode": "10003",
"state": "NY"
},
"channel": "web",
"channelName": null,
"createdOn": "2026-10-20T15:58:07.187Z",
"customerEmail": "bob@example.com",
"customerId": "585d498fdee9f31a60284a38",
"discountTotal": {
"currency": "USD",
"value": "0.00"
},
"externalOrderReference": null,
"fulfilledOn": null,
"fulfillmentStatus": "PENDING",
"fulfillments": [],
"grandTotal": {
"currency": "USD",
"value": "58.35"
},
"id": "585d498fdee9f31a60284a37",
"lineItems": [
{
"id": "585d4975dee9f31a60284a16",
"imageUrl": null,
"lineItemType": "PHYSICAL_PRODUCT",
"productId": "565c8f3da7c8a3cf71d5fd0a",
"productName": "Linen tote bag",
"quantity": 2,
"sku": "SQ3381024",
"unitPricePaid": {
"currency": "USD",
"value": "24.50"
},
"variantId": "88c16ee4-547b-445e-a392-bded9991ae30",
"variantOptions": [
{
"optionName": "Size",
"value": "Large"
}
]
}
],
"modifiedOn": "2026-10-20T16:02:11.022Z",
"orderNumber": "1004",
"paymentState": "PAID",
"priceTaxInterpretation": "EXCLUSIVE",
"refundedTotal": {
"currency": "USD",
"value": "0.00"
},
"shippingAddress": {
"address1": "459 Broadway",
"address2": null,
"city": "New York",
"countryCode": "US",
"firstName": "Bob",
"lastName": "Loblaw",
"phone": "5553334444",
"postalCode": "10003",
"state": "NY"
},
"shippingLines": [
{
"amount": {
"currency": "USD",
"value": "5.00"
},
"method": "UPS Ground"
}
],
"shippingTotal": {
"currency": "USD",
"value": "5.00"
},
"subtotal": {
"currency": "USD",
"value": "49.00"
},
"taxTotal": {
"currency": "USD",
"value": "4.35"
},
"testmode": false
}
}Get product
Get one product with its variants, prices, stock and images.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
Outputs
productobject- The product
Example output
{
"product": {
"createdOn": "2026-10-01T12:00:00Z",
"description": "<p>A sturdy linen tote.</p>",
"id": "565c8f3da7c8a3cf71d5fd0a",
"images": [
{
"altText": "tote",
"availableFormats": [
"100w",
"300w",
"500w",
"750w",
"1000w"
],
"id": "5f2a1c0de4b0a1b2c3d4e5f6",
"orderIndex": 0,
"url": "https://images.squarespace-cdn.com/content/v1/tote.jpg"
}
],
"isVisible": true,
"modifiedOn": "2026-10-20T12:00:00Z",
"name": "Linen tote bag",
"storePageId": "5e8b7a6c5d4e3f2a1b0c9d8e",
"tags": [
"bags"
],
"type": "PHYSICAL",
"url": "https://example.squarespace.com/shop/p/linen-tote-bag",
"urlSlug": "linen-tote-bag",
"variantAttributes": [
"Size"
],
"variants": [
{
"attributes": {
"Size": "Large"
},
"id": "88c16ee4-547b-445e-a392-bded9991ae30",
"pricing": {
"basePrice": {
"currency": "USD",
"value": "24.50"
},
"onSale": false,
"salePrice": {
"currency": "USD",
"value": "0.00"
}
},
"sku": "SQ3381024",
"stock": {
"quantity": 12,
"unlimited": false
}
}
]
}
}Get site info
Get the Squarespace site the connection uses: its title, address, currency, language and time zone.
Inputs
None.
Outputs
siteobject- The site
Example output
{
"site": {
"currency": "USD",
"id": "5863f6faf7e0abc3cf95ce3a",
"language": "en-US",
"location": {
"country": "United States",
"region": "New York, NY, 10014"
},
"measurementStandard": "IMPERIAL",
"siteId": "developers",
"timeZone": "America/New_York",
"title": "Squarespace Developers",
"url": "https://developers.squarespace.com"
}
}Get stock levels
Get how many are in stock of up to 50 product variants.
Inputs
- Variants
variant_idslistRequired - The variants. Pick them, or give their ids.
Outputs
countnumber- How many
itemslist- The variants' stock
Example output
{
"count": 1,
"items": [
{
"descriptor": "Linen tote bag [Large]",
"isUnlimited": false,
"quantity": 12,
"sku": "SQ3381024",
"variantId": "88c16ee4-547b-445e-a392-bded9991ae30"
}
]
}Get transactions
Get up to 50 payment records by their ids.
Inputs
- Transaction IDs
transaction_idslistRequired - The payment records' ids, from 'List transactions'.
Outputs
countnumber- How many
transactionslist- The payment records
Example output
{
"count": 1,
"transactions": [
{
"createdOn": "2026-10-20T15:58:07.187Z",
"customerEmail": "bob@example.com",
"id": "a7e4c6b5-d1fe-4e42-a932-f185b4b86829",
"modifiedOn": "2026-10-20T15:58:09.870Z",
"paymentGatewayError": null,
"payments": [
{
"amount": {
"currency": "USD",
"value": "58.35"
},
"creditCardType": "VISA",
"externalTransactionId": "ch_1FFCJCLMG4qggZ0BzchTZjwR",
"id": "ece69479-50bc-4763-9067-4473f3abcf83",
"netAmount": {
"currency": "USD",
"value": "58.35"
},
"paidOn": "2026-10-20T15:58:09.845Z",
"provider": "STRIPE",
"refundedAmount": {
"currency": "USD",
"value": "0.00"
}
}
],
"salesOrderId": "585d498fdee9f31a60284a37",
"total": {
"currency": "USD",
"value": "58.35"
},
"totalNetPayment": {
"currency": "USD",
"value": "56.36"
},
"totalNetSales": {
"currency": "USD",
"value": "49.00"
},
"totalNetShipping": {
"currency": "USD",
"value": "5.00"
},
"totalSales": {
"currency": "USD",
"value": "49.00"
},
"totalTaxes": {
"currency": "USD",
"value": "4.35"
},
"voided": false
}
]
}Import order
Add an order placed on another sales channel, such as a marketplace, to your Squarespace orders. The totals are worked out from the items, shipping, tax and discount. Squarespace allows 100 imports an hour.
Inputs
- Sales channel
channel_nametextRequired - Where the order was placed, up to 30 characters, such as Etsy.
- Order number on that channel
external_order_referencetextRequired - The order's number or id on the other channel. Importing the same order again with the same details doesn't make a second copy.
- Placed at
created_ondate and timeRequired - When the order was placed on the other channel.
- Items
line_itemslistRequired - What was bought. Each item has a price and quantity, and either a variant_id from your store or a title for something that isn't.
- Customer email
customer_emailtext - The customer's email address.
- Shipping cost
shipping_costnumber - What the customer paid for shipping.At least 0.
- Shipping method
shipping_methodtext - The shipping chosen, such as UPS Ground.
- Tax
tax_totalnumber - The tax on the whole order.At least 0.
- Discount
discount_totalnumber - The discount on the whole order, as an amount taken off.At least 0.
- Prices and tax
prices_include_taxtext - Whether the item prices already include tax.One of:
EXCLUSIVE(Prices don't include tax (default)),INCLUSIVE(Prices include tax). - Fulfillment
fulfillment_statustext - Whether the order has already been sent.One of:
PENDING(Not yet fulfilled (default)),FULFILLED(Already fulfilled). - Fulfilled at
fulfilled_ondate and time - When it was sent. Defaults to when it was placed.Only when Fulfillment is Already fulfilled.
- Take the items off stock
deduct_stocktrue/false - Lower your store's stock of the variants sold.Default:
false. - Ship to: first name
ship_to_first_nametext - The first name on the shipping address.
- Ship to: last name
ship_to_last_nametext - The last name on the shipping address.
- Ship to: street address
ship_to_address1text - The first line of the shipping address.
- Ship to: address line 2
ship_to_address2text - An apartment, suite or unit.
- Ship to: city
ship_to_citytext - The city.
- Ship to: state or province
ship_to_statetext - The state, province or region, such as NY.
- Ship to: postal code
ship_to_postal_codetext - The postal or ZIP code.
- Ship to: country
ship_to_country_codetext - The two-letter country code, such as US or GB. Needed with an address.
- Ship to: phone
ship_to_phonetext - A phone number for the delivery.
Outputs
orderobject- The order
Example output
{
"order": {
"billingAddress": {
"address1": "459 Broadway",
"address2": null,
"city": "New York",
"countryCode": "US",
"firstName": "Bob",
"lastName": "Loblaw",
"phone": "5553334444",
"postalCode": "10003",
"state": "NY"
},
"channel": "Etsy",
"channelName": "Etsy",
"createdOn": "2026-10-20T15:58:07.187Z",
"customerEmail": "bob@example.com",
"customerId": "585d498fdee9f31a60284a38",
"discountTotal": {
"currency": "USD",
"value": "0.00"
},
"externalOrderReference": "ETSY-2871",
"fulfilledOn": null,
"fulfillmentStatus": "PENDING",
"fulfillments": [],
"grandTotal": {
"currency": "USD",
"value": "58.35"
},
"id": "585d498fdee9f31a60284a37",
"lineItems": [
{
"id": "585d4975dee9f31a60284a16",
"imageUrl": null,
"lineItemType": "PHYSICAL_PRODUCT",
"productId": "565c8f3da7c8a3cf71d5fd0a",
"productName": "Linen tote bag",
"quantity": 2,
"sku": "SQ3381024",
"unitPricePaid": {
"currency": "USD",
"value": "24.50"
},
"variantId": "88c16ee4-547b-445e-a392-bded9991ae30",
"variantOptions": [
{
"optionName": "Size",
"value": "Large"
}
]
}
],
"modifiedOn": "2026-10-20T16:02:11.022Z",
"orderNumber": "1004",
"paymentState": "PAID",
"priceTaxInterpretation": "EXCLUSIVE",
"refundedTotal": {
"currency": "USD",
"value": "0.00"
},
"shippingAddress": {
"address1": "459 Broadway",
"address2": null,
"city": "New York",
"countryCode": "US",
"firstName": "Bob",
"lastName": "Loblaw",
"phone": "5553334444",
"postalCode": "10003",
"state": "NY"
},
"shippingLines": [
{
"amount": {
"currency": "USD",
"value": "5.00"
},
"method": "UPS Ground"
}
],
"shippingTotal": {
"currency": "USD",
"value": "5.00"
},
"subtotal": {
"currency": "USD",
"value": "49.00"
},
"taxTotal": {
"currency": "USD",
"value": "4.35"
},
"testmode": false
}
}List orders
List up to 50 orders at a time, oldest change first, filtered by fulfillment, payment, when they changed or customer. Donations are under 'List transactions'.
Inputs
- Fulfillment
fulfillment_statustext - Only orders in this state.One of:
PENDING(Not yet fulfilled),FULFILLED,CANCELED. - Payment
payment_stateslist - Only orders with these payment states. Leave empty for Squarespace's usual set: paid, not charged, authorized and refunded.One or more of:
PAID,PARTIALLY_PAID(Partly paid (payment plan)),NOT_CHARGED(Not charged),AUTHORIZED(Authorized, not yet captured),PENDING(Payment pending),FAILED(Payment failed),REFUND_PENDING(Refund pending),REFUNDED,REFUND_FAILED(Refund failed). - Changed after
changed_afterdate and time - Only those changed after this time.
- Changed before
changed_beforedate and time - Only those changed before this time.
- Customer ID
customer_idtext - Only this customer's orders: their contact id.
- Next page
cursortext - The 'next_cursor' an earlier run of this step gave, to get the page after it. The page keeps that run's filters.
Outputs
countnumber- How many on this page
has_moretrue/false- True when there are more after this page
next_cursortext- Give this as the Next page field to get the next page; empty on the last one
orderslist- The orders
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"orders": [
{
"billingAddress": {
"address1": "459 Broadway",
"address2": null,
"city": "New York",
"countryCode": "US",
"firstName": "Bob",
"lastName": "Loblaw",
"phone": "5553334444",
"postalCode": "10003",
"state": "NY"
},
"channel": "web",
"channelName": null,
"createdOn": "2026-10-20T15:58:07.187Z",
"customerEmail": "bob@example.com",
"customerId": "585d498fdee9f31a60284a38",
"discountTotal": {
"currency": "USD",
"value": "0.00"
},
"externalOrderReference": null,
"fulfilledOn": null,
"fulfillmentStatus": "PENDING",
"fulfillments": [],
"grandTotal": {
"currency": "USD",
"value": "58.35"
},
"id": "585d498fdee9f31a60284a37",
"lineItems": [
{
"id": "585d4975dee9f31a60284a16",
"imageUrl": null,
"lineItemType": "PHYSICAL_PRODUCT",
"productId": "565c8f3da7c8a3cf71d5fd0a",
"productName": "Linen tote bag",
"quantity": 2,
"sku": "SQ3381024",
"unitPricePaid": {
"currency": "USD",
"value": "24.50"
},
"variantId": "88c16ee4-547b-445e-a392-bded9991ae30",
"variantOptions": [
{
"optionName": "Size",
"value": "Large"
}
]
}
],
"modifiedOn": "2026-10-20T16:02:11.022Z",
"orderNumber": "1004",
"paymentState": "PAID",
"priceTaxInterpretation": "EXCLUSIVE",
"refundedTotal": {
"currency": "USD",
"value": "0.00"
},
"shippingAddress": {
"address1": "459 Broadway",
"address2": null,
"city": "New York",
"countryCode": "US",
"firstName": "Bob",
"lastName": "Loblaw",
"phone": "5553334444",
"postalCode": "10003",
"state": "NY"
},
"shippingLines": [
{
"amount": {
"currency": "USD",
"value": "5.00"
},
"method": "UPS Ground"
}
],
"shippingTotal": {
"currency": "USD",
"value": "5.00"
},
"subtotal": {
"currency": "USD",
"value": "49.00"
},
"taxTotal": {
"currency": "USD",
"value": "4.35"
},
"testmode": false
}
]
}List products
List up to 50 products at a time with their variants, prices, stock and images, optionally of one kind or changed in a window.
Inputs
- Kind
product_typetext - Only products of this kind.One of:
PHYSICAL(Physical products),SERVICE(Services),GIFT_CARD(Gift cards),DIGITAL(Downloads). - Changed after
changed_afterdate and time - Only those changed after this time.
- Changed before
changed_beforedate and time - Only those changed before this time.
- Next page
cursortext - The 'next_cursor' an earlier run of this step gave, to get the page after it. The page keeps that run's filters.
Outputs
countnumber- How many on this page
has_moretrue/false- True when there are more after this page
next_cursortext- Give this as the Next page field to get the next page; empty on the last one
productslist- The products
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"products": [
{
"createdOn": "2026-10-01T12:00:00Z",
"description": "<p>A sturdy linen tote.</p>",
"id": "565c8f3da7c8a3cf71d5fd0a",
"images": [
{
"altText": "tote",
"availableFormats": [
"100w",
"300w",
"500w",
"750w",
"1000w"
],
"id": "5f2a1c0de4b0a1b2c3d4e5f6",
"orderIndex": 0,
"url": "https://images.squarespace-cdn.com/content/v1/tote.jpg"
}
],
"isVisible": true,
"modifiedOn": "2026-10-20T12:00:00Z",
"name": "Linen tote bag",
"storePageId": "5e8b7a6c5d4e3f2a1b0c9d8e",
"tags": [
"bags"
],
"type": "PHYSICAL",
"url": "https://example.squarespace.com/shop/p/linen-tote-bag",
"urlSlug": "linen-tote-bag",
"variantAttributes": [
"Size"
],
"variants": [
{
"attributes": {
"Size": "Large"
},
"id": "88c16ee4-547b-445e-a392-bded9991ae30",
"pricing": {
"basePrice": {
"currency": "USD",
"value": "24.50"
},
"onSale": false,
"salePrice": {
"currency": "USD",
"value": "0.00"
}
},
"sku": "SQ3381024",
"stock": {
"quantity": 12,
"unlimited": false
}
}
]
}
]
}List stock levels
List up to 50 product variants at a time with their SKU and how many are in stock.
Inputs
- Next page
cursortext - The 'next_cursor' an earlier run of this step gave, to get the page after it. The page keeps that run's filters.
Outputs
countnumber- How many on this page
has_moretrue/false- True when there are more after this page
itemslist- The variants' stock
next_cursortext- Give this as the Next page field to get the next page; empty on the last one
Example output
{
"count": 1,
"has_more": false,
"items": [
{
"descriptor": "Linen tote bag [Large]",
"isUnlimited": false,
"quantity": 12,
"sku": "SQ3381024",
"variantId": "88c16ee4-547b-445e-a392-bded9991ae30"
}
],
"next_cursor": ""
}List store pages
List the site's store pages, the pages products are sold on, with their ids for 'Create product'.
Inputs
- Next page
cursortext - The 'next_cursor' an earlier run of this step gave, to get the page after it. The page keeps that run's filters.
Outputs
countnumber- How many on this page
has_moretrue/false- True when there are more after this page
next_cursortext- Give this as the Next page field to get the next page; empty on the last one
store_pageslist- The store pages
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"store_pages": [
{
"id": "5e8b7a6c5d4e3f2a1b0c9d8e",
"isEnabled": true,
"title": "Shop",
"urlSlug": "shop"
}
]
}List transactions
List up to 50 payment records at a time, one per order or donation, with payments, refunds, fees and taxes.
Inputs
- Order ID
order_idtext - Only the payment record of this order.
- Changed after
changed_afterdate and time - Only those changed after this time.
- Changed before
changed_beforedate and time - Only those changed before this time.
- Next page
cursortext - The 'next_cursor' an earlier run of this step gave, to get the page after it. The page keeps that run's filters.
Outputs
countnumber- How many on this page
has_moretrue/false- True when there are more after this page
next_cursortext- Give this as the Next page field to get the next page; empty on the last one
transactionslist- The payment records
Example output
{
"count": 1,
"has_more": false,
"next_cursor": "",
"transactions": [
{
"createdOn": "2026-10-20T15:58:07.187Z",
"customerEmail": "bob@example.com",
"id": "a7e4c6b5-d1fe-4e42-a932-f185b4b86829",
"modifiedOn": "2026-10-20T15:58:09.870Z",
"paymentGatewayError": null,
"payments": [
{
"amount": {
"currency": "USD",
"value": "58.35"
},
"creditCardType": "VISA",
"externalTransactionId": "ch_1FFCJCLMG4qggZ0BzchTZjwR",
"id": "ece69479-50bc-4763-9067-4473f3abcf83",
"netAmount": {
"currency": "USD",
"value": "58.35"
},
"paidOn": "2026-10-20T15:58:09.845Z",
"provider": "STRIPE",
"refundedAmount": {
"currency": "USD",
"value": "0.00"
}
}
],
"salesOrderId": "585d498fdee9f31a60284a37",
"total": {
"currency": "USD",
"value": "58.35"
},
"totalNetPayment": {
"currency": "USD",
"value": "56.36"
},
"totalNetSales": {
"currency": "USD",
"value": "49.00"
},
"totalNetShipping": {
"currency": "USD",
"value": "5.00"
},
"totalSales": {
"currency": "USD",
"value": "49.00"
},
"totalTaxes": {
"currency": "USD",
"value": "4.35"
},
"voided": false
}
]
}Update contact
Change a contact's name or email, or subscribe or unsubscribe them from marketing emails.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'Find contacts', or an order's customer id.
- First name
first_nametext - A new first name. Leave empty to keep it.
- Last name
last_nametext - A new last name. Leave empty to keep it.
- Email
emailtext - A new email address. Leave empty to keep it.
- Marketing emails
marketingtext - Subscribe or unsubscribe them. Leave empty to keep it.One of:
subscribed(Subscribed to marketing emails),unsubscribed(Not subscribed).
Outputs
contactobject- The contact
Example output
{
"contact": {
"createdOn": "2026-10-15T09:00:00Z",
"firstName": "Jane",
"id": "64a7e3d2c8f1b95e30a14d2b",
"lastName": "Smith",
"locale": "en-US",
"primaryEmail": {
"acceptsMarketing": {
"acceptsMarketing": true,
"joinedOn": "2026-10-15T09:00:00Z",
"leftOn": null
},
"createdOn": "2026-10-15T09:00:00Z",
"email": "jane.doe@example.com"
}
}
}Update product
Change a product's name, description, URL slug, tags or visibility. Only the fields given change.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Description
descriptiontext - A new description. Leave empty to keep it.
- URL slug
url_slugtext - The end of the product's page address, such as linen-tote. Leave empty for one made from the name.
- Tags
tagslist - The product's tags, in place of the ones it has.
- Visibility
visibilitytext - Whether shoppers can see and buy it.One of:
visible(Visible: on sale in the store),hidden.
Outputs
productobject- The product
Example output
{
"product": {
"createdOn": "2026-10-01T12:00:00Z",
"description": "<p>A sturdy linen tote.</p>",
"id": "565c8f3da7c8a3cf71d5fd0a",
"images": [
{
"altText": "tote",
"availableFormats": [
"100w",
"300w",
"500w",
"750w",
"1000w"
],
"id": "5f2a1c0de4b0a1b2c3d4e5f6",
"orderIndex": 0,
"url": "https://images.squarespace-cdn.com/content/v1/tote.jpg"
}
],
"isVisible": true,
"modifiedOn": "2026-10-20T12:00:00Z",
"name": "Linen tote",
"storePageId": "5e8b7a6c5d4e3f2a1b0c9d8e",
"tags": [
"bags"
],
"type": "PHYSICAL",
"url": "https://example.squarespace.com/shop/p/linen-tote-bag",
"urlSlug": "linen-tote-bag",
"variantAttributes": [
"Size"
],
"variants": [
{
"attributes": {
"Size": "Large"
},
"id": "88c16ee4-547b-445e-a392-bded9991ae30",
"pricing": {
"basePrice": {
"currency": "USD",
"value": "24.50"
},
"onSale": false,
"salePrice": {
"currency": "USD",
"value": "0.00"
}
},
"sku": "SQ3381024",
"stock": {
"quantity": 12,
"unlimited": false
}
}
]
}
}Update variant
Change a variant's SKU, price, sale or options. To change its stock, use 'Change stock'.
Inputs
- Product
product_idtextRequired - The product. Pick one, or give its id from an earlier step.
- Variant
variant_idtextRequired - The product's variant. Pick one, or give its id.
- SKU
skutext - A new SKU. Leave empty to keep it.
- Price
pricenumber - A new regular price. Leave empty to keep it.At least 0.
- Sale price
sale_pricenumber - Put it on sale at this price.At least 0.
- Sale
on_saletext - Start or end its sale at the sale price it has.One of:
on(On sale at the sale price),off(Not on sale). - This variant's options
variant_optionsobject - New choices for its options, such as Size: Large.
Outputs
product_idtext- The product the variant belongs to
variantobject- A product variant
Example output
{
"product_id": "565c8f3da7c8a3cf71d5fd0a",
"variant": {
"attributes": {
"Size": "Large"
},
"id": "88c16ee4-547b-445e-a392-bded9991ae30",
"pricing": {
"basePrice": {
"currency": "USD",
"value": "24.50"
},
"onSale": true,
"salePrice": {
"currency": "USD",
"value": "19.99"
}
},
"sku": "SQ3381024",
"stock": {
"quantity": 12,
"unlimited": false
}
}
}