A modular source's runtime projection: modules, lifecycle stages, active avails, catalog-mapping readiness
curl --request GET \
--url https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"inventorySource": {
"id": "<string>",
"storefrontId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"executionType": "MODULAR_SOURCE",
"status": "<string>",
"healthStatus": "<string>",
"lastError": "<string>",
"lastCheckedAt": "<string>",
"verificationMode": "LIVE_SOURCE"
},
"modules": [
{
"moduleRowId": "<string>",
"inventorySourceId": "<string>",
"moduleInstanceId": "<string>",
"kind": "INVENTORY_FEED",
"name": "<string>",
"provider": "<string>",
"status": "CONFIGURING",
"contractId": "<string>",
"contractVersion": "<string>",
"contract": null,
"configuredFieldKeys": [
"<string>"
],
"missingSetupFieldsBySource": [
{
"source": "MODULE_CONFIG",
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"source": "MODULE_CONFIG",
"valueType": "<string>",
"required": true,
"requiredFor": [
"LIST_ACCOUNTS"
]
}
]
}
],
"lifecycle": [
{
"stage": "LIST_ACCOUNTS",
"mode": "AUTOMATED",
"description": "<string>",
"outputKeys": [
"<string>"
],
"requiredFieldsBySource": [
{
"source": "MODULE_CONFIG",
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"source": "MODULE_CONFIG",
"valueType": "<string>",
"required": true,
"requiredFor": [
"LIST_ACCOUNTS"
]
}
]
}
],
"missingSetupFieldsBySource": [
{
"source": "MODULE_CONFIG",
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"source": "MODULE_CONFIG",
"valueType": "<string>",
"required": true,
"requiredFor": [
"LIST_ACCOUNTS"
]
}
]
}
],
"moduleConfigReady": true,
"workItemKind": "<string>"
}
],
"openWorkItemCount": 4503599627370495,
"openWorkItemCountsByKind": {},
"lastError": "<string>",
"lastCheckedAt": "<string>",
"issues": [
"<string>"
]
}
],
"lifecycleSummary": [
{
"stage": "LIST_ACCOUNTS",
"supported": true,
"status": "UNSUPPORTED",
"modes": [
"AUTOMATED"
],
"moduleInstanceIds": [
"<string>"
],
"moduleNames": [
"<string>"
],
"setupConfigured": true,
"runtimeInputsRequired": true,
"hitlRequired": true,
"openWorkItemCount": 4503599627370495,
"requiredRuntimeFieldSources": [
"MODULE_CONFIG"
],
"missingSetupFieldsBySource": [
{
"source": "MODULE_CONFIG",
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"source": "MODULE_CONFIG",
"valueType": "<string>",
"required": true,
"requiredFor": [
"LIST_ACCOUNTS"
]
}
]
}
],
"issues": [
"<string>"
]
}
],
"openWorkItemCount": 4503599627370495,
"activeAvailCount": 4503599627370495,
"catalogMappingReadiness": {
"verificationMode": "LIVE_SOURCE",
"sections": [
{
"id": "SET_UP_INVENTORY",
"title": "Set up inventory",
"rows": [
{
"id": "<string>",
"title": "<string>",
"requirement": "REQUIRED",
"status": "NOT_STARTED",
"evidence": [
{
"code": "<string>",
"summary": "<string>",
"observedAt": "<string>",
"value": "<string>"
}
],
"freshness": {
"state": "FRESH",
"observedAt": "<string>"
},
"sourceOfTruth": "INVENTORY_SOURCE",
"action": {
"operation": "open_modular_avails_commit",
"arguments": {
"sourceId": "<string>"
}
},
"externalOwner": "PUBLISHER",
"diagnostics": [
{
"code": "<string>",
"message": "<string>"
}
]
}
]
}
],
"progress": {
"ready": 0,
"applicable": 0,
"percent": 0
},
"requiredProgress": {
"ready": 0,
"applicable": 0,
"percent": 0
},
"nextAction": {
"operation": "open_modular_avails_commit",
"arguments": {
"sourceId": "<string>"
}
}
}
},
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": "<unknown>"
}
}Inventory Sources
A modular source's runtime projection: modules, lifecycle stages, active avails, catalog-mapping readiness
GET
/
api
/
v2
/
storefront
/
inventory-sources
/
{id}
/
modular
A modular source's runtime projection: modules, lifecycle stages, active avails, catalog-mapping readiness
curl --request GET \
--url https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.semicola.com/api/v2/storefront/inventory-sources/{id}/modular")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"inventorySource": {
"id": "<string>",
"storefrontId": "<string>",
"sourceId": "<string>",
"name": "<string>",
"executionType": "MODULAR_SOURCE",
"status": "<string>",
"healthStatus": "<string>",
"lastError": "<string>",
"lastCheckedAt": "<string>",
"verificationMode": "LIVE_SOURCE"
},
"modules": [
{
"moduleRowId": "<string>",
"inventorySourceId": "<string>",
"moduleInstanceId": "<string>",
"kind": "INVENTORY_FEED",
"name": "<string>",
"provider": "<string>",
"status": "CONFIGURING",
"contractId": "<string>",
"contractVersion": "<string>",
"contract": null,
"configuredFieldKeys": [
"<string>"
],
"missingSetupFieldsBySource": [
{
"source": "MODULE_CONFIG",
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"source": "MODULE_CONFIG",
"valueType": "<string>",
"required": true,
"requiredFor": [
"LIST_ACCOUNTS"
]
}
]
}
],
"lifecycle": [
{
"stage": "LIST_ACCOUNTS",
"mode": "AUTOMATED",
"description": "<string>",
"outputKeys": [
"<string>"
],
"requiredFieldsBySource": [
{
"source": "MODULE_CONFIG",
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"source": "MODULE_CONFIG",
"valueType": "<string>",
"required": true,
"requiredFor": [
"LIST_ACCOUNTS"
]
}
]
}
],
"missingSetupFieldsBySource": [
{
"source": "MODULE_CONFIG",
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"source": "MODULE_CONFIG",
"valueType": "<string>",
"required": true,
"requiredFor": [
"LIST_ACCOUNTS"
]
}
]
}
],
"moduleConfigReady": true,
"workItemKind": "<string>"
}
],
"openWorkItemCount": 4503599627370495,
"openWorkItemCountsByKind": {},
"lastError": "<string>",
"lastCheckedAt": "<string>",
"issues": [
"<string>"
]
}
],
"lifecycleSummary": [
{
"stage": "LIST_ACCOUNTS",
"supported": true,
"status": "UNSUPPORTED",
"modes": [
"AUTOMATED"
],
"moduleInstanceIds": [
"<string>"
],
"moduleNames": [
"<string>"
],
"setupConfigured": true,
"runtimeInputsRequired": true,
"hitlRequired": true,
"openWorkItemCount": 4503599627370495,
"requiredRuntimeFieldSources": [
"MODULE_CONFIG"
],
"missingSetupFieldsBySource": [
{
"source": "MODULE_CONFIG",
"fields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"source": "MODULE_CONFIG",
"valueType": "<string>",
"required": true,
"requiredFor": [
"LIST_ACCOUNTS"
]
}
]
}
],
"issues": [
"<string>"
]
}
],
"openWorkItemCount": 4503599627370495,
"activeAvailCount": 4503599627370495,
"catalogMappingReadiness": {
"verificationMode": "LIVE_SOURCE",
"sections": [
{
"id": "SET_UP_INVENTORY",
"title": "Set up inventory",
"rows": [
{
"id": "<string>",
"title": "<string>",
"requirement": "REQUIRED",
"status": "NOT_STARTED",
"evidence": [
{
"code": "<string>",
"summary": "<string>",
"observedAt": "<string>",
"value": "<string>"
}
],
"freshness": {
"state": "FRESH",
"observedAt": "<string>"
},
"sourceOfTruth": "INVENTORY_SOURCE",
"action": {
"operation": "open_modular_avails_commit",
"arguments": {
"sourceId": "<string>"
}
},
"externalOwner": "PUBLISHER",
"diagnostics": [
{
"code": "<string>",
"message": "<string>"
}
]
}
]
}
],
"progress": {
"ready": 0,
"applicable": 0,
"percent": 0
},
"requiredProgress": {
"ready": 0,
"applicable": 0,
"percent": 0
},
"nextAction": {
"operation": "open_modular_avails_commit",
"arguments": {
"sourceId": "<string>"
}
}
}
},
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": "<unknown>"
}
}