Get a canonical proposal artifact
curl --request GET \
--url https://api.interchange.io/api/v2/storefront/proposal-artifacts/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/storefront/proposal-artifacts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/storefront/proposal-artifacts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "<string>",
"storefrontId": "<string>",
"buyerCustomerId": 0,
"briefArtifactId": "<string>",
"chefComposeRunId": "<string>",
"version": 0,
"supersedesArtifactId": "<string>",
"schemaVersion": "<string>",
"redactionManifest": {
"redactedPaths": [
"<string>"
],
"truncated": [
{
"field": "<string>",
"reason": "<string>",
"originalByteSize": 0
}
]
},
"digest": "<string>",
"byteSize": 0,
"complete": true,
"createdAt": "<string>",
"response": "<unknown>",
"productSnapshots": "<unknown>"
}
}{
"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
Get a canonical proposal artifact
Fetch one proposal artifact including the exact response envelope and the resolved immutable product snapshots for every referenced product.
GET
/
proposal-artifacts
/
{id}
Get a canonical proposal artifact
curl --request GET \
--url https://api.interchange.io/api/v2/storefront/proposal-artifacts/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/storefront/proposal-artifacts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/storefront/proposal-artifacts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "<string>",
"storefrontId": "<string>",
"buyerCustomerId": 0,
"briefArtifactId": "<string>",
"chefComposeRunId": "<string>",
"version": 0,
"supersedesArtifactId": "<string>",
"schemaVersion": "<string>",
"redactionManifest": {
"redactedPaths": [
"<string>"
],
"truncated": [
{
"field": "<string>",
"reason": "<string>",
"originalByteSize": 0
}
]
},
"digest": "<string>",
"byteSize": 0,
"complete": true,
"createdAt": "<string>",
"response": "<unknown>",
"productSnapshots": "<unknown>"
}
}{
"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
Artifact id (UUID).
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)$Example:
"5f0c2a54-9c1b-4f0e-8a9d-3f4b2f4a1c11"
Response
Get a canonical proposal artifact
The canonical outbound proposal: exact response envelope + immutable product snapshots, with brief/run lineage.
Show child attributes
Show child attributes