The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Gift Card Adjustment
Requires
gift_card_adjustments access scope.A gift card adjustment is a way to adjust the balance of a gift card. Balances cannot be adjusted to below $0. Balances are updated as soon as you receive a successful response.
When creating a gift card adjustment, you may also set note, remote_transaction_ref, and remote_transaction_url.
Was this section helpful?
#
Endpoints
- post/admin/api/latest/gift_
cards/{gift_ card_ id}/adjustments. json Create a new Gift Card Adjustment - get/admin/api/latest/gift_
cards/{gift_ card_ id}/adjustments. json Receive a list of all Gift Card Adjustments - get/admin/api/latest/gift_
cards/{gift_ card_ id}/adjustments/{adjustment_ id}. json Receive a single Gift Card Adjustment
Anchor to
The Gift Card Adjustment resource
Anchor to
Properties
id
->
id
A unique numeric identifier for the adjustment.
number
deprecated
A numeric sequence number for this adjustment with respect to the gift card.
amount
->
amount
A number (signed) representing the value of the adjustment.
note
->
note
The text of an optional note that can be attached to the adjustment. This value is not visible to customers.
remote_transaction_ref
The text of an optional reference note that can be attached to the adjustment. This value is not visible to customers.
remote_transaction_url
An optional reference URL that can be attached to the adjustment. This value is not visible to customers.
api_client_id
deprecated
A unique numeric identifier of the application that issued the adjustment (if it was issued by an application).
user_id
deprecated
A unique numeric identifier of the user that issued the adjustment (if it was issued by a user).
order_transaction_id
deprecated
A unique numeric identifier of the order transaction that issued the adjustment (if it was caused by an application of a gift card to an order).
created_at
The date and time when the adjustment was created. The API returns this value in ISO 8601 format.
processed_at
The date and time when the adjustment was imported, in ISO 8601 format. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated.
Was this section helpful?
{}
The Gift Card Adjustment resource
{
"id": 989034056,
"number": 1,
"amount": -20,
"note": "External debit of gift card",
"remote_transaction_ref": "external-ref-230923",
"remote_transaction_url": "http://example.com/external-gift-card-app/external-ref-230923",
"api_client_id": 431223487,
"user_id": 241253183,
"order_transaction_id": 203972033,
"created_at": "2015-06-31T19:00:00-05:00",
"processed_at": "2015-06-31T19:00:00-05:00"
}
Anchor to POST request, Create a new Gift Card AdjustmentpostCreate a new Gift Card Adjustment
post
Create a new Gift Card Adjustment
api_version
string
required
gift_card_id
string
required
Was this section helpful?
Create an adjustment that references an external transaction
Create an adjustment that references an external transaction
Path parameters
gift_
string
required
Credit a gift card to increase the balance
Credit a gift card to increase the balance
Path parameters
gift_
string
required
Debit a gift card to decrease the balance
Debit a gift card to decrease the balance
Path parameters
gift_
string
required
Record a gift card adjustment as if it happened in the past
Record a gift card adjustment as if it happened in the past
Path parameters
gift_
string
required
Was this section helpful?
post
/admin/api/2025-07/gift_
curl -d '{"adjustment":{"amount":10.0,"remote_transaction_ref":"gift_card_app_transaction_193402","remote_transaction_url":"http://example.com/my-gift-card-app/gift_card_adjustments/193402"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2025-07/gift_cards/1035197676/adjustments.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}
Response
JSON
HTTP/1.1 201 Created
{
"adjustment": {
"id": 1064273911,
"gift_card_id": 1035197676,
"api_client_id": 755357713,
"user_id": null,
"order_transaction_id": null,
"number": 1,
"amount": "10.00",
"processed_at": "2025-07-01T14:41:56-04:00",
"created_at": "2025-07-01T14:41:56-04:00",
"updated_at": "2025-07-01T14:41:56-04:00",
"note": null,
"remote_transaction_ref": "gift_card_app_transaction_193402",
"remote_transaction_url": "http://example.com/my-gift-card-app/gift_card_adjustments/193402"
}
}
examples
Create an adjustment that references an external transaction
curl -d '{"adjustment":{"amount":10.0,"remote_transaction_ref":"gift_card_app_transaction_193402","remote_transaction_url":"http://example.com/my-gift-card-app/gift_card_adjustments/193402"}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-07/gift_cards/1035197676/adjustments.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const gift_card_adjustment = new admin.rest.resources.GiftCardAdjustment({session: session}); gift_card_adjustment.gift_card_id = 1035197676; gift_card_adjustment.amount = 10.0; gift_card_adjustment.remote_transaction_ref = "gift_card_app_transaction_193402"; gift_card_adjustment.remote_transaction_url = "http://example.com/my-gift-card-app/gift_card_adjustments/193402"; await gift_card_adjustment.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session gift_card_adjustment = ShopifyAPI::GiftCardAdjustment.new(session: test_session) gift_card_adjustment.gift_card_id = 1035197676 gift_card_adjustment.amount = 10.0 gift_card_adjustment.remote_transaction_ref = "gift_card_app_transaction_193402" gift_card_adjustment.remote_transaction_url = "http://example.com/my-gift-card-app/gift_card_adjustments/193402" gift_card_adjustment.save!// Session is built by the OAuth process const gift_card_adjustment = new shopify.rest.GiftCardAdjustment({session: session}); gift_card_adjustment.gift_card_id = 1035197676; gift_card_adjustment.amount = 10.0; gift_card_adjustment.remote_transaction_ref = "gift_card_app_transaction_193402"; gift_card_adjustment.remote_transaction_url = "http://example.com/my-gift-card-app/gift_card_adjustments/193402"; await gift_card_adjustment.save({ update: true, });response
HTTP/1.1 201 Created{"adjustment":{"id":1064273911,"gift_card_id":1035197676,"api_client_id":755357713,"user_id":null,"order_transaction_id":null,"number":1,"amount":"10.00","processed_at":"2025-07-01T14:41:56-04:00","created_at":"2025-07-01T14:41:56-04:00","updated_at":"2025-07-01T14:41:56-04:00","note":null,"remote_transaction_ref":"gift_card_app_transaction_193402","remote_transaction_url":"http://example.com/my-gift-card-app/gift_card_adjustments/193402"}}Credit a gift card to increase the balance
curl -d '{"adjustment":{"amount":10.0,"note":"Customer refilled gift card by $10"}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-07/gift_cards/1035197676/adjustments.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const gift_card_adjustment = new admin.rest.resources.GiftCardAdjustment({session: session}); gift_card_adjustment.gift_card_id = 1035197676; gift_card_adjustment.amount = 10.0; gift_card_adjustment.note = "Customer refilled gift card by $10"; await gift_card_adjustment.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session gift_card_adjustment = ShopifyAPI::GiftCardAdjustment.new(session: test_session) gift_card_adjustment.gift_card_id = 1035197676 gift_card_adjustment.amount = 10.0 gift_card_adjustment.note = "Customer refilled gift card by $10" gift_card_adjustment.save!// Session is built by the OAuth process const gift_card_adjustment = new shopify.rest.GiftCardAdjustment({session: session}); gift_card_adjustment.gift_card_id = 1035197676; gift_card_adjustment.amount = 10.0; gift_card_adjustment.note = "Customer refilled gift card by $10"; await gift_card_adjustment.save({ update: true, });response
HTTP/1.1 201 Created{"adjustment":{"id":1064273912,"gift_card_id":1035197676,"api_client_id":755357713,"user_id":null,"order_transaction_id":null,"number":1,"amount":"10.00","processed_at":"2025-07-01T14:41:57-04:00","created_at":"2025-07-01T14:41:57-04:00","updated_at":"2025-07-01T14:41:57-04:00","note":"Customer refilled gift card by $10","remote_transaction_ref":null,"remote_transaction_url":null}}Debit a gift card to decrease the balance
curl -d '{"adjustment":{"amount":-20.0,"note":"Customer spent $20 via external service"}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-07/gift_cards/1035197676/adjustments.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const gift_card_adjustment = new admin.rest.resources.GiftCardAdjustment({session: session}); gift_card_adjustment.gift_card_id = 1035197676; gift_card_adjustment.amount = -20.0; gift_card_adjustment.note = "Customer spent $20 via external service"; await gift_card_adjustment.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session gift_card_adjustment = ShopifyAPI::GiftCardAdjustment.new(session: test_session) gift_card_adjustment.gift_card_id = 1035197676 gift_card_adjustment.amount = -20.0 gift_card_adjustment.note = "Customer spent $20 via external service" gift_card_adjustment.save!// Session is built by the OAuth process const gift_card_adjustment = new shopify.rest.GiftCardAdjustment({session: session}); gift_card_adjustment.gift_card_id = 1035197676; gift_card_adjustment.amount = -20.0; gift_card_adjustment.note = "Customer spent $20 via external service"; await gift_card_adjustment.save({ update: true, });response
HTTP/1.1 201 Created{"adjustment":{"id":1064273910,"gift_card_id":1035197676,"api_client_id":755357713,"user_id":null,"order_transaction_id":null,"number":1,"amount":"-20.00","processed_at":"2025-07-01T14:41:55-04:00","created_at":"2025-07-01T14:41:55-04:00","updated_at":"2025-07-01T14:41:55-04:00","note":"Customer spent $20 via external service","remote_transaction_ref":null,"remote_transaction_url":null}}Record a gift card adjustment as if it happened in the past
curl -d '{"adjustment":{"amount":10.0,"processed_at":"2025-01-01T14:41:53-05:00"}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-07/gift_cards/1035197676/adjustments.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const gift_card_adjustment = new admin.rest.resources.GiftCardAdjustment({session: session}); gift_card_adjustment.gift_card_id = 1035197676; gift_card_adjustment.amount = 10.0; gift_card_adjustment.processed_at = "2025-01-01T14:41:53-05:00"; await gift_card_adjustment.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session gift_card_adjustment = ShopifyAPI::GiftCardAdjustment.new(session: test_session) gift_card_adjustment.gift_card_id = 1035197676 gift_card_adjustment.amount = 10.0 gift_card_adjustment.processed_at = "2025-01-01T14:41:53-05:00" gift_card_adjustment.save!// Session is built by the OAuth process const gift_card_adjustment = new shopify.rest.GiftCardAdjustment({session: session}); gift_card_adjustment.gift_card_id = 1035197676; gift_card_adjustment.amount = 10.0; gift_card_adjustment.processed_at = "2025-01-01T14:41:53-05:00"; await gift_card_adjustment.save({ update: true, });response
HTTP/1.1 201 Created{"adjustment":{"id":1064273909,"gift_card_id":1035197676,"api_client_id":755357713,"user_id":null,"order_transaction_id":null,"number":1,"amount":"10.00","processed_at":"2025-01-01T14:41:53-05:00","created_at":"2025-07-01T14:41:53-04:00","updated_at":"2025-07-01T14:41:53-04:00","note":null,"remote_transaction_ref":null,"remote_transaction_url":null}}
Anchor to GET request, Receive a list of all Gift Card AdjustmentsgetReceive a list of all Gift Card Adjustments
get
Receive a list of all Gift Card Adjustments
api_version
string
required
gift_card_id
string
required
Was this section helpful?
Get a list of all adjustments made to a gift card
Get a list of all adjustments made to a gift card
Path parameters
gift_
string
required
Was this section helpful?
get
/admin/api/2025-07/gift_
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/gift_cards/1035197676/adjustments.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{
"adjustments": [
{
"id": 1064273908,
"gift_card_id": 1035197676,
"api_client_id": null,
"user_id": null,
"order_transaction_id": null,
"number": null,
"amount": "10.00",
"processed_at": null,
"created_at": "2025-07-01T14:37:24-04:00",
"updated_at": "2025-07-01T14:37:24-04:00",
"note": "Customer refilled gift card by $10",
"remote_transaction_ref": null,
"remote_transaction_url": null
}
]
}
examples
Get a list of all adjustments made to a gift card
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/gift_cards/1035197676/adjustments.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.GiftCardAdjustment.all({ session: session, gift_card_id: 1035197676, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::GiftCardAdjustment.all( session: test_session, gift_card_id: 1035197676, )// Session is built by the OAuth process await shopify.rest.GiftCardAdjustment.all({ session: session, gift_card_id: 1035197676, });response
HTTP/1.1 200 OK{"adjustments":[{"id":1064273908,"gift_card_id":1035197676,"api_client_id":null,"user_id":null,"order_transaction_id":null,"number":null,"amount":"10.00","processed_at":null,"created_at":"2025-07-01T14:37:24-04:00","updated_at":"2025-07-01T14:37:24-04:00","note":"Customer refilled gift card by $10","remote_transaction_ref":null,"remote_transaction_url":null}]}
Anchor to GET request, Receive a single Gift Card AdjustmentgetReceive a single Gift Card Adjustment
get
Receive a single Gift Card Adjustment
adjustment_id
string
required
api_version
string
required
gift_card_id
string
required
Was this section helpful?
Show the details of a particular adjustment
Show the details of a particular adjustment
Was this section helpful?
get
/admin/api/2025-07/gift_
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/gift_cards/1035197676/adjustments/1064273908.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{
"adjustment": {
"id": 1064273908,
"gift_card_id": 1035197676,
"api_client_id": null,
"user_id": null,
"order_transaction_id": null,
"number": null,
"amount": "10.00",
"processed_at": null,
"created_at": "2025-07-01T14:37:24-04:00",
"updated_at": "2025-07-01T14:37:24-04:00",
"note": "Customer refilled gift card by $10",
"remote_transaction_ref": null,
"remote_transaction_url": null
}
}
examples
Show the details of a particular adjustment
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/gift_cards/1035197676/adjustments/1064273908.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.GiftCardAdjustment.find({ session: session, gift_card_id: 1035197676, id: 1064273908, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::GiftCardAdjustment.find( session: test_session, gift_card_id: 1035197676, id: 1064273908, )// Session is built by the OAuth process await shopify.rest.GiftCardAdjustment.find({ session: session, gift_card_id: 1035197676, id: 1064273908, });response
HTTP/1.1 200 OK{"adjustment":{"id":1064273908,"gift_card_id":1035197676,"api_client_id":null,"user_id":null,"order_transaction_id":null,"number":null,"amount":"10.00","processed_at":null,"created_at":"2025-07-01T14:37:24-04:00","updated_at":"2025-07-01T14:37:24-04:00","note":"Customer refilled gift card by $10","remote_transaction_ref":null,"remote_transaction_url":null}}