2.6 KiB
2.6 KiB
name, description
| name | description |
|---|---|
| gift-cards-routes | Handle 9 OpenAPI operation(s) under /v2/gift-cards for the gift cards route group. |
gift cards API Routes
Handle 9 OpenAPI operation(s) under /v2/gift-cards for the gift cards route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
list_gift_cards
- Operation ID:
list_gift_cards - Route:
GET /v2/gift-cards - Mode: READ
- Summary: ListGiftCards
- Parameters:
typeinquerystateinquerylimitinquerycursorinquerycustomer_idinquery
create_gift_card
- Operation ID:
create_gift_card - Route:
POST /v2/gift-cards - Mode: WRITE
- Summary: CreateGiftCard
- Body: JSON request body accepted.
list_gift_card_activities
- Operation ID:
list_gift_card_activities - Route:
GET /v2/gift-cards/activities - Mode: READ
- Summary: ListGiftCardActivities
- Parameters:
gift_card_idinquerytypeinquerylocation_idinquerybegin_timeinqueryend_timeinquerylimitinquerycursorinquerysort_orderinquery
create_gift_card_activity
- Operation ID:
create_gift_card_activity - Route:
POST /v2/gift-cards/activities - Mode: WRITE
- Summary: CreateGiftCardActivity
- Body: JSON request body accepted.
retrieve_gift_card_from_gan
- Operation ID:
retrieve_gift_card_from_gan - Route:
POST /v2/gift-cards/from-gan - Mode: WRITE
- Summary: RetrieveGiftCardFromGAN
- Body: JSON request body accepted.
retrieve_gift_card_from_nonce
- Operation ID:
retrieve_gift_card_from_nonce - Route:
POST /v2/gift-cards/from-nonce - Mode: WRITE
- Summary: RetrieveGiftCardFromNonce
- Body: JSON request body accepted.
link_customer_to_gift_card
- Operation ID:
link_customer_to_gift_card - Route:
POST /v2/gift-cards/{gift_card_id}/link-customer - Mode: WRITE
- Summary: LinkCustomerToGiftCard
- Parameters:
gift_card_idinpathrequired
- Body: JSON request body accepted.
unlink_customer_from_gift_card
- Operation ID:
unlink_customer_from_gift_card - Route:
POST /v2/gift-cards/{gift_card_id}/unlink-customer - Mode: WRITE
- Summary: UnlinkCustomerFromGiftCard
- Parameters:
gift_card_idinpathrequired
- Body: JSON request body accepted.
retrieve_gift_card
- Operation ID:
retrieve_gift_card - Route:
GET /v2/gift-cards/{id} - Mode: READ
- Summary: RetrieveGiftCard
- Parameters:
idinpathrequired