Skip to main content
GET
cURL
Returns the partner brands’ offers to show on this merchant’s surface on your platform, for one offer type. For example, post-purchase offers appear on the merchant’s order confirmation page. Call it from your server at the moment you show the offers. Views and orders from these offers are credited to your platform. The merchant must have approved your platform.
cURL

When the list is empty

The response is { "offers": [] } whenever the merchant’s campaign of this type isn’t live on your platform: placement is off, usage billing is off, setup isn’t finished, or there’s no partner offer to show right now. Show nothing in that case. It isn’t an error. The first call from a merchant’s surface also tells Branduo that the merchant can show partner offers. A merchant’s own offer is shown to other brands’ shoppers only after one of their surfaces has asked, so call this route wherever you show offers, even while it returns nothing.

Path parameters

string
required
The merchant’s store domain, *.myshopify.com or custom.

Query parameters

string
required
The offer type. Today the only value is post-purchase: offers shown after checkout, such as on the order confirmation page.
string
Optional but recommended. A unique ID for one display of the offers. For an order confirmation page, use the order ID. Repeating a viewId returns the same offer and counts one view, even if the page is refreshed. Up to 200 printable characters; a longer or unprintable value is ignored, and the request counts as a new view.

Response

object[]
required
The offers to show. Empty when the merchant’s campaign isn’t live here.
Each offer returned counts as one view for your platform, once per viewId. This route allows 1,200 requests per minute per key; see Rate limiting.

Errors