Skip to content

README.md

Latest commit

 

History

History
64 lines (46 loc) · 5.73 KB

README.md

File metadata and controls

64 lines (46 loc) · 5.73 KB

Buyers.GiftCards

Overview

Available Operations

  • list - List gift cards for a buyer

list

List all the stored gift cards for a specific buyer.

Example Usage

from gr4vy import Gr4vy
import os


with Gr4vy(
    merchant_account_id="default",
    bearer_auth=os.getenv("GR4VY_BEARER_AUTH", ""),
) as g_client:

    res = g_client.buyers.gift_cards.list(order_by="desc")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
buyer_external_identifier OptionalNullable[str] ➖ N/A
buyer_id OptionalNullable[str] ➖ N/A
sort_by OptionalNullable[models.ListBuyerGiftCardsSortBy] ➖ The field to sort the gift cards by. last_used_at
order_by Optional[models.ListBuyerGiftCardsOrderBy] ➖ The direction to sort the gift cards in. desc
merchant_account_id Optional[str] ➖ The ID of the merchant account to use for this request. default
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GiftCardSummaries

Errors

Error Type Status Code Content Type
errors.Error400 400 application/json
errors.Error401 401 application/json
errors.Error403 403 application/json
errors.Error404 404 application/json
errors.Error405 405 application/json
errors.Error409 409 application/json
errors.HTTPValidationError 422 application/json
errors.Error425 425 application/json
errors.Error429 429 application/json
errors.Error500 500 application/json
errors.Error502 502 application/json
errors.Error504 504 application/json
errors.APIError 4XX, 5XX */*