GET /external/api/statistics/revenue

GET /external/api/statistics/revenue
Authorization key

Query parameters

  • storeId string(uuid)
  • from string(date-time)
  • to string(date-time)

Responses

  • 200

    Success

    Hide response attribute Show response attribute object
    • totalForStores array[object] | null
      Hide totalForStores attributes Show totalForStores attributes object
      • storePublicId string(uuid)
      • storeExternalId string | null
      • totalAmount integer(int64)
      • totalForTaxGroups array[object] | null
        Hide totalForTaxGroups attributes Show totalForTaxGroups attributes object
        • taxGroup string | null
        • totalAmount integer(int64)
      • totalForPaymentMethod array[object] | null
        Hide totalForPaymentMethod attributes Show totalForPaymentMethod attributes object
        • paymentMethod string | null
        • totalAmount integer(int64)
      • totalForOrderReferences array[object] | null
        Hide totalForOrderReferences attributes Show totalForOrderReferences attributes object
        • orderReference string | null
        • totalAmount integer(int64)
        • totalForTaxGroups array[object] | null
          Hide totalForTaxGroups attributes Show totalForTaxGroups attributes object
          • taxGroup string | null
          • totalAmount integer(int64)
        • totalForPaymentMethod array[object] | null
          Hide totalForPaymentMethod attributes Show totalForPaymentMethod attributes object
          • paymentMethod string | null
          • totalAmount integer(int64)
        • totalForProductGroup array[object] | null
          Hide totalForProductGroup attributes Show totalForProductGroup attributes object
          • productGroup string | null
          • totalAmount integer(int64)
          • tax integer(int32)
      • totalForProductGroups array[object] | null
        Hide totalForProductGroups attributes Show totalForProductGroups attributes object
        • productGroup string | null
        • totalAmount integer(int64)
        • tax integer(int32)
    Hide response attribute Show response attribute object
    • totalForStores array[object] | null
      Hide totalForStores attributes Show totalForStores attributes object
      • storePublicId string(uuid)
      • storeExternalId string | null
      • totalAmount integer(int64)
      • totalForTaxGroups array[object] | null
        Hide totalForTaxGroups attributes Show totalForTaxGroups attributes object
        • taxGroup string | null
        • totalAmount integer(int64)
      • totalForPaymentMethod array[object] | null
        Hide totalForPaymentMethod attributes Show totalForPaymentMethod attributes object
        • paymentMethod string | null
        • totalAmount integer(int64)
      • totalForOrderReferences array[object] | null
        Hide totalForOrderReferences attributes Show totalForOrderReferences attributes object
        • orderReference string | null
        • totalAmount integer(int64)
        • totalForTaxGroups array[object] | null
          Hide totalForTaxGroups attributes Show totalForTaxGroups attributes object
          • taxGroup string | null
          • totalAmount integer(int64)
        • totalForPaymentMethod array[object] | null
          Hide totalForPaymentMethod attributes Show totalForPaymentMethod attributes object
          • paymentMethod string | null
          • totalAmount integer(int64)
        • totalForProductGroup array[object] | null
          Hide totalForProductGroup attributes Show totalForProductGroup attributes object
          • productGroup string | null
          • totalAmount integer(int64)
          • tax integer(int32)
      • totalForProductGroups array[object] | null
        Hide totalForProductGroups attributes Show totalForProductGroups attributes object
        • productGroup string | null
        • totalAmount integer(int64)
        • tax integer(int32)
    Hide response attribute Show response attribute object
    • totalForStores array[object] | null
      Hide totalForStores attributes Show totalForStores attributes object
      • storePublicId string(uuid)
      • storeExternalId string | null
      • totalAmount integer(int64)
      • totalForTaxGroups array[object] | null
        Hide totalForTaxGroups attributes Show totalForTaxGroups attributes object
        • taxGroup string | null
        • totalAmount integer(int64)
      • totalForPaymentMethod array[object] | null
        Hide totalForPaymentMethod attributes Show totalForPaymentMethod attributes object
        • paymentMethod string | null
        • totalAmount integer(int64)
      • totalForOrderReferences array[object] | null
        Hide totalForOrderReferences attributes Show totalForOrderReferences attributes object
        • orderReference string | null
        • totalAmount integer(int64)
        • totalForTaxGroups array[object] | null
          Hide totalForTaxGroups attributes Show totalForTaxGroups attributes object
          • taxGroup string | null
          • totalAmount integer(int64)
        • totalForPaymentMethod array[object] | null
          Hide totalForPaymentMethod attributes Show totalForPaymentMethod attributes object
          • paymentMethod string | null
          • totalAmount integer(int64)
        • totalForProductGroup array[object] | null
          Hide totalForProductGroup attributes Show totalForProductGroup attributes object
          • productGroup string | null
          • totalAmount integer(int64)
          • tax integer(int32)
      • totalForProductGroups array[object] | null
        Hide totalForProductGroups attributes Show totalForProductGroups attributes object
        • productGroup string | null
        • totalAmount integer(int64)
        • tax integer(int32)
GET /external/api/statistics/revenue 
curl \
 --request GET 'https://api.fygi.store/external/api/statistics/revenue' \
 --header "authorization: $API_KEY"
Response examples (200) 
{
  "totalForStores": [
    {
      "storePublicId": "string",
      "storeExternalId": "string",
      "totalAmount": 42,
      "totalForTaxGroups": [
        {
          "taxGroup": "string",
          "totalAmount": 42
        }
      ],
      "totalForPaymentMethod": [
        {
          "paymentMethod": "string",
          "totalAmount": 42
        }
      ],
      "totalForOrderReferences": [
        {
          "orderReference": "string",
          "totalAmount": 42,
          "totalForTaxGroups": [
            {
              "taxGroup": "string",
              "totalAmount": 42
            }
          ],
          "totalForPaymentMethod": [
            {
              "paymentMethod": "string",
              "totalAmount": 42
            }
          ],
          "totalForProductGroup": [
            {
              "productGroup": "string",
              "totalAmount": 42,
              "tax": 42
            }
          ]
        }
      ],
      "totalForProductGroups": [
        {
          "productGroup": "string",
          "totalAmount": 42,
          "tax": 42
        }
      ]
    }
  ]
}
Response examples (200) 
{
  "totalForStores": [
    {
      "storePublicId": "string",
      "storeExternalId": "string",
      "totalAmount": 42,
      "totalForTaxGroups": [
        {
          "taxGroup": "string",
          "totalAmount": 42
        }
      ],
      "totalForPaymentMethod": [
        {
          "paymentMethod": "string",
          "totalAmount": 42
        }
      ],
      "totalForOrderReferences": [
        {
          "orderReference": "string",
          "totalAmount": 42,
          "totalForTaxGroups": [
            {
              "taxGroup": "string",
              "totalAmount": 42
            }
          ],
          "totalForPaymentMethod": [
            {
              "paymentMethod": "string",
              "totalAmount": 42
            }
          ],
          "totalForProductGroup": [
            {
              "productGroup": "string",
              "totalAmount": 42,
              "tax": 42
            }
          ]
        }
      ],
      "totalForProductGroups": [
        {
          "productGroup": "string",
          "totalAmount": 42,
          "tax": 42
        }
      ]
    }
  ]
}