Execute a pinned merchandising simulation variant
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/simulator/scenarios/{scenarioId}/revisions/{revisionId}/variants/{variantId}/executions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.interchange.io/api/v2/storefront/simulator/scenarios/{scenarioId}/revisions/{revisionId}/variants/{variantId}/executions"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.interchange.io/api/v2/storefront/simulator/scenarios/{scenarioId}/revisions/{revisionId}/variants/{variantId}/executions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intelligenceRunId": "<string>",
"attemptNumber": 4503599627370495,
"status": "succeeded",
"resultCode": "<string>",
"inputDigest": "<string>",
"overrideDigest": "<string>",
"outputDigest": "<string>",
"decisionRecord": {
"id": "<string>",
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"purpose": {
"availability": "recorded",
"value": "live"
},
"buyer": {
"operatorDomain": "<string>",
"brandDomain": "<string>",
"country": "<string>",
"customerId": 0
},
"ask": {
"brief": "<string>",
"buyingMode": "<string>",
"requestAsks": [
"<string>"
],
"inputSnapshotAvailability": "recorded"
},
"fit": {
"disposition": "responded",
"qualified": true,
"reasonAxis": "fit",
"reason": "<string>",
"policyDecision": "definitely_on_policy",
"matchedProducts": [
{
"productId": "<string>",
"name": "<string>",
"description": "<string>",
"reasoning": "<string>",
"pricing": {
"baseCpm": 123,
"currency": "<string>",
"operatorDiscount": 123,
"finalCpm": 123
},
"bundleIds": [
"<string>"
],
"signalIds": [
"<string>"
],
"formatIds": [
{
"agentUrl": "<string>",
"id": "<string>"
}
]
}
],
"unavailableProducts": [
{
"name": "<string>",
"reasoning": "<string>",
"reason": "<string>",
"bundleIds": [
"<string>"
],
"signalIds": [
"<string>"
]
}
]
},
"posture": {
"recommended": "direct_fit",
"selected": "direct_fit",
"rationale": "<string>",
"intensity": "low",
"signals": [
"<string>"
],
"guidance": [
"<string>"
],
"matchedPricingFactIds": [
"<string>"
],
"operatingInstructionsVersion": 0,
"matchedBuyerInstructionIds": [
"<string>"
],
"override": {
"availability": "recorded",
"actor": "<string>"
},
"acceptancePolicyVersion": {
"availability": "recorded",
"value": 0
}
},
"response": {
"status": "responded",
"summary": "<string>",
"exactSentState": {
"availability": "recorded",
"productCount": 4503599627370495,
"proposalHistoryAvailability": "recorded"
},
"negotiationChanges": {
"requestAsks": [
"<string>"
],
"refinementApplied": null
},
"limitations": [
"<string>"
]
},
"approval": {
"availability": "recorded",
"id": "<string>",
"status": "pending",
"reviewedBy": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z",
"reviewerNotes": "<string>",
"forwardedAt": "2023-11-07T05:31:56Z"
},
"outcome": {
"state": "pending",
"eventType": "<string>",
"eventAt": "2023-11-07T05:31:56Z",
"mediaBuyId": "<string>",
"mediaBuyStatus": "<string>",
"pendingApprovalId": "<string>",
"bookedBudget": 123,
"deliveredImpressions": 123,
"deliveredSpend": 123,
"deliveredCurrency": "<string>",
"attribution": {
"availability": "recorded",
"model": "<string>",
"matchedRunId": "<string>",
"matchedProductIds": [
"<string>"
]
}
},
"learning": {
"analyticsEligibility": {
"status": "eligible",
"reason": "<string>"
},
"postureContribution": {
"availability": "recorded",
"selected": "direct_fit",
"recommended": "direct_fit"
},
"recommendationLineage": {
"availability": "recorded"
}
},
"provenance": {
"modelProvider": "<string>",
"modelName": "<string>",
"operatingInstructionsVersion": 0,
"durationMs": 0
}
},
"sourceScope": {
"mode": "storefront",
"sourceId": null,
"sourceName": null,
"diagnostics": {
"includedBundleCount": 0,
"includedSignalCount": 0,
"excludedBundleCount": 0,
"excludedSignalCount": 0,
"missingLineageCount": 0,
"ambiguousLineageCount": 0,
"crossSourceLineageCount": 0
}
},
"createdByUserId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}{
"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": {}
}
}{
"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
Execute a pinned merchandising simulation variant
Execute one unexpired pinned variant through the resolved merchandising engine and append an immutable Seller Decision Record. The empty request body cannot replace frozen inputs or mutate live Storefront controls.
POST
/
simulator
/
scenarios
/
{scenarioId}
/
revisions
/
{revisionId}
/
variants
/
{variantId}
/
executions
Execute a pinned merchandising simulation variant
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/simulator/scenarios/{scenarioId}/revisions/{revisionId}/variants/{variantId}/executions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.interchange.io/api/v2/storefront/simulator/scenarios/{scenarioId}/revisions/{revisionId}/variants/{variantId}/executions"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.interchange.io/api/v2/storefront/simulator/scenarios/{scenarioId}/revisions/{revisionId}/variants/{variantId}/executions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"intelligenceRunId": "<string>",
"attemptNumber": 4503599627370495,
"status": "succeeded",
"resultCode": "<string>",
"inputDigest": "<string>",
"overrideDigest": "<string>",
"outputDigest": "<string>",
"decisionRecord": {
"id": "<string>",
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"purpose": {
"availability": "recorded",
"value": "live"
},
"buyer": {
"operatorDomain": "<string>",
"brandDomain": "<string>",
"country": "<string>",
"customerId": 0
},
"ask": {
"brief": "<string>",
"buyingMode": "<string>",
"requestAsks": [
"<string>"
],
"inputSnapshotAvailability": "recorded"
},
"fit": {
"disposition": "responded",
"qualified": true,
"reasonAxis": "fit",
"reason": "<string>",
"policyDecision": "definitely_on_policy",
"matchedProducts": [
{
"productId": "<string>",
"name": "<string>",
"description": "<string>",
"reasoning": "<string>",
"pricing": {
"baseCpm": 123,
"currency": "<string>",
"operatorDiscount": 123,
"finalCpm": 123
},
"bundleIds": [
"<string>"
],
"signalIds": [
"<string>"
],
"formatIds": [
{
"agentUrl": "<string>",
"id": "<string>"
}
]
}
],
"unavailableProducts": [
{
"name": "<string>",
"reasoning": "<string>",
"reason": "<string>",
"bundleIds": [
"<string>"
],
"signalIds": [
"<string>"
]
}
]
},
"posture": {
"recommended": "direct_fit",
"selected": "direct_fit",
"rationale": "<string>",
"intensity": "low",
"signals": [
"<string>"
],
"guidance": [
"<string>"
],
"matchedPricingFactIds": [
"<string>"
],
"operatingInstructionsVersion": 0,
"matchedBuyerInstructionIds": [
"<string>"
],
"override": {
"availability": "recorded",
"actor": "<string>"
},
"acceptancePolicyVersion": {
"availability": "recorded",
"value": 0
}
},
"response": {
"status": "responded",
"summary": "<string>",
"exactSentState": {
"availability": "recorded",
"productCount": 4503599627370495,
"proposalHistoryAvailability": "recorded"
},
"negotiationChanges": {
"requestAsks": [
"<string>"
],
"refinementApplied": null
},
"limitations": [
"<string>"
]
},
"approval": {
"availability": "recorded",
"id": "<string>",
"status": "pending",
"reviewedBy": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z",
"reviewerNotes": "<string>",
"forwardedAt": "2023-11-07T05:31:56Z"
},
"outcome": {
"state": "pending",
"eventType": "<string>",
"eventAt": "2023-11-07T05:31:56Z",
"mediaBuyId": "<string>",
"mediaBuyStatus": "<string>",
"pendingApprovalId": "<string>",
"bookedBudget": 123,
"deliveredImpressions": 123,
"deliveredSpend": 123,
"deliveredCurrency": "<string>",
"attribution": {
"availability": "recorded",
"model": "<string>",
"matchedRunId": "<string>",
"matchedProductIds": [
"<string>"
]
}
},
"learning": {
"analyticsEligibility": {
"status": "eligible",
"reason": "<string>"
},
"postureContribution": {
"availability": "recorded",
"selected": "direct_fit",
"recommended": "direct_fit"
},
"recommendationLineage": {
"availability": "recorded"
}
},
"provenance": {
"modelProvider": "<string>",
"modelName": "<string>",
"operatingInstructionsVersion": 0,
"durationMs": 0
}
},
"sourceScope": {
"mode": "storefront",
"sourceId": null,
"sourceName": null,
"diagnostics": {
"includedBundleCount": 0,
"includedSignalCount": 0,
"excludedBundleCount": 0,
"excludedSignalCount": 0,
"missingLineageCount": 0,
"ambiguousLineageCount": 0,
"crossSourceLineageCount": 0
}
},
"createdByUserId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}{
"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": {}
}
}{
"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
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
application/json
The body is of type object.
Response
Execute a pinned merchandising simulation variant
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required range:
0 < x <= 9007199254740991Available options:
succeeded, failed Pattern:
^[a-f0-9]{64}$Pattern:
^[a-f0-9]{64}$Pattern:
^[a-f0-9]{64}$Canonical seller-readable decision record projected from one storefront intelligence run and its attributed approval/commercial evidence.
Show child attributes
Show child attributes
- Option 1
- Option 2
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))$