Squarespace Developer Platform: APIs, Apps, and Docs
Commerce API
Commerce API

Transactions

Download schema

List transactions

GET
https://api.squarespace.com
/1.0/commerce/transactions

Retrieves all financial transactions for orders and donations. Per order and donation, the response groups transactions into a Document, contains up to 50 Documents ordered by their modification date (modifiedOn), and supports dynamic cursors for pagination.

List transactions › query Parameters

cursor
​string

Identifies where the next page of results should begin. Should be the value of pagination.nextPageCursor from a previous response.

modifiedAfter
​string

Time-boxes the request to Documents that were modified after a given ISO 8601 UTC date and time string (YYYY-MM-DDThh:mm:ss.sZ).

modifiedBefore
​string

Time-boxes the request to Documents that were modified before a given ISO 8601 UTC date and time string (YYYY-MM-DDThh:mm:ss.sZ).

orderId
​string

List transactions › Headers

Authorization
​string · required

API key or OAuth access token

Default: Bearer YOUR_API_KEY_OR_OAUTH_TOKEN
User-Agent
​string · required

User Agent

Default: YOUR_CUSTOM_APP_DESCRIPTION

List transactions › Responses

A paginated list of transaction documents.

PaginatedTransactionListResponse

Array of Document resources. If the merchant site doesn't have any payment transactions for orders or donations, this array is empty.

​object

Get transactions

GET
https://api.squarespace.com
/1.0/commerce/transactions/{documentIds}

Retrieves information for specific transaction Documents. The response contains up to 50 Documents. Multiple Documents can be retrieved by providing a comma-separated list of Document ids.

Get transactions › path Parameters

documentIds
​string · required

Specifies the Documents to retrieve. Multiple Documents can be retrieved by providing a comma-separated list of Document ids.

Get transactions › Headers

Authorization
​string · required

API key or OAuth access token

Default: Bearer YOUR_API_KEY_OR_OAUTH_TOKEN
User-Agent
​string · required

User Agent

Default: YOUR_CUSTOM_APP_DESCRIPTION

Get transactions › Responses

The requested transaction documents.

TransactionListResponse

Array of Document resources.

OrdersProfiles