Get the report by day for a StoreId

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "advancedFilters": {
      "type": "object",
      "required": [
        "linkClickToOrderType",
        "marginType",
        "onlyDirectSales",
        "onlyPaymentValidatedOrders",
        "performanceIndicatorFormula"
      ],
      "properties": {
        "globalMarginPercent": {
          "type": "integer",
          "description": "If the margin type is 'Global', indicate the percentage of sale price."
        },
        "linkClickToOrderMaxDay": {
          "type": "integer",
          "description": "If the linkOrderType is OnClickDate, indicate the max day to search the click from the order"
        },
        "linkClickToOrderType": {
          "type": "string",
          "enum": [
            "OnPurchaseDate",
            "OnClickDate"
          ]
        },
        "marginType": {
          "type": "string",
          "enum": [
            "Tracker",
            "Global"
          ]
        },
        "onlyDirectSales": {
          "type": "boolean",
          "description": "If true, you will get only direct sales. Otherwise the indirect sales will be included."
        },
        "onlyPaymentValidatedOrders": {
          "type": "boolean",
          "description": "If true, you will get the only the orders with payment validated. Otherwise, you will get all orders validated or not."
        },
        "performanceIndicatorFormula": {
          "type": "object",
          "description": "The KPI formula",
          "properties": {
            "firstParameter": {
              "type": "string",
              "description": "Indicate on which indicator or value you want to make your formula",
              "enum": [
                "Cost",
                "TotalSales",
                "Margin",
                "TotalSalesMinusCost",
                "MarginMinusCost",
                "OrderCount",
                "ClickCount",
                "SoldProductCount",
                "One"
              ]
            },
            "operatorName": {
              "type": "string",
              "enum": [
                "Multiply",
                "Divide"
              ]
            },
            "secondParameter": {
              "type": "string",
              "description": "Indicate on which indicator or value you want to make your formula",
              "enum": [
                "Cost",
                "TotalSales",
                "Margin",
                "TotalSalesMinusCost",
                "MarginMinusCost",
                "OrderCount",
                "ClickCount",
                "SoldProductCount",
                "One"
              ]
            },
            "thirdParameter": {
              "type": "integer",
              "description": "Indicate the value of the third parameter of your formula"
            }
          }
        }
      }
    },
    "beginPeriodUtcDate": {
      "type": "string",
      "format": "date",
      "description": "The begin date of the period for the report"
    },
    "catalogCategoryId": {
      "type": "string",
      "format": "guid",
      "description": "The catalog category identifier"
    },
    "channelIds": {
      "type": "array",
      "description": "Indicate the channel identifier list",
      "items": {
        "type": "string",
        "format": "guid",
        "description": "The channel identifier"
      }
    },
    "endPeriodUtcDate": {
      "type": "string",
      "format": "date",
      "description": "The end date of the period for the report"
    },
    "productId": {
      "type": "string",
      "format": "guid",
      "description": "The product identifier"
    },
    "storeId": {
      "type": "string",
      "format": "guid"
    }
  },
  "required": [
    "beginPeriodUtcDate",
    "endPeriodUtcDate",
    "storeId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "currencyCode",
    "days",
    "globalPerformanceIndicators"
  ],
  "properties": {
    "currencyCode": {
      "type": "string",
      "description": "The currency code <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">(ISO 4217)</a>\n"
    },
    "days": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "day",
          "allChannels",
          "byChannels"
        ],
        "properties": {
          "allChannels": {
            "type": "object",
            "required": [
              "clickCount",
              "cost",
              "orderCount",
              "roi",
              "margin",
              "performanceIndicator",
              "totalSales",
              "soldProductCount"
            ],
            "properties": {
              "clickCount": {
                "type": "integer",
                "description": "The click count"
              },
              "cost": {
                "type": "number",
                "description": "The cost"
              },
              "margin": {
                "type": "number",
                "description": "The margin"
              },
              "orderCount": {
                "type": "integer",
                "description": "The order count"
              },
              "performanceIndicator": {
                "type": "number",
                "description": "The performance indicator based on the performance indicator formula indicated in the request"
              },
              "roi": {
                "type": "number",
                "description": "The Return On Investment"
              },
              "soldProductCount": {
                "type": "integer",
                "description": "The product sold count count"
              },
              "totalSales": {
                "type": "number",
                "description": "The total sales"
              }
            }
          },
          "byChannels": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "day": {
            "type": "string",
            "format": "date"
          }
        }
      }
    },
    "globalPerformanceIndicators": {
      "type": "object",
      "required": [
        "allChannels",
        "byChannels"
      ],
      "properties": {
        "allChannels": {
          "type": "object",
          "required": [
            "performanceIndicator"
          ],
          "properties": {
            "performanceIndicator": {
              "type": "number",
              "description": "Indicates the global performance indicator"
            }
          }
        },
        "byChannels": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    }
  }
}