{ "openapi": "3.0.1", "info": { "title": "next Pim", "description": "This is the API of nextPIM ", "termsOfService": "https://nextpim.de/", "contact": { "name": "nextPIM GmbH", "url": "https://nextpim.de/", "email": "t.reimelt@nextpim.de" }, "version": "v1" }, "paths": { "/connect/token": { "post": { "tags": [ "Authorization" ], "summary": "Token endpoint. Issues an access token for the `password` grant (username + password) or the\r\n`refresh_token` grant, sent as an OAuth 2.0 form-encoded request.", "responses": { "200": { "description": "The token response containing the access token (and refresh token)." }, "400": { "description": "The grant is invalid, e.g. wrong credentials or an expired refresh token." } } } }, "/connect/userinfo": { "get": { "tags": [ "Authorization" ], "summary": "User info endpoint. Returns the claims of the user identified by the supplied access token —\r\nsubject and customer id, plus email, phone and roles depending on the granted scopes.", "responses": { "200": { "description": "The user's claims." }, "401": { "description": "The access token is missing, invalid or bound to a deleted account." } } }, "post": { "tags": [ "Authorization" ], "summary": "User info endpoint. Returns the claims of the user identified by the supplied access token —\r\nsubject and customer id, plus email, phone and roles depending on the granted scopes.", "responses": { "200": { "description": "The user's claims." }, "401": { "description": "The access token is missing, invalid or bound to a deleted account." } } } }, "/Cloud/{catalogId}/{customerId}/{mimeSource}": { "get": { "tags": [ "Cloud" ], "summary": "Returns a catalog media file for the given catalog, customer and media source.", "parameters": [ { "name": "catalogId", "in": "path", "description": "The catalog's unique identifier (ObjectId).", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The customer's unique identifier (GUID).", "required": true, "schema": { "type": "string" } }, { "name": "mimeSource", "in": "path", "description": "The media source (file name) within the catalog.", "required": true, "schema": { "type": "string" } }, { "name": "useNorm", "in": "query", "description": "When true, the normalized file variant is returned instead of the original.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "The requested media file." }, "400": { "description": "The catalogId or customerId is invalid." }, "404": { "description": "The catalog, customer or file was not found." } } }, "head": { "tags": [ "Cloud" ], "summary": "Returns a catalog media file for the given catalog, customer and media source.", "parameters": [ { "name": "catalogId", "in": "path", "description": "The catalog's unique identifier (ObjectId).", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The customer's unique identifier (GUID).", "required": true, "schema": { "type": "string" } }, { "name": "mimeSource", "in": "path", "description": "The media source (file name) within the catalog.", "required": true, "schema": { "type": "string" } }, { "name": "useNorm", "in": "query", "description": "When true, the normalized file variant is returned instead of the original.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "The requested media file." }, "400": { "description": "The catalogId or customerId is invalid." }, "404": { "description": "The catalog, customer or file was not found." } } } }, "/Cloud/{useCache}/{catalogId}/{customerId}/{mimeSource}": { "get": { "tags": [ "Cloud" ], "summary": "Returns a catalog media file for the given catalog, customer and media source, with control over\r\nwhether the file-lookup cache is used.", "parameters": [ { "name": "catalogId", "in": "path", "description": "The catalog's unique identifier (ObjectId).", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The customer's unique identifier (GUID).", "required": true, "schema": { "type": "string" } }, { "name": "mimeSource", "in": "path", "description": "The media source (file name) within the catalog.", "required": true, "schema": { "type": "string" } }, { "name": "useCache", "in": "path", "description": "When true, the cached file lookup is used.", "required": true, "schema": { "type": "boolean", "default": true } }, { "name": "useNorm", "in": "query", "description": "When true, the normalized file variant is returned instead of the original.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "The requested media file." }, "400": { "description": "The catalogId or customerId is invalid." }, "404": { "description": "The catalog, customer or file was not found." } } }, "head": { "tags": [ "Cloud" ], "summary": "Returns a catalog media file for the given catalog, customer and media source, with control over\r\nwhether the file-lookup cache is used.", "parameters": [ { "name": "catalogId", "in": "path", "description": "The catalog's unique identifier (ObjectId).", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The customer's unique identifier (GUID).", "required": true, "schema": { "type": "string" } }, { "name": "mimeSource", "in": "path", "description": "The media source (file name) within the catalog.", "required": true, "schema": { "type": "string" } }, { "name": "useCache", "in": "path", "description": "When true, the cached file lookup is used.", "required": true, "schema": { "type": "boolean", "default": true } }, { "name": "useNorm", "in": "query", "description": "When true, the normalized file variant is returned instead of the original.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "The requested media file." }, "400": { "description": "The catalogId or customerId is invalid." }, "404": { "description": "The catalog, customer or file was not found." } } } }, "/api/Print/GetCatalogsAuth": { "get": { "tags": [ "Print" ], "summary": "Returns all catalogs available for printing for the given customer, authenticated with the\r\ncustomer's print credentials.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "login", "in": "query", "description": "The print credential login.", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The print credential password.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The catalogs available for printing.", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogDto" } } } } }, "400": { "description": "The customer is unknown, the login is invalid, or a previous call is still in progress." } } } }, "/api/Print/GetCatalogs": { "get": { "tags": [ "Print" ], "summary": "Returns all catalogs available for printing for the given customer. Requires a bearer token\r\nwith at least read access to the customer.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The catalogs available for printing.", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogDto" } } } } }, "400": { "description": "The customer is unknown or a previous call is still in progress." }, "403": { "description": "The current user has no access to the customer." } } } }, "/api/Print/GetCatalogAuth": { "get": { "tags": [ "Print" ], "summary": "Returns a single full catalog (categories, products and media) as JSON, authenticated with the\r\ncustomer's print credentials.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "description": "The catalog's unique identifier (ObjectId).", "schema": { "type": "string" } }, { "name": "login", "in": "query", "description": "The print credential login.", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The print credential password.", "schema": { "type": "string" } }, { "name": "asDownload", "in": "query", "description": "When true, the catalog is returned as a downloadable file attachment.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "The full catalog as a JSON document.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CatalogDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CatalogDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CatalogDto" } } } }, "400": { "description": "The customer is unknown, the login is invalid, or a previous call is still in progress." } } } }, "/api/Print/GetCatalogTreeAuth": { "get": { "tags": [ "Print" ], "summary": "Returns the category tree of a catalog (without products), authenticated with the customer's\r\nprint credentials.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "description": "The catalog's unique identifier (ObjectId).", "schema": { "type": "string" } }, { "name": "login", "in": "query", "description": "The print credential login.", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The print credential password.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The catalog including its category tree.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CatalogDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CatalogDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CatalogDto" } } } }, "400": { "description": "The customer is unknown, the login is invalid, or a previous call is still in progress." } } } }, "/api/Print/GetCatalogTree": { "get": { "tags": [ "Print" ], "summary": "Returns the category tree of a catalog (without products). Requires a bearer token with at least\r\nread access to the customer.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "description": "The catalog's unique identifier (ObjectId).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The catalog including its category tree.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CatalogDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CatalogDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CatalogDto" } } } }, "400": { "description": "The customer is unknown or a previous call is still in progress." }, "403": { "description": "The current user has no access to the customer." } } } }, "/api/Print/GetProducts": { "get": { "tags": [ "Print" ], "summary": "Returns a paged list of products of a catalog. Requires a bearer token with at least read access\r\nto the customer.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "description": "The catalog's unique identifier (ObjectId).", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "The maximum number of products to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "The number of products to skip (for paging).", "schema": { "type": "integer", "format": "int32" } }, { "name": "changedSince", "in": "query", "description": "When set, only products changed after this timestamp are returned.", "schema": { "type": "string", "format": "date-time" } }, { "name": "manufacturerName", "in": "query", "description": "When set, restricts the result to products of this manufacturer.", "schema": { "type": "string" } }, { "name": "orderByParentId", "in": "query", "description": "When true, products are ordered by their parent product id.", "schema": { "type": "boolean" } }, { "name": "supplierPids", "in": "query", "description": "When set, restricts the result to products with these supplier PIDs.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "isDownload", "in": "query", "description": "When true, the export is written as a zipped JSON file to blob storage and a\r\n time-limited download link (valid for 7 days) is returned instead of the product list.", "schema": { "type": "boolean", "default": false } }, { "name": "asJob", "in": "query", "description": "When true, a background job is started that exports the whole catalog as a zipped\r\n JSON file (paging and filter parameters are ignored) and the job id is returned. Poll\r\n GetProductsJobStatus with this id to obtain the download link.", "schema": { "type": "boolean", "default": false } }, { "name": "language", "in": "query", "description": "When set, translates the products into this language code using the customer's\r\n product translations, instead of returning them in the catalog's default language. Ignored when\r\n asJob is true.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The matching products, a download link when isDownload is true,\r\n or a job id when asJob is true.", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDto" } } } } }, "400": { "description": "The customer or catalog is unknown, the language code is unknown, a previous call\r\n is still in progress, or an export job for the catalog is already in progress." }, "403": { "description": "The current user has no access to the customer." } } } }, "/api/Print/GetProductsJobStatus": { "get": { "tags": [ "Print" ], "summary": "Returns the state of a product export job started via GetProducts with asJob=true. Requires a\r\nbearer token with at least read access to the customer.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "jobId", "in": "query", "description": "The job id returned when the export was started.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "The download link of the finished export, or \"running\" while the job is still in progress.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "The job failed or was canceled." }, "403": { "description": "The current user has no access to the customer." }, "404": { "description": "No product export job with this id exists for the customer." } } } }, "/api/Print/GetProductsAuth": { "get": { "tags": [ "Print" ], "summary": "Returns a paged list of products of a catalog, authenticated with the customer's print credentials.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "description": "The catalog's unique identifier (ObjectId).", "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "The maximum number of products to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "The number of products to skip (for paging).", "schema": { "type": "integer", "format": "int32" } }, { "name": "login", "in": "query", "description": "The print credential login.", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The print credential password.", "schema": { "type": "string" } }, { "name": "changedSince", "in": "query", "description": "When set, only products changed after this timestamp are returned.", "schema": { "type": "string", "format": "date-time" } }, { "name": "manufacturerName", "in": "query", "description": "When set, restricts the result to products of this manufacturer.", "schema": { "type": "string" } }, { "name": "orderByParentId", "in": "query", "description": "When true, products are ordered by their parent product id.", "schema": { "type": "boolean" } }, { "name": "supplierPids", "in": "query", "description": "When set, restricts the result to products with these supplier PIDs.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "isDownload", "in": "query", "description": "When true, the export is written as a zipped JSON file to blob storage and a\r\n time-limited download link (valid for 7 days) is returned instead of the product list.", "schema": { "type": "boolean", "default": false } }, { "name": "asJob", "in": "query", "description": "When true, a background job is started that exports the whole catalog as a zipped\r\n JSON file (paging and filter parameters are ignored) and the job id is returned. Poll\r\n GetProductsJobStatusAuth with this id to obtain the download link.", "schema": { "type": "boolean", "default": false } }, { "name": "language", "in": "query", "description": "When set, translates the products into this language code using the customer's\r\n product translations, instead of returning them in the catalog's default language. Ignored when\r\n asJob is true.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The matching products, a download link when isDownload is true,\r\n or a job id when asJob is true.", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDto" } } } } }, "400": { "description": "The customer or catalog is unknown, the login is invalid, the language code is\r\n unknown, a previous call is still in progress, or an export job for the catalog is already in progress." } } } }, "/api/Print/GetProductsJobStatusAuth": { "get": { "tags": [ "Print" ], "summary": "Returns the state of a product export job started via GetProductsAuth with asJob=true,\r\nauthenticated with the customer's print credentials.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "jobId", "in": "query", "description": "The job id returned when the export was started.", "schema": { "type": "integer", "format": "int64" } }, { "name": "login", "in": "query", "description": "The print credential login.", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The print credential password.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The download link of the finished export, or \"running\" while the job is still in progress.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "The login is invalid, or the job failed or was canceled." }, "404": { "description": "No product export job with this id exists for the customer." } } } }, "/api/Print/GetFeaturesOfCatalog": { "get": { "tags": [ "Print" ], "summary": "Returns all feature systems used by the products of a catalog, each with its used features and\r\ntheir distinct feature values. Requires a bearer token with at least read access to the customer.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "description": "The catalog's unique identifier (ObjectId).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The feature systems used in the catalog with their features and feature values.", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFeatureSystemDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFeatureSystemDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFeatureSystemDto" } } } } }, "400": { "description": "The customer or catalog is unknown or a previous call is still in progress." }, "403": { "description": "The current user has no access to the customer." } } } }, "/api/Print/GetFeaturesOfCatalogAuth": { "get": { "tags": [ "Print" ], "summary": "Returns all feature systems used by the products of a catalog, each with its used features and\r\ntheir distinct feature values, authenticated with the customer's print credentials.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "description": "The catalog's unique identifier (ObjectId).", "schema": { "type": "string" } }, { "name": "login", "in": "query", "description": "The print credential login.", "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "The print credential password.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The feature systems used in the catalog with their features and feature values.", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFeatureSystemDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFeatureSystemDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFeatureSystemDto" } } } } }, "400": { "description": "The customer or catalog is unknown, the login is invalid, or a previous call is still in progress." } } } }, "/api/Print/GetPrintCredentials": { "get": { "tags": [ "Print" ], "summary": "Returns the print (Easy Catalog) credentials for a customer. Requires a bearer token with at\r\nleast read access to the customer.", "parameters": [ { "name": "customerId", "in": "query", "description": "The customer's unique identifier (GUID).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The customer's print credentials.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrintCredentialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrintCredentialDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrintCredentialDto" } } } }, "400": { "description": "The customer is unknown." }, "403": { "description": "The current user has no access to the customer." } } } }, "/api/Print/CreateCredential": { "post": { "tags": [ "Print" ], "summary": "Creates or regenerates the print (Easy Catalog) credentials for a customer. On first creation a\r\ndedicated print user is created; otherwise the existing user's password is regenerated. Requires\r\na bearer token with the manager role for the customer.", "requestBody": { "description": "The request identifying the customer the credentials are created for.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCredentialDto" } } } }, "responses": { "200": { "description": "The created or updated print credentials, including the generated password.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrintCredentialDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrintCredentialDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrintCredentialDto" } } } }, "400": { "description": "The customer is unknown or the request is invalid." }, "403": { "description": "The current user is not a manager of the customer." } } } }, "/Version": { "get": { "tags": [ "Version" ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "Address": { "type": "object", "properties": { "addressRemarks": { "type": "string", "nullable": true }, "addressType": { "type": "string", "nullable": true }, "boxNo": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int64" }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "name3": { "type": "string", "nullable": true }, "party": { "$ref": "#/components/schemas/Party" }, "phone": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "zipBox": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddressDto": { "type": "object", "properties": { "addressRemarks": { "type": "string", "nullable": true }, "addressType": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "name3": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AgreementDto": { "type": "object", "properties": { "agreementDesc": { "type": "string", "nullable": true }, "agreementId": { "type": "string", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BuyerDto": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/AddressDto" }, "buyerId": { "type": "string", "nullable": true }, "buyerIdType": { "type": "string", "nullable": true }, "buyerName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CatalogContainerInfoDto": { "type": "object", "properties": { "containerId": { "type": "string", "nullable": true }, "containerName": { "type": "string", "nullable": true }, "containerType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CatalogDto": { "type": "object", "properties": { "classifaiData": { "$ref": "#/components/schemas/ClassifaiDataDto" }, "isActivId": { "type": "boolean" }, "productPrefix": { "type": "string", "nullable": true }, "startCatId": { "type": "integer", "format": "int32" }, "usePrintView": { "type": "boolean" }, "memo": { "type": "string", "nullable": true }, "osgSegmentMapping": { "$ref": "#/components/schemas/OsgSegmentMappingDto" }, "responsible": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementDto" }, "buyer": { "$ref": "#/components/schemas/BuyerDto" }, "catalogAlias": { "type": "string", "nullable": true }, "catalogId": { "type": "string", "nullable": true }, "catalogName": { "type": "string", "nullable": true }, "catalogVersion": { "type": "string", "nullable": true }, "classificationSystems": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificationSystemDto" }, "nullable": true }, "categoryCount": { "type": "integer", "format": "int32" }, "currency": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "shopUrl": { "type": "string", "nullable": true }, "shopAuth": { "type": "string", "nullable": true }, "generatorInfo": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "catalogState": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isPublic": { "type": "boolean" }, "isPrint": { "type": "boolean" }, "isVirtual": { "type": "boolean" }, "isDemoCatalog": { "type": "boolean" }, "isDpbCatalog": { "type": "boolean" }, "language": { "type": "string", "nullable": true }, "lastImageUpload": { "type": "string", "format": "date-time" }, "lastUpdate": { "type": "string", "format": "date-time" }, "mimeRoot": { "type": "string", "nullable": true }, "mimes": { "type": "array", "items": { "$ref": "#/components/schemas/MimeDto" }, "nullable": true }, "mimeTemplate": { "type": "array", "items": { "$ref": "#/components/schemas/MimeDto" }, "nullable": true }, "featureTemplate": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureSystemDto" }, "nullable": true }, "pimGroup": { "type": "string", "nullable": true }, "priceLists": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogPriceListDto" }, "nullable": true }, "productCount": { "type": "integer", "format": "int32" }, "uniqueProductCount": { "type": "integer", "format": "int32" }, "state": { "type": "string", "nullable": true }, "supplier": { "$ref": "#/components/schemas/SupplierDto" }, "territories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "thumbUri": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "udxs": { "type": "array", "items": { "$ref": "#/components/schemas/UdxFieldDto" }, "nullable": true }, "uploadDate": { "type": "string", "nullable": true }, "shopWareConnection": { "$ref": "#/components/schemas/ShopWareConnectionDto" }, "shopWare5Connection": { "$ref": "#/components/schemas/Shopware5Connection" }, "odooConnection": { "$ref": "#/components/schemas/OdooConnection" }, "intershopConnection": { "$ref": "#/components/schemas/IntershopConnection" }, "electronicSalesConnection": { "$ref": "#/components/schemas/ElectronicSalesConnection" }, "validationMethodId": { "type": "string", "nullable": true }, "wawiTemplate": { "$ref": "#/components/schemas/WawiIntegrationDto" }, "legalTemplate": { "$ref": "#/components/schemas/LegalCharacteristicDto" }, "refecenceCatalogs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "importContainerNote": { "type": "string", "nullable": true }, "alternativeFeatureSystemIDUsedForExport": { "type": "string", "nullable": true }, "containers": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogContainerInfoDto" }, "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryDto" }, "nullable": true } }, "additionalProperties": false }, "CatalogFeatureDto": { "type": "object", "properties": { "featureName": { "type": "string", "nullable": true }, "featureValues": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CatalogFeatureSystemDto": { "type": "object", "properties": { "featureSystemName": { "type": "string", "nullable": true }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogFeatureDto" }, "nullable": true } }, "additionalProperties": false }, "CatalogMappingDto": { "type": "object", "properties": { "catalogId": { "type": "string", "nullable": true }, "categoryId": { "type": "string", "nullable": true }, "isVirtualCatalog": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "sortNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CatalogPriceListDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CategoryDto": { "type": "object", "properties": { "stableId": { "type": "string", "nullable": true }, "catalogId": { "type": "string", "nullable": true }, "categoryCount": { "type": "integer", "format": "int32" }, "childCategories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryDto" }, "nullable": true }, "customerId": { "type": "string", "nullable": true }, "groupDescription": { "type": "string", "nullable": true }, "groupId": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true }, "groupOrder": { "type": "integer", "format": "int64" }, "id": { "type": "string", "nullable": true }, "mimes": { "type": "array", "items": { "$ref": "#/components/schemas/MimeDto" }, "nullable": true }, "mimeTemplate": { "type": "array", "items": { "$ref": "#/components/schemas/MimeDto" }, "nullable": true }, "featureTemplate": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureSystemDto" }, "nullable": true }, "parentCategoryId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "productCount": { "type": "integer", "format": "int32" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDto" }, "nullable": true }, "type": { "type": "string", "nullable": true }, "udxs": { "type": "array", "items": { "$ref": "#/components/schemas/UdxFieldDto" }, "nullable": true }, "metaDescription": { "type": "string", "nullable": true }, "metaTitel": { "type": "string", "nullable": true }, "htmlDescription": { "type": "string", "nullable": true }, "shopware6CategoryMapping": { "$ref": "#/components/schemas/Shopware6CategoryMappingDto" }, "osgCategoryMapping": { "$ref": "#/components/schemas/OsgCategoryMappingDto" }, "wawiTemplate": { "$ref": "#/components/schemas/WawiIntegrationDto" }, "legalTemplate": { "$ref": "#/components/schemas/LegalCharacteristicDto" }, "orderValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ChangeInfoDto": { "type": "object", "properties": { "isDeleted": { "type": "boolean" }, "isNew": { "type": "boolean" }, "isMimeChanged": { "type": "boolean" }, "isLogisticChanged": { "type": "boolean" }, "isFeatureChanged": { "type": "boolean" }, "isUdxChanged": { "type": "boolean" }, "isOrderDetailChanged": { "type": "boolean" }, "isKeywordChanged": { "type": "boolean" }, "isReferencesChanged": { "type": "boolean" }, "isBaseProductChanged": { "type": "boolean" }, "isSuppliersChanged": { "type": "boolean" }, "isPricesChanged": { "type": "boolean" }, "isLegalChanged": { "type": "boolean" }, "isWawiChanged": { "type": "boolean" }, "isPackingsChanged": { "type": "boolean" } }, "additionalProperties": false }, "ClassifaiDataDto": { "type": "object", "properties": { "classifaiDate": { "type": "string", "format": "date-time" }, "isClassifaied": { "type": "boolean" } }, "additionalProperties": false }, "ClassificationSystemDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "isGlobal": { "type": "boolean" }, "isVisible": { "type": "boolean" }, "createdByCustomerId": { "type": "string", "format": "uuid", "nullable": true }, "requiredAddon": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateCredentialDto": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomWawiFieldDto": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "elementId": { "type": "integer", "format": "int32", "nullable": true }, "listId": { "type": "string", "nullable": true }, "stringValue": { "type": "string", "nullable": true }, "numberValue": { "type": "number", "format": "double", "nullable": true }, "boolValue": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "DisplayItemDto": { "type": "object", "properties": { "artIdTo": { "type": "string", "nullable": true }, "descriptionShort": { "type": "string", "nullable": true }, "quantityMinNumber": { "type": "number", "format": "double" }, "displayCount": { "type": "integer", "format": "int32" }, "disposable": { "type": "boolean" }, "purchasePrice": { "type": "number", "format": "double" }, "salesPrice": { "type": "number", "format": "double" }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ElectronicSalesConnection": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true }, "updateMode": { "type": "string", "nullable": true }, "ftpServerId": { "type": "integer", "format": "int32" }, "productFilePath": { "type": "string", "nullable": true }, "categoryFilePath": { "type": "string", "nullable": true }, "featureFilePath": { "type": "string", "nullable": true }, "eclassVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ElectronicSalesDto": { "type": "object", "properties": { "notReturnable": { "type": "boolean", "nullable": true }, "notDiscountable": { "type": "boolean", "nullable": true }, "notOrderable": { "type": "boolean", "nullable": true }, "notRequestable": { "type": "boolean", "nullable": true }, "locked": { "type": "boolean", "nullable": true }, "onlyOffline": { "type": "boolean", "nullable": true }, "dateCreated": { "type": "string", "nullable": true }, "descriptionMarketing": { "type": "string", "nullable": true }, "descriptionLong": { "type": "string", "nullable": true }, "promoInfo": { "type": "string", "nullable": true }, "noteCustomer": { "type": "string", "nullable": true }, "seoUrlFilename": { "type": "string", "nullable": true }, "fsk": { "type": "string", "nullable": true }, "euDataSheet": { "type": "string", "nullable": true }, "eek": { "type": "string", "nullable": true }, "eeLabel": { "type": "string", "nullable": true }, "eekColor": { "type": "string", "nullable": true }, "stockKeeping": { "type": "string", "nullable": true }, "stockUnit": { "type": "string", "nullable": true }, "stockInfoText": { "type": "string", "nullable": true }, "stockKeepingModus": { "type": "string", "nullable": true }, "stockPriceFactor": { "type": "string", "nullable": true }, "noStockInfoText": { "type": "string", "nullable": true }, "surCharges1ArtNr": { "type": "string", "nullable": true }, "surCharges1Percent": { "type": "string", "nullable": true }, "surCharges1FixValue": { "type": "string", "nullable": true }, "surCharges2ArtNr": { "type": "string", "nullable": true }, "surCharges2Percent": { "type": "string", "nullable": true }, "surCharges2FixValue": { "type": "string", "nullable": true }, "charges": { "type": "string", "nullable": true }, "orderDecimalPlaces": { "type": "integer", "format": "int32", "nullable": true }, "orderFactor": { "type": "number", "format": "double", "nullable": true }, "orderStockFactor": { "type": "number", "format": "double", "nullable": true }, "orderPriceFactor": { "type": "number", "format": "double", "nullable": true }, "priceInfo": { "type": "string", "nullable": true }, "newInShopTime": { "type": "string", "nullable": true }, "alternateArticleNumber": { "type": "string", "nullable": true }, "materialGroup": { "type": "string", "nullable": true }, "alternativePackageUnit": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FeatureDto": { "type": "object", "properties": { "validFeatureId": { "type": "string", "nullable": true }, "oldValidFeatureId": { "type": "string", "nullable": true }, "updateLinkedFields": { "type": "boolean" }, "guid": { "type": "string", "nullable": true }, "printOrder": { "type": "integer", "format": "int32" }, "fDescr": { "type": "string", "nullable": true }, "forder": { "type": "integer", "format": "int32" }, "ftIdref": { "type": "string", "nullable": true }, "funit": { "type": "string", "nullable": true }, "fValueDetails": { "type": "string", "nullable": true }, "fRequired": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "featureValues": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureValueDto" }, "nullable": true }, "valueSource": { "type": "string", "nullable": true }, "csCardFilter": { "type": "string", "nullable": true }, "isVariant": { "type": "boolean", "nullable": true }, "orderValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "FeatureSystemDto": { "type": "object", "properties": { "areFeaturesInitialised": { "type": "boolean" }, "oldValidFeatureSystemId": { "type": "string", "nullable": true }, "validFeatureSystemId": { "type": "string", "nullable": true }, "updateLinkedFields": { "type": "boolean" }, "referenceFeatureGroupName": { "type": "string", "nullable": true }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureDto" }, "nullable": true }, "order": { "type": "integer", "format": "int32" }, "referenceFeatureGroupId": { "type": "string", "nullable": true }, "referenceFeatureGroupId2": { "type": "string", "nullable": true }, "referenceFeatureSystemName": { "type": "string", "nullable": true }, "guid": { "type": "string", "nullable": true }, "orderValue": { "type": "integer", "format": "int32", "nullable": true }, "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FeatureValueDto": { "type": "object", "properties": { "validFeatureValueId": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IdType": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "IntershopConnection": { "type": "object", "properties": { "domain": { "type": "string", "nullable": true, "deprecated": true }, "organisationId": { "type": "string", "nullable": true }, "channelId": { "type": "string", "nullable": true }, "updateMode": { "type": "string", "nullable": true }, "ftpServerId": { "type": "integer", "format": "int32", "nullable": true }, "productFilePath": { "type": "string", "nullable": true }, "categoryFilePath": { "type": "string", "nullable": true }, "attributesFilePath": { "type": "string", "nullable": true }, "exportMedia": { "type": "boolean", "nullable": true }, "mediaFilePath": { "type": "string", "nullable": true }, "mediaAssetBasePath": { "type": "string", "nullable": true }, "hideProductsWithoutMedia": { "type": "boolean" }, "determineFeatureTypesBeforeExport": { "type": "boolean" }, "apiUrl": { "type": "string", "nullable": true }, "apiUsername": { "type": "string", "nullable": true }, "apiPassword": { "type": "string", "nullable": true }, "apiSite": { "type": "string", "nullable": true }, "apiJobName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LegalCharacteristicDto": { "type": "object", "properties": { "isBiocidalProduct": { "type": "boolean", "nullable": true }, "biocidalFeature": { "type": "string", "nullable": true }, "biocidalIngredient": { "type": "string", "nullable": true }, "isSelfServiceForbidden": { "type": "boolean", "nullable": true }, "isFertigpackv": { "type": "boolean", "nullable": true }, "isOekodesignEvpgEnvkg": { "type": "boolean", "nullable": true }, "isCommoditiesControll": { "type": "boolean", "nullable": true }, "isDetergenzienv": { "type": "boolean", "nullable": true }, "isKosmetikv": { "type": "boolean", "nullable": true }, "isCeGs": { "type": "boolean", "nullable": true }, "isWeeeRohsEar": { "type": "boolean", "nullable": true }, "weeeDeviceType": { "type": "string", "nullable": true }, "weeeNumber": { "type": "string", "nullable": true }, "isReach": { "type": "boolean", "nullable": true }, "scipNumber": { "type": "string", "nullable": true }, "isVerpackungsv": { "type": "boolean", "nullable": true }, "isSecurityDatasheetNeeded": { "type": "boolean", "nullable": true }, "isDualUse": { "type": "boolean", "nullable": true }, "isBatterieV": { "type": "boolean", "nullable": true }, "battGRegistrationNumber": { "type": "string", "nullable": true }, "manufacturer": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "subjectToTax": { "type": "boolean", "nullable": true }, "freelyAvailable": { "type": "boolean", "nullable": true }, "akkuIncluded": { "type": "boolean", "nullable": true }, "batteryIncluded": { "type": "boolean", "nullable": true }, "isEnergyEfficiencyClassRelevant": { "type": "boolean", "nullable": true }, "energyEfficiencyClass": { "type": "string", "nullable": true }, "energyEfficiencyPrescriptionYear": { "type": "string", "nullable": true }, "energyEfficiencyPrescriptionNumber": { "type": "string", "nullable": true }, "energyEfficiencyPrescription": { "type": "string", "nullable": true }, "isEudrRelevant": { "type": "boolean", "nullable": true }, "eudrReferenceNumber": { "type": "string", "nullable": true }, "isHazmatProduct": { "type": "boolean", "nullable": true }, "signalWord": { "type": "string", "nullable": true }, "hazardStatements": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hazardPictograms": { "type": "array", "items": { "type": "string" }, "nullable": true }, "precautionaryStatements": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isSubjectToExplosionProtectionRegulation": { "type": "boolean", "nullable": true }, "eprelLink": { "type": "string", "nullable": true }, "eprelCategory": { "type": "string", "nullable": true }, "eprelRegistrationNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LinkedFieldDto": { "type": "object", "properties": { "field": { "type": "string", "nullable": true }, "systemKey": { "type": "string", "nullable": true }, "elementKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MimeDto": { "type": "object", "properties": { "blobUri": { "type": "string", "nullable": true }, "lastImageLookup": { "type": "string", "format": "date-time", "nullable": true }, "mimeAlt": { "type": "string", "nullable": true }, "mimeDescr": { "type": "string", "nullable": true }, "mimeOrder": { "type": "integer", "format": "int32" }, "mimePurpose": { "type": "string", "nullable": true }, "mimeSource": { "type": "string", "nullable": true }, "mimeType": { "type": "string", "nullable": true }, "normUri": { "type": "string", "nullable": true }, "thumbUri": { "type": "string", "nullable": true }, "excludeFromShopware6": { "type": "boolean" }, "externalImageUrl": { "type": "string", "nullable": true }, "imageRights": { "type": "array", "items": { "type": "string" }, "nullable": true }, "validFrom": { "type": "string", "format": "date-time", "nullable": true }, "validTo": { "type": "string", "format": "date-time", "nullable": true }, "lastChanged": { "type": "string", "format": "date-time" }, "orderValue": { "type": "integer", "format": "int32", "nullable": true }, "mimeSourceEncoded": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "OdooConnection": { "type": "object", "properties": { "baseUri": { "type": "string", "nullable": true }, "user": { "type": "string", "nullable": true }, "database": { "type": "string", "nullable": true }, "apiKey": { "type": "string", "nullable": true }, "newProductsCategory": { "type": "integer", "format": "int32", "nullable": true }, "brandCategory": { "type": "string", "nullable": true }, "overwriteSalesPrices": { "type": "boolean" } }, "additionalProperties": false }, "OrderDetailDto": { "type": "object", "properties": { "contentUnit": { "type": "string", "nullable": true }, "deliveryTime": { "type": "string", "nullable": true }, "noCuPerOu": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "noCuPerOuNumber": { "type": "number", "format": "double", "nullable": true }, "orderUnit": { "type": "string", "nullable": true }, "baseUnit": { "type": "string", "nullable": true }, "packingUnits": { "type": "array", "items": { "$ref": "#/components/schemas/PackingUnitDto" }, "nullable": true }, "priceQuantity": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "priceQuantityNumber": { "type": "number", "format": "double", "nullable": true }, "quantityInterval": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "quantityIntervalNumber": { "type": "number", "format": "double", "nullable": true }, "quantityMax": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "quantityMaxNumber": { "type": "number", "format": "double", "nullable": true }, "quantityMin": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "quantityMinNumber": { "type": "number", "format": "double", "nullable": true }, "contentQuantity": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "contentQuantityNumber": { "type": "number", "format": "double", "nullable": true }, "basicQuantity": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "basicQuantityNumber": { "type": "number", "format": "double", "nullable": true }, "isDurabilityProduct": { "type": "boolean", "nullable": true }, "durabilityDays": { "type": "integer", "format": "int32", "nullable": true }, "contentPackage": { "type": "string", "nullable": true }, "hasBasicPriceDuty": { "type": "boolean", "nullable": true }, "isBulkyGood": { "type": "boolean", "nullable": true }, "isTruckageCompanyGood": { "type": "boolean", "nullable": true }, "costOfLivingAdjustment": { "type": "number", "format": "double", "nullable": true }, "alloySurcharge": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "OsgCategoryMappingDto": { "type": "object", "properties": { "segmentId": { "type": "integer", "format": "int64" }, "segmentIdTest": { "type": "integer", "format": "int64" }, "lastSend": { "type": "string", "format": "date-time", "nullable": true }, "productRange": { "type": "string", "nullable": true }, "categoryIdString": { "type": "string", "nullable": true }, "parentCategoryIdString": { "type": "string", "nullable": true }, "lastSendTest": { "type": "string", "format": "date-time", "nullable": true }, "categoryIdStringTest": { "type": "string", "nullable": true }, "parentCategoryIdStringTest": { "type": "string", "nullable": true }, "productRangeTest": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OsgSegmentMappingDto": { "type": "object", "properties": { "priceType": { "type": "string", "nullable": true }, "categoriesAreSegments": { "type": "boolean" }, "lastSend": { "type": "string", "format": "date-time", "nullable": true }, "productRange": { "type": "string", "nullable": true }, "segmentId": { "type": "integer", "format": "int64" }, "lastSendTest": { "type": "string", "format": "date-time", "nullable": true }, "productRangeTest": { "type": "string", "nullable": true }, "segmentIdTest": { "type": "integer", "format": "int64" }, "includeHazmatClassesInDescriptionTest": { "type": "boolean" }, "includeHazmatClassesInDescription": { "type": "boolean" }, "includeLegal": { "type": "boolean" }, "includeLegalTest": { "type": "boolean" }, "keepRootCategory": { "type": "boolean" }, "exportBrandNameAsTechnicalFeature": { "type": "boolean" }, "exportBrandNameAsTechnicalFeatureTest": { "type": "boolean" } }, "additionalProperties": false }, "PackagingDto": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "internationalPid": { "type": "string", "nullable": true }, "orderUnit": { "type": "string", "nullable": true }, "contentQuantity": { "type": "number", "format": "double", "nullable": true }, "depthNumber": { "type": "number", "format": "double", "nullable": true }, "lengthNumber": { "type": "number", "format": "double", "nullable": true }, "weightNumber": { "type": "number", "format": "double", "nullable": true }, "widthNumber": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Packing": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "supplierPid": { "type": "string", "nullable": true }, "internationalPid": { "type": "string", "nullable": true }, "depth": { "type": "number", "format": "float", "nullable": true }, "length": { "type": "number", "format": "float", "nullable": true }, "width": { "type": "number", "format": "float", "nullable": true }, "weight": { "type": "number", "format": "float", "nullable": true }, "quantityMax": { "type": "integer", "format": "int32", "nullable": true }, "quantityMin": { "type": "integer", "format": "int32", "nullable": true }, "unit": { "type": "string", "nullable": true }, "contentQuantity": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "PackingUnitDto": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "packingUnitCode": { "type": "string", "nullable": true }, "packingUnitDescr": { "type": "string", "nullable": true }, "quantityMax": { "type": "integer", "format": "int32" }, "quantityMin": { "type": "integer", "format": "int32" }, "amountContentUnit": { "type": "integer", "format": "int32" }, "amountSmallerUnit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Party": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "partyId": { "type": "string", "nullable": true }, "partyIdType": { "$ref": "#/components/schemas/IdType" }, "partyRole": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PriceListDto": { "type": "object", "properties": { "catalogPriceList": { "$ref": "#/components/schemas/CatalogPriceListDto" }, "end": { "type": "string", "format": "date-time", "nullable": true }, "priceListOrder": { "type": "integer", "format": "int32" }, "isDailyPrice": { "type": "boolean", "nullable": true }, "productPriceDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPriceDetailDto" }, "nullable": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "orderValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PrintCredentialDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "customerId": { "type": "string", "nullable": true }, "login": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProductDto": { "type": "object", "properties": { "confidence": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "amazonAsin": { "type": "string", "nullable": true }, "buyerAid": { "type": "string", "nullable": true }, "buyerAidType": { "type": "string", "nullable": true }, "catalogId": { "type": "string", "nullable": true }, "changeInfo": { "$ref": "#/components/schemas/ChangeInfoDto" }, "customerId": { "type": "string", "nullable": true }, "descriptionLong": { "type": "string", "nullable": true }, "descriptionShort": { "type": "string", "nullable": true }, "descriptionShort2": { "type": "string", "nullable": true }, "descriptionShort3": { "type": "string", "nullable": true }, "descriptionShort4": { "type": "string", "nullable": true }, "matchcode": { "type": "string", "nullable": true }, "ebayCategory": { "type": "string", "nullable": true }, "edeNumber1": { "type": "string", "nullable": true }, "edeNumber2": { "type": "string", "nullable": true }, "edeNumber3": { "type": "string", "nullable": true }, "edeNumber4": { "type": "string", "nullable": true }, "edeNumber5": { "type": "string", "nullable": true }, "erpGroupBuyer": { "type": "string", "nullable": true }, "erpGroupSupplier": { "type": "string", "nullable": true }, "featureSystems": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureSystemDto" }, "nullable": true }, "googleProductCategory": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "internationalPid": { "type": "string", "nullable": true }, "internationalPidType": { "type": "string", "nullable": true }, "isChild": { "type": "boolean" }, "isMaster": { "type": "boolean" }, "wasMaster": { "type": "boolean" }, "keywords": { "type": "array", "items": { "type": "string" }, "nullable": true }, "printIndexe": { "type": "array", "items": { "type": "string" }, "nullable": true }, "lastChange": { "type": "string", "format": "date-time", "nullable": true }, "manufacturerAid": { "type": "string", "nullable": true }, "manufacturerName": { "type": "string", "nullable": true }, "manufacturerGln": { "type": "string", "nullable": true }, "manufacturerTypeDescr": { "type": "string", "nullable": true }, "brandName": { "type": "string", "nullable": true }, "metaDescription": { "type": "string", "nullable": true }, "isDiscontinued": { "type": "boolean", "nullable": true }, "discontinuedDate": { "type": "string", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "metaTitel": { "type": "string", "nullable": true }, "faqContentHtml": { "type": "string", "nullable": true }, "faqContentJson": { "type": "string", "nullable": true }, "mimes": { "type": "array", "items": { "$ref": "#/components/schemas/MimeDto" }, "nullable": true }, "picture1": { "type": "string", "nullable": true }, "marketingClaim": { "type": "string", "nullable": true }, "scopeOfSupply": { "type": "string", "nullable": true }, "descriptionLongNoHtml": { "type": "string", "nullable": true }, "orderDetail": { "$ref": "#/components/schemas/OrderDetailDto" }, "parentProductId": { "type": "string", "nullable": true }, "priceLists": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListDto" }, "nullable": true }, "productCount": { "type": "integer", "format": "int32" }, "productLogistic": { "$ref": "#/components/schemas/ProductLogisticDto" }, "productOrder": { "type": "number", "format": "double" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDto" }, "nullable": true }, "sourceProductId": { "type": "string", "nullable": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "nullable": true }, "displayItems": { "type": "array", "items": { "$ref": "#/components/schemas/DisplayItemDto" }, "nullable": true }, "remarks": { "type": "string", "nullable": true }, "yearlySellThroughFigures": { "type": "array", "items": { "$ref": "#/components/schemas/SellThroughFiguresDto" }, "nullable": true }, "supplierAltAid": { "type": "string", "nullable": true }, "supplierPid": { "type": "string", "nullable": true }, "udxs": { "type": "array", "items": { "$ref": "#/components/schemas/UdxFieldDto" }, "nullable": true }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/VariantDto" }, "nullable": true }, "mainSupplierId": { "type": "string", "nullable": true }, "purchasingBaseUnit": { "type": "string", "nullable": true }, "suppliers": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSupplierDto" }, "nullable": true }, "stableId": { "type": "string", "nullable": true }, "states": { "type": "array", "items": { "type": "string" }, "nullable": true }, "reportRuns": { "type": "array", "items": { "$ref": "#/components/schemas/ReportLastRunDto" }, "nullable": true }, "linkedFields": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedFieldDto" }, "nullable": true }, "catalogMappings": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogMappingDto" }, "nullable": true }, "legalCharacteristic": { "$ref": "#/components/schemas/LegalCharacteristicDto" }, "wawi": { "$ref": "#/components/schemas/WawiIntegrationDto" }, "electronicSales": { "$ref": "#/components/schemas/ElectronicSalesDto" }, "shopware6Configuration": { "$ref": "#/components/schemas/Shopware6ProductConfiguration" }, "scireum": { "$ref": "#/components/schemas/ProductScireum" }, "normen": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "nullable": true }, "packings": { "type": "array", "items": { "$ref": "#/components/schemas/Packing" }, "nullable": true }, "gpsr": { "$ref": "#/components/schemas/ProductGpsrDto" }, "importer": { "$ref": "#/components/schemas/ProductImporterDto" } }, "additionalProperties": false }, "ProductGpsrDto": { "type": "object", "properties": { "manufacturerName": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Address" }, "countryCode": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "contactPerson": { "type": "string", "nullable": true }, "supportTel": { "type": "string", "nullable": true }, "supportMail": { "type": "string", "nullable": true }, "supportWebsite": { "type": "string", "nullable": true }, "warrantyPages": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProductImporterDto": { "type": "object", "properties": { "importerName": { "type": "string", "nullable": true }, "importerAddress": { "$ref": "#/components/schemas/Address" }, "importerCountryCode": { "type": "string", "nullable": true }, "importerWebsite": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProductLogisticDto": { "type": "object", "properties": { "countryOfOrigin": { "type": "string", "nullable": true }, "customsNumber": { "type": "string", "nullable": true }, "depth": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "depthNumber": { "type": "number", "format": "double", "nullable": true }, "length": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "lengthNumber": { "type": "number", "format": "double", "nullable": true }, "weight": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "weightNumber": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "widthNumber": { "type": "number", "format": "double", "nullable": true }, "specialTreatmentClass": { "type": "string", "nullable": true }, "specialTreatmentClassType": { "type": "string", "nullable": true }, "packagings": { "type": "array", "items": { "$ref": "#/components/schemas/PackagingDto" }, "nullable": true }, "warrantyClassId": { "type": "string", "nullable": true }, "hazardousMaterialClassId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProductPriceDetailDto": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32", "nullable": true }, "lowerBound": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "lowerBoundNumber": { "type": "number", "format": "double", "nullable": true }, "priceAmount": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "priceAmountNumber": { "type": "number", "format": "double", "nullable": true }, "priceFactor": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "priceFactorNumber": { "type": "number", "format": "double", "nullable": true }, "discountPercentNumber": { "type": "number", "format": "double", "nullable": true }, "tax": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "priceCurrency": { "type": "string", "nullable": true }, "priceListId": { "type": "integer", "format": "int64" }, "priceType": { "type": "string", "nullable": true }, "territory": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProductScireum": { "type": "object", "properties": { "isNew": { "type": "boolean", "nullable": true }, "sale": { "type": "boolean", "nullable": true }, "clearance": { "type": "boolean", "nullable": true }, "isNotOrderable": { "type": "boolean", "nullable": true }, "hidden": { "type": "boolean", "nullable": true }, "stockItem": { "type": "boolean", "nullable": true }, "exportable": { "type": "boolean", "nullable": true }, "specialistRetailer": { "type": "boolean", "nullable": true }, "series": { "type": "string", "nullable": true }, "extendedKeyword": { "type": "string", "nullable": true }, "configuratorLink": { "type": "string", "nullable": true }, "ranking": { "type": "integer", "format": "int32", "nullable": true }, "oxomiHausmarkennummer": { "type": "string", "nullable": true }, "nordwestArtikelnummer": { "type": "string", "nullable": true }, "abweichendeLieferantennummer": { "type": "string", "nullable": true }, "zusaetzlicherMatchCode": { "type": "string", "nullable": true }, "katalogartikelnummer": { "type": "string", "nullable": true }, "empfohleneMenge": { "type": "integer", "format": "int32", "nullable": true }, "befoerderungskategorie": { "type": "integer", "format": "int32", "nullable": true }, "artikellaengeMM": { "type": "integer", "format": "int32", "nullable": true }, "artikelbreiteMM": { "type": "integer", "format": "int32", "nullable": true }, "artikelhoeheMM": { "type": "integer", "format": "int32", "nullable": true }, "artikeltiefeMM": { "type": "integer", "format": "int32", "nullable": true }, "artikelGewichtKG": { "type": "number", "format": "double", "nullable": true }, "volumen": { "type": "number", "format": "double", "nullable": true }, "warennummer": { "type": "string", "nullable": true }, "nurGewerblich": { "type": "boolean", "nullable": true }, "lithiumbatterieEnthalten": { "type": "boolean", "nullable": true }, "enthaeltElektrischeKomponenten": { "type": "boolean", "nullable": true }, "ceKennzeichnung": { "type": "boolean", "nullable": true }, "echadbhinterlegt": { "type": "boolean", "nullable": true }, "ubaListKonform": { "type": "boolean", "nullable": true }, "gefahrengutKlasse": { "type": "string", "nullable": true }, "unNummer": { "type": "integer", "format": "int32", "nullable": true }, "offizielleBezeichnung": { "type": "string", "nullable": true }, "technischeBezeichnung": { "type": "string", "nullable": true }, "versandbezeichnung": { "type": "string", "nullable": true }, "gefahrenzettel": { "type": "string", "nullable": true }, "gefahrgutVerpackungsgruppe": { "type": "string", "nullable": true }, "anzahlGefahrgutVersandstuecke": { "type": "integer", "format": "int32", "nullable": true }, "beschreibungGefargutVersandstuecke": { "type": "string", "nullable": true }, "batteriepiktogramm": { "type": "integer", "format": "int32", "nullable": true }, "handelsname": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProductSupplierDto": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "supplierId": { "type": "string", "nullable": true }, "supplierName": { "type": "string", "nullable": true }, "pid": { "type": "string", "nullable": true }, "internationalId": { "type": "string", "nullable": true }, "internationalIdType": { "type": "string", "nullable": true }, "supplierProductDescription": { "type": "string", "nullable": true }, "supplierProductDescriptionShort": { "type": "string", "nullable": true }, "deliveryTime": { "type": "integer", "format": "int32", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "validFrom": { "type": "string", "format": "date-time", "nullable": true }, "validUntil": { "type": "string", "format": "date-time", "nullable": true }, "discountGroupCode": { "type": "string", "nullable": true }, "pricingUnitCode": { "type": "string", "nullable": true }, "priceAllocationUnitCode": { "type": "string", "nullable": true }, "originalPriceAllocationUnitCode": { "type": "string", "nullable": true }, "contentUnitCode": { "type": "string", "nullable": true }, "packingAmount": { "type": "string", "nullable": true }, "orderIntervall": { "type": "string", "nullable": true }, "minOrderAmount": { "type": "string", "nullable": true }, "discontinuedProduct": { "type": "boolean", "nullable": true }, "discontinuedDate": { "type": "string", "format": "date-time", "nullable": true }, "bauvistaArticleNumber": { "type": "string", "nullable": true }, "priceType": { "type": "string", "nullable": true }, "discount": { "type": "number", "format": "double", "nullable": true }, "scaleQuantity": { "type": "number", "format": "double", "nullable": true }, "hasBasicPriceDuty": { "type": "boolean", "nullable": true }, "contentPackage": { "type": "string", "nullable": true }, "basicQuantityNumber": { "type": "number", "format": "double", "nullable": true }, "contentQuantityNumber": { "type": "number", "format": "double", "nullable": true }, "purchasingUnits": { "type": "array", "items": { "$ref": "#/components/schemas/PurchasingUnitDto" }, "nullable": true } }, "additionalProperties": false }, "PurchasingUnitDto": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "unit": { "type": "string", "nullable": true }, "pid": { "type": "string", "nullable": true }, "internationalId": { "type": "string", "nullable": true }, "gevisMapping": { "type": "string", "nullable": true }, "contentQuantity": { "type": "number", "format": "float", "nullable": true }, "depth": { "type": "number", "format": "float", "nullable": true }, "length": { "type": "number", "format": "float", "nullable": true }, "width": { "type": "number", "format": "float", "nullable": true }, "weight": { "type": "number", "format": "float", "nullable": true }, "quantityMin": { "type": "integer", "format": "int32", "nullable": true }, "quantityMax": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ReferenceDto": { "type": "object", "properties": { "artIdTo": { "type": "string", "nullable": true }, "descriptionShort": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "isDisplaySync": { "type": "boolean" }, "quantity": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ReportLastRunDto": { "type": "object", "properties": { "reportName": { "type": "string", "nullable": true }, "lastChange": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SalesChannelToPriceList": { "type": "object", "properties": { "salesChannel": { "$ref": "#/components/schemas/ShopwareSalesChannel" }, "priceList": { "type": "string", "nullable": true }, "priceListOrder": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SellThroughFiguresDto": { "type": "object", "properties": { "year": { "type": "integer", "format": "int32" }, "averageSellThroughPerParticipant": { "type": "integer", "format": "int32" }, "marketVolume": { "type": "integer", "format": "int32" }, "sellThroughVolume": { "type": "integer", "format": "int32" }, "participantCount": { "type": "integer", "format": "int32" }, "marketCount": { "type": "integer", "format": "int32" }, "averageSellThroughPerMarket": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ShopWareConnectionDto": { "type": "object", "properties": { "productLayoutId": { "type": "string", "nullable": true }, "includeHazmatClassesInDescription": { "type": "boolean" }, "variantRepresentation": { "type": "string", "nullable": true }, "categoryLayoutId": { "type": "string", "nullable": true }, "productChanelId": { "type": "string", "nullable": true }, "productChannelIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "baseUri": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "lastSend": { "type": "string", "format": "date-time", "nullable": true }, "rootCatCategoryId": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" }, "nullable": true }, "useQueueIndexing": { "type": "boolean" }, "additionalFeatureSystemNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "deactivateProductsWithoutCategory": { "type": "boolean" }, "dontUpdatePrices": { "type": "boolean" }, "enableDateRules": { "type": "boolean" }, "dateRulesOnlyForMultiplePeriods": { "type": "boolean" }, "overwriteCategoryLayouts": { "type": "boolean" }, "salesChannelsToPriceList": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelToPriceList" }, "nullable": true }, "exportBrandAsManufacturer": { "type": "boolean" }, "exportBrandAsTechnicalFeature": { "type": "boolean" } }, "additionalProperties": false }, "Shopware5Connection": { "type": "object", "properties": { "baseUri": { "type": "string", "nullable": true }, "shopId": { "type": "integer", "format": "int32" }, "rootCatId": { "type": "integer", "format": "int32" }, "rootCatName": { "type": "string", "nullable": true }, "user": { "type": "string", "nullable": true }, "apiKey": { "type": "string", "nullable": true }, "onlyCreatePrices": { "type": "boolean" }, "topFeatureAttribute": { "type": "string", "nullable": true }, "benefitsAttribute": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shopware6CategoryMappingDto": { "type": "object", "properties": { "lastSend": { "type": "string", "format": "date-time" }, "shopWareId": { "type": "string", "nullable": true }, "cmsPageId": { "type": "string", "nullable": true }, "cmsPageName": { "type": "string", "nullable": true }, "productChannelIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Shopware6ProductConfiguration": { "type": "object", "properties": { "excludeFromSalesChannels": { "type": "array", "items": { "type": "string" }, "nullable": true }, "excludeFromExport": { "type": "boolean" } }, "additionalProperties": false }, "ShopwareSalesChannel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SupplierDto": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/AddressDto" }, "mime": { "$ref": "#/components/schemas/MimeDto" }, "supplierId": { "type": "string", "nullable": true }, "supplierIdType": { "type": "string", "nullable": true }, "supplierName": { "type": "string", "nullable": true }, "manufacturer": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UdxFieldDto": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "childs": { "type": "array", "items": { "$ref": "#/components/schemas/UdxFieldDto" }, "nullable": true }, "name": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "type": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VariantDto": { "type": "object", "properties": { "supplierPid": { "type": "string", "nullable": true }, "featureSystem": { "$ref": "#/components/schemas/FeatureSystemDto" } }, "additionalProperties": false }, "WawiIntegrationDto": { "type": "object", "properties": { "wawiId": { "type": "string", "nullable": true }, "line1": { "type": "string", "nullable": true }, "line2": { "type": "string", "nullable": true }, "line3": { "type": "string", "nullable": true }, "line4": { "type": "string", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomWawiFieldDto" }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://app.nextpim.de/connect/token", "scopes": { } } } } } }, "security": [ { "Bearer": [ ] } ] }