Skip to main content
GET /api/v2/storefront/buyer-instructions Lists every buyer-instructions row configured on your storefront.

​
Request

curl
curl https://api.interchange.io/api/v2/storefront/buyer-instructions \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Response

Returns an array of buyer-instructions rows. 
[
  {
    "id": "17",
    "storefrontId": "1234",
    "operatorDomain": "acme-media.com",
    "brandDomain": "northwind.example",
    "discountPercent": 15,
    "notes": "Brand requires Acme Media viewability ≥ 70%.",
    "countries": ["US", "CA"],
    "createdAt": "2026-05-02T14:21:00.000Z",
    "updatedAt": "2026-05-02T14:21:00.000Z",
    "createdBy": "operator@acme-media.com"
  }
]
FieldTypeDescription
[].idstringSurrogate id (BIGINT serialized as string)
[].storefrontIdstringStorefront the row belongs to
[].operatorDomainstring | nullOperator scope, or null to match any
[].brandDomainstring | nullBrand scope, or null to match any
[].discountPercentnumber | nullDiscount off base price, or null
[].notesstring | nullFreeform composition notes, or null
[].countriesstring[] | nullISO 3166-1 alpha-2 country filter, or null
[].createdAt, [].updatedAtstringISO 8601 timestamps
[].createdBystring | nullWho created the row, when known

​
Errors

  • 401 UNAUTHORIZED — missing or invalid bearer token.
See Errors for the full error contract.

Buyer instruction tasks

All buyer-instructions operations.

Create buyer instructions

Add a new scoped row.