Skip to main content
POST
Run an inventory source discovery test

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

sourceId
string
required

Inventory source ID

Minimum string length: 1

Body

application/json

Input for a read-only, no-spend get_products diagnostic against one external sales-agent source.

brief
string

Optional bounded buyer brief sent directly to this source with get_products. A deterministic diagnostic brief is used when omitted.

Required string length: 1 - 2000

Response

Run an inventory source discovery test

Normalized result of a direct, read-only get_products diagnostic against one third-party sales-agent source.

source
object
required
operation
enum<string>
required
Available options:
get_products
outcome
enum<string>
required
Available options:
passed,
empty,
failed,
not_reached
message
string
required
productCount
integer
required
Required range: 0 <= x <= 9007199254740991
products
object[]
required

Representative matching products (id and name) from the source, capped at 20 items. products.length is at most productCount: items the source returned without a resolvable id are still counted in productCount but omitted from this list.

Maximum array length: 20
checkedAt
string<date-time>
required
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))$
durationMs
integer | null
required
Required range: 0 <= x <= 9007199254740991
trace
object | null
required
steps
object[]
required
run
object | null
required