Update storefront proposal
curl --request PATCH \
--url https://api.interchange.io/api/v2/storefront/proposals/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"notes": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/proposals/{id}"
payload = {
"label": "<string>",
"notes": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
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({label: '<string>', notes: '<string>', expiresAt: '2023-11-07T05:31:56Z'})
};
fetch('https://api.interchange.io/api/v2/storefront/proposals/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 4503599627370495,
"proposalCode": "PRP-XK4A29",
"operatorId": "<string>",
"operatorRef": {
"domain": "acme.com"
},
"label": "<string>",
"notes": "<string>",
"status": "active",
"expiresAt": "2023-11-07T05:31:56Z",
"proposalId": "<string>",
"discoverySessionId": "<string>",
"snapshot": {
"products": [
{
"productId": "prod_123",
"name": "Premium CTV Inventory - Sports",
"channel": "ctv",
"channels": [
"streaming_audio",
"podcast"
],
"inventoryType": "run_of_site",
"formatTypes": [
"video_hosted"
],
"cpm": 12.5,
"currency": "USD",
"expiresAt": "2023-11-07T05:31:56Z",
"pricingScope": "public",
"salesAgentId": "<string>",
"salesAgentName": "<string>",
"storefrontId": "<string>",
"inventorySourceId": "<string>",
"storefrontName": "<string>",
"supportedRoutingTypes": [
"DECISIONED"
],
"description": "<string>",
"deliveryType": "guaranteed",
"briefRelevance": "<string>",
"productCard": {
"image": {
"asset_type": "image",
"url": "<string>",
"width": 4503599627370496,
"height": 4503599627370496,
"file_size_bytes": 4503599627370496,
"pixel_ratio": 1,
"state_id": "<string>",
"breakpoint_id": "<string>",
"focal_point": [
123
],
"format": "<string>",
"alt_text": "<string>",
"provenance": {
"digital_source_type": "digital_capture",
"synthetic_depiction": true,
"ai_tool": {
"name": "<string>",
"version": "<string>",
"provider": "<string>"
},
"human_oversight": "none",
"declared_by": {
"role": "creator",
"agent_url": "<string>"
},
"declared_at": "<string>",
"created_time": "<string>",
"c2pa": {
"manifest_url": "<string>"
},
"embedded_provenance": [
{
"method": "manifest_wrapper",
"provider": "<string>",
"standard": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"embedded_at": "<string>"
}
],
"watermarks": [
{
"media_type": "audio",
"provider": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"c2pa_action": "c2pa.watermarked.bound",
"embedded_at": "<string>"
}
],
"disclosure": {
"required": true,
"jurisdictions": [
{
"country": "<string>",
"regulation": "<string>",
"region": "<string>",
"label_text": "<string>",
"render_guidance": {
"persistence": "continuous",
"min_duration_ms": 4503599627370496,
"positions": [
"prominent"
],
"ext": {}
}
}
]
},
"verification": [
{
"verified_by": "<string>",
"result": "authentic",
"verified_time": "<string>",
"confidence": 0.5,
"details_url": "<string>"
}
],
"ext": {}
}
},
"title": "<string>",
"description": "<string>",
"price_label": "<string>",
"cta_label": "<string>"
},
"productCardDetailed": {
"hero_image": {
"asset_type": "image",
"url": "<string>",
"width": 4503599627370496,
"height": 4503599627370496,
"file_size_bytes": 4503599627370496,
"pixel_ratio": 1,
"state_id": "<string>",
"breakpoint_id": "<string>",
"focal_point": [
123
],
"format": "<string>",
"alt_text": "<string>",
"provenance": {
"digital_source_type": "digital_capture",
"synthetic_depiction": true,
"ai_tool": {
"name": "<string>",
"version": "<string>",
"provider": "<string>"
},
"human_oversight": "none",
"declared_by": {
"role": "creator",
"agent_url": "<string>"
},
"declared_at": "<string>",
"created_time": "<string>",
"c2pa": {
"manifest_url": "<string>"
},
"embedded_provenance": [
{
"method": "manifest_wrapper",
"provider": "<string>",
"standard": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"embedded_at": "<string>"
}
],
"watermarks": [
{
"media_type": "audio",
"provider": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"c2pa_action": "c2pa.watermarked.bound",
"embedded_at": "<string>"
}
],
"disclosure": {
"required": true,
"jurisdictions": [
{
"country": "<string>",
"regulation": "<string>",
"region": "<string>",
"label_text": "<string>",
"render_guidance": {
"persistence": "continuous",
"min_duration_ms": 4503599627370496,
"positions": [
"prominent"
],
"ext": {}
}
}
]
},
"verification": [
{
"verified_by": "<string>",
"result": "authentic",
"verified_time": "<string>",
"confidence": 0.5,
"details_url": "<string>"
}
],
"ext": {}
}
},
"carousel_images": [
{
"asset_type": "image",
"url": "<string>",
"width": 4503599627370496,
"height": 4503599627370496,
"file_size_bytes": 4503599627370496,
"pixel_ratio": 1,
"state_id": "<string>",
"breakpoint_id": "<string>",
"focal_point": [
123
],
"format": "<string>",
"alt_text": "<string>",
"provenance": {
"digital_source_type": "digital_capture",
"synthetic_depiction": true,
"ai_tool": {
"name": "<string>",
"version": "<string>",
"provider": "<string>"
},
"human_oversight": "none",
"declared_by": {
"role": "creator",
"agent_url": "<string>"
},
"declared_at": "<string>",
"created_time": "<string>",
"c2pa": {
"manifest_url": "<string>"
},
"embedded_provenance": [
{
"method": "manifest_wrapper",
"provider": "<string>",
"standard": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"embedded_at": "<string>"
}
],
"watermarks": [
{
"media_type": "audio",
"provider": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"c2pa_action": "c2pa.watermarked.bound",
"embedded_at": "<string>"
}
],
"disclosure": {
"required": true,
"jurisdictions": [
{
"country": "<string>",
"regulation": "<string>",
"region": "<string>",
"label_text": "<string>",
"render_guidance": {
"persistence": "continuous",
"min_duration_ms": 4503599627370496,
"positions": [
"prominent"
],
"ext": {}
}
}
]
},
"verification": [
{
"verified_by": "<string>",
"result": "authentic",
"verified_time": "<string>",
"confidence": 0.5,
"details_url": "<string>"
}
],
"ext": {}
}
}
],
"title": "<string>",
"description": "<string>",
"specifications": [
{
"label": "<string>",
"value": "<string>"
}
],
"price_label": "<string>",
"cta_label": "<string>"
},
"pricingOptions": [
{
"pricingOptionId": "<string>",
"pricingModel": "<string>",
"isFixed": true,
"rate": 123,
"floorPrice": 123,
"fixedPrice": 123,
"maxBid": true,
"currency": "<string>",
"priceGuidance": {
"floor": 123,
"p25": 123,
"p50": 123,
"p75": 123,
"p90": 123
}
}
],
"estimatedExposures": 0,
"forecast": {},
"bookability": "<string>",
"publisherProperties": [
{
"publisherDomain": "<string>",
"propertyType": "<string>",
"name": "<string>",
"selectionType": "<string>",
"identifiers": [
{}
]
}
],
"isSandbox": true,
"formatOptions": [
{
"format_kind": "video_hosted",
"format_option_id": "<string>",
"display_name": "<string>",
"params": {
"containers": [
"mp4"
],
"video_codecs": [
"h264"
],
"audio_codecs": [
"aac"
]
}
}
],
"supportedTargeting": [
"<string>"
]
}
],
"proposals": [
{
"proposalId": "<string>",
"name": "<string>",
"allocations": [
{
"productId": "<string>",
"allocationPercentage": 50,
"pricingOptionId": "<string>",
"rationale": "<string>",
"sequence": 0,
"tags": [
"<string>"
]
}
],
"description": "<string>",
"briefAlignment": "<string>",
"salesAgentId": "<string>",
"salesAgentName": "<string>",
"storefrontId": "<string>",
"storefrontName": "<string>",
"supportedRoutingTypes": [
"DECISIONED"
],
"expiresAt": "<string>",
"totalBudgetGuidance": {
"min": 123,
"recommended": 123,
"max": 123,
"currency": "<string>"
}
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"firstViewedAt": "2023-11-07T05:31:56Z",
"lastViewedAt": "2023-11-07T05:31:56Z",
"redeemedAt": "2023-11-07T05:31:56Z",
"redeemedInMediaBuyId": "<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": {}
}
}Storefront Proposals
Update storefront proposal
Update label, notes, or expiry of a storefront proposal.
PATCH
/
proposals
/
{id}
Update storefront proposal
curl --request PATCH \
--url https://api.interchange.io/api/v2/storefront/proposals/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"notes": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/proposals/{id}"
payload = {
"label": "<string>",
"notes": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
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({label: '<string>', notes: '<string>', expiresAt: '2023-11-07T05:31:56Z'})
};
fetch('https://api.interchange.io/api/v2/storefront/proposals/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 4503599627370495,
"proposalCode": "PRP-XK4A29",
"operatorId": "<string>",
"operatorRef": {
"domain": "acme.com"
},
"label": "<string>",
"notes": "<string>",
"status": "active",
"expiresAt": "2023-11-07T05:31:56Z",
"proposalId": "<string>",
"discoverySessionId": "<string>",
"snapshot": {
"products": [
{
"productId": "prod_123",
"name": "Premium CTV Inventory - Sports",
"channel": "ctv",
"channels": [
"streaming_audio",
"podcast"
],
"inventoryType": "run_of_site",
"formatTypes": [
"video_hosted"
],
"cpm": 12.5,
"currency": "USD",
"expiresAt": "2023-11-07T05:31:56Z",
"pricingScope": "public",
"salesAgentId": "<string>",
"salesAgentName": "<string>",
"storefrontId": "<string>",
"inventorySourceId": "<string>",
"storefrontName": "<string>",
"supportedRoutingTypes": [
"DECISIONED"
],
"description": "<string>",
"deliveryType": "guaranteed",
"briefRelevance": "<string>",
"productCard": {
"image": {
"asset_type": "image",
"url": "<string>",
"width": 4503599627370496,
"height": 4503599627370496,
"file_size_bytes": 4503599627370496,
"pixel_ratio": 1,
"state_id": "<string>",
"breakpoint_id": "<string>",
"focal_point": [
123
],
"format": "<string>",
"alt_text": "<string>",
"provenance": {
"digital_source_type": "digital_capture",
"synthetic_depiction": true,
"ai_tool": {
"name": "<string>",
"version": "<string>",
"provider": "<string>"
},
"human_oversight": "none",
"declared_by": {
"role": "creator",
"agent_url": "<string>"
},
"declared_at": "<string>",
"created_time": "<string>",
"c2pa": {
"manifest_url": "<string>"
},
"embedded_provenance": [
{
"method": "manifest_wrapper",
"provider": "<string>",
"standard": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"embedded_at": "<string>"
}
],
"watermarks": [
{
"media_type": "audio",
"provider": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"c2pa_action": "c2pa.watermarked.bound",
"embedded_at": "<string>"
}
],
"disclosure": {
"required": true,
"jurisdictions": [
{
"country": "<string>",
"regulation": "<string>",
"region": "<string>",
"label_text": "<string>",
"render_guidance": {
"persistence": "continuous",
"min_duration_ms": 4503599627370496,
"positions": [
"prominent"
],
"ext": {}
}
}
]
},
"verification": [
{
"verified_by": "<string>",
"result": "authentic",
"verified_time": "<string>",
"confidence": 0.5,
"details_url": "<string>"
}
],
"ext": {}
}
},
"title": "<string>",
"description": "<string>",
"price_label": "<string>",
"cta_label": "<string>"
},
"productCardDetailed": {
"hero_image": {
"asset_type": "image",
"url": "<string>",
"width": 4503599627370496,
"height": 4503599627370496,
"file_size_bytes": 4503599627370496,
"pixel_ratio": 1,
"state_id": "<string>",
"breakpoint_id": "<string>",
"focal_point": [
123
],
"format": "<string>",
"alt_text": "<string>",
"provenance": {
"digital_source_type": "digital_capture",
"synthetic_depiction": true,
"ai_tool": {
"name": "<string>",
"version": "<string>",
"provider": "<string>"
},
"human_oversight": "none",
"declared_by": {
"role": "creator",
"agent_url": "<string>"
},
"declared_at": "<string>",
"created_time": "<string>",
"c2pa": {
"manifest_url": "<string>"
},
"embedded_provenance": [
{
"method": "manifest_wrapper",
"provider": "<string>",
"standard": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"embedded_at": "<string>"
}
],
"watermarks": [
{
"media_type": "audio",
"provider": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"c2pa_action": "c2pa.watermarked.bound",
"embedded_at": "<string>"
}
],
"disclosure": {
"required": true,
"jurisdictions": [
{
"country": "<string>",
"regulation": "<string>",
"region": "<string>",
"label_text": "<string>",
"render_guidance": {
"persistence": "continuous",
"min_duration_ms": 4503599627370496,
"positions": [
"prominent"
],
"ext": {}
}
}
]
},
"verification": [
{
"verified_by": "<string>",
"result": "authentic",
"verified_time": "<string>",
"confidence": 0.5,
"details_url": "<string>"
}
],
"ext": {}
}
},
"carousel_images": [
{
"asset_type": "image",
"url": "<string>",
"width": 4503599627370496,
"height": 4503599627370496,
"file_size_bytes": 4503599627370496,
"pixel_ratio": 1,
"state_id": "<string>",
"breakpoint_id": "<string>",
"focal_point": [
123
],
"format": "<string>",
"alt_text": "<string>",
"provenance": {
"digital_source_type": "digital_capture",
"synthetic_depiction": true,
"ai_tool": {
"name": "<string>",
"version": "<string>",
"provider": "<string>"
},
"human_oversight": "none",
"declared_by": {
"role": "creator",
"agent_url": "<string>"
},
"declared_at": "<string>",
"created_time": "<string>",
"c2pa": {
"manifest_url": "<string>"
},
"embedded_provenance": [
{
"method": "manifest_wrapper",
"provider": "<string>",
"standard": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"embedded_at": "<string>"
}
],
"watermarks": [
{
"media_type": "audio",
"provider": "<string>",
"verify_agent": {
"agent_url": "<string>",
"feature_id": "<string>"
},
"c2pa_action": "c2pa.watermarked.bound",
"embedded_at": "<string>"
}
],
"disclosure": {
"required": true,
"jurisdictions": [
{
"country": "<string>",
"regulation": "<string>",
"region": "<string>",
"label_text": "<string>",
"render_guidance": {
"persistence": "continuous",
"min_duration_ms": 4503599627370496,
"positions": [
"prominent"
],
"ext": {}
}
}
]
},
"verification": [
{
"verified_by": "<string>",
"result": "authentic",
"verified_time": "<string>",
"confidence": 0.5,
"details_url": "<string>"
}
],
"ext": {}
}
}
],
"title": "<string>",
"description": "<string>",
"specifications": [
{
"label": "<string>",
"value": "<string>"
}
],
"price_label": "<string>",
"cta_label": "<string>"
},
"pricingOptions": [
{
"pricingOptionId": "<string>",
"pricingModel": "<string>",
"isFixed": true,
"rate": 123,
"floorPrice": 123,
"fixedPrice": 123,
"maxBid": true,
"currency": "<string>",
"priceGuidance": {
"floor": 123,
"p25": 123,
"p50": 123,
"p75": 123,
"p90": 123
}
}
],
"estimatedExposures": 0,
"forecast": {},
"bookability": "<string>",
"publisherProperties": [
{
"publisherDomain": "<string>",
"propertyType": "<string>",
"name": "<string>",
"selectionType": "<string>",
"identifiers": [
{}
]
}
],
"isSandbox": true,
"formatOptions": [
{
"format_kind": "video_hosted",
"format_option_id": "<string>",
"display_name": "<string>",
"params": {
"containers": [
"mp4"
],
"video_codecs": [
"h264"
],
"audio_codecs": [
"aac"
]
}
}
],
"supportedTargeting": [
"<string>"
]
}
],
"proposals": [
{
"proposalId": "<string>",
"name": "<string>",
"allocations": [
{
"productId": "<string>",
"allocationPercentage": 50,
"pricingOptionId": "<string>",
"rationale": "<string>",
"sequence": 0,
"tags": [
"<string>"
]
}
],
"description": "<string>",
"briefAlignment": "<string>",
"salesAgentId": "<string>",
"salesAgentName": "<string>",
"storefrontId": "<string>",
"storefrontName": "<string>",
"supportedRoutingTypes": [
"DECISIONED"
],
"expiresAt": "<string>",
"totalBudgetGuidance": {
"min": 123,
"recommended": 123,
"max": 123,
"currency": "<string>"
}
}
]
},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"firstViewedAt": "2023-11-07T05:31:56Z",
"lastViewedAt": "2023-11-07T05:31:56Z",
"redeemedAt": "2023-11-07T05:31:56Z",
"redeemedInMediaBuyId": "<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
Proposal row id
Required range:
0 < x <= 9007199254740991Body
application/json
Request body for editing a storefront proposal
Updated label
Required string length:
1 - 255Updated notes
Maximum string length:
4000Updated expiry (ISO 8601)
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))$Response
Update storefront proposal
A persisted storefront proposal
Proposal row id
Required range:
0 < x <= 9007199254740991Short shareable handle. Sellers give this to buyers; buyers pass it to discover_products.
Example:
"PRP-XK4A29"
Encoded buyer identity retained for backwards compatibility. Use operatorRef for the structured form.
Structured buyer identity for redemption auth.
- Option 1
- Option 2
Show child attributes
Show child attributes
Proposal lifecycle status. 'active': available to redeem. 'redeemed': buyer has applied it to a media buy. 'expired': past TTL. 'revoked': seller withdrew.
Available options:
active, redeemed, expired, revoked 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))$The protocol-level proposalId from the saved discovery snapshot
Discovery session id this proposal was captured from (for traceability)
The frozen products + proposals returned to the buyer on redemption
Show child attributes
Show child attributes
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))$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))$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))$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))$