action beezup_get_store_report_by_product {
  label: "Get the report by product"
  description: "Get the report by product"
  provider: beezup
  method: POST
  path: "/v2/user/analytics/{storeId}/reports/byproduct"
  encoding: json
  input: {
    type: "object"
    properties: {
      storeId: {
        type: "string"
        format: "guid"
      }
    }
    required: ["storeId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["currencyCode", "links", "paginationResult", "products"]
    properties: {
      currencyCode: {
        type: "string"
        description: "The currency code <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">(ISO 4217)</a>\n"
      }
      links: {
        type: "object"
      }
      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: {
          type: "object"
          required: ["product", "enabledOnChannelCount", "channelCount", "clickCount", "cost", "orderCount", "performanceIndicator", "totalSales", "soldProductCount", "links"]
          properties: {
            channelCount: {
              type: "integer"
              description: "The channel count where this product can be enabled"
            }
            clickCount: {
              type: "integer"
              description: "The click count for this product"
            }
            cost: {
              type: "number"
              description: "The cost for this product"
            }
            enabledOnChannelCount: {
              type: "integer"
              description: "The count of channel where this product is enabled"
            }
            links: {
              type: "object"
              description: "Depending if the report concerned multiple channels or one channel."
              properties: {
                allChannelsLinks: {
                  type: "object"
                  required: ["enableProductForAllChannels", "disableProductForAllChannels"]
                  properties: {
                    disableProductForAllChannels: {
                      type: "object"
                    }
                    enableProductForAllChannels: {
                      type: "object"
                    }
                  }
                }
                oneChannelLinks: {
                  type: "object"
                  description: "If the report concerned one product for one channel the channel catalog product info will give you all you need to enable or disable the product."
                  required: ["productInfo", "enableProductForOneChannel", "disableProductForOneChannel"]
                  properties: {
                    disableProductForOneChannel: {
                      type: "object"
                    }
                    enableProductForOneChannel: {
                      type: "object"
                    }
                    productInfo: {
                      type: "object"
                    }
                  }
                }
              }
            }
            margin: {
              type: "number"
              description: "The margin for this product"
            }
            orderCount: {
              type: "integer"
              description: "The order count for this product"
            }
            performanceIndicator: {
              type: "number"
              description: "The performance indicator based on the performance indicator formula indicated in the request for this product"
            }
            product: {
              type: "object"
              description: "The basic information related to a product"
              required: ["productId", "productSku", "productTitle", "productExists"]
              properties: {
                productExists: {
                  type: "boolean"
                  description: "Indicates if the product still exists in your catalog"
                }
                productId: {
                  type: "string"
                  format: "guid"
                  description: "The product identifier"
                }
                productImageUrl: {
                  type: "string"
                  format: "uri"
                  description: "The product image Url"
                }
                productSku: {
                  type: "string"
                  description: "The product SKU"
                }
                productTitle: {
                  type: "string"
                  description: "The product tile"
                }
              }
            }
            roi: {
              type: "number"
              description: "The Return On Investment for this product"
            }
            soldProductCount: {
              type: "integer"
              description: "The product sold count count for this product"
            }
            totalSales: {
              type: "number"
              description: "The total sales for this product"
            }
          }
        }
      }
    }
  }
}