API reference

Open Brand Exchange 0.1.0. Generated from the specification; the prose in docs/ is authoritative where this reference is silent.

APIs

• OBX Protocol normative

  What retailers' software reads: discovery, access, the change feed, products, images, exports, webhooks. OpenAPI (YAML)

• OBX Ingest API normative

  How a brand's own systems publish: idempotent writes, files by checksum, batches, imports, jobs. OpenAPI (YAML)

• Node Admin + Portal API non-normative

  The API behind the shared admin and retailer portal of the reference portals. OpenAPI (YAML)

JSON Schemas

AccessRequest, AccessRequestInput, Asset, AssetInput, Blob, Brand, BrandInput, Care, Change, ChangesPage, Color, Common, Directory, DirectoryEntry, DiscoveryDocument, Export, ExportManifestLine, ExportRequest, Grant, GtinLookupResult, ImportRowError, ImportRun, ImportSource, IngestInfo, IngestJob, IngestOperation, IngestRecord, IngestResult, LocalizedText, Materials, Problem, Product, ProductDetail, ProductInput, Provenance, Rendition, Rights, TokenResponse, Upload, Usage, UsageEvent, Variant, VariantInput, WebhookEvent, WebhookSubscription