propose_write

Issue a gift card (store credit), optionally emailed to the customer of a named order. Capped at the store's CS max_gift

Issue a gift card (store credit), optionally emailed to the customer of a named order. Capped at the store's CS max_gift_card_amount; above it the result is needs_owner and nothing is issued. Approval/auto-apply gated.

post/api/v1/tools/shopify_create_gift_card

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/shopify_create_gift_card
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: promotions:write)

Request body

amountnumber required
currencystring

ISO currency (default EUR).

shopify_order_idinteger

Numeric Shopify order id. Required when recipient_email is set: the card is e-mailed to that order's customer, whatever address was given.

recipient_emailstring

Optional. Only honoured together with shopify_order_id, and then bound to that order's customer. Omit to issue unassigned store credit.

notestring

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.