action beezup_catalog_get_products { label: "Get product list" provider: beezup method: POST path: "/v2/user/catalogs/{storeId}/products/list" encoding: json input: { type: "object" properties: { categoryPath: { type: "array" description: "The catalog category path" items: { type: "string" } } columnIdList: { type: "array" items: { type: "string" format: "guid" description: "The catalog column identifier (catalog or custom column)" } } ean: { type: "string" description: "Search for product by ean" } exists: { type: "boolean" description: "Search for existing products or not. If null you will received both." } mpn: { type: "string" description: "Search for product by mpn" } orderByCatalogColumnId: { type: "string" format: "guid" description: "The catalog column identifier (catalog or custom column)" } pageNumber: { type: "integer" format: "int32" description: "Indicates the page number" } pageSize: { type: "integer" format: "int32" description: "Indicate the item count per page" } productIdList: { type: "array" description: "Filter with a list of product identifier" items: { type: "string" format: "guid" description: "The product identifier" } } sku: { type: "string" description: "Search for product by sku" } storeId: { type: "string" format: "guid" } title: { type: "string" description: "Search for products containing this title" } withoutSubCategories: { type: "boolean" description: "Do not retrieve sub categories. By default, this value is set to false" } } required: ["pageNumber", "pageSize", "storeId"] additionalProperties: false } output: { type: "object" required: ["paginationResult", "products"] properties: { paginationResult: { type: "object" required: ["entryCount", "links", "pageCount", "totalEntryCount"] properties: { entryCount: { type: "integer" description: "The entry count currently returned" } links: { type: "object" description: "The navigation links 'first', 'last', 'next', 'previous'" required: ["first", "last"] properties: { first: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } last: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } next: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } previous: { type: "object" required: ["href"] properties: { allOptionalParamsProvided: { type: "boolean" description: "indicates whether all optionals params have been provided" } allRequiredParamsProvided: { type: "boolean" description: "indicates whether all required params have been provided" } description: { type: "string" description: "The description of the link" } docUrl: { type: "string" format: "uri" description: "The documentation related to this operation." } href: { type: "string" description: "Indicate the relative uri for this link" } info: { type: "object" properties: { errors: { type: "array" items: { type: "object" properties: { errorArguments: { type: "object" } errorCode: { type: "string" } errorGuid: { type: "string" format: "uuid" } errorMessage: { type: "string" } exceptionDetail: { type: "object" properties: { helpLink: { type: "string" } message: { type: "string" } stackTrace: { type: "string" } type: { type: "string" } } } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } source: { type: "string" } technicalErrorMessage: { type: "string" } utcDate: { type: "string" format: "date-time" } } } } informations: { type: "array" items: { type: "object" properties: { informationArguments: { type: "object" } informationCode: { type: "string" } informationMessage: { type: "string" } objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } } } } successes: { type: "array" items: { type: "object" properties: { objectName: { type: "string" } propertyName: { type: "string" } propertyValue: { type: "string" } successArguments: { type: "object" } successCode: { type: "string" } successMessage: { type: "string" } } } } warnings: { type: "array" items: { type: "object" properties: { technicalErrorMessage: { type: "string" } warningArguments: { type: "object" } warningCode: { type: "string" } warningMessage: { type: "string" } } } } } } label: { type: "string" description: "The label corresponding to the link. This label is automatically translated based on the Accept-Language http header." } method: { type: "string" description: "Indicate the http method to use on this link" enum: ["GET", "POST", "PATCH", "DELETE", "PUT", "HEAD"] } operationId: { type: "string" description: "The operationId to call." } parameters: { type: "object" } urlTemplated: { type: "boolean" description: "indicates whether the href is templated or not" } } } } } pageCount: { type: "integer" description: "The page count" } totalEntryCount: { type: "integer" description: "The total entry count" } } } products: { type: "array" items: { description: "Represent a catalog product" required: ["productId", "categoryId", "values", "exists"] properties: { categoryId: { type: "string" format: "guid" description: "The catalog category identifier" } exists: { type: "boolean" description: "Indicates if the product exists in the current catalog" } productId: { type: "string" format: "guid" description: "The product identifier" } values: { type: "object" description: "The key is the column identifier" } } } } } } }