commerce/customer/accounts/transactions

Use the Customer Account Transactions resource to manage the transactions associated with a customer account.

JSON Example

Transaction Properties

Property Description
amount

type: decimal

The amount of the order-level adjustment, which can be a positive or negative amount.

currencyCode

type: string

The localized currency code for the monetary amount.

date

type: DateTime

The date and time recording for a customer action including a transaction and storefront visit.

interactionType

type: string

The type of payment interaction. The payment can be Capture or CheckReceived. The value also includes customer payment interactions such as Website, Call, Store, or Unknown.

transactionId

type: string

The unique identifier of the transaction.

transactionType

type: string

Specifies the type of transaction, including customer transactions and credit transactions.

Valid values for credit transactions are the following:

  • Debit—decreases the credit amount
  • Credit—updates the credit amount

Valid values for customer transaction types are the following:

  • Order
  • Return
  • OrderPickup
  • Wishlist

visitId

type: string

Unique identifier of the customer visit in which the cart was created or last modified.

Operations

Operation Name Request URI Description
AddTransaction POST %7baccountId%7d%2ftransactions%3fresponseFields%3d%7bresponseFields%7d

Creates a new transaction for the customer account specified in the request.

GetTransactions GET %7baccountId%7d%2ftransactions

Retrieves a list of transactions associated with the customer account specified in the request.

RemoveTransaction DELETE %7baccountId%7d%2ftransactions%2f%7btransactionId%7d

Deletes a transaction from the customer account specified in the request.