List buyer instructions - Interchange API

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"
  }
]

Field	Type	Description
`[].id`	string	Surrogate id (BIGINT serialized as string)
`[].storefrontId`	string	Storefront the row belongs to
`[].operatorDomain`	string \| null	Operator scope, or `null` to match any
`[].brandDomain`	string \| null	Brand scope, or `null` to match any
`[].discountPercent`	number \| null	Discount off base price, or `null`
`[].notes`	string \| null	Freeform composition notes, or `null`
`[].countries`	string[] \| null	ISO 3166-1 alpha-2 country filter, or `null`
`[].createdAt`, `[].updatedAt`	string	ISO 8601 timestamps
`[].createdBy`	string \| null	Who 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.

Delete buyer instructions Update buyer instructions

⌘I

​Request

​Response

​Errors

​Related

Buyer instruction tasks

Create buyer instructions

Request

Response

Errors

Related