Superfiliate

Fulfill a gifting reward

Bearer authgifting_rewards.writeBeta

Records fulfillment for a merchant-managed gift after the creator submits their details. Use status: order_placed with external_order_id and external_provider to register an order before shipping. Later send status: shipped with tracking details. The registered order references are retained when omitted; conflicting references are rejected. Omitting status preserves the existing shipped behavior.

Identical retries do not change timestamps or regress shipped/delivered gifts. Once shipped, different details are rejected. Campaigns using Shopify-managed fulfillment are not available through this endpoint.

POSTapi.superfiliate.com/api/v1/gifting_rewards/{id}/fulfill

Path parameters1

idrequired
integer
Gifting reward ID

Body parametersapplication/json

  • statusenum<string>

    Current status of this resource.

    "order_placed""shipped"

  • external_providerstring

    Provider name (e.g. shopify). Required for order_placed.

  • external_order_idstring

    Order ID in the merchant's OMS

  • carrierstring

    Shipping carrier

  • tracking_numberstring

    Carrier tracking number

  • tracking_urlstring

    HTTP(S) tracking URL

Responses

Order placed before shipping

  • idinteger
  • gifting_stageenum<string>

    Current lifecycle stage for this reward.

    "unlocked""claimed""shipped""delivered""expired""paused""skipped""not_eligible""pending""error""ready_to_send""missing_address""order_placed""canceled""posted"

  • Program associated with this resource.

    • idinteger
    • namestring

      Human-readable name for this resource.

  • Creator associated with this resource.

    • idinteger
    • first_namestring

      Person's given name.

    • last_namestring

      Person's family name.

    • emailstring

      Email address for this person.

    • phonestring

      Phone number for this person.

  • Shipping address for this reward.

    • address1string

      First line of the shipping address.

    • address2string | null

      Second line of the shipping address, when provided.

    • citystring

      City in the shipping address.

    • country_codestring

      ISO country code in the shipping address.

    • province_codestring | null

      Province or state code in the shipping address.

    • zipstring

      Postal or ZIP code in the shipping address.

  • The selected products for this resource.

    • product_external_idstring

      Identifier for the related product external.

    • variant_external_idstring

      Identifier for the related variant external.

    • product_titlestring

      The product title for this resource.

    • variant_titlestring

      The variant title for this resource.

    • image_urlstring | null

      URL for image.

    • skustring | null

      The sku for this resource.

    • The options for this resource.

      • namestring

        Human-readable name for this resource.

      • valuestring

        The value for this resource.

    • quantityinteger

      The quantity for this resource.

    • selected_atstring

      ISO 8601 timestamp for selected.

  • The fulfillment for this resource.

    • external_order_idstring | null

      Identifier for the related external order.

    • external_providerstring | null

      The external provider for this resource.

    • order_placed_atstring | null

      ISO 8601 timestamp for order placed.

    • carrierstring | null

      The carrier for this resource.

    • tracking_numberstring | null

      The tracking number for this resource.

    • tracking_urlstring | null

      URL for tracking.

    • fulfilled_atstring | null

      ISO 8601 timestamp for fulfilled.

  • details_submitted_atstring

    ISO 8601 timestamp for details submitted.

  • created_atstring

    ISO 8601 timestamp when this resource was created.

  • updated_atstring

    ISO 8601 timestamp when this resource was last updated.