Get Gift Card amount in Shop Money

Retired Boards Appdev Graphql Basics And Troubleshooting

Topic summary

Main issue: Determining the gift card debit in the shop’s base currency (Shop Money/store currency) when an order is placed in a foreign currency. The transactions.json only shows the gift card portion in the presentment currency (e.g., 5,800 JPY) without an exchange rate or shop-currency amount.

Key context: A USD $50 gift card was used on a JPY order, and the remainder was paid via JPY PayPal. The goal is to track gift card liability in the store currency via API rather than manually from the order screen.

Resolution: Use the Checkout API’s payments endpoint to retrieve the gift card amount in store currency. The field amount_used returns the gift card amount in the shop’s base currency.

How to access: GET /admin/api/2021-10/checkouts/{token}/payments.json (Payment endpoint). This provided the needed value programmatically.

Status: Resolved with a clear API-based approach; no further open questions noted.

Summarized with AI on February 24. AI used: gpt-5.
1

Hello! Using API I am getting the order and transaction information for orders. When an order is paid in a foreign currency using a gift card in USD, how can I find how much of the Gift Card was actually debited?
For example, a recent order was placed in Japanese Yen. They used a USD $50 gift card and paid the rest using JPY Paypal. On transactions.json it only tells me that 5800 JPY of the gift card was used, but there is no indication of the exchange rate or Shop Money value there. How can I find (using API) that this is $50?? We are tracking our gift card liability, so we need to know how much gift card was actually used. Of course I can manually see this info on the order screen. I want to figure out how to get it programmatically.

Thank you!

2

Ok, so I answered my own question. I found the Gift Card amount in the Store Currency using the payment section of the Checkout API. It was listed as amount_used:
Here is Shopify’s help on this section:

Retrieves a list of payments on a particular checkout

Payment (shopify.dev)