Cmdlets for Shopify

Build 24.0.9060

OrderTransactions

Retrieves the transactions associated with the resource.

Table-Specific Information

Select

The cmdlet uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The cmdlet processes other filters client-side within the cmdlet.

  • ResourceId supports the '=,IN' comparison operators.

For example, the following queries are processed server side:

  SELECT * FROM OrderTransactions
  SELECT * FROM OrderTransactions WHERE ResourceId = 'Val1'

Insert

The following columns can be used to create a new record:

ResourceId, ParentTransactionId, Amount, Currency

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A globally-unique ID.

ResourceId [KEY] String True

Orders.Id

A globally-unique ID.

PaymentId String True

The payment ID associated with the transaction.

ParentTransactionId String True

The associated parent transaction, for example the authorization of a capture.

AccountNumber String True

The masked account number associated with the payment method.

Gateway String True

The payment gateway used to process the transaction.

Kind String True

The kind of transaction.

Status String True

The status of this transaction.

Test Bool True

Whether the transaction is a test transaction.

AuthorizationCode String True

Authorization code associated with the transaction.

ErrorCode String True

A standardized error code, independent of the payment provider.

FormattedGateway String True

The human-readable payment gateway name used to process the transaction.

ManuallyCapturable Bool True

Whether the transaction can be manually captured.

MultiCapturable Bool True

Whether the transaction can be captured multiple times.

ProcessedAt Datetime True

Date and time when the transaction was processed.

ReceiptJson String True

The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction.

SettlementCurrency String True

The settlement currency.

AuthorizationExpiresAt Datetime True

The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations.

SettlementCurrencyRate Decimal True

The rate used when converting the transaction amount to settlement currency.

CreatedAt Datetime True

Date and time when the transaction was created.

CardPaymentDetailsName String True

The holder of the credit card.

CardPaymentDetailsBin String True

The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.

CardPaymentDetailsCompany String True

The name of the company that issued the customer's credit card.

CardPaymentDetailsNumber String True

The customer's credit card number, with most of the leading digits redacted.

CardPaymentDetailsWallet String True

Digital wallet used for the payment.

CardPaymentDetailsExpirationMonth Int True

The month in which the used credit card expires.

CardPaymentDetailsExpirationYear Int True

The year in which the used credit card expires.

CardPaymentDetailsAvsResultCode String True

The response code from the address verification system (AVS). The code is always a single letter.

CardPaymentDetailsCvvResultCode String True

The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string.

PaymentIconId String True

A unique ID for the image.

PaymentIconWidth Int True

The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.

PaymentIconAltText String True

A word or phrase to share the nature or contents of an image.

PaymentIconHeight Int True

The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.

AmountSetPresentmentMoneyAmount Decimal True

Decimal money amount.

AmountSetPresentmentMoneyCurrencyCode String True

Currency of the money.

AmountSetShopMoneyAmount Decimal True

Decimal money amount.

AmountSetShopMoneyCurrencyCode String True

Currency of the money.

MaximumRefundableV2Amount Decimal True

Decimal money amount.

MaximumRefundableV2CurrencyCode String True

Currency of the money.

ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt Datetime True

The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment.

ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt Datetime True

The time after which capture will incur an additional fee.

ShopifyPaymentsSetRefundSetAcquirerReferenceNumber String True

The acquirer reference number (ARN) code generated for Visa/Mastercard transactions.

TotalUnsettledSetPresentmentMoneyAmount Decimal True

Decimal money amount.

TotalUnsettledSetPresentmentMoneyCurrencyCode String True

Currency of the money.

TotalUnsettledSetShopMoneyAmount Decimal True

Decimal money amount.

TotalUnsettledSetShopMoneyCurrencyCode String True

Currency of the money.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements, to offer a more granular control over the tuples that are returned from the data source, or as parameters in INSERT statements.

Name Type Description
Amount Decimal

The amount to capture. The capture amount can't be greater than the amount of the authorized transaction.

Currency String

The amount to capture. The capture amount can't be greater than the amount of the authorized transaction.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060