Gift Cards

Upsert Gift Card

put/v1/transactions/gift_cards/{gift_card_id}

Request

  • Base URL: https://api.blueonion.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.blueonion.ai/v1/transactions/gift_cards/{gift_card_id}
  • Auth: HTTP bearer

Path parameters

gift_card_idstring required

Request body

gift_card_idstring required

External gift card id (Shopify GiftCard.id).

issued_atstring date-time required

When the card was issued (GiftCard.createdAt).

currencystring required

ISO 4217 currency code; auto-uppercased.

initial_valuenumber required

Value the card was issued with.

balancenumber required

Current remaining balance.

last_charactersstring nullable

Last characters of the card code (GiftCard.lastCharacters).

source_namestring nullable

Provider/system that generated the card (e.g. 'Loop', 'Narvar', 'Complimentary'). Defaults to 'data_ingestion_api'.

notestring nullable

Free-text note on the card.

expires_atstring date-time nullable

Expiry timestamp, if any.

disabled_atstring date-time nullable

When the card was disabled, if any.

customer_idstring nullable

External customer id the card belongs to.

order_reference_idstring nullable

Issuing order id (GiftCard.order).

edit_versioninteger nullable

Issuing order edit version.

Response

Successful Response

transaction_idstring required
actionstring required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.