post https://{shopdomain}.myshoplaza.com/openapi/2022-01/gift_cards//disable
Requires
price_rulesaccess scope. More access scope
The Update Gift Card API updates the details of a specific gift card using its unique ID.
This API is especially useful for:
- Updating the expiration date of a gift card.
- Modifying notes attached to a gift card.
- Changing the template used for rendering a gift card.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Yes | Gift card's ID. | 377006280092433706 |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
gift_card.id | string | Unique identifier for the gift card. | 377006280092433706 |
gift_card.last_characters | string | Last characters of the gift card code. | ghjg |
gift_card.balance | string | Current balance of the gift card. | 100.00 |
gift_card.initial_value | string | Initial value of the gift card. | 100.00 |
gift_card.note | string | Note attached to the gift card. | Updated expiration date |
gift_card.expires_on | string | Expiration date of the gift card in ISO-8601 format. | 2025-11-01T00:00:00Z |
gift_card.disabled_at | string | Timestamp when the gift card was disabled. | null |
gift_card.enabled | boolean | Whether the gift card is currently enabled. | true |
gift_card.created_at | string | Timestamp of when the gift card was created. | 2024-05-06T10:06:04Z |
gift_card.updated_at | string | Timestamp of when the gift card was last updated. | 2024-05-07T02:37:20Z |
gift_card.status | string | Status of the gift card (enable or disable). | enable |
gift_card.currency | string | Currency in which the gift card is denominated. | USD |
gift_card.line_item_id | string | ID of the line item associated with the gift card. | null |
gift_card.order_id | string | ID of the order associated with the gift card. | null |
gift_card.user_id | string | User ID of the creator or owner of the gift card. | null |
gift_card.template_suffix | string | Suffix of the template used to render the gift card online. | null |
gift_card.customer_id | string | Customer ID associated with the gift card. | 8b91ccbd-37d0-4897-aac6-5082e64ca374 |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "invalid line_item id"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 422 | empty or bad request-id | invalid or empty request_id | empty or bad request-id |
| 404 | data not found | The id provided is not found. | data not found |