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"
]
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/buyer-instructions/{id}"
payload = {
"discountPercent": 15,
"notes": "<string>",
"countries": ["US", "CA"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({discountPercent: 15, notes: '<string>', countries: ['US', 'CA']})
};
fetch('https://api.interchange.io/api/v2/storefront/buyer-instructions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Update a buyer-instructions row
Partially update a buyer-instructions row. Scope columns (operatorDomain, brandDomain) are immutable — delete and recreate to change them.
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"
]
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/buyer-instructions/{id}"
payload = {
"discountPercent": 15,
"notes": "<string>",
"countries": ["US", "CA"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({discountPercent: 15, notes: '<string>', countries: ['US', 'CA']})
};
fetch('https://api.interchange.io/api/v2/storefront/buyer-instructions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Surrogate id of the buyer-instruction row.
0 < x <= 900719925474099117
Body
Partial update for a buyer-instructions row. Scope (operatorDomain, brandDomain) is immutable — delete and recreate to change it.
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.
0 <= x <= 10015
2000ISO 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.
1^[A-Z]{2}$["US", "CA"]
Response
Update a buyer-instructions row
A single buyer-instructions row.
Surrogate id (BIGINT serialized as string).
"17"
Storefront the row belongs to (BIGINT serialized as string).
"1234"
^(?:(?:\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))$^(?:(?:\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))$