Superfiliate

List gifting campaigns

Bearer auth

Lists seeding campaigns belonging to your shop, including campaigns without submitted gifts. These are gifting campaigns, separate from the loyalty and creator programs returned by /api/v1/campaigns.

Use the returned id as campaign_id when listing gifting rewards. Both Shopify and merchant-managed campaigns are included; filter by fulfillment_mode=merchant_managed for external OMS fulfillment. The gifting rewards API only supports merchant-managed campaigns.

available_products contains products and their eligible variants, with internal and external IDs, titles, SKUs, images, and option values. Merchant-managed campaigns use their configured variants; depleted campaign quantities and unavailable catalog entries are excluded. Shopify campaigns use their configured product and Shopify collections, excluding unavailable variants. Quantity caps and remaining quantities are campaign-wide and are null for uncapped variants. Availability is a snapshot, not a reservation; campaign and category selection limits still apply.

Results include active and inactive campaigns by default and are ordered by creation time, then ID, descending. A campaign is active when neither its expiration nor archive date has passed. Pagination returns an array; request successive pages until an empty array is returned.

Production requests require gifting_campaigns.read, which must be explicitly granted to your API key.

GETapi.superfiliate.com/api/dry-run/v1/gifting_campaigns

Query parameters5

id
integer
Only return the gifting campaign with this ID
active
boolean
Only return active or inactive campaigns
fulfillment_mode
string
Only return campaigns using this fulfillment mode
page
integer
Default is 1; values below 1 use 1default:1
items
integer
Default is 25; values are clamped between 1 and 250default:25

Responses

A list of gifting campaigns

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