Get an inventory source mapping workspace
curl --request GET \
--url https://api.interchange.io/api/v2/storefront/inventory-sources/{sourceId}/mapping-workspace \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/storefront/inventory-sources/{sourceId}/mapping-workspace"
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/inventory-sources/{sourceId}/mapping-workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"source": {
"id": "<string>",
"sourceId": "<string>",
"name": "<string>",
"status": "PENDING",
"executionType": "<string>",
"declaredAgentProductMode": "WHOLESALE",
"bindingProductMode": "WHOLESALE",
"effectiveProductMode": "WHOLESALE",
"runtimeReasons": [
"SOURCE_NOT_ACTIVE"
]
},
"productPaths": [
{
"productPath": "WHOLESALE",
"active": true,
"runtimeReady": true,
"runtimeReasons": [
"SOURCE_NOT_ACTIVE"
],
"sections": [
{
"id": "connection",
"label": "<string>",
"owner": "SUPPLIED_BY_CONNECTED_AGENT",
"access": "READ_ONLY",
"state": "READY",
"summary": "<string>",
"counts": {
"shared": 4503599627370495,
"source": 4503599627370495,
"mapped": 4503599627370495
},
"nextAction": {
"label": "<string>",
"owner": "SELLER",
"path": "<string>"
}
}
]
}
],
"storefrontProjection": {
"properties": {
"shared": 4503599627370495,
"source": 4503599627370495,
"mapped": 4503599627370495
},
"formats": {
"shared": 4503599627370495,
"source": 4503599627370495,
"mapped": 4503599627370495
},
"advertisers": {
"shared": 4503599627370495,
"source": 4503599627370495,
"mapped": 4503599627370495
}
},
"generatedAt": "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
Get an inventory source mapping workspace
Project shared Storefront identities through one exact inventory Source, with independent Storefront-built and Agent-supplied ownership, readiness, and retained inactive product-path state. This preview is hidden unless source-mapping-workspaces is enabled.
GET
/
inventory-sources
/
{sourceId}
/
mapping-workspace
Get an inventory source mapping workspace
curl --request GET \
--url https://api.interchange.io/api/v2/storefront/inventory-sources/{sourceId}/mapping-workspace \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/storefront/inventory-sources/{sourceId}/mapping-workspace"
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/inventory-sources/{sourceId}/mapping-workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"source": {
"id": "<string>",
"sourceId": "<string>",
"name": "<string>",
"status": "PENDING",
"executionType": "<string>",
"declaredAgentProductMode": "WHOLESALE",
"bindingProductMode": "WHOLESALE",
"effectiveProductMode": "WHOLESALE",
"runtimeReasons": [
"SOURCE_NOT_ACTIVE"
]
},
"productPaths": [
{
"productPath": "WHOLESALE",
"active": true,
"runtimeReady": true,
"runtimeReasons": [
"SOURCE_NOT_ACTIVE"
],
"sections": [
{
"id": "connection",
"label": "<string>",
"owner": "SUPPLIED_BY_CONNECTED_AGENT",
"access": "READ_ONLY",
"state": "READY",
"summary": "<string>",
"counts": {
"shared": 4503599627370495,
"source": 4503599627370495,
"mapped": 4503599627370495
},
"nextAction": {
"label": "<string>",
"owner": "SELLER",
"path": "<string>"
}
}
]
}
],
"storefrontProjection": {
"properties": {
"shared": 4503599627370495,
"source": 4503599627370495,
"mapped": 4503599627370495
},
"formats": {
"shared": 4503599627370495,
"source": 4503599627370495,
"mapped": 4503599627370495
},
"advertisers": {
"shared": 4503599627370495,
"source": 4503599627370495,
"mapped": 4503599627370495
}
},
"generatedAt": "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
Inventory source ID
Minimum string length:
1Response
Get an inventory source mapping workspace
Mode-aware, source-scoped mapping workspace. Shared identity counts are Storefront projections; source and mapped counts never imply coverage by another Source.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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))$