Get Gift Card

Detail of a gift card looked up by its card NUMBER — despite the path segment name, this GET takes the card number (e.g. DOCS-GC-0001), not the numeric id used by the update and delete methods on this path. An unknown number returns {"data": null} with status 200. Requires the p/r-gift-cards permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Gift card NUMBER (not the numeric id).

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json