Most sold

List all products given an analysis

post

Authorizations

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Body

typestring · enumoptional

Available options:

partner_idstringoptional

start_datestring · daterequired

final_datestring · daterequired

limitinteger · int32optional

filterstringoptional

with_product_databooleanoptional

criteriastring[]optional

argumentsstringoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.zydon.com.br/api/sales/products/analysis/most-sold' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "ORDER_QUANTITY",
    "partner_id": "text",
    "start_date": "2025-04-01",
    "final_date": "2025-04-01",
    "limit": 1,
    "filter": "text",
    "with_product_data": true,
    "criteria": [
      "text"
    ],
    "arguments": "text"
  }'

200

404

500

200

[
  {
    "product_id": "text",
    "quantity": 1,
    "value": 1,
    "product": {
      "id": "text",
      "active": true,
      "name": "text",
      "sku": "text",
      "short_description": "text",
      "long_description": "text",
      "ean_gtin": "text",
      "brand_id": "text",
      "brand_name": "text",
      "video_url": "text",
      "main_image_url": "text",
      "price": 1,
      "stock": 1,
      "warehouse_default": "text",
      "warehouse_default_name": "text",
      "maximum_discount": 1,
      "minimum_stock": 1,
      "minimum_for_sale": 1,
      "multiple_for_sale": 1,
      "standard_unit_id": "text",
      "standard_unit_name": "text",
      "standard_unit_abbreviation": "text",
      "standard_unit_decimals_for_quantity": 1,
      "category_id": "text",
      "category_name": "text",
      "product_weight": 1,
      "product_width": 1,
      "product_height": 1,
      "product_depth": 1,
      "packaging_weight": 1,
      "packaging_width": 1,
      "packaging_height": 1,
      "packaging_depth": 1,
      "highlight": true,
      "seo_title": "text",
      "seo_description": "text",
      "seo_meta_keywords": [
        "text"
      ],
      "maximum_markup": 1,
      "alternative_units": [
        {
          "id": "text",
          "product_id": "text",
          "unit_id": "text",
          "unit_name": "text",
          "unit_abbreviation": "text",
          "decimals_for_quantity": 1,
          "value_multiplier": 1,
          "quantity": 1
        }
      ],
      "variations": [
        {
          "id": "text",
          "sku": "text",
          "price": 1,
          "stock": 1,
          "variation_weight": 1,
          "variation_width": 1,
          "variation_height": 1,
          "variation_depth": 1,
          "packaging_weight": 1,
          "packaging_width": 1,
          "packaging_height": 1,
          "packaging_depth": 1,
          "images": [
            {
              "resource_id": "text",
              "main": true
            }
          ],
          "values": [
            {
              "variation_id": "text",
              "name": "text",
              "value": "text"
            }
          ]
        }
      ],
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "category_specifications": [
        {
          "name": "text",
          "items": [
            {
              "id": "text",
              "specification_id": "text",
              "name": "text",
              "type": "text",
              "options": [
                "text"
              ],
              "values": [
                "text"
              ]
            }
          ]
        }
      ]
    }
  }
]

OK