{
"openapi" : "3.1.0",
"info" : {
"title" : "Product Information",
"version" : "1.0.0",
"description" : "Provides various services for requesting product information."
},
"paths" : {
"/portals/api/v2/product/data" : {
"post" : {
"operationId" : "post-portals-api-v2-product-data",
"summary" : "Fetch Complete Information of Products V2",
"description" : "Allows to fetch extensive product information in different formats (existence flag, JSON or HTML).\nUp to 30 products can be requested in a single call.\n",
"parameters" : [ {
"name" : "accessToken",
"in" : "query",
"required" : true,
"description" : "Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See kba:INT63 for details.",
"schema" : {
"type" : "string"
},
"example" : "d0765f518ff0cab426dbbd6d467c9967"
}, {
"name" : "portal",
"in" : "query",
"required" : true,
"description" : "Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page.",
"schema" : {
"type" : "string"
},
"example" : "9999999"
}, {
"name" : "user",
"in" : "query",
"required" : true,
"description" : "User name",
"schema" : {
"type" : "string"
},
"example" : "john.doe"
}, {
"name" : "language",
"in" : "query",
"required" : false,
"description" : "Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "roles",
"in" : "query",
"required" : false,
"description" : "Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public.",
"schema" : {
"type" : "string"
},
"example" : "Heating,Electronics,Top-Customer"
} ],
"requestBody" : {
"description" : "General and product-specific queries.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"outputMode" : "normal",
"queries" : {
"product-images" : {
"type" : "json",
"settings" : {
"limit" : 5
}
},
"attachments" : {
"type" : "json",
"settings" : {
"hideGroups" : true
}
}
},
"products" : [ {
"itemNumber" : "2186 183",
"supplierNumber" : "WI",
"queries" : {
"cover" : {
"type" : "exists"
}
}
}, {
"itemNumber" : "2186 183",
"supplierNumber" : "WI",
"queries" : { }
} ]
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "General and product-specific queries.",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"success" : true,
"error" : false,
"products" : [ {
"productId" : "ABC123",
"supplierNumber" : "WI",
"itemNumber" : "2186 183",
"resolved" : true,
"queries" : [ {
"name" : "product-images",
"error" : false,
"images" : [ {
"type" : "COLORED_IMAGE",
"typeName" : "Produktbild",
"description" : null,
"filename" : "product.png",
"iconUrl" : "https://oxomi.com/shared-media/epoch/.../oxomi/attachments/other.png",
"downloadUrl" : "https://oxomi.com/dasd/pd/attachments/.../.../.../product.png",
"fingerprint" : "ABC123",
"fileSize" : "189.54 KB",
"fileSizeInBytes" : 189537
} ]
}, {
"name" : "attachments",
"error" : false,
"documents" : [ {
"id" : "11002077",
"name" : "Dokument 1",
"internalName" : "document 1",
"brand" : "Marke 1",
"brandIcon" : "http://localhost:9000/assets/images/brand-preview.png",
"outdated" : false,
"previewUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"mediumUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"pages" : [ {
"pageNumber" : 1,
"pageName" : "1",
"previewUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"mediumUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg"
} ]
} ]
}, {
"name" : "cover",
"error" : false,
"exists" : true
} ]
}, {
"productId" : "ABC124",
"supplierNumber" : "WI",
"itemNumber" : "2186 184",
"resolved" : true,
"queries" : [ {
"name" : "product-images",
"error" : false,
"images" : [ {
"type" : "COLORED_IMAGE",
"typeName" : "Produktbild",
"description" : null,
"filename" : "product2.png",
"iconUrl" : "https://oxomi.com/shared-media/epoch/.../oxomi/attachments/other.png",
"downloadUrl" : "https://oxomi.com/dasd/pd/attachments/.../.../.../product2.png",
"fingerprint" : "ABC123",
"fileSize" : "189.54 KB",
"fileSizeInBytes" : 189537
} ]
}, {
"name" : "attachments",
"error" : false,
"documents" : [ {
"id" : "11002077",
"name" : "Dokument 2",
"internalName" : "document 2",
"brand" : "Marke 1",
"brandIcon" : "http://localhost:9000/assets/images/brand-preview.png",
"outdated" : false,
"previewUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"mediumUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"pages" : [ {
"pageNumber" : 2,
"pageName" : "2",
"previewUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"mediumUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg"
} ]
} ]
} ]
} ]
}
}
}
}
}
},
"400" : {
"description" : "Missing parameter or malformed request",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"success" : false,
"error" : true,
"message" : "The parameter {missingParameter} must be filled."
}
}
}
}
}
},
"401" : {
"description" : "Authentication required but none provided",
"content" : {
"application/json" : { }
}
},
"403" : {
"description" : "Invalid authentication or missing permission",
"content" : {
"application/json" : { }
}
},
"404" : {
"description" : "Resource not found",
"content" : {
"application/json" : { }
}
},
"405" : {
"description" : "Incorrect request method, e.g. GET instead of POST",
"content" : {
"application/json" : { }
}
},
"500" : {
"description" : "Unexpected server-side error",
"content" : {
"application/json" : { }
}
}
}
}
},
"/portals/api/v1/product/data" : {
"get" : {
"operationId" : "get-portals-api-v1-product-data",
"summary" : "Fetch Complete Information of Products V1",
"description" : "Allows to fetch extensive product information in different formats (existence flag, JSON or HTML).\nUp to 30 products can be requested by numbering the parameters itemNumber, supplierNumber or productId upwards.\n",
"parameters" : [ {
"name" : "accessToken",
"in" : "query",
"required" : true,
"description" : "Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See kba:INT63 for details.",
"schema" : {
"type" : "string"
},
"example" : "d0765f518ff0cab426dbbd6d467c9967"
}, {
"name" : "portal",
"in" : "query",
"required" : true,
"description" : "Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page.",
"schema" : {
"type" : "string"
},
"example" : "9999999"
}, {
"name" : "user",
"in" : "query",
"required" : true,
"description" : "User name",
"schema" : {
"type" : "string"
},
"example" : "john.doe"
}, {
"name" : "gtin1",
"in" : "query",
"required" : false,
"description" : "Specifies the GTIN of the product to search for. Can be used as an alternative to 'itemNumber1'.",
"schema" : {
"type" : "string"
},
"example" : "12345678901231"
}, {
"name" : "itemNumber1",
"in" : "query",
"required" : false,
"description" : "Specifies the item number to search for. Required if no 'productId1' is provided.",
"schema" : {
"type" : "string"
},
"example" : "2186 183"
}, {
"name" : "language",
"in" : "query",
"required" : false,
"description" : "Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "model1",
"in" : "query",
"required" : false,
"description" : "Specifies the model of the product to search for. Can be used as an alternative to 'itemNumber1'.",
"schema" : {
"type" : "string"
},
"example" : "Model 2186 White"
}, {
"name" : "productId1",
"in" : "query",
"required" : false,
"description" : "Specifies the product entity ID to search for. Required if no 'itemNumber1' is provided.",
"schema" : {
"type" : "string"
},
"example" : "ABC123"
}, {
"name" : "queries",
"in" : "query",
"required" : false,
"description" : "Specifies the information to fetch for each product.\nProvide no suffix for JSON Data, suffix '-html' for rendered HTML and '-exists' for a boolean flag.\nThis parameter could be provided multiple times with one parameter-value-pair for each queried information.\nSee kba:22MEJ#information-types for possible values.\n",
"schema" : {
"type" : "string"
},
"example" : "attachments-html"
}, {
"name" : "queries1",
"in" : "query",
"required" : false,
"description" : "Specifies the information to fetch for a specific product.\nProvide no suffix for JSON Data, suffix '-html' for rendered HTML and '-exists' for a boolean flag.\nThis parameter could be provided multiple times with one parameter-value-pair for each queried information.\n",
"schema" : {
"type" : "string"
},
"example" : "attachments-html"
}, {
"name" : "roles",
"in" : "query",
"required" : false,
"description" : "Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public.",
"schema" : {
"type" : "string"
},
"example" : "Heating,Electronics,Top-Customer"
}, {
"name" : "supplierNumber1",
"in" : "query",
"required" : false,
"description" : "Specifies the number of the supplier of the product to search for.",
"schema" : {
"type" : "string"
},
"example" : "WI"
} ],
"responses" : {
"200" : {
"description" : "Images and document pages for multiple products.",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"success" : true,
"error" : false,
"products" : [ {
"productId" : "ABC123",
"supplierNumber" : "WI",
"itemNumber" : "2186 183",
"resolved" : true,
"queries" : [ {
"name" : "product-images",
"error" : false,
"images" : [ {
"type" : "COLORED_IMAGE",
"typeName" : "Produktbild",
"description" : null,
"filename" : "product.png",
"iconUrl" : "https://oxomi.com/shared-media/epoch/.../oxomi/attachments/other.png",
"downloadUrl" : "https://oxomi.com/dasd/pd/attachments/.../.../.../product.png",
"fingerprint" : "ABC123",
"fileSize" : "189.54 KB",
"fileSizeInBytes" : 189537
} ]
}, {
"name" : "attachments",
"error" : false,
"documents" : [ {
"id" : "11002077",
"name" : "Dokument 1",
"internalName" : "document 1",
"brand" : "Marke 1",
"brandIcon" : "http://localhost:9000/assets/images/brand-preview.png",
"outdated" : false,
"previewUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"mediumUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"pages" : [ {
"pageNumber" : 1,
"pageName" : "1",
"previewUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"mediumUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg"
} ]
} ]
} ]
}, {
"productId" : "ABC124",
"supplierNumber" : "WI",
"itemNumber" : "2186 184",
"resolved" : true,
"queries" : [ {
"name" : "product-images",
"error" : false,
"images" : [ {
"type" : "COLORED_IMAGE",
"typeName" : "Produktbild",
"description" : null,
"filename" : "product2.png",
"iconUrl" : "https://oxomi.com/shared-media/epoch/.../oxomi/attachments/other.png",
"downloadUrl" : "https://oxomi.com/dasd/pd/attachments/.../.../.../product2.png",
"fingerprint" : "ABC123",
"fileSize" : "189.54 KB",
"fileSizeInBytes" : 189537
} ]
}, {
"name" : "attachments",
"error" : false,
"documents" : [ {
"id" : "11002077",
"name" : "Dokument 2",
"internalName" : "document 2",
"brand" : "Marke 1",
"brandIcon" : "http://localhost:9000/assets/images/brand-preview.png",
"outdated" : false,
"previewUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"mediumUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"pages" : [ {
"pageNumber" : 2,
"pageName" : "2",
"previewUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg",
"mediumUrl" : "http://localhost:9000/dasd/p/documents/.../.../....jpg"
} ]
} ]
} ]
} ]
}
}
}
}
}
},
"400" : {
"description" : "Missing parameter or malformed request",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"success" : false,
"error" : true,
"message" : "The parameter {missingParameter} must be filled."
}
}
}
}
}
},
"401" : {
"description" : "Authentication required but none provided",
"content" : {
"application/json" : { }
}
},
"403" : {
"description" : "Invalid authentication or missing permission",
"content" : {
"application/json" : { }
}
},
"404" : {
"description" : "Resource not found",
"content" : {
"application/json" : { }
}
},
"405" : {
"description" : "Incorrect request method, e.g. GET instead of POST",
"content" : {
"application/json" : { }
}
},
"500" : {
"description" : "Unexpected server-side error",
"content" : {
"application/json" : { }
}
}
}
}
},
"/portals/api/v1/products/availability" : {
"post" : {
"operationId" : "post-portals-api-v1-products-availability",
"summary" : "Product Availability",
"description" : "Obtains product availability details from manufacturers.\nUp to 100 items can be requested by numbering the parameters item, quantity and unit upwards.\n",
"parameters" : [ {
"name" : "accessToken",
"in" : "query",
"required" : true,
"description" : "Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See kba:INT63 for details.",
"schema" : {
"type" : "string"
},
"example" : "d0765f518ff0cab426dbbd6d467c9967"
}, {
"name" : "itemNumber1",
"in" : "query",
"required" : true,
"description" : "Item number",
"schema" : {
"type" : "string"
},
"example" : "2186 183"
}, {
"name" : "mode",
"in" : "query",
"required" : true,
"description" : "Mode (cached or live)",
"schema" : {
"type" : "string"
},
"example" : "live"
}, {
"name" : "portal",
"in" : "query",
"required" : true,
"description" : "Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page.",
"schema" : {
"type" : "string"
},
"example" : "9999999"
}, {
"name" : "user",
"in" : "query",
"required" : true,
"description" : "User name",
"schema" : {
"type" : "string"
},
"example" : "john.doe"
}, {
"name" : "language",
"in" : "query",
"required" : false,
"description" : "Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "quantity1",
"in" : "query",
"required" : false,
"description" : "Item quantity",
"schema" : {
"type" : "string"
},
"example" : "500"
}, {
"name" : "roles",
"in" : "query",
"required" : false,
"description" : "Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public.",
"schema" : {
"type" : "string"
},
"example" : "Heating,Electronics,Top-Customer"
}, {
"name" : "supplierNumber1",
"in" : "query",
"required" : false,
"description" : "Supplier number in the partnership",
"schema" : {
"type" : "string"
},
"example" : "WI"
}, {
"name" : "unit1",
"in" : "query",
"required" : false,
"description" : "Item unit related to the item quantity",
"schema" : {
"type" : "string"
},
"example" : "PCE"
} ],
"responses" : {
"200" : {
"description" : "Successful response",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"items" : [ {
"itemNumber" : "2186 183",
"normalizedItemNumber" : "2186183",
"supplierNumber" : "WI",
"requestedQuantity" : 500,
"cached" : false,
"unknownPartner" : false,
"expectedRenewedAvailability" : "2022-08-15",
"unit" : "PCE",
"unitName" : "Stück",
"stock" : 1200,
"stockIndicator" : "LOW",
"stockMessage" : "Geringer Bestand: 1.200 Stk",
"computedStockMessage" : "Geringer Bestand: 1.200 Stk",
"manufacturerStockMessage" : "",
"manufacturingTimeDays" : null
} ]
}
}
}
}
}
},
"400" : {
"description" : "Missing parameter or malformed request",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"success" : false,
"error" : true,
"message" : "The parameter {missingParameter} must be filled."
}
}
}
}
}
},
"401" : {
"description" : "Authentication required but none provided",
"content" : {
"application/json" : { }
}
},
"403" : {
"description" : "Invalid authentication or missing permission",
"content" : {
"application/json" : { }
}
},
"404" : {
"description" : "Resource not found",
"content" : {
"application/json" : { }
}
},
"405" : {
"description" : "Incorrect request method, e.g. GET instead of POST",
"content" : {
"application/json" : { }
}
},
"500" : {
"description" : "Unexpected server-side error",
"content" : {
"application/json" : { }
}
}
}
}
},
"/portals/api/xml/v1/products/availability" : {
"post" : {
"operationId" : "post-portals-api-xml-v1-products-availability",
"summary" : "Product Availability",
"description" : "Obtains product availability details from manufacturers.\nUp to 100 items can be requested.",
"parameters" : [ {
"name" : "accessToken",
"in" : "query",
"required" : true,
"description" : "Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See kba:INT63 for details.",
"schema" : {
"type" : "string"
},
"example" : "d0765f518ff0cab426dbbd6d467c9967"
}, {
"name" : "mode",
"in" : "query",
"required" : true,
"description" : "Mode (cached or live)",
"schema" : {
"type" : "string"
},
"example" : "live"
}, {
"name" : "portal",
"in" : "query",
"required" : true,
"description" : "Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page.",
"schema" : {
"type" : "string"
},
"example" : "9999999"
}, {
"name" : "user",
"in" : "query",
"required" : true,
"description" : "User name",
"schema" : {
"type" : "string"
},
"example" : "john.doe"
}, {
"name" : "language",
"in" : "query",
"required" : false,
"description" : "Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "roles",
"in" : "query",
"required" : false,
"description" : "Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public.",
"schema" : {
"type" : "string"
},
"example" : "Heating,Electronics,Top-Customer"
} ],
"requestBody" : {
"description" : "Single item",
"required" : false,
"content" : {
"text/xml" : {
"examples" : {
"example1" : {
"value" : "\n cached\n - \n 2186 183\n WI\n 500\n PCE\n
\n\n"
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Single item",
"content" : {
"text/xml" : {
"examples" : {
"example1" : {
"value" : "\n - \n 2186 183\n 2186183\n WI\n 500\n false\n false\n 2022-08-15\n PCE\n Stück\n 1200\n LOW\n Geringer Bestand: 1.200 Stk\n Geringer Bestand: 1.200 Stk\n \n \n
\n \n"
}
}
}
}
},
"400" : {
"description" : "Missing parameter or malformed request",
"content" : {
"text/xml" : {
"examples" : {
"example1" : {
"value" : "\n false\n true\n The parameter {missingParameter} must be filled.\n\n"
}
}
}
}
},
"401" : {
"description" : "Authentication required but none provided",
"content" : {
"text/xml" : { }
}
},
"403" : {
"description" : "Invalid authentication or missing permission",
"content" : {
"text/xml" : { }
}
},
"404" : {
"description" : "Resource not found",
"content" : {
"text/xml" : { }
}
},
"405" : {
"description" : "Incorrect request method, e.g. GET instead of POST",
"content" : {
"text/xml" : { }
}
},
"500" : {
"description" : "Unexpected server-side error",
"content" : {
"text/xml" : { }
}
}
}
}
},
"/portals/api/v1/products/resolve-gtin" : {
"get" : {
"operationId" : "get-portals-api-v1-products-resolve-gtin",
"summary" : "Resolve GTIN to Product",
"description" : "Resolves a product from a given GTIN13 or GTIN14.\n",
"parameters" : [ {
"name" : "accessToken",
"in" : "query",
"required" : true,
"description" : "Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See kba:INT63 for details.",
"schema" : {
"type" : "string"
},
"example" : "d0765f518ff0cab426dbbd6d467c9967"
}, {
"name" : "gtin",
"in" : "query",
"required" : true,
"description" : "A valid GTIN13 or GTIN14 that should be resolved to a supplier and item number pair.",
"schema" : {
"type" : "string"
},
"example" : "12345678901231"
}, {
"name" : "portal",
"in" : "query",
"required" : true,
"description" : "Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page.",
"schema" : {
"type" : "string"
},
"example" : "9999999"
}, {
"name" : "user",
"in" : "query",
"required" : true,
"description" : "User name",
"schema" : {
"type" : "string"
},
"example" : "john.doe"
}, {
"name" : "filterCountry",
"in" : "query",
"required" : false,
"description" : "The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "filterLanguage",
"in" : "query",
"required" : false,
"description" : "The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "language",
"in" : "query",
"required" : false,
"description" : "Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "roles",
"in" : "query",
"required" : false,
"description" : "Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public.",
"schema" : {
"type" : "string"
},
"example" : "Heating,Electronics,Top-Customer"
} ],
"responses" : {
"200" : {
"description" : "Product not found",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"success" : true,
"error" : false,
"resolved" : false
}
}
}
}
}
},
"400" : {
"description" : "Missing parameter or malformed request",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"success" : false,
"error" : true,
"message" : "The parameter {missingParameter} must be filled."
}
}
}
}
}
},
"401" : {
"description" : "Authentication required but none provided",
"content" : {
"application/json" : { }
}
},
"403" : {
"description" : "Invalid authentication or missing permission",
"content" : {
"application/json" : { }
}
},
"404" : {
"description" : "Resource not found",
"content" : {
"application/json" : { }
}
},
"405" : {
"description" : "Incorrect request method, e.g. GET instead of POST",
"content" : {
"application/json" : { }
}
},
"500" : {
"description" : "Unexpected server-side error",
"content" : {
"application/json" : { }
}
}
}
}
},
"/portals/api/xml/v1/products/resolve-gtin" : {
"get" : {
"operationId" : "get-portals-api-xml-v1-products-resolve-gtin",
"summary" : "Resolve GTIN to Product",
"description" : "Resolves a product from a given GTIN13 or GTIN14.\n",
"parameters" : [ {
"name" : "accessToken",
"in" : "query",
"required" : true,
"description" : "Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See kba:INT63 for details.",
"schema" : {
"type" : "string"
},
"example" : "d0765f518ff0cab426dbbd6d467c9967"
}, {
"name" : "gtin",
"in" : "query",
"required" : true,
"description" : "A valid GTIN13 or GTIN14 that should be resolved to a supplier and item number pair.",
"schema" : {
"type" : "string"
},
"example" : "00012345600012"
}, {
"name" : "portal",
"in" : "query",
"required" : true,
"description" : "Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page.",
"schema" : {
"type" : "string"
},
"example" : "9999999"
}, {
"name" : "user",
"in" : "query",
"required" : true,
"description" : "User name",
"schema" : {
"type" : "string"
},
"example" : "john.doe"
}, {
"name" : "filterCountry",
"in" : "query",
"required" : false,
"description" : "The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "filterLanguage",
"in" : "query",
"required" : false,
"description" : "The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "language",
"in" : "query",
"required" : false,
"description" : "Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "roles",
"in" : "query",
"required" : false,
"description" : "Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public.",
"schema" : {
"type" : "string"
},
"example" : "Heating,Electronics,Top-Customer"
} ],
"responses" : {
"200" : {
"description" : "Product not found",
"content" : {
"text/xml" : {
"examples" : {
"example1" : {
"value" : "\n true\n false\n false\n\n"
}
}
}
}
},
"400" : {
"description" : "Missing parameter or malformed request",
"content" : {
"text/xml" : {
"examples" : {
"example1" : {
"value" : "\n false\n true\n The parameter {missingParameter} must be filled.\n\n"
}
}
}
}
},
"401" : {
"description" : "Authentication required but none provided",
"content" : {
"text/xml" : { }
}
},
"403" : {
"description" : "Invalid authentication or missing permission",
"content" : {
"text/xml" : { }
}
},
"404" : {
"description" : "Resource not found",
"content" : {
"text/xml" : { }
}
},
"405" : {
"description" : "Incorrect request method, e.g. GET instead of POST",
"content" : {
"text/xml" : { }
}
},
"500" : {
"description" : "Unexpected server-side error",
"content" : {
"text/xml" : { }
}
}
}
}
},
"/portals/api/v2/products/search" : {
"post" : {
"operationId" : "post-portals-api-v2-products-search",
"summary" : "Search Products via Query Text",
"description" : "Allows to search for products based on the same query logic as used in Navigator Pro.\n",
"parameters" : [ {
"name" : "accessToken",
"in" : "query",
"required" : true,
"description" : "Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See kba:INT63 for details.",
"schema" : {
"type" : "string"
},
"example" : "d0765f518ff0cab426dbbd6d467c9967"
}, {
"name" : "portal",
"in" : "query",
"required" : true,
"description" : "Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page.",
"schema" : {
"type" : "string"
},
"example" : "9999999"
}, {
"name" : "user",
"in" : "query",
"required" : true,
"description" : "User name",
"schema" : {
"type" : "string"
},
"example" : "john.doe"
}, {
"name" : "language",
"in" : "query",
"required" : false,
"description" : "Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code.",
"schema" : {
"type" : "string"
},
"example" : "de"
}, {
"name" : "roles",
"in" : "query",
"required" : false,
"description" : "Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public.",
"schema" : {
"type" : "string"
},
"example" : "Heating,Electronics,Top-Customer"
} ],
"requestBody" : {
"description" : "Providing multiple query texts",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"limit" : 10,
"queries" : [ "ST.001.A", "00012345600012", "ST Sanitär Halbeinbauwaschtisch weiß mit Tisch schwarz", "ST Sanitär Waschtisch weiß" ]
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Result on query match",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"success" : true,
"error" : false,
"matchedQuery" : 0,
"total" : 1,
"products" : [ {
"itemNumber" : "ST.001.A",
"supplierNumber" : "1351",
"gtin" : "00012345600012",
"model" : "ST 001 A",
"previewImageUrl" : "https://oxomi.com/dasd/cv/attachments/.../product-image-preview/....jpg",
"brand" : {
"id" : "ABC123",
"name" : "ST Sanitär",
"mediumImageUrl" : "https://oxomi.com/dasd/cv/tenants/.../tenant-medium/....jpg"
},
"series" : {
"id" : "XYZ123",
"code" : "ST-CeramX",
"name" : "ST-CeramX",
"mediumImageUrl" : "https://oxomi.com/dasd/p/series/.../.../....jpg"
},
"shortText" : "Halbeinbauwaschtisch weiß mit Tisch schwarz",
"descriptionText" : "Ein Halbeinbauwaschtisch von ST Sanitär aus der Serie ST-CeramX. Erhältlich in weiß mit schwarzem Tisch.",
"marketingText" : "Der Halbeinbauwaschtisch ST.001.A von ST Sanitär aus der Serie ST-CeramX überzeugt durch sein modernes Design und die hochwertige Verarbeitung."
} ]
}
}
}
}
}
},
"400" : {
"description" : "Missing parameter or malformed request",
"content" : {
"application/json" : {
"examples" : {
"example1" : {
"value" : {
"success" : false,
"error" : true,
"message" : "The parameter {missingParameter} must be filled."
}
}
}
}
}
},
"401" : {
"description" : "Authentication required but none provided",
"content" : {
"application/json" : { }
}
},
"403" : {
"description" : "Invalid authentication or missing permission",
"content" : {
"application/json" : { }
}
},
"404" : {
"description" : "Resource not found",
"content" : {
"application/json" : { }
}
},
"405" : {
"description" : "Incorrect request method, e.g. GET instead of POST",
"content" : {
"application/json" : { }
}
},
"500" : {
"description" : "Unexpected server-side error",
"content" : {
"application/json" : { }
}
}
}
}
}
}
}