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.

Choose a version:

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
giftCardCredit
giftCardCredit
get
/admin/api/latest/gift_cards/{gift_card_id}/adjustments.json
Receive a list of all Gift Card Adjustments
giftCard
get
/admin/api/latest/gift_cards/{gift_card_id}/adjustments/{adjustment_id}.json
Receive a single Gift Card Adjustment
node

Anchor to

The Gift Card Adjustment resource

Anchor to

Properties

A unique numeric identifier for the adjustment.

number

deprecated

A numeric sequence number for this adjustment with respect to the gift card.

amount

A number (signed) representing the value of the adjustment.

note

The text of an optional note that can be attached to the adjustment. This value is not visible to customers.

remote_transaction_ref

metafields

The text of an optional reference note that can be attached to the adjustment. This value is not visible to customers.

remote_transaction_url

metafields

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

processedAt

The date and time when the adjustment was created. The API returns this value in ISO 8601 format.

processed_at

processedAt

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 Adjustment
post
Create a new Gift Card Adjustment

giftCardCredit

Anchor to Parameters of Create a new Gift Card AdjustmentParameters

api_version

string

required

gift_card_id

string

required

Was this section helpful?

Anchor to post-gift-cards-gift-card-id-adjustments-examplesExamples

Create an adjustment that references an external transaction

Path parameters

gift_card_id=1035197676

string

required

Credit a gift card to increase the balance

Path parameters

gift_card_id=1035197676

string

required

Debit a gift card to decrease the balance

Path parameters

gift_card_id=1035197676

string

required

Record a gift card adjustment as if it happened in the past

Path parameters

gift_card_id=1035197676

string

required

Was this section helpful?

post

/admin/api/2026-07/gift_cards/1035197676/adjustments.json

curl -d '{"adjustment":{"amount":10,"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/2026-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": 1064273917,

"gift_card_id": 1035197676,

"api_client_id": 755357713,

"user_id": null,

"order_transaction_id": null,

"number": 1,

"amount": "10.00",

"processed_at": "2026-07-01T12:17:01-04:00",

"created_at": "2026-07-01T12:17:01-04:00",

