{ "openapi": "3.0.3", "info": { "title": "ShelfRelay ONIX", "version": "1.0.0", "description": "Bounded ONIX3 physical-book normalization plus a free WooCommerce scheduled-update connector. Caller-owned prior state enables safe block merges. Explicit market/currency/price policy; no catalogue lookup or asset fetching. Read every record status before applying changes.", "termsOfService": "https://shelfrelay.flamingoapis.synology.me:8443/terms" }, "servers": [ { "url": "https://shelfrelay.flamingoapis.synology.me:8443" } ], "tags": [ { "name": "Catalogue" }, { "name": "Usage" } ], "paths": { "/v1/normalize": { "post": { "operationId": "normalizeCatalogue", "tags": [ "Catalogue" ], "summary": "Normalize a bounded batch of ONIX product envelopes", "description": "1–100 product envelopes, each XML/previousXML at most256KiB UTF8; JSON body at most8MiB. Accepts supported3.0/3.1 reference/short tags. Complete/block04/withdraw05 processing. Returns next_xml, source_hash, projection and diagnostics per record. HTTP200 can include rejected records. Completed batches debit calls/all submitted records/input bytes; unsafe or malformed envelopes return400.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizeRequest" }, "example": { "records": [ { "xml": "\n\n

USD01

\n \n shelfrelay-demo-00103\n 159781234567897\n 00BC\n 0101The Orchard Notebook (sample)\n 1A01Alex Example\n 01eng\n \n 0300A fictional demonstration book. Replace this record with your authorized catalogue.\n 01000302https://shelfrelay.flamingoapis.synology.me:8443/sample-cover.png\n \n 01Example Press04\n US01Example Distribution200118.50USD\n \n" } ], "policy": { "market_country": "US", "currency": "USD", "price_type": "01" } } } } }, "responses": { "200": { "description": "Processed batch; inspect each record status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizeResponse" } } } }, "400": { "description": "Invalid request/policy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Valid authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Unsupported subscription or cross-origin request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Input limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Unsupported content type/encoding", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Worker/resource limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Quota/rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Worker busy; respect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/usage": { "get": { "operationId": "getResourceUsage", "tags": [ "Usage" ], "summary": "Read backend UTC-month resource counters", "description": "No backend processing debit; can count as a RapidAPI Request. Not a keepalive.", "responses": { "200": { "description": "Account plan, current month, used counters and limits", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid request/policy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Valid authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Unsupported subscription or cross-origin request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Input limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Unsupported content type/encoding", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Worker/resource limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Quota/rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Worker busy; respect Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "NormalizeRequest": { "type": "object", "additionalProperties": false, "required": [ "records", "policy" ], "properties": { "records": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "additionalProperties": false, "required": [ "xml" ], "properties": { "xml": { "type": "string", "description": "One Product with ONIX release/namespace context. Header may contain only safe currency/price defaults." }, "previous_xml": { "type": "string", "description": "Opaque prior next_xml from the last applied state, required for block04 and record-only withdrawals." } } } }, "policy": { "type": "object", "additionalProperties": false, "required": [ "market_country", "currency", "price_type" ], "properties": { "market_country": { "type": "string", "pattern": "^[A-Z]{2}$", "example": "US" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "example": "USD" }, "price_type": { "type": "string", "enum": [ "01", "02" ], "description": "RRP01 excludes tax;02 includes tax. Match the store price-entry convention." }, "as_of": { "type": "string", "format": "date", "description": "Effective policy date; omitted uses today in UTC." }, "supplier_id": { "type": "object", "additionalProperties": false, "required": [ "type", "value" ], "properties": { "type": { "type": "string", "pattern": "^[0-9]{2}$" }, "value": { "type": "string", "maxLength": 200 } } }, "merchant_owned_fields": { "type": "array", "items": { "type": "string", "enum": [ "title", "description", "regular_price", "stock_status", "contributors", "publisher", "publication_date", "languages", "subjects", "cover_url", "product_form", "availability_code", "publishing_status", "price_includes_tax" ] }, "uniqueItems": true } } } } }, "NormalizeResponse": { "type": "object", "properties": { "ok": { "type": "boolean" }, "profile": { "type": "string" }, "summary": { "type": "object" }, "usage": { "type": "object" }, "results": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "status": { "type": "string", "enum": [ "ok", "rejected" ] }, "operation": { "type": "string", "nullable": true, "enum": [ "upsert", "withdraw", null ] }, "identity": { "type": "object", "nullable": true }, "next_xml": { "type": "string", "nullable": true }, "source_hash": { "type": "string", "nullable": true }, "projection": { "type": "object", "nullable": true, "description": "fields, field_states, apply_fields, merchant_owned_fields. Only apply documented value/clear mutations; unknown/absent preserve." }, "diagnostics": { "type": "array", "items": { "type": "object" } } } } } } }, "Error": { "type": "object", "required": [ "ok", "error" ], "properties": { "ok": { "type": "boolean", "example": false }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "security": [] }