Definition

Gifting

Gifting campaigns configure creator gifts. Gifting rewards contain the creator contact, shipping details, and product selections submitted for merchant-managed campaigns.

Response blueprint

Fields returned for this resource. Expand nested objects to inspect their fields.

array of objects — item fields

idinteger
namestring
Human-readable name for this resource.
activeboolean
True when neither the expiration nor archive date has passed
fulfillment_modeenum<string>
The fulfillment mode for this resource.
"shopify""merchant_managed"
redeem_methodenum<string>
The redeem method for this resource.
"automatic""manual"
multi_product_selection_limitinteger
The multi product selection limit for this resource.
expires_atstringnull
ISO 8601 timestamp for expires.
archived_atstringnull
ISO 8601 timestamp for archived.
created_atstring
ISO 8601 timestamp when this resource was created.
updated_atstring
ISO 8601 timestamp when this resource was last updated.
Selectable products with campaign-eligible variants. Empty when no products are selectable.
- idinteger
- external_idstring
  Identifier for the related external.
- titlestring
  The title for this resource.
- The variants for this resource.
  idinteger
  external_idstring
  Identifier for the related external.
  titlestring
  The title for this resource.
  skustringnull
  The sku for this resource.
  image_urlstringnull
  URL for image.
  The options for this resource.
  namestring
  Human-readable name for this resource.
  valuestring
  The value for this resource.
  available_quantityintegernull
  Campaign-wide configured cap; null means no campaign cap
  remaining_quantityintegernull
  Cap minus active submitted selections; null means no campaign cap

Endpoints

GETList gifting campaigns/api/v1/gifting_campaignsPOSTEnroll a customer in a gifting campaign/api/v1/gifting_campaigns/{id}/enrollGETList gifting rewards/api/v1/gifting_rewardsPOSTFulfill a gifting reward/api/v1/gifting_rewards/{id}/fulfill