---
title: "Get transactions"
method: GET
path: "/1.0/commerce/transactions/{documentIds}"
tags: ["Transactions"]
---

# Get transactions

`GET /1.0/commerce/transactions/{documentIds}`

## Request

- Base URL: `https://api.squarespace.com`
- URL: `https://api.squarespace.com/1.0/commerce/transactions/{documentIds}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/squarespace/apis/commerce-api/docs/1.0/commerce/transactions/:documentIds/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `documentIds` string, required

## Headers

- `Authorization` string, required
- `User-Agent` string, required

## Response `200`

The requested transaction documents.

- TransactionListResponse
  - `documents` TransactionDocument[]: Array of Document resources.
    - `createdOn` string, date-time: ISO 8601 UTC date and time string; represents when the Document was created.
    - `customerEmail` string, email: Customer or donor email address. May be null for point of sale orders because email wasn't collected.
    - `discounts` TransactionDiscount[]: Array of discounts for an order payment transaction; empty for donations.
      - `amount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `description` string: Discount description.
      - `name` string: Discount name.
    - `id` string: Unique Document id.
    - `modifiedOn` string, date-time: ISO 8601 UTC date and time string; represents when the Document was last modified.
    - `paymentGatewayError` 'GATEWAY_FEE_PROCEESING_ERROR' | 'GATEWAY_API_PERMISSION_ERROR' | 'GATEWAY_DISCONNNECTED': Captures errors from the payment gateway; value is null if not applicable.
    - `payments` TransactionPayment[]: Array of payment transactions for the order or donation.
      - `amount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `creditCardType` string: Payment credit card type; possible values: VISA, MASTERCARD, DISCOVER, AMEX, JCB, and OTHER. null if credit card processing isn't available for the payment gateway.
      - `externalCustomerId` string: Unique customer id for the payment transaction provided by the payment gateway. Value is null if not available.
      - `externalTransactionId` string: Unique id for the payment transaction provided by the payment gateway.
      - `externalTransactionProperties` ExternalTransactionProperty[]: Array of properties for the payment transaction provided by the payment gateway. Properties are listed in key/value pairs.
        - `key` string
        - `value` string
      - `giftCardId` string, uuid: Unique id for a Squarespace gift card. Value is null if a gift card was not used.
      - `id` string: Unique payment id.
      - `netAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `paidOn` string, date-time: ISO 8601 UTC date and time string; represents when the payment was made.
      - `processingFees` TransactionProcessingFee[]: Array of processing fees associated with the payment.
        - `amount` MonetaryAmount: A monetary amount with currency code and decimal value.
          - `currency` object: ISO 4217 currency code.
            - `currencyCode` string
            - `defaultFractionDigits` integer
            - `displayName` string
            - `numericCode` integer
            - `numericCodeAsString` string
            - `symbol` string
          - `value` number: Decimal monetary value.
        - `amountGatewayCurrency` MonetaryAmount: A monetary amount with currency code and decimal value.
          - `currency` object: ISO 4217 currency code.
            - `currencyCode` string
            - `defaultFractionDigits` integer
            - `displayName` string
            - `numericCode` integer
            - `numericCodeAsString` string
            - `symbol` string
          - `value` number: Decimal monetary value.
        - `exchangeRate` number: Foreign exchange rate between the payment gateway's and payment's currencies; determined when the payment is processed.
        - `feeRefunds` TransactionProcessingFeeRefund[]: Array of processing fee refunds for the payment.
          - `amount` MonetaryAmount: A monetary amount with currency code and decimal value.
            - `currency` object: ISO 4217 currency code.
              - …
            - `value` number: Decimal monetary value.
          - `amountGatewayCurrency` MonetaryAmount: A monetary amount with currency code and decimal value.
            - `currency` object: ISO 4217 currency code.
              - …
            - `value` number: Decimal monetary value.
          - `exchangeRate` number: Foreign exchange rate between the payment gateway's and payment's currencies; determined when the payment is processed.
          - `externalTransactionId` string: Unique id for the processing fee refund transaction provided by the payment gateway.
          - `id` string: Unique processing fee refund id.
          - `refundedOn` string, date-time: ISO 8601 UTC date and time string; represents when the processing fee refund was issued.
        - `id` string: Unique processing fee id.
        - `netAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
          - `currency` object: ISO 4217 currency code.
            - `currencyCode` string
            - `defaultFractionDigits` integer
            - `displayName` string
            - `numericCode` integer
            - `numericCodeAsString` string
            - `symbol` string
          - `value` number: Decimal monetary value.
        - `netAmountGatewayCurrency` MonetaryAmount: A monetary amount with currency code and decimal value.
          - `currency` object: ISO 4217 currency code.
            - `currencyCode` string
            - `defaultFractionDigits` integer
            - `displayName` string
            - `numericCode` integer
            - `numericCodeAsString` string
            - `symbol` string
          - `value` number: Decimal monetary value.
        - `refundedAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
          - `currency` object: ISO 4217 currency code.
            - `currencyCode` string
            - `defaultFractionDigits` integer
            - `displayName` string
            - `numericCode` integer
            - `numericCodeAsString` string
            - `symbol` string
          - `value` number: Decimal monetary value.
        - `refundedAmountGatewayCurrency` MonetaryAmount: A monetary amount with currency code and decimal value.
          - `currency` object: ISO 4217 currency code.
            - `currencyCode` string
            - `defaultFractionDigits` integer
            - `displayName` string
            - `numericCode` integer
            - `numericCodeAsString` string
            - `symbol` string
          - `value` number: Decimal monetary value.
      - `provider` string: Payment gateway used for processing.
      - `refundedAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `refunds` TransactionRefund[]: Array of refunds for the payment transaction.
        - `amount` MonetaryAmount: A monetary amount with currency code and decimal value.
          - `currency` object: ISO 4217 currency code.
            - `currencyCode` string
            - `defaultFractionDigits` integer
            - `displayName` string
            - `numericCode` integer
            - `numericCodeAsString` string
            - `symbol` string
          - `value` number: Decimal monetary value.
        - `externalTransactionId` string: Unique id for the refund transaction provided by the payment gateway.
        - `id` string: Unique refund id.
        - `refundedOn` string, date-time: ISO 8601 UTC date and time string; represents refund issue date.
    - `salesLineItems` TransactionSalesLineItem[]: Array of sales items for an order payment transaction; empty for donations.
      - `discountAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `id` string: Unique id for the sales item.
      - `taxes` TransactionTax[]: Array of taxes for the sale item.
        - `amount` MonetaryAmount: A monetary amount with currency code and decimal value.
          - `currency` object: ISO 4217 currency code.
            - `currencyCode` string
            - `defaultFractionDigits` integer
            - `displayName` string
            - `numericCode` integer
            - `numericCodeAsString` string
            - `symbol` string
          - `value` number: Decimal monetary value.
        - `jurisdiction` string: Tax jurisdiction in COUNTRY:{value},STATE:{value},LOCAL:{value} format. Examples: COUNTRY:US, COUNTRY:US,STATE:NY, and COUNTRY:US,STATE:NY,LOCAL:10001.
        - `name` string: Tax classification as defined by the Squarespace merchant.
        - `rate` string: Tax rate as a percent. For example, a value of 7.00 is a 7% tax.
      - `total` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `totalNetSales` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `totalSales` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
    - `salesOrderId` string: Unique order id; not applicable if payment transaction is a donation.
    - `shippingLineItems` TransactionShippingLineItem[]: Array of shipping line items.
      - `amount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `description` string: Description of the shipping line item as defined by the Squarespace merchant.
      - `discountAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `id` string: Unique id for the shipping line item.
      - `netAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `taxes` TransactionTax[]: Array of taxes for the shipping line item.
        - `amount` MonetaryAmount: A monetary amount with currency code and decimal value.
          - `currency` object: ISO 4217 currency code.
            - `currencyCode` string
            - `defaultFractionDigits` integer
            - `displayName` string
            - `numericCode` integer
            - `numericCodeAsString` string
            - `symbol` string
          - `value` number: Decimal monetary value.
        - `jurisdiction` string: Tax jurisdiction in COUNTRY:{value},STATE:{value},LOCAL:{value} format. Examples: COUNTRY:US, COUNTRY:US,STATE:NY, and COUNTRY:US,STATE:NY,LOCAL:10001.
        - `name` string: Tax classification as defined by the Squarespace merchant.
        - `rate` string: Tax rate as a percent. For example, a value of 7.00 is a 7% tax.
    - `total` MonetaryAmount: A monetary amount with currency code and decimal value.
      - `currency` object: ISO 4217 currency code.
        - `currencyCode` string
        - `defaultFractionDigits` integer
        - `displayName` string
        - `numericCode` integer
        - `numericCodeAsString` string
        - `symbol` string
      - `value` number: Decimal monetary value.
    - `totalNetPayment` MonetaryAmount: A monetary amount with currency code and decimal value.
      - `currency` object: ISO 4217 currency code.
        - `currencyCode` string
        - `defaultFractionDigits` integer
        - `displayName` string
        - `numericCode` integer
        - `numericCodeAsString` string
        - `symbol` string
      - `value` number: Decimal monetary value.
    - `totalNetSales` MonetaryAmount: A monetary amount with currency code and decimal value.
      - `currency` object: ISO 4217 currency code.
        - `currencyCode` string
        - `defaultFractionDigits` integer
        - `displayName` string
        - `numericCode` integer
        - `numericCodeAsString` string
        - `symbol` string
      - `value` number: Decimal monetary value.
    - `totalNetShipping` MonetaryAmount: A monetary amount with currency code and decimal value.
      - `currency` object: ISO 4217 currency code.
        - `currencyCode` string
        - `defaultFractionDigits` integer
        - `displayName` string
        - `numericCode` integer
        - `numericCodeAsString` string
        - `symbol` string
      - `value` number: Decimal monetary value.
    - `totalSales` MonetaryAmount: A monetary amount with currency code and decimal value.
      - `currency` object: ISO 4217 currency code.
        - `currencyCode` string
        - `defaultFractionDigits` integer
        - `displayName` string
        - `numericCode` integer
        - `numericCodeAsString` string
        - `symbol` string
      - `value` number: Decimal monetary value.
    - `totalTaxes` MonetaryAmount: A monetary amount with currency code and decimal value.
      - `currency` object: ISO 4217 currency code.
        - `currencyCode` string
        - `defaultFractionDigits` integer
        - `displayName` string
        - `numericCode` integer
        - `numericCodeAsString` string
        - `symbol` string
      - `value` number: Decimal monetary value.
    - `voided` boolean: Flag; indicates order cancellation.

## Other responses

- `400`: Bad request. ids specifies greater than 50 Documents.
- `404`: Not found. One or more requested Documents were not found.

---

[API](https://skmtc.dev/squarespace/apis/commerce-api.md) - [All operations](https://skmtc.dev/squarespace/apis/commerce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/squarespace/apis/commerce-api/revisions/5dd4b1b7cd38?raw)