Get gift cards

Requires read_gift_card access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/gift_cards.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Get a list of gift cards.
Query Parameters
  • code string
    Gift card code.
    Example: dbe95e7f02606fc4
  • created_at_max string
    Specify the latest creation time for the gift card to be queried. Gift cards created before this time will be returned. Format: ISO 8601.
    Example: 2021-09-02T14:11:54+00:00
  • created_at_min string
    Specify the earliest creation time for the gift card to be queried. Gift cards created on and after this time will be returned. Format: ISO 8601.
    Example: 2021-09-02T14:11:54+00:00
  • expires_on_min string
    Specify the earliest expiration time for the gift card to be queried. Gift cards expiring on and after this time will be returned. Format: ISO 8601.
    Example: 2021-09-02T14:11:54+00:00
  • limit string
    The quantity limit of gift cards to be queried.
    Value range: 1-250
    Default value: 50
  • since_id string
    The ID of a specific gift card. Start querying gift cards from this specified ID.
    Example: 30171274557691301804060045
  • status string
    The status of the gift card. Valid values are:
    • enabled: enabled
    • disabled: not enabled
  • expires_on_max string
    Specify the latest expiration time for the gift card to be queried. Gift cards expiring before this time will be returned. Format: ISO 8601.
    Example: 2021-09-02T14:11:54+00:00
  • fields string
    Specify the fields to be returned, with multiple fields separated by commas. For available fields, refer to the top-level child parameters under the gift_cards object in the response.
    Example: id,last_characters
  • page_info string
    The unique identifier for pagination queries, used to locate a specific page.
    This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.
    For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/gift_cards.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 .
    For more information on how to use pagination, refer to Paging Mechanism.
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • link
    The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.
    This parameter is returned when the requested page has a previous or next page.
    For more information on how to use pagination, refer to Paging Mechanism.
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • gift_cardsobject[]
    Gift card information.
  • api_client_id string
    Caller ID.
    Example: 36d2bc4e97af056677b61c529d9e3a3f7396040d
  • balance string
    The balance of the gift card.
    Example: 200
  • created_at string
    The date and time when the gift card was created. Format: ISO 8601.
    Example: 2023-08-16T23:59:59+08:00
  • currency string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • customer_id string
    The ID of the customer who owns the gift card.
    Example: 4200113946
  • disabled_at string
    The date and time when the gift card was disabled. Format: ISO 8601.
    Example: 2023-08-16T23:59:59+08:00
  • expires_on string
    The date and time when the gift card expires. A value of null indicates the gift card never expires. Format: ISO 8601.
    Example: 2023-08-16T23:59:59+08:00
  • id string
    The unique identifier for the gift card .
    Example: 30171274557691301804060045
  • initial_value string
    The initial amount of the gift card.
    Example: 200
  • last_characters string
    The last four characters of the gift card code.
    Example: d246
  • line_item_id string
    The associated order line item ID.
    Example: 18060183094426803997483534
  • note string
    The note content of the gift card.
    Example: This is a note
  • order_id string
    The associated order ID.
    Example: 24060486231247568944830202
  • updated_at string
    The date and time when the gift card was last updated. Format: ISO 8601.
    Example: 2021-09-02T14:11:54+00:00
  • user_id string
    The SHOPLINE Admin account ID for creating the gift card.
    Example: 4214250478
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/gift_cards.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Get gift cards
Response
{
  "gift_cards": [
    {
      "api_client_id": null,
      "balance": "10.00",
      "created_at": "2023-07-24T15:32:18+08:00",
      "currency": "USD",
      "customer_id": "2006314005",
      "disabled_at": null,
      "expires_on": null,
      "id": "30160373789860060302632788",
      "initial_value": "10.00",
      "last_characters": "bdbf",
      "line_item_id": "5682",
      "note": null,
      "order_id": "21059257552171693554015400",
      "updated_at": "2023-07-24T15:32:18+08:00",
      "user_id": null
    }
  ]
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.