{ "openapi": "3.0.4", "info": { "title": "NeutronEdi.Api | v1", "version": "1.0.0" }, "servers": [ { "url": "http://api.neutronedi.com/" } ], "paths": { "/api/v1/read/x12": { "post": { "tags": [ "EDI Operations" ], "summary": "Parse raw X12 EDI content into structured JSON or XML", "description": "Accepts raw X12 EDI text and returns parsed transaction sets. Use Accept: application/xml or ?format=xml for XML output. Errors are always returned as JSON.", "operationId": "ReadX12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadX12Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadX12Result" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReadX12Result" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadX12Result" } } } }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } } } }, "/api/v1/read/edifact": { "post": { "tags": [ "EDI Operations" ], "summary": "Parse raw EDIFACT EDI content into structured JSON or XML", "description": "Accepts raw EDIFACT EDI text and returns parsed messages. Use Accept: application/xml or ?format=xml for XML output. Errors are always returned as JSON.", "operationId": "ReadEdifact", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadEdifactRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadEdifactResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReadEdifactResult" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadEdifactResult" } } } }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } } } }, "/api/v1/write/x12": { "post": { "tags": [ "EDI Operations" ], "summary": "Generate raw X12 EDI output from JSON", "description": "Accepts an X12 interchange as JSON with ISA, Groups (containing GS and Transactions), and IEA. Version and transaction set ID are extracted automatically. Optional top-level delimiters configure elementSeparator, componentSeparator, segmentTerminator, and repetitionSeparator as single characters.", "operationId": "WriteX12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteX12Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteX12Result" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteX12Result" } } } }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } } } }, "/api/v1/write/edifact": { "post": { "tags": [ "EDI Operations" ], "summary": "Generate raw EDIFACT EDI output from JSON", "description": "Accepts an EDIFACT interchange as JSON with UNB, Messages (containing UNH), and optional UNG. Version and message type are extracted automatically.", "operationId": "WriteEdifact", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteEdifactRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteEdifactResult" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteEdifactResult" } } } }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } } } }, "/api/v1/validate/x12": { "post": { "tags": [ "EDI Operations" ], "summary": "Validate raw X12 EDI content against EDI specifications", "description": "Accepts raw X12 EDI text and returns a detailed validation report including errors and warnings.", "operationId": "ValidateX12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateX12Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateX12Result" } } } }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } } } }, "/api/v1/validate/edifact": { "post": { "tags": [ "EDI Operations" ], "summary": "Validate raw EDIFACT EDI content against EDI specifications", "description": "Accepts raw EDIFACT EDI text and returns a detailed validation report including errors and warnings.", "operationId": "ValidateEdifact", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateEdifactRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateEdifactResult" } } } }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } } } }, "/api/v1/interchange/receive/x12": { "post": { "tags": [ "EDI Operations" ], "summary": "Receive an inbound X12 interchange with partner tracking", "description": "Parses raw X12 EDI, records the interchange, resolves the trading partner, applies partner validation rules, and performs duplicate detection and 997 acknowledgment matching.", "operationId": "ReceiveX12", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiveX12Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiveX12Result" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReceiveX12Result" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiveX12Result" } } } }, "401": { "description": "Unauthorized" }, "409": { "description": "Conflict" }, "429": { "description": "Too Many Requests" } } } }, "/api/v1/profiles/catalog": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ProfileCatalog", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileCatalog" } } } } } } }, "/api/v1/profiles/template": { "post": { "tags": [ "Document Pipeline" ], "operationId": "ProfileTemplate", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDefinition" } } } } } } }, "/api/v1/profiles": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ListProfiles", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilePage" } } } } } }, "post": { "tags": [ "Document Pipeline" ], "operationId": "CreateProfile", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } } }, "/api/v1/profiles/{id}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } }, "put": { "tags": [ "Document Pipeline" ], "operationId": "UpdateProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } } }, "/api/v1/profile-revisions/{id}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetProfileRevision", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileRevisionDetail" } } } } } } }, "/api/v1/profiles/{id}/export": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ExportProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/profiles/import": { "post": { "tags": [ "Document Pipeline" ], "operationId": "ImportProfile", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } } }, "/api/v1/profiles/{id}/publish": { "post": { "tags": [ "Document Pipeline" ], "operationId": "PublishProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileRevisionDetail" } } } } } } }, "/api/v1/profiles/{id}/archive": { "post": { "tags": [ "Document Pipeline" ], "operationId": "ArchiveProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } } }, "/api/v1/mappers/validate": { "post": { "tags": [ "Document Pipeline" ], "operationId": "ValidateMapperDraft", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperValidationResult" } } } } } } }, "/api/v1/mappers/preview": { "post": { "tags": [ "Document Pipeline" ], "operationId": "PreviewMapper", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperPreviewResult" } } } } } } }, "/api/v1/mappers": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ListMappers", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperPage" } } } } } }, "post": { "tags": [ "Document Pipeline" ], "operationId": "CreateMapper", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperDetail" } } } } } } }, "/api/v1/mappers/{id}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetMapper", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperDetail" } } } } } }, "put": { "tags": [ "Document Pipeline" ], "operationId": "UpdateMapper", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperDetail" } } } } } } }, "/api/v1/mapper-revisions/{id}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetMapperRevision", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperRevisionDetail" } } } } } } }, "/api/v1/mappers/{id}/publish": { "post": { "tags": [ "Document Pipeline" ], "operationId": "PublishMapper", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperRevisionDetail" } } } } } } }, "/api/v1/mappers/{id}/archive": { "post": { "tags": [ "Document Pipeline" ], "operationId": "ArchiveMapper", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperDetail" } } } } } } }, "/api/v1/mapped-documents": { "post": { "tags": [ "Document Pipeline" ], "operationId": "RunMapperDirectly", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunMapperResult" } } } } } } }, "/api/v1/mapped-documents/{runId}/artifacts/{artifactId}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "DownloadMappedDocumentArtifact", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/pipeline/runs": { "post": { "tags": [ "Document Pipeline" ], "operationId": "AcceptPipelineDocument", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineAccepted" } } } } } }, "get": { "tags": [ "Document Pipeline" ], "operationId": "ListPipelineRuns", "responses": { "200": { "description": "OK" } } } }, "/api/v1/pipeline/runs/{runId}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetPipelineRun", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/pipeline/runs/{runId}/artifacts/{artifactId}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "DownloadPipelineArtifact", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/pipeline/runs/{runId}/reprocess": { "post": { "tags": [ "Document Pipeline" ], "operationId": "ReprocessPipelineRun", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReprocessRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/orders": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ListOrders", "responses": { "200": { "description": "OK" } } } }, "/api/v1/orders/{orderId}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetOrders", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/imported-orders": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ListImportedOrders", "responses": { "200": { "description": "OK" } } } }, "/api/v1/imported-orders/{orderId}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetImportedOrders", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/shopify-sources/{shopId}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetShopifySourceConfiguration", "parameters": [ { "name": "shopId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Document Pipeline" ], "operationId": "ConfigureShopifySource", "parameters": [ { "name": "shopId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/partners/{partnerId}/documents": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ListSupportedDocuments", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedDocumentSummary" } } } } } } }, "post": { "tags": [ "Document Pipeline" ], "operationId": "AddSupportedDocument", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedDocumentSummary" } } } } } } }, "/api/v1/partners/{partnerId}/documents/{id}/remove": { "post": { "tags": [ "Document Pipeline" ], "operationId": "RemoveSupportedDocument", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedDocumentSummary" } } } } } } }, "/api/v1/partners/{partnerId}/documents/{id}/mapper": { "put": { "tags": [ "Document Pipeline" ], "operationId": "AssignDocumentMapper", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedDocumentSummary" } } } } } } }, "/api/v1/partners/{partnerId}/eligible-mappers": { "get": { "tags": [ "Document Pipeline" ], "operationId": "EligibleDocumentMappers", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "documentCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "documentVersion", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EligibleMapper" } } } } } } } }, "/api/v1/pipeline/shops": { "get": { "tags": [ "Document Pipeline" ], "operationId": "LinkedPipelineShops", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedShopSummary" } } } } } } } }, "/api/v1/partners/{partnerId}/shopify-bindings": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ListShopifyBindings", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShopifyBindingSummary" } } } } } } }, "post": { "tags": [ "Document Pipeline" ], "operationId": "AddShopifyBinding", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/partners/{partnerId}/shopify-bindings/{id}": { "delete": { "tags": [ "Document Pipeline" ], "operationId": "RemoveShopifyBinding", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/items": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ListItems", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "partnerId", "in": "query", "schema": { "type": "string" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPageOfItemDetail" } } } } } }, "post": { "tags": [ "Document Pipeline" ], "operationId": "CreateItem", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/api/v1/items/{id}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } }, "put": { "tags": [ "Document Pipeline" ], "operationId": "UpdateItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/api/v1/items/{id}/archive": { "post": { "tags": [ "Document Pipeline" ], "operationId": "ArchiveItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/api/v1/items/{id}/source-identifiers": { "post": { "tags": [ "Document Pipeline" ], "operationId": "AddItemIdentifier", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/api/v1/items/{id}/source-identifiers/{identifierId}/remove": { "post": { "tags": [ "Document Pipeline" ], "operationId": "RemoveItemIdentifier", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "identifierId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/api/v1/item-reference-tables": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ListReferenceTables", "parameters": [ { "name": "partnerId", "in": "query", "schema": { "type": "string" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPageOfReferenceTableDetail" } } } } } }, "post": { "tags": [ "Document Pipeline" ], "operationId": "CreateReferenceTable", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } } }, "/api/v1/item-reference-tables/{id}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetReferenceTable", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } }, "put": { "tags": [ "Document Pipeline" ], "operationId": "UpdateReferenceTable", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } } }, "/api/v1/item-reference-tables/{id}/archive": { "post": { "tags": [ "Document Pipeline" ], "operationId": "ArchiveReferenceTable", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } } }, "/api/v1/item-reference-tables/{id}/rows": { "get": { "tags": [ "Document Pipeline" ], "operationId": "ListReferenceRows", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPageOfReferenceRowDetail" } } } } } }, "post": { "tags": [ "Document Pipeline" ], "operationId": "CreateReferenceRow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceRowDetail" } } } } } } }, "/api/v1/item-reference-tables/{id}/rows/{rowId}": { "put": { "tags": [ "Document Pipeline" ], "operationId": "UpdateReferenceRow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceRowDetail" } } } } } } }, "/api/v1/item-reference-tables/{id}/rows/{rowId}/remove": { "post": { "tags": [ "Document Pipeline" ], "operationId": "RemoveReferenceRow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } } }, "/api/v1/item-reference-tables/{id}/lookup": { "post": { "tags": [ "Document Pipeline" ], "operationId": "LookupReferenceRow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceRowDetail" } } } } } } }, "/api/v1/item-imports/preview": { "post": { "tags": [ "Document Pipeline" ], "operationId": "PreviewItemImport", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogImportPreview" } } } } } } }, "/api/v1/item-imports/{id}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetItemImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogImportPreview" } } } } } } }, "/api/v1/item-imports/{id}/commit": { "post": { "tags": [ "Document Pipeline" ], "operationId": "CommitItemImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogImportResult" } } } } } } }, "/api/v1/reference-imports/phase-ii/preview": { "post": { "tags": [ "Document Pipeline" ], "operationId": "PreviewPhaseIiImport", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseIiImportReview" } } } } } } }, "/api/v1/reference-imports/{id}": { "get": { "tags": [ "Document Pipeline" ], "operationId": "GetReferenceImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseIiImportReview" } } } } } } }, "/api/v1/reference-imports/{id}/review": { "put": { "tags": [ "Document Pipeline" ], "operationId": "ReviewPhaseIiImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseIiImportReview" } } } } } } }, "/api/v1/reference-imports/{id}/commit": { "post": { "tags": [ "Document Pipeline" ], "operationId": "CommitPhaseIiImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogImportResult" } } } } } } }, "/internal/v1/profiles/catalog": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalProfileCatalog", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileCatalog" } } } } } } }, "/internal/v1/profiles/template": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalProfileTemplate", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDefinition" } } } } } } }, "/internal/v1/profiles": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListProfiles", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilePage" } } } } } }, "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalCreateProfile", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } } }, "/internal/v1/profiles/{id}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } }, "put": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalUpdateProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } } }, "/internal/v1/profile-revisions/{id}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetProfileRevision", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileRevisionDetail" } } } } } } }, "/internal/v1/profiles/{id}/export": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalExportProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/internal/v1/profiles/import": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalImportProfile", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } } }, "/internal/v1/profiles/{id}/publish": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalPublishProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileRevisionDetail" } } } } } } }, "/internal/v1/profiles/{id}/archive": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalArchiveProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetail" } } } } } } }, "/internal/v1/mappers/validate": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalValidateMapperDraft", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperValidationResult" } } } } } } }, "/internal/v1/mappers/preview": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalPreviewMapper", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperPreviewResult" } } } } } } }, "/internal/v1/mappers": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListMappers", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperPage" } } } } } }, "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalCreateMapper", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperDetail" } } } } } } }, "/internal/v1/mappers/{id}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetMapper", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperDetail" } } } } } }, "put": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalUpdateMapper", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperDetail" } } } } } } }, "/internal/v1/mapper-revisions/{id}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetMapperRevision", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperRevisionDetail" } } } } } } }, "/internal/v1/mappers/{id}/publish": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalPublishMapper", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperRevisionDetail" } } } } } } }, "/internal/v1/mappers/{id}/archive": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalArchiveMapper", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapperDetail" } } } } } } }, "/internal/v1/mapped-documents": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalRunMapperDirectly", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunMapperResult" } } } } } } }, "/internal/v1/mapped-documents/{runId}/artifacts/{artifactId}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalDownloadMappedDocumentArtifact", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/internal/v1/pipeline/runs": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalAcceptPipelineDocument", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineAccepted" } } } } } }, "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListPipelineRuns", "responses": { "200": { "description": "OK" } } } }, "/internal/v1/pipeline/runs/{runId}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetPipelineRun", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/internal/v1/pipeline/runs/{runId}/artifacts/{artifactId}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalDownloadPipelineArtifact", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "artifactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/internal/v1/pipeline/runs/{runId}/reprocess": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalReprocessPipelineRun", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReprocessRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/internal/v1/orders": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListOrders", "responses": { "200": { "description": "OK" } } } }, "/internal/v1/orders/{orderId}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetOrders", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/internal/v1/imported-orders": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListImportedOrders", "responses": { "200": { "description": "OK" } } } }, "/internal/v1/imported-orders/{orderId}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetImportedOrders", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/internal/v1/shopify-sources/{shopId}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetShopifySourceConfiguration", "parameters": [ { "name": "shopId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalConfigureShopifySource", "parameters": [ { "name": "shopId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/internal/v1/partners/{partnerId}/documents": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListSupportedDocuments", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedDocumentSummary" } } } } } } }, "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalAddSupportedDocument", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedDocumentSummary" } } } } } } }, "/internal/v1/partners/{partnerId}/documents/{id}/remove": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalRemoveSupportedDocument", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedDocumentSummary" } } } } } } }, "/internal/v1/partners/{partnerId}/documents/{id}/mapper": { "put": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalAssignDocumentMapper", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedDocumentSummary" } } } } } } }, "/internal/v1/partners/{partnerId}/eligible-mappers": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalEligibleDocumentMappers", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "documentCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "documentVersion", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EligibleMapper" } } } } } } } }, "/internal/v1/pipeline/shops": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalLinkedPipelineShops", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedShopSummary" } } } } } } } }, "/internal/v1/partners/{partnerId}/shopify-bindings": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListShopifyBindings", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShopifyBindingSummary" } } } } } } }, "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalAddShopifyBinding", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/internal/v1/partners/{partnerId}/shopify-bindings/{id}": { "delete": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalRemoveShopifyBinding", "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/internal/v1/items": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListItems", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "partnerId", "in": "query", "schema": { "type": "string" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPageOfItemDetail" } } } } } }, "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalCreateItem", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/internal/v1/items/{id}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } }, "put": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalUpdateItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/internal/v1/items/{id}/archive": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalArchiveItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/internal/v1/items/{id}/source-identifiers": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalAddItemIdentifier", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/internal/v1/items/{id}/source-identifiers/{identifierId}/remove": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalRemoveItemIdentifier", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "identifierId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDetail" } } } } } } }, "/internal/v1/item-reference-tables": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListReferenceTables", "parameters": [ { "name": "partnerId", "in": "query", "schema": { "type": "string" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPageOfReferenceTableDetail" } } } } } }, "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalCreateReferenceTable", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } } }, "/internal/v1/item-reference-tables/{id}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetReferenceTable", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } }, "put": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalUpdateReferenceTable", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } } }, "/internal/v1/item-reference-tables/{id}/archive": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalArchiveReferenceTable", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } } }, "/internal/v1/item-reference-tables/{id}/rows": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalListReferenceRows", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPageOfReferenceRowDetail" } } } } } }, "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalCreateReferenceRow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceRowDetail" } } } } } } }, "/internal/v1/item-reference-tables/{id}/rows/{rowId}": { "put": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalUpdateReferenceRow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceRowDetail" } } } } } } }, "/internal/v1/item-reference-tables/{id}/rows/{rowId}/remove": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalRemoveReferenceRow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "rowId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceTableDetail" } } } } } } }, "/internal/v1/item-reference-tables/{id}/lookup": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalLookupReferenceRow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceRowDetail" } } } } } } }, "/internal/v1/item-imports/preview": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalPreviewItemImport", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogImportPreview" } } } } } } }, "/internal/v1/item-imports/{id}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetItemImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogImportPreview" } } } } } } }, "/internal/v1/item-imports/{id}/commit": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalCommitItemImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogImportResult" } } } } } } }, "/internal/v1/reference-imports/phase-ii/preview": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalPreviewPhaseIiImport", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseIiImportReview" } } } } } } }, "/internal/v1/reference-imports/{id}": { "get": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalGetReferenceImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseIiImportReview" } } } } } } }, "/internal/v1/reference-imports/{id}/review": { "put": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalReviewPhaseIiImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseIiImportReview" } } } } } } }, "/internal/v1/reference-imports/{id}/commit": { "post": { "tags": [ "Internal Document Pipeline" ], "operationId": "InternalCommitPhaseIiImport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogImportResult" } } } } } } } }, "components": { "schemas": { "AdapterCompatibility": { "required": [ "adapterId", "version", "templateFingerprint" ], "type": "object", "properties": { "adapterId": { "type": "string" }, "version": { "type": "string" }, "templateFingerprint": { "type": "string", "nullable": true } } }, "AdapterDescriptor": { "required": [ "id", "version", "format", "canInferStructure", "usesEnvelopes" ], "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "string" }, "format": { "$ref": "#/components/schemas/DocumentFormat" }, "canInferStructure": { "type": "boolean" }, "usesEnvelopes": { "type": "boolean" } } }, "AdapterExecutionContext": { "required": [ "timestamp", "isPreview", "controlNumbers", "envelopeContext" ], "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "isPreview": { "type": "boolean" }, "controlNumbers": { "type": "object", "additionalProperties": { "type": "string" } }, "envelopeContext": { "$ref": "#/components/schemas/JsonElement" } } }, "CatalogDiagnostic": { "required": [ "code", "path", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "path": { "type": "string" }, "message": { "type": "string" }, "sheet": { "type": "string", "default": null, "nullable": true }, "row": { "type": "integer", "format": "int32", "default": null, "nullable": true }, "column": { "type": "string", "default": null, "nullable": true } } }, "CatalogImportPreview": { "required": [ "schemaVersion", "id", "kind", "partnerId", "fileName", "sha256", "parserVersion", "version", "status", "items", "references", "diagnostics" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "kind": { "type": "string" }, "partnerId": { "type": "string", "nullable": true }, "fileName": { "type": "string" }, "sha256": { "type": "string" }, "parserVersion": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemImportRow" } }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceImportRow" } }, "diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogDiagnostic" } } } }, "CatalogImportResult": { "required": [ "schemaVersion", "id", "version", "status", "created", "updated", "unchanged", "committedAt" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "updated": { "type": "integer", "format": "int32" }, "unchanged": { "type": "integer", "format": "int32" }, "committedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CatalogPageOfItemDetail": { "required": [ "schemaVersion", "items", "page", "pageSize", "total" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDetail" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "CatalogPageOfReferenceRowDetail": { "required": [ "schemaVersion", "items", "page", "pageSize", "total" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRowDetail" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "CatalogPageOfReferenceTableDetail": { "required": [ "schemaVersion", "items", "page", "pageSize", "total" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceTableDetail" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "CollectionRule": { "required": [ "id", "sourceNodeId", "destinationNodeId", "fields", "collections" ], "type": "object", "properties": { "id": { "type": "string" }, "sourceNodeId": { "type": "string" }, "destinationNodeId": { "type": "string" }, "fields": { "type": "array", "items": { } }, "collections": { "type": "array", "items": { } }, "include": { "default": null } } }, "DocumentDiagnostic": { "required": [ "code", "path", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "path": { "type": "string" }, "message": { "type": "string" }, "ruleId": { "type": "string", "default": null, "nullable": true } } }, "DocumentFormat": { "enum": [ "x12", "json", "xml", "shopify-order-webhook" ] }, "DocumentIdentity": { "required": [ "format", "code", "version" ], "type": "object", "properties": { "format": { "$ref": "#/components/schemas/DocumentFormat" }, "code": { "type": "string" }, "version": { "type": "string" } } }, "DocumentValue": { "required": [ "kind" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/DocumentValueMissingValue" }, { "$ref": "#/components/schemas/DocumentValueNullValue" }, { "$ref": "#/components/schemas/DocumentValueStringValue" }, { "$ref": "#/components/schemas/DocumentValueIntegerValue" }, { "$ref": "#/components/schemas/DocumentValueDecimalValue" }, { "$ref": "#/components/schemas/DocumentValueBooleanValue" }, { "$ref": "#/components/schemas/DocumentValueObjectValue" }, { "$ref": "#/components/schemas/DocumentValueArrayValue" } ], "discriminator": { "propertyName": "kind", "mapping": { "missing": "#/components/schemas/DocumentValueMissingValue", "null": "#/components/schemas/DocumentValueNullValue", "string": "#/components/schemas/DocumentValueStringValue", "integer": "#/components/schemas/DocumentValueIntegerValue", "decimal": "#/components/schemas/DocumentValueDecimalValue", "boolean": "#/components/schemas/DocumentValueBooleanValue", "object": "#/components/schemas/DocumentValueObjectValue", "array": "#/components/schemas/DocumentValueArrayValue" } } }, "DocumentValueArrayValue": { "required": [ "items" ], "properties": { "kind": { "enum": [ "array" ], "type": "string" }, "items": { "type": "array", "items": { "discriminator": { "propertyName": "kind", "mapping": { "missing": "#/components/schemas/DocumentValueMissingValue", "null": "#/components/schemas/DocumentValueNullValue", "string": "#/components/schemas/DocumentValueStringValue", "integer": "#/components/schemas/DocumentValueIntegerValue", "decimal": "#/components/schemas/DocumentValueDecimalValue", "boolean": "#/components/schemas/DocumentValueBooleanValue", "object": "#/components/schemas/DocumentValueObjectValue", "array": "#/components/schemas/DocumentValueArrayValue" } } } } } }, "DocumentValueBooleanValue": { "required": [ "value" ], "properties": { "kind": { "enum": [ "boolean" ], "type": "string" }, "value": { "type": "boolean" } } }, "DocumentValueDecimalValue": { "required": [ "value" ], "properties": { "kind": { "enum": [ "decimal" ], "type": "string" }, "value": { "type": "string" } } }, "DocumentValueIntegerValue": { "required": [ "value" ], "properties": { "kind": { "enum": [ "integer" ], "type": "string" }, "value": { "type": "string" } } }, "DocumentValueMissingValue": { "properties": { "kind": { "enum": [ "missing" ], "type": "string" } } }, "DocumentValueNullValue": { "properties": { "kind": { "enum": [ "null" ], "type": "string" } } }, "DocumentValueObjectValue": { "required": [ "fields" ], "properties": { "kind": { "enum": [ "object" ], "type": "string" }, "fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentValue" } } } }, "DocumentValueStringValue": { "required": [ "value" ], "properties": { "kind": { "enum": [ "string" ], "type": "string" }, "value": { "type": "string" } } }, "DocumentValueTree": { "required": [ "schemaVersion", "root" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "root": { "$ref": "#/components/schemas/DocumentValue" } }, "nullable": true }, "EligibleMapper": { "required": [ "id", "mapperId", "name", "revisionNumber", "destinationFormat", "destinationCode", "destinationVersion" ], "type": "object", "properties": { "id": { "type": "string" }, "mapperId": { "type": "string" }, "name": { "type": "string" }, "revisionNumber": { "type": "integer", "format": "int32" }, "destinationFormat": { "type": "string" }, "destinationCode": { "type": "string" }, "destinationVersion": { "type": "string" } } }, "EnrichmentBinding": { "required": [ "kind" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/EnrichmentBindingValueBinding" }, { "$ref": "#/components/schemas/EnrichmentBindingItemBinding" }, { "$ref": "#/components/schemas/EnrichmentBindingReferenceBinding" } ], "discriminator": { "propertyName": "kind", "mapping": { "value": "#/components/schemas/EnrichmentBindingValueBinding", "item": "#/components/schemas/EnrichmentBindingItemBinding", "reference": "#/components/schemas/EnrichmentBindingReferenceBinding" } } }, "EnrichmentBindingItemBinding": { "required": [ "identifiers", "field", "id", "scope", "collectionNodeId", "type" ], "properties": { "kind": { "enum": [ "item" ], "type": "string" }, "identifiers": { "type": "array", "items": { "required": [ "kind", "value" ], "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/SourceIdentifierKind" }, "value": { "$ref": "#/components/schemas/ValueExpression" } } } }, "field": { "type": "string" }, "fallback": { "required": [ "kind" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/DocumentValueMissingValue" }, { "$ref": "#/components/schemas/DocumentValueNullValue" }, { "$ref": "#/components/schemas/DocumentValueStringValue" }, { "$ref": "#/components/schemas/DocumentValueIntegerValue" }, { "$ref": "#/components/schemas/DocumentValueDecimalValue" }, { "$ref": "#/components/schemas/DocumentValueBooleanValue" }, { "$ref": "#/components/schemas/DocumentValueObjectValue" }, { "$ref": "#/components/schemas/DocumentValueArrayValue" } ], "default": null, "nullable": true, "discriminator": { "propertyName": "kind", "mapping": { "missing": "#/components/schemas/DocumentValueMissingValue", "null": "#/components/schemas/DocumentValueNullValue", "string": "#/components/schemas/DocumentValueStringValue", "integer": "#/components/schemas/DocumentValueIntegerValue", "decimal": "#/components/schemas/DocumentValueDecimalValue", "boolean": "#/components/schemas/DocumentValueBooleanValue", "object": "#/components/schemas/DocumentValueObjectValue", "array": "#/components/schemas/DocumentValueArrayValue" } } }, "id": { "type": "string" }, "scope": { "enum": [ "root", "item" ] }, "collectionNodeId": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/StructureKind" } } }, "EnrichmentBindingReferenceBinding": { "required": [ "partnerId", "tableId", "keys", "resultColumn", "id", "scope", "collectionNodeId", "type" ], "properties": { "kind": { "enum": [ "reference" ], "type": "string" }, "partnerId": { "type": "string" }, "tableId": { "type": "string" }, "keys": { "type": "array", "items": { "required": [ "name", "type", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/StructureKind" }, "value": { "$ref": "#/components/schemas/ValueExpression" } } } }, "resultColumn": { "type": "string" }, "fallback": { "required": [ "kind" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/DocumentValueMissingValue" }, { "$ref": "#/components/schemas/DocumentValueNullValue" }, { "$ref": "#/components/schemas/DocumentValueStringValue" }, { "$ref": "#/components/schemas/DocumentValueIntegerValue" }, { "$ref": "#/components/schemas/DocumentValueDecimalValue" }, { "$ref": "#/components/schemas/DocumentValueBooleanValue" }, { "$ref": "#/components/schemas/DocumentValueObjectValue" }, { "$ref": "#/components/schemas/DocumentValueArrayValue" } ], "default": null, "nullable": true, "discriminator": { "propertyName": "kind", "mapping": { "missing": "#/components/schemas/DocumentValueMissingValue", "null": "#/components/schemas/DocumentValueNullValue", "string": "#/components/schemas/DocumentValueStringValue", "integer": "#/components/schemas/DocumentValueIntegerValue", "decimal": "#/components/schemas/DocumentValueDecimalValue", "boolean": "#/components/schemas/DocumentValueBooleanValue", "object": "#/components/schemas/DocumentValueObjectValue", "array": "#/components/schemas/DocumentValueArrayValue" } } }, "id": { "type": "string" }, "scope": { "enum": [ "root", "item" ] }, "collectionNodeId": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/StructureKind" } } }, "EnrichmentBindingValueBinding": { "required": [ "value", "id", "scope", "collectionNodeId", "type" ], "properties": { "kind": { "enum": [ "value" ], "type": "string" }, "value": { "$ref": "#/components/schemas/ValueExpression" }, "id": { "type": "string" }, "scope": { "enum": [ "root", "item" ] }, "collectionNodeId": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/StructureKind" } } }, "EnrichmentFailure": { "required": [ "bindingId", "sourcePath", "code", "message" ], "type": "object", "properties": { "bindingId": { "type": "string" }, "sourcePath": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } } }, "EnrichmentLineValues": { "required": [ "collectionNodeId", "sourcePath", "values" ], "type": "object", "properties": { "collectionNodeId": { "type": "string" }, "sourcePath": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "discriminator": { "propertyName": "kind", "mapping": { "missing": "#/components/schemas/DocumentValueMissingValue", "null": "#/components/schemas/DocumentValueNullValue", "string": "#/components/schemas/DocumentValueStringValue", "integer": "#/components/schemas/DocumentValueIntegerValue", "decimal": "#/components/schemas/DocumentValueDecimalValue", "boolean": "#/components/schemas/DocumentValueBooleanValue", "object": "#/components/schemas/DocumentValueObjectValue", "array": "#/components/schemas/DocumentValueArrayValue" } } } } } }, "EnrichmentRead": { "required": [ "bindingId", "sourcePath", "outcome", "inputs", "value" ], "type": "object", "properties": { "bindingId": { "type": "string" }, "sourcePath": { "type": "string" }, "outcome": { "type": "string" }, "inputs": { "type": "object", "additionalProperties": { "discriminator": { "propertyName": "kind", "mapping": { "missing": "#/components/schemas/DocumentValueMissingValue", "null": "#/components/schemas/DocumentValueNullValue", "string": "#/components/schemas/DocumentValueStringValue", "integer": "#/components/schemas/DocumentValueIntegerValue", "decimal": "#/components/schemas/DocumentValueDecimalValue", "boolean": "#/components/schemas/DocumentValueBooleanValue", "object": "#/components/schemas/DocumentValueObjectValue", "array": "#/components/schemas/DocumentValueArrayValue" } } } }, "value": { "$ref": "#/components/schemas/DocumentValue" }, "itemId": { "type": "string", "default": null, "nullable": true }, "itemVersion": { "type": "integer", "format": "int32", "default": null, "nullable": true }, "partnerId": { "type": "string", "default": null, "nullable": true }, "tableId": { "type": "string", "default": null, "nullable": true }, "tableVersion": { "type": "integer", "format": "int32", "default": null, "nullable": true }, "rowId": { "type": "string", "default": null, "nullable": true }, "rowVersion": { "type": "integer", "format": "int32", "default": null, "nullable": true } } }, "EnrichmentScope": { "required": [ "customerId", "sourceSystem", "sourceInstance", "partnerId" ], "type": "object", "properties": { "customerId": { "type": "string" }, "sourceSystem": { "type": "string" }, "sourceInstance": { "type": "string" }, "partnerId": { "type": "string", "nullable": true } } }, "EnrichmentSnapshot": { "required": [ "schemaVersion", "capturedAt", "scope", "bindings", "context", "reads" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "capturedAt": { "type": "string", "format": "date-time" }, "scope": { "$ref": "#/components/schemas/EnrichmentScope" }, "bindings": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentBinding" } }, "context": { "$ref": "#/components/schemas/MappingEnrichmentContext" }, "reads": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentRead" } } }, "default": null, "nullable": true }, "FieldRule": { "required": [ "id", "destinationNodeId", "value" ], "type": "object", "properties": { "id": { "type": "string" }, "destinationNodeId": { "type": "string" }, "value": { "$ref": "#/components/schemas/ValueExpression" } } }, "ItemDetail": { "required": [ "schemaVersion", "id", "version", "values", "archivedAt", "updatedAt", "sourceIdentifiers" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "values": { "$ref": "#/components/schemas/ItemValues" }, "archivedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "sourceIdentifiers": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSourceIdentifierDetail" } } } }, "ItemImportRow": { "required": [ "row", "values", "sourceIdentifiers", "existingItemId", "expectedVersion" ], "type": "object", "properties": { "row": { "type": "integer", "format": "int32" }, "values": { "$ref": "#/components/schemas/ItemValues" }, "sourceIdentifiers": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSourceIdentifierValues" } }, "existingItemId": { "type": "string", "nullable": true }, "expectedVersion": { "type": "integer", "format": "int32", "nullable": true } } }, "ItemSourceIdentifierDetail": { "required": [ "id", "itemId", "values" ], "type": "object", "properties": { "id": { "type": "string" }, "itemId": { "type": "string" }, "values": { "$ref": "#/components/schemas/ItemSourceIdentifierValues" } } }, "ItemSourceIdentifierValues": { "required": [ "sourceSystem", "sourceInstance", "kind", "value" ], "type": "object", "properties": { "sourceSystem": { "type": "string" }, "sourceInstance": { "type": "string" }, "kind": { "$ref": "#/components/schemas/SourceIdentifierKind" }, "value": { "type": "string" } } }, "ItemValues": { "required": [ "internalNumber", "name", "partnerId", "vendorNumber", "description", "price", "cost", "currency", "packCount", "innerPackCount", "color", "style", "model", "attributes" ], "type": "object", "properties": { "internalNumber": { "type": "string" }, "name": { "type": "string" }, "partnerId": { "type": "string", "nullable": true }, "vendorNumber": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "price": { "type": "string", "nullable": true }, "cost": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "packCount": { "type": "integer", "format": "int32", "nullable": true }, "innerPackCount": { "type": "integer", "format": "int32", "nullable": true }, "color": { "type": "string", "nullable": true }, "style": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentValue" } } } }, "JsonElement": { }, "LinkedShopSummary": { "required": [ "id", "shopDomain", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "shopDomain": { "type": "string" }, "name": { "type": "string", "nullable": true } } }, "MapperDefinition": { "required": [ "schemaVersion", "engineVersion", "sourceProfileRevisionId", "destinationProfileRevisionId", "fields", "collections" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "engineVersion": { "type": "string" }, "sourceProfileRevisionId": { "type": "string" }, "destinationProfileRevisionId": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldRule" } }, "collections": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionRule" } }, "runtimeCompatibility": { "$ref": "#/components/schemas/MappingRuntimeCompatibility" }, "bindings": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentBinding" }, "default": null, "nullable": true } } }, "MapperDetail": { "required": [ "mapper", "definition", "source", "destination", "revisions", "diagnostics" ], "type": "object", "properties": { "mapper": { "$ref": "#/components/schemas/MapperSummary" }, "definition": { "$ref": "#/components/schemas/MapperDefinition" }, "source": { "$ref": "#/components/schemas/ProfileRevisionDetail" }, "destination": { "$ref": "#/components/schemas/ProfileRevisionDetail" }, "revisions": { "type": "array", "items": { "$ref": "#/components/schemas/MapperRevisionSummary" } }, "diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentDiagnostic" } } } }, "MapperPage": { "required": [ "items", "page", "pageSize", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MapperSummary" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "MapperPreviewResult": { "required": [ "mappedValue", "content", "contentType", "context", "diagnostics" ], "type": "object", "properties": { "mappedValue": { "$ref": "#/components/schemas/DocumentValueTree" }, "content": { "type": "string", "format": "byte", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "context": { "$ref": "#/components/schemas/AdapterExecutionContext" }, "diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineDiagnostic" } }, "runtimeCompatibility": { "$ref": "#/components/schemas/MappingRuntimeCompatibility" }, "enrichment": { "$ref": "#/components/schemas/EnrichmentSnapshot" }, "selection": { "type": "array", "items": { "$ref": "#/components/schemas/MappingSelection" }, "default": null, "nullable": true } } }, "MapperRevisionDetail": { "required": [ "id", "mapperId", "revisionNumber", "name", "definition", "publishedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "mapperId": { "type": "string" }, "revisionNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "definition": { "$ref": "#/components/schemas/MapperDefinition" }, "publishedAt": { "type": "string", "format": "date-time" } } }, "MapperRevisionSummary": { "required": [ "id", "revisionNumber", "name", "sourceProfileRevisionId", "destinationProfileRevisionId", "publishedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "revisionNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "sourceProfileRevisionId": { "type": "string" }, "destinationProfileRevisionId": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time" } } }, "MapperSummary": { "required": [ "id", "name", "version", "revisionCount", "archivedAt", "updatedAt", "sourceProfileRevisionId", "destinationProfileRevisionId" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "revisionCount": { "type": "integer", "format": "int32" }, "archivedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" }, "sourceProfileRevisionId": { "type": "string" }, "destinationProfileRevisionId": { "type": "string" } } }, "MapperValidationResult": { "required": [ "diagnostics" ], "type": "object", "properties": { "diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentDiagnostic" } } } }, "MappingEnrichmentContext": { "required": [ "schemaVersion", "root", "lines" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "root": { "type": "object", "additionalProperties": { "discriminator": { "propertyName": "kind", "mapping": { "missing": "#/components/schemas/DocumentValueMissingValue", "null": "#/components/schemas/DocumentValueNullValue", "string": "#/components/schemas/DocumentValueStringValue", "integer": "#/components/schemas/DocumentValueIntegerValue", "decimal": "#/components/schemas/DocumentValueDecimalValue", "boolean": "#/components/schemas/DocumentValueBooleanValue", "object": "#/components/schemas/DocumentValueObjectValue", "array": "#/components/schemas/DocumentValueArrayValue" } } } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentLineValues" } }, "failures": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentFailure" }, "default": null, "nullable": true } } }, "MappingRuntimeCompatibility": { "required": [ "engineVersion", "sourceAdapter", "destinationAdapter", "ediFabricVersion", "timeZoneFingerprints" ], "type": "object", "properties": { "engineVersion": { "type": "string" }, "sourceAdapter": { "$ref": "#/components/schemas/AdapterCompatibility" }, "destinationAdapter": { "$ref": "#/components/schemas/AdapterCompatibility" }, "ediFabricVersion": { "type": "string", "nullable": true }, "timeZoneFingerprints": { "type": "object", "additionalProperties": { "type": "string" } } }, "default": null, "nullable": true }, "MappingSelection": { "required": [ "ruleId", "sourcePath", "ordinal", "sourceLineId", "included" ], "type": "object", "properties": { "ruleId": { "type": "string" }, "sourcePath": { "type": "string" }, "ordinal": { "type": "integer", "format": "int32" }, "sourceLineId": { "type": "string", "nullable": true }, "included": { "type": "boolean" } } }, "NativeBinding": { "required": [ "kind" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/NativeBindingJsonNativeBinding" }, { "$ref": "#/components/schemas/NativeBindingXmlNativeBinding" }, { "$ref": "#/components/schemas/NativeBindingEdiNativeBinding" } ], "discriminator": { "propertyName": "kind", "mapping": { "json": "#/components/schemas/NativeBindingJsonNativeBinding", "xml": "#/components/schemas/NativeBindingXmlNativeBinding", "edi": "#/components/schemas/NativeBindingEdiNativeBinding" } } }, "NativeBindingEdiNativeBinding": { "required": [ "templatePath", "segment", "position", "component" ], "properties": { "kind": { "enum": [ "edi" ], "type": "string" }, "templatePath": { "type": "string" }, "segment": { "type": "string", "nullable": true }, "position": { "type": "integer", "format": "int32", "nullable": true }, "component": { "type": "integer", "format": "int32", "nullable": true }, "adapterProvided": { "type": "boolean", "default": false } } }, "NativeBindingJsonNativeBinding": { "required": [ "propertyName" ], "properties": { "kind": { "enum": [ "json" ], "type": "string" }, "propertyName": { "type": "string" } } }, "NativeBindingXmlNativeBinding": { "required": [ "nodeKind", "localName", "namespaceUri", "order" ], "properties": { "kind": { "enum": [ "xml" ], "type": "string" }, "nodeKind": { "enum": [ "element", "attribute", "text" ] }, "localName": { "type": "string" }, "namespaceUri": { "type": "string" }, "order": { "type": "integer", "format": "int32" } } }, "NullableOfJsonElement": { "nullable": true }, "PhaseIiColorApplicability": { "required": [ "row", "product", "color", "modelChoices", "selectedModels" ], "type": "object", "properties": { "row": { "type": "integer", "format": "int32" }, "product": { "type": "string" }, "color": { "type": "string" }, "modelChoices": { "type": "array", "items": { "type": "string" } }, "selectedModels": { "type": "array", "items": { "type": "string" } } } }, "PhaseIiImportReview": { "required": [ "preview", "sourceRows", "applicability", "tables" ], "type": "object", "properties": { "preview": { "$ref": "#/components/schemas/CatalogImportPreview" }, "sourceRows": { "type": "array", "items": { } }, "applicability": { "type": "array", "items": { "$ref": "#/components/schemas/PhaseIiColorApplicability" } }, "tables": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceTablePlan" } } } }, "PipelineAccepted": { "required": [ "runId", "status", "statusUrl" ], "type": "object", "properties": { "runId": { "type": "string" }, "status": { "$ref": "#/components/schemas/PipelineStatus" }, "statusUrl": { "type": "string" }, "processingMode": { "type": "string", "default": null, "nullable": true } } }, "PipelineArtifactSummary": { "required": [ "id", "documentId", "role", "contentType", "fileName", "byteLength", "sha256", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "documentId": { "type": "string", "nullable": true }, "role": { "type": "string" }, "contentType": { "type": "string" }, "fileName": { "type": "string" }, "byteLength": { "type": "integer", "format": "int32" }, "sha256": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "PipelineDiagnostic": { "required": [ "stage", "code", "path", "message" ], "type": "object", "properties": { "stage": { "$ref": "#/components/schemas/PipelineStage" }, "code": { "type": "string" }, "path": { "type": "string" }, "message": { "type": "string" }, "ruleId": { "type": "string", "default": null, "nullable": true } } }, "PipelineStage": { "enum": [ "intake", "import", "classify", "resolve", "read", "validate-source", "map", "validate-destination", "write", "store", "finalize" ] }, "PipelineStatus": { "enum": [ "queued", "processing", "succeeded", "blocked", "failed" ] }, "ProfileCatalog": { "required": [ "adapters", "x12", "shopifyVersions" ], "type": "object", "properties": { "adapters": { "type": "array", "items": { "$ref": "#/components/schemas/AdapterDescriptor" } }, "x12": { "type": "array", "items": { "$ref": "#/components/schemas/X12CatalogEntry" } }, "shopifyVersions": { "type": "array", "items": { "type": "string" } } } }, "ProfileDefinition": { "required": [ "schemaVersion", "identity", "root", "compatibility", "settings" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "identity": { "$ref": "#/components/schemas/DocumentIdentity" }, "root": { "$ref": "#/components/schemas/StructureNode" }, "compatibility": { "$ref": "#/components/schemas/AdapterCompatibility" }, "settings": { "$ref": "#/components/schemas/JsonElement" } } }, "ProfileDetail": { "required": [ "profile", "definition", "revisions", "diagnostics" ], "type": "object", "properties": { "profile": { "$ref": "#/components/schemas/ProfileSummary" }, "definition": { "$ref": "#/components/schemas/ProfileDefinition" }, "revisions": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileRevisionSummary" } }, "diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentDiagnostic" } } } }, "ProfilePage": { "required": [ "items", "page", "pageSize", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileSummary" } }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "ProfileRevisionDetail": { "required": [ "id", "profileId", "revisionNumber", "name", "definition", "publishedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "profileId": { "type": "string" }, "revisionNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "definition": { "$ref": "#/components/schemas/ProfileDefinition" }, "publishedAt": { "type": "string", "format": "date-time" } } }, "ProfileRevisionSummary": { "required": [ "id", "revisionNumber", "name", "format", "documentCode", "documentVersion", "publishedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "revisionNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "format": { "type": "string" }, "documentCode": { "type": "string" }, "documentVersion": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time" } } }, "ProfileSummary": { "required": [ "id", "name", "version", "revisionCount", "archivedAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "revisionCount": { "type": "integer", "format": "int32" }, "archivedAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" } } }, "ReadEdifactRequest": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" }, "includeCONTRL": { "type": "boolean", "default": false } } }, "ReadEdifactResult": { "required": [ "success", "version", "messages", "ackCONTRL", "errors" ], "type": "object", "properties": { "success": { "type": "boolean" }, "version": { "type": "string" }, "messages": { "type": "array" }, "ackCONTRL": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "type": "string" } }, "requestId": { "type": "string", "default": null, "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "default": null, "nullable": true } } }, "ReadX12Group": { "required": [ "gs", "ge", "transactionSets" ], "type": "object", "properties": { "gs": { "$ref": "#/components/schemas/JsonElement" }, "ge": { "$ref": "#/components/schemas/NullableOfJsonElement" }, "transactionSets": { "type": "array" } } }, "ReadX12Request": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" }, "include997": { "type": "boolean", "default": false } } }, "ReadX12Result": { "required": [ "success", "version", "isa", "iea", "groups", "ack997", "ackTA1", "errors" ], "type": "object", "properties": { "success": { "type": "boolean" }, "version": { "type": "string" }, "isa": { "$ref": "#/components/schemas/NullableOfJsonElement" }, "iea": { "$ref": "#/components/schemas/NullableOfJsonElement" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ReadX12Group" } }, "ack997": { "type": "string", "nullable": true }, "ackTA1": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "type": "string" } }, "requestId": { "type": "string", "default": null, "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "default": null, "nullable": true } } }, "ReceiveX12Group": { "required": [ "gs", "ge", "transactionSets" ], "type": "object", "properties": { "gs": { "$ref": "#/components/schemas/JsonElement" }, "ge": { "$ref": "#/components/schemas/NullableOfJsonElement" }, "transactionSets": { "type": "array" } } }, "ReceiveX12Request": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" }, "partnerId": { "type": "string", "default": null, "nullable": true }, "include997": { "type": "boolean", "default": false } } }, "ReceiveX12Result": { "required": [ "success", "version", "isa", "iea", "groups", "ack997", "ackTA1", "errors" ], "type": "object", "properties": { "success": { "type": "boolean" }, "version": { "type": "string" }, "isa": { "$ref": "#/components/schemas/NullableOfJsonElement" }, "iea": { "$ref": "#/components/schemas/NullableOfJsonElement" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ReceiveX12Group" } }, "ack997": { "type": "string", "nullable": true }, "ackTA1": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "type": "string" } }, "interchangeRecordId": { "type": "string", "default": null, "nullable": true }, "resolvedPartnerId": { "type": "string", "default": null, "nullable": true }, "partnerValidationErrors": { "type": "array", "items": { "type": "string" }, "default": null, "nullable": true }, "requestId": { "type": "string", "default": null, "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "default": null, "nullable": true } } }, "ReferenceColumn": { "required": [ "name", "type", "required" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ReferenceColumnKind" }, "required": { "type": "boolean" } } }, "ReferenceColumnKind": { "enum": [ "string", "integer", "decimal", "boolean" ] }, "ReferenceImportRow": { "required": [ "tableName", "values", "source", "applicabilityResolved", "existingRowId", "expectedVersion" ], "type": "object", "properties": { "tableName": { "type": "string" }, "values": { "$ref": "#/components/schemas/ReferenceRowValues" }, "source": { "$ref": "#/components/schemas/ReferenceProvenance2" }, "applicabilityResolved": { "type": "boolean" }, "existingRowId": { "type": "string", "nullable": true }, "expectedVersion": { "type": "integer", "format": "int32", "nullable": true } } }, "ReferenceProvenance": { "required": [ "importId", "sheet", "row", "column" ], "type": "object", "properties": { "importId": { "type": "string", "nullable": true }, "sheet": { "type": "string", "nullable": true }, "row": { "type": "integer", "format": "int32", "nullable": true }, "column": { "type": "string", "nullable": true } }, "nullable": true }, "ReferenceProvenance2": { "required": [ "importId", "sheet", "row", "column" ], "type": "object", "properties": { "importId": { "type": "string", "nullable": true }, "sheet": { "type": "string", "nullable": true }, "row": { "type": "integer", "format": "int32", "nullable": true }, "column": { "type": "string", "nullable": true } } }, "ReferenceRowDetail": { "required": [ "schemaVersion", "id", "tableId", "version", "values", "provenance" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "tableId": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "values": { "$ref": "#/components/schemas/ReferenceRowValues" }, "provenance": { "$ref": "#/components/schemas/ReferenceProvenance" } } }, "ReferenceRowValues": { "required": [ "keys", "values" ], "type": "object", "properties": { "keys": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DocumentValue" } }, "values": { "type": "object", "additionalProperties": { "discriminator": { "propertyName": "kind", "mapping": { "missing": "#/components/schemas/DocumentValueMissingValue", "null": "#/components/schemas/DocumentValueNullValue", "string": "#/components/schemas/DocumentValueStringValue", "integer": "#/components/schemas/DocumentValueIntegerValue", "decimal": "#/components/schemas/DocumentValueDecimalValue", "boolean": "#/components/schemas/DocumentValueBooleanValue", "object": "#/components/schemas/DocumentValueObjectValue", "array": "#/components/schemas/DocumentValueArrayValue" } } } } } }, "ReferenceTableDetail": { "required": [ "schemaVersion", "id", "version", "values", "archivedAt" ], "type": "object", "properties": { "schemaVersion": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "values": { "$ref": "#/components/schemas/ReferenceTableValues" }, "archivedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "ReferenceTablePlan": { "required": [ "values", "existingTableId", "expectedVersion" ], "type": "object", "properties": { "values": { "$ref": "#/components/schemas/ReferenceTableValues" }, "existingTableId": { "type": "string", "nullable": true }, "expectedVersion": { "type": "integer", "format": "int32", "nullable": true } } }, "ReferenceTableValues": { "required": [ "partnerId", "name", "keyColumns", "valueColumns" ], "type": "object", "properties": { "partnerId": { "type": "string" }, "name": { "type": "string" }, "keyColumns": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceColumn" } }, "valueColumns": { "type": "array", "items": { } } } }, "ReprocessMode": { "enum": [ "original-configuration", "current-configuration" ] }, "ReprocessRequest": { "required": [ "idempotencyKey", "mode" ], "type": "object", "properties": { "idempotencyKey": { "type": "string" }, "mode": { "$ref": "#/components/schemas/ReprocessMode" } } }, "RunMapperResult": { "required": [ "runId", "status", "artifacts", "diagnostics" ], "type": "object", "properties": { "runId": { "type": "string" }, "status": { "type": "string" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineArtifactSummary" } }, "diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineDiagnostic" } } } }, "ShopifyBindingSummary": { "required": [ "id", "shopId", "shopDomain", "topic", "apiVersion", "supportedDocumentId", "isActive", "blocked" ], "type": "object", "properties": { "id": { "type": "string" }, "shopId": { "type": "string" }, "shopDomain": { "type": "string" }, "topic": { "type": "string" }, "apiVersion": { "type": "string" }, "supportedDocumentId": { "type": "string" }, "isActive": { "type": "boolean" }, "blocked": { "type": "boolean" } } }, "SourceIdentifierKind": { "enum": [ "sku", "product-id", "variant-id", "alias" ] }, "StructureKind": { "enum": [ "object", "array", "string", "integer", "decimal", "boolean" ] }, "StructureNode": { "required": [ "id", "name", "kind", "required", "nullable", "minOccurs", "maxOccurs", "children", "binding" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "$ref": "#/components/schemas/StructureKind" }, "required": { "type": "boolean" }, "nullable": { "type": "boolean" }, "minOccurs": { "type": "integer", "format": "int32" }, "maxOccurs": { "type": "integer", "format": "int32", "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/StructureNode" } }, "binding": { "discriminator": { "propertyName": "kind", "mapping": { "json": "#/components/schemas/NativeBindingJsonNativeBinding", "xml": "#/components/schemas/NativeBindingXmlNativeBinding", "edi": "#/components/schemas/NativeBindingEdiNativeBinding" } } }, "constraints": { "default": null, "nullable": true } } }, "SupportedDocumentSummary": { "required": [ "id", "partnerId", "direction", "format", "documentCode", "documentVersion", "mapperRevisionId", "mapperName", "mapperRevisionNumber", "destinationFormat", "destinationCode", "destinationVersion", "isActive", "version" ], "type": "object", "properties": { "id": { "type": "string" }, "partnerId": { "type": "string" }, "direction": { "type": "string" }, "format": { "type": "string" }, "documentCode": { "type": "string" }, "documentVersion": { "type": "string" }, "mapperRevisionId": { "type": "string", "nullable": true }, "mapperName": { "type": "string", "nullable": true }, "mapperRevisionNumber": { "type": "integer", "format": "int32", "nullable": true }, "destinationFormat": { "type": "string", "nullable": true }, "destinationCode": { "type": "string", "nullable": true }, "destinationVersion": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "version": { "type": "integer", "format": "int32" } } }, "ValidateEdifactRequest": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" } } }, "ValidateEdifactResult": { "required": [ "isValid", "errors", "warnings" ], "type": "object", "properties": { "isValid": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } }, "warnings": { "type": "array", "items": { "type": "string" } }, "requestId": { "type": "string", "default": null, "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "default": null, "nullable": true } } }, "ValidateX12Request": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" } } }, "ValidateX12Result": { "required": [ "isValid", "errors", "warnings" ], "type": "object", "properties": { "isValid": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } }, "warnings": { "type": "array", "items": { "type": "string" } }, "requestId": { "type": "string", "default": null, "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "default": null, "nullable": true } } }, "ValidationError": { "required": [ "segment", "position", "message", "errorCode" ], "type": "object", "properties": { "segment": { "type": "string" }, "position": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "errorCode": { "type": "string", "nullable": true } } }, "ValueConstraints": { "type": "object", "properties": { "minLength": { "type": "integer", "format": "int32", "default": null, "nullable": true }, "maxLength": { "type": "integer", "format": "int32", "default": null, "nullable": true }, "minimum": { "type": "string", "default": null, "nullable": true }, "maximum": { "type": "string", "default": null, "nullable": true }, "allowedValues": { "type": "array", "items": { "type": "string" }, "default": null, "nullable": true } }, "default": null, "nullable": true }, "ValueExpression": { }, "WriteEdifactRequest": { "required": [ "content" ], "type": "object", "properties": { "content": { "$ref": "#/components/schemas/JsonElement" } } }, "WriteEdifactResult": { "required": [ "success", "ediContent", "errors" ], "type": "object", "properties": { "success": { "type": "boolean" }, "ediContent": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } }, "requestId": { "type": "string", "default": null, "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "default": null, "nullable": true } } }, "WriteX12Request": { "required": [ "content" ], "type": "object", "properties": { "content": { "$ref": "#/components/schemas/JsonElement" }, "delimiters": { "$ref": "#/components/schemas/X12Delimiters" } } }, "WriteX12Result": { "required": [ "success", "ediContent", "errors" ], "type": "object", "properties": { "success": { "type": "boolean" }, "ediContent": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } }, "requestId": { "type": "string", "default": null, "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "default": null, "nullable": true } } }, "X12CatalogEntry": { "required": [ "identity", "templateName", "fingerprint" ], "type": "object", "properties": { "identity": { "$ref": "#/components/schemas/DocumentIdentity" }, "templateName": { "type": "string" }, "fingerprint": { "type": "string" } } }, "X12Delimiters": { "type": "object", "properties": { "elementSeparator": { "maxLength": 1, "minLength": 1, "type": "string", "format": "char", "default": "*" }, "componentSeparator": { "maxLength": 1, "minLength": 1, "type": "string", "format": "char", "default": ":" }, "segmentTerminator": { "maxLength": 1, "minLength": 1, "type": "string", "format": "char", "default": "~" }, "repetitionSeparator": { "maxLength": 1, "minLength": 1, "type": "string", "format": "char", "default": "^" } }, "default": null, "nullable": true } } }, "tags": [ { "name": "EDI Operations" }, { "name": "Document Pipeline" }, { "name": "Internal Document Pipeline" } ] }