GET /admin/api/{api_version}/gift_cards/search.json
Searches for gift cards that match a supplied query. The following fields are indexed by search:EndFragment
created_atupdated_atdisabled_atbalanceinitial_valueamount_spentlast_characters
This endpoint implements pagination by using links that are provided in the response header. To learn more, see Make paginated requests to the REST Admin API.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_version |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
x-shopify-access-token |
String | No |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
updated_at_min |
String | No |
Show gift cards last updated at or after date. |
order |
String | No |
The field and direction to order results by.(default: disabled_at DESC) |
query |
String | No |
The text to search for. |
limit |
String | No |
The maximum number of results to retrieve.(default: 50)(maximum: 250) |
created_at_max |
String | No |
Show gift cards created at or before date. |
fields |
String | No |
Show only certain fields, specified by a comma-separated list of field names. |
created_at_min |
String | No |
Show gift cards created at or after date. |
updated_at_max |
String | No |
Show gift cards last updated at or before date. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.