Retrieve gift certificates by query
POST/gift_certificate/gift_certificates/query
Retrieves gift certificates from the account. If no parameters are specified, all gift certificates will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
Your UltraCart data warehouse has this data as uc_gift_certificates, built from the same objects this API returns. For backfills, exports and reporting, query it in BigQuery instead of paging this API: no REST rate limits, read-only, one to two minutes behind live data. Data Warehouse
Request
Responses
- 200
- 400
- 401
- 410
- 429
- 500
Successful response
Status Code 400: bad request input such as invalid json
Response Headers
Contains human readable error message
Status Code 401: invalid credentials supplied
Response Headers
Contains human readable error message
Status Code 410: Your authorized application has been disabled by UltraCart
Response Headers
Contains human readable error message
Status Code 429: you have exceeded the allowed API call rate limit for your application.
Response Headers
Contains human readable error message
Status Code 500: any server side error. the body will contain a generic server error message
Response Headers
Contains human readable error message