Skip to main content
PATCH
/
buyer-instructions
/
{id}
Update a buyer-instructions row
curl --request PATCH \
  --url https://api.interchange.io/api/v2/storefront/buyer-instructions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "discountPercent": 15,
  "notes": "<string>",
  "countries": [
    "US",
    "CA"
  ]
}
'
{
  "id": "17",
  "storefrontId": "1234",
  "operatorDomain": "<string>",
  "brandDomain": "<string>",
  "discountPercent": 123,
  "notes": "<string>",
  "countries": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.interchange.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
id
integer
required

Surrogate id of the buyer-instruction row.

Required range: x <= 9007199254740991
Example:

17

Body

application/json

Partial update for a buyer-instructions row. Scope (operatorDomain, brandDomain) is immutable — delete and recreate to change it.

​
discountPercent
number | null

Discount percent off the storefront base price. 0–100. Resolver picks MAX across all matching rows — adding a brand-specific row only wins by being a better deal.

Required range: 0 <= x <= 100
Example:

15

​
notes
string | null
Maximum string length: 2000
​
countries
string[] | null

ISO 3166-1 alpha-2 country codes (uppercase). Row applies only when the buy targets one of these countries. Omit (or send null) for a global row.

Minimum array length: 1
Pattern: ^[A-Z]{2}$
Example:
["US", "CA"]

Response

Update a buyer-instructions row

A single buyer-instructions row.

​
id
string
required

Surrogate id (BIGINT serialized as string).

Example:

"17"

​
storefrontId
string
required

Storefront the row belongs to (BIGINT serialized as string).

Example:

"1234"

​
operatorDomain
string | null
required
​
brandDomain
string | null
required
​
discountPercent
number | null
required
​
notes
string | null
required
​
countries
string[] | null
required
​
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
createdBy
string | null
required