"updated_at": "2026-07-01T12:17:01-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,"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/2026-07/gift_cards/1035197676/adjustments.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = 10;
$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->post(
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = 10;
$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->post(
    test_session,
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = 10;
$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->post(
    1035197676,
);

response

HTTP/1.1 201 Created{"adjustment":{"id":1064273917,"gift_card_id":1035197676,"api_client_id":755357713,"user_id":null,"order_transaction_id":null,"number":1,"amount":"10.00","processed_at":"2026-07-01T12:17:01-04:00","created_at":"2026-07-01T12:17:01-04:00","updated_at":"2026-07-01T12:17:01-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,"note":"Customer refilled gift card by $10"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2026-07/gift_cards/1035197676/adjustments.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = 10;
$gift_card_adjustment->note = "Customer refilled gift card by $10";
$gift_card_adjustment->post(
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = 10;
$gift_card_adjustment->note = "Customer refilled gift card by $10";
$gift_card_adjustment->post(
    test_session,
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = 10;
$gift_card_adjustment->note = "Customer refilled gift card by $10";
$gift_card_adjustment->post(
    1035197676,
);

response

HTTP/1.1 201 Created{"adjustment":{"id":1064273916,"gift_card_id":1035197676,"api_client_id":755357713,"user_id":null,"order_transaction_id":null,"number":1,"amount":"10.00","processed_at":"2026-07-01T12:17:01-04:00","created_at":"2026-07-01T12:17:01-04:00","updated_at":"2026-07-01T12:17:01-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,"note":"Customer spent $20 via external service"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2026-07/gift_cards/1035197676/adjustments.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = -20;
$gift_card_adjustment->note = "Customer spent $20 via external service";
$gift_card_adjustment->post(
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = -20;
$gift_card_adjustment->note = "Customer spent $20 via external service";
$gift_card_adjustment->post(
    test_session,
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = -20;
$gift_card_adjustment->note = "Customer spent $20 via external service";
$gift_card_adjustment->post(
    1035197676,
);

response

HTTP/1.1 201 Created{"adjustment":{"id":1064273915,"gift_card_id":1035197676,"api_client_id":755357713,"user_id":null,"order_transaction_id":null,"number":1,"amount":"-20.00","processed_at":"2026-07-01T12:17:01-04:00","created_at":"2026-07-01T12:17:01-04:00","updated_at":"2026-07-01T12:17:01-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,"processed_at":"2023-12-15T08:00:00-05:00"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2026-07/gift_cards/1035197676/adjustments.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = 10;
$gift_card_adjustment->processed_at = "2023-12-15T08:00:00-05:00";
$gift_card_adjustment->post(
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = 10;
$gift_card_adjustment->processed_at = "2023-12-15T08:00:00-05:00";
$gift_card_adjustment->post(
    test_session,
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$gift_card_adjustment = new GiftCardAdjustment($this->test_session);
$gift_card_adjustment->amount = 10;
$gift_card_adjustment->processed_at = "2023-12-15T08:00:00-05:00";
$gift_card_adjustment->post(
    1035197676,
);

response

HTTP/1.1 201 Created{"adjustment":{"id":1064273914,"gift_card_id":1035197676,"api_client_id":755357713,"user_id":null,"order_transaction_id":null,"number":1,"amount":"10.00","processed_at":"2023-12-15T08:00:00-05:00","created_at":"2024-06-15T08:00:00-04:00","updated_at":"2024-06-15T08:00:00-04:00","note":null,"remote_transaction_ref":null,"remote_transaction_url":null}}

Anchor to GET request, Receive a list of all Gift Card Adjustments
get
Receive a list of all Gift Card Adjustments

giftCard

Anchor to Parameters of Receive a list of all Gift Card AdjustmentsParameters

api_version

string

required

gift_card_id

string

required

Was this section helpful?

Anchor to get-gift-cards-gift-card-id-adjustments-examplesExamples

Get a list of all adjustments made to a gift card

Path parameters

gift_card_id=1035197676

string

required

Was this section helpful?

get

/admin/api/2026-07/gift_cards/1035197676/adjustments.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-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": 801038806,

"number": null,

"amount": "10.00",

"processed_at": null,

"created_at": "2026-07-01T12:15:55-04:00",

"updated_at": "2026-07-01T12:15:55-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/2026-07/gift_cards/1035197676/adjustments.json" \
-H "X-Shopify-Access-Token: {access_token}"

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$response = admin.rest.resources.GiftCardAdjustment::all(
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$response = GiftCardAdjustment::all(
    1035197676,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$response = GiftCardAdjustment::all(
    1035197676,
);

response

HTTP/1.1 200 OK{"adjustments":[{"id":1064273908,"gift_card_id":1035197676,"api_client_id":null,"user_id":null,"order_transaction_id":801038806,"number":null,"amount":"10.00","processed_at":null,"created_at":"2026-07-01T12:15:55-04:00","updated_at":"2026-07-01T12:15:55-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 Adjustment
get
Receive a single Gift Card Adjustment

node

Anchor to Parameters of Receive a single Gift Card AdjustmentParameters

adjustment_id

string

required

api_version

string

required

gift_card_id

string

required

Was this section helpful?

Anchor to get-gift-cards-gift-card-id-adjustments-adjustment-id-examplesExamples

Show the details of a particular adjustment

Was this section helpful?

get

/admin/api/2026-07/gift_cards/1035197676/adjustments/1064273908.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2026-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": 801038806,

"number": null,

"amount": "10.00",

"processed_at": null,

"created_at": "2026-07-01T12:15:55-04:00",

"updated_at": "2026-07-01T12:15:55-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/2026-07/gift_cards/1035197676/adjustments/1064273908.json" \
-H "X-Shopify-Access-Token: {access_token}"

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$result = admin.rest.resources.GiftCardAdjustment::find(
    1035197676,
    1064273908,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$result = GiftCardAdjustment::find(
    1035197676,
    1064273908,
);

use Shopify\Rest\Admin2026_07\GiftCardAdjustment;
use Shopify\Utils;

$this->test_session = Utils::loadCurrentSession(
    $requestHeaders,
    $requestCookies,
    $isOnline
);

$result = GiftCardAdjustment::find(
    1035197676,
    1064273908,
);

response

HTTP/1.1 200 OK{"adjustment":{"id":1064273908,"gift_card_id":1035197676,"api_client_id":null,"user_id":null,"order_transaction_id":801038806,"number":null,"amount":"10.00","processed_at":null,"created_at":"2026-07-01T12:15:55-04:00","updated_at":"2026-07-01T12:15:55-04:00","note":"Customer refilled gift card by $10","remote_transaction_ref":null,"remote_transaction_url":null}}

Gift Card Adjustment

Endpoints

The Gift Card Adjustment resource

Properties

The Gift Card Adjustment resource

Anchor to POST request, Create a new Gift Card AdjustmentpostCreate a new Gift Card Adjustment

Anchor to Parameters of Create a new Gift Card AdjustmentParameters

Anchor to post-gift-cards-gift-card-id-adjustments-examplesExamples

Response

examples

Create an adjustment that references an external transaction

response

Credit a gift card to increase the balance

response

Debit a gift card to decrease the balance

response

Record a gift card adjustment as if it happened in the past

response

Anchor to GET request, Receive a list of all Gift Card AdjustmentsgetReceive a list of all Gift Card Adjustments

Anchor to Parameters of Receive a list of all Gift Card AdjustmentsParameters

Anchor to get-gift-cards-gift-card-id-adjustments-examplesExamples

Response

examples

Get a list of all adjustments made to a gift card

response

Anchor to GET request, Receive a single Gift Card AdjustmentgetReceive a single Gift Card Adjustment

Anchor to Parameters of Receive a single Gift Card AdjustmentParameters

Anchor to get-gift-cards-gift-card-id-adjustments-adjustment-id-examplesExamples

Response

examples

Show the details of a particular adjustment

response

Anchor to POST request, Create a new Gift Card Adjustment
post
Create a new Gift Card Adjustment

Anchor to GET request, Receive a list of all Gift Card Adjustments
get
Receive a list of all Gift Card Adjustments

Anchor to GET request, Receive a single Gift Card Adjustment
get
Receive a single Gift Card Adjustment