vendorSalesReport: {
    definitions: {
        Amount: {
            examples: readonly [
                { amount: 0; currencyCode: "USD" },
                { amount: 20; currencyCode: "EUR" },
            ];
            properties: {
                amount: {
                    description: "The amount.";
                    examples: readonly [20];
                    type: "number";
                };
                currencyCode: {
                    description: "Currency code of the amount. In ISO 4217 format.";
                    examples: readonly ["USD", "EUR", "AUD", "JPY"];
                    type: "string";
                };
            };
            required: readonly ["amount", "currencyCode"];
            type: "object";
        };
        SalesAggregate: {
            description: "Describes aggregated sales metrics for ASINs in the vendor's account.";
            examples: readonly [
                {
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1500; currencyCode: "USD" };
                    orderedUnits: 75;
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
            ];
            properties: {
                customerReturns: {
                    description: "The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS.";
                    examples: readonly [0];
                    minimum: 0;
                    type: "integer";
                };
                endDate: {
                    description: "The end date of the aggregated data.";
                    examples: readonly ["2021-06-12"];
                    format: "date";
                    type: "string";
                };
                orderedRevenue: {
                    $ref: "#/definitions/Amount";
                    description: "Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING.";
                };
                orderedUnits: {
                    description: "Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING.";
                    examples: readonly [75];
                    minimum: 0;
                    type: "integer";
                };
                shippedCogs: {
                    $ref: "#/definitions/Amount";
                    description: "Revenue based on the cost of goods sold. Adjustments are made for returns.";
                };
                shippedRevenue: {
                    $ref: "#/definitions/Amount";
                    description: "Revenue based on units shipped in the selected time frame. Adjustments are made for returns.";
                };
                shippedUnits: {
                    description: "Number of units shipped to Amazon customers.";
                    examples: readonly [10];
                    minimum: 0;
                    type: "integer";
                };
                startDate: {
                    description: "The start date of the aggregated data.";
                    examples: readonly ["2021-06-06"];
                    format: "date";
                    type: "string";
                };
            };
            required: readonly [
                "startDate",
                "endDate",
                "shippedCogs",
                "shippedRevenue",
                "shippedUnits",
            ];
            type: "object";
        };
        SalesByAsin: {
            description: "Describes aggregated ASIN-level sales metrics for ASINs in the vendor's account.";
            examples: readonly [
                {
                    asin: "B123456789";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1000; currencyCode: "USD" };
                    orderedUnits: 25;
                    shippedCogs: { amount: 50; currencyCode: "USD" };
                    shippedRevenue: { amount: 150; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
            ];
            properties: {
                asin: {
                    description: "The Amazon Standard Identification Number.";
                    examples: readonly ["B123456789"];
                    type: "string";
                };
                customerReturns: {
                    description: "The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS.";
                    examples: readonly [0];
                    minimum: 0;
                    type: "integer";
                };
                endDate: {
                    description: "The end date of the aggregated ASIN-level data.";
                    examples: readonly ["2021-06-12"];
                    format: "date";
                    type: "string";
                };
                orderedRevenue: {
                    $ref: "#/definitions/Amount";
                    description: "Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING";
                };
                orderedUnits: {
                    description: "Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING";
                    examples: readonly [25];
                    minimum: 0;
                    type: "integer";
                };
                shippedCogs: {
                    $ref: "#/definitions/Amount";
                    description: "Revenue based on the cost of goods sold. Adjustments are made for returns.";
                };
                shippedRevenue: {
                    $ref: "#/definitions/Amount";
                    description: "Revenue based on units shipped in the selected time frame. Adjustments are made for returns.";
                };
                shippedUnits: {
                    description: "Number of units shipped to Amazon customers.";
                    examples: readonly [5];
                    minimum: 0;
                    type: "integer";
                };
                startDate: {
                    description: "The start date of the aggregated ASIN-level data.";
                    examples: readonly ["2021-06-06"];
                    format: "date";
                    type: "string";
                };
            };
            required: readonly [
                "startDate",
                "endDate",
                "asin",
                "shippedCogs",
                "shippedRevenue",
                "shippedUnits",
            ];
            type: "object";
        };
    };
    description: "This report shares data on the sales performance of vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods.";
    examples: readonly [
        {
            reportSpecification: {
                dataEndTime: "2021-06-19";
                dataStartTime: "2021-06-06";
                lastUpdatedDate: "2021-06-20";
                marketplaceIds: readonly ["ATVPDKIKX0DER"];
                reportOptions: {
                    distributorView: "MANUFACTURING";
                    reportPeriod: "WEEK";
                    sellingProgram: "RETAIL";
                };
                reportType: "GET_VENDOR_SALES_REPORT";
            };
            salesAggregate: readonly [
                {
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1500; currencyCode: "USD" };
                    orderedUnits: 75;
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
                {
                    customerReturns: 0;
                    endDate: "2021-06-19";
                    orderedRevenue: { amount: 0; currencyCode: "USD" };
                    orderedUnits: 0;
                    shippedCogs: { amount: 0; currencyCode: "USD" };
                    shippedRevenue: { amount: 0; currencyCode: "USD" };
                    shippedUnits: 0;
                    startDate: "2021-06-13";
                },
            ];
            salesByAsin: readonly [
                {
                    asin: "B123456789";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1000; currencyCode: "USD" };
                    orderedUnits: 25;
                    shippedCogs: { amount: 50; currencyCode: "USD" };
                    shippedRevenue: { amount: 150; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
                {
                    asin: "B987654321";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 500; currencyCode: "USD" };
                    orderedUnits: 50;
                    shippedCogs: { amount: 40; currencyCode: "USD" };
                    shippedRevenue: { amount: 50; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
                {
                    asin: "B123456789";
                    customerReturns: 0;
                    endDate: "2021-06-19";
                    orderedRevenue: { amount: 0; currencyCode: "USD" };
                    orderedUnits: 0;
                    shippedCogs: { amount: 0; currencyCode: "USD" };
                    shippedRevenue: { amount: 0; currencyCode: "USD" };
                    shippedUnits: 0;
                    startDate: "2021-06-13";
                },
                {
                    asin: "B987654321";
                    customerReturns: 0;
                    endDate: "2021-06-19";
                    orderedRevenue: { amount: 0; currencyCode: "USD" };
                    orderedUnits: 0;
                    shippedCogs: { amount: 0; currencyCode: "USD" };
                    shippedRevenue: { amount: 0; currencyCode: "USD" };
                    shippedUnits: 0;
                    startDate: "2021-06-13";
                },
            ];
        },
        {
            reportSpecification: {
                dataEndTime: "2021-06-19";
                dataStartTime: "2021-06-06";
                lastUpdatedDate: "2021-06-20";
                marketplaceIds: readonly ["ATVPDKIKX0DER"];
                reportOptions: {
                    distributorView: "MANUFACTURING";
                    reportPeriod: "WEEK";
                    sellingProgram: "FRESH";
                };
                reportType: "GET_VENDOR_SALES_REPORT";
            };
            salesAggregate: readonly [
                {
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1500; currencyCode: "USD" };
                    orderedUnits: 75;
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
            ];
            salesByAsin: readonly [
                {
                    asin: "B123456789";
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1500; currencyCode: "USD" };
                    orderedUnits: 75;
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
            ];
        },
        {
            reportSpecification: {
                dataEndTime: "2021-06-12";
                dataStartTime: "2021-06-06";
                lastUpdatedDate: "2021-06-20";
                marketplaceIds: readonly ["ATVPDKIKX0DER"];
                reportOptions: {
                    distributorView: "SOURCING";
                    reportPeriod: "WEEK";
                    sellingProgram: "RETAIL";
                };
                reportType: "GET_VENDOR_SALES_REPORT";
            };
            salesAggregate: readonly [
                {
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
            ];
            salesByAsin: readonly [
                {
                    asin: "B123456789";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    shippedCogs: { amount: 50; currencyCode: "USD" };
                    shippedRevenue: { amount: 150; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
                {
                    asin: "B987654321";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    shippedCogs: { amount: 40; currencyCode: "USD" };
                    shippedRevenue: { amount: 50; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
            ];
        },
    ];
    properties: {
        reportSpecification: {
            description: "The report summary including reporting date range, distributor view, selling program, and last updated date in the input.";
            examples: readonly [
                {
                    dataEndTime: "2021-06-19";
                    dataStartTime: "2021-06-06";
                    lastUpdatedDate: "2021-06-20";
                    marketplaceIds: readonly ["ATVPDKIKX0DER"];
                    reportOptions: {
                        distributorView: "MANUFACTURING";
                        reportPeriod: "WEEK";
                        sellingProgram: "RETAIL";
                    };
                    reportType: "GET_VENDOR_SALES_REPORT";
                },
            ];
            properties: {
                dataEndTime: {
                    description: "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod.";
                    examples: readonly ["2021-06-19"];
                    format: "date";
                    type: "string";
                };
                dataStartTime: {
                    description: "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod.";
                    examples: readonly ["2021-06-06"];
                    format: "date";
                    type: "string";
                };
                lastUpdatedDate: {
                    description: "The date when the report was last updated. Follows the <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> Date format of YYYY-MM-DD.";
                    examples: readonly ["2021-06-20"];
                    format: "date";
                    type: "string";
                };
                marketplaceIds: {
                    description: "This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to only one marketplaceId.";
                    examples: readonly [readonly ["ATVPDKIKX0DER"]];
                    items: { type: "string" };
                    type: "array";
                };
                reportOptions: {
                    description: "Report options specifying parameters such as reportPeriod, distributorView, and sellingProgram.";
                    examples: readonly [
                        {
                            distributorView: "MANUFACTURING";
                            reportPeriod: "WEEK";
                            sellingProgram: "RETAIL";
                        },
                    ];
                    properties: {
                        distributorView: {
                            description: "The distributor view.";
                            enum: readonly ["MANUFACTURING", "SOURCING"];
                            type: "string";
                        };
                        reportPeriod: {
                            description: "Determines what granularity of data is expected in the report. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR.";
                            enum: readonly ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"];
                            type: "string";
                        };
                        sellingProgram: {
                            description: "The selling program.";
                            enum: readonly ["RETAIL", "BUSINESS", "FRESH"];
                            type: "string";
                        };
                    };
                    required: readonly [
                        "distributorView",
                        "reportPeriod",
                        "sellingProgram",
                    ];
                    type: "object";
                };
                reportType: {
                    description: "The report type.";
                    enum: readonly ["GET_VENDOR_SALES_REPORT"];
                    type: "string";
                };
            };
            required: readonly [
                "reportType",
                "reportOptions",
                "lastUpdatedDate",
                "dataStartTime",
                "dataEndTime",
                "marketplaceIds",
            ];
            type: "object";
        };
        salesAggregate: {
            items: { $ref: "#/definitions/SalesAggregate" };
            type: "array";
        };
        salesByAsin: {
            items: { $ref: "#/definitions/SalesByAsin" };
            type: "array";
        };
    };
    required: readonly ["reportSpecification", "salesAggregate", "salesByAsin"];
    type: "object";
} = ...

Type declaration

  • Readonlydefinitions: {
        Amount: {
            examples: readonly [
                { amount: 0; currencyCode: "USD" },
                { amount: 20; currencyCode: "EUR" },
            ];
            properties: {
                amount: {
                    description: "The amount.";
                    examples: readonly [20];
                    type: "number";
                };
                currencyCode: {
                    description: "Currency code of the amount. In ISO 4217 format.";
                    examples: readonly ["USD", "EUR", "AUD", "JPY"];
                    type: "string";
                };
            };
            required: readonly ["amount", "currencyCode"];
            type: "object";
        };
        SalesAggregate: {
            description: "Describes aggregated sales metrics for ASINs in the vendor's account.";
            examples: readonly [
                {
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1500; currencyCode: "USD" };
                    orderedUnits: 75;
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
            ];
            properties: {
                customerReturns: {
                    description: "The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS.";
                    examples: readonly [0];
                    minimum: 0;
                    type: "integer";
                };
                endDate: {
                    description: "The end date of the aggregated data.";
                    examples: readonly ["2021-06-12"];
                    format: "date";
                    type: "string";
                };
                orderedRevenue: {
                    $ref: "#/definitions/Amount";
                    description: "Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING.";
                };
                orderedUnits: {
                    description: "Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING.";
                    examples: readonly [75];
                    minimum: 0;
                    type: "integer";
                };
                shippedCogs: {
                    $ref: "#/definitions/Amount";
                    description: "Revenue based on the cost of goods sold. Adjustments are made for returns.";
                };
                shippedRevenue: {
                    $ref: "#/definitions/Amount";
                    description: "Revenue based on units shipped in the selected time frame. Adjustments are made for returns.";
                };
                shippedUnits: {
                    description: "Number of units shipped to Amazon customers.";
                    examples: readonly [10];
                    minimum: 0;
                    type: "integer";
                };
                startDate: {
                    description: "The start date of the aggregated data.";
                    examples: readonly ["2021-06-06"];
                    format: "date";
                    type: "string";
                };
            };
            required: readonly [
                "startDate",
                "endDate",
                "shippedCogs",
                "shippedRevenue",
                "shippedUnits",
            ];
            type: "object";
        };
        SalesByAsin: {
            description: "Describes aggregated ASIN-level sales metrics for ASINs in the vendor's account.";
            examples: readonly [
                {
                    asin: "B123456789";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1000; currencyCode: "USD" };
                    orderedUnits: 25;
                    shippedCogs: { amount: 50; currencyCode: "USD" };
                    shippedRevenue: { amount: 150; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
            ];
            properties: {
                asin: {
                    description: "The Amazon Standard Identification Number.";
                    examples: readonly ["B123456789"];
                    type: "string";
                };
                customerReturns: {
                    description: "The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS.";
                    examples: readonly [0];
                    minimum: 0;
                    type: "integer";
                };
                endDate: {
                    description: "The end date of the aggregated ASIN-level data.";
                    examples: readonly ["2021-06-12"];
                    format: "date";
                    type: "string";
                };
                orderedRevenue: {
                    $ref: "#/definitions/Amount";
                    description: "Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING";
                };
                orderedUnits: {
                    description: "Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING";
                    examples: readonly [25];
                    minimum: 0;
                    type: "integer";
                };
                shippedCogs: {
                    $ref: "#/definitions/Amount";
                    description: "Revenue based on the cost of goods sold. Adjustments are made for returns.";
                };
                shippedRevenue: {
                    $ref: "#/definitions/Amount";
                    description: "Revenue based on units shipped in the selected time frame. Adjustments are made for returns.";
                };
                shippedUnits: {
                    description: "Number of units shipped to Amazon customers.";
                    examples: readonly [5];
                    minimum: 0;
                    type: "integer";
                };
                startDate: {
                    description: "The start date of the aggregated ASIN-level data.";
                    examples: readonly ["2021-06-06"];
                    format: "date";
                    type: "string";
                };
            };
            required: readonly [
                "startDate",
                "endDate",
                "asin",
                "shippedCogs",
                "shippedRevenue",
                "shippedUnits",
            ];
            type: "object";
        };
    }
  • Readonlydescription: "This report shares data on the sales performance of vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods."
  • Readonlyexamples: readonly [
        {
            reportSpecification: {
                dataEndTime: "2021-06-19";
                dataStartTime: "2021-06-06";
                lastUpdatedDate: "2021-06-20";
                marketplaceIds: readonly ["ATVPDKIKX0DER"];
                reportOptions: {
                    distributorView: "MANUFACTURING";
                    reportPeriod: "WEEK";
                    sellingProgram: "RETAIL";
                };
                reportType: "GET_VENDOR_SALES_REPORT";
            };
            salesAggregate: readonly [
                {
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1500; currencyCode: "USD" };
                    orderedUnits: 75;
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
                {
                    customerReturns: 0;
                    endDate: "2021-06-19";
                    orderedRevenue: { amount: 0; currencyCode: "USD" };
                    orderedUnits: 0;
                    shippedCogs: { amount: 0; currencyCode: "USD" };
                    shippedRevenue: { amount: 0; currencyCode: "USD" };
                    shippedUnits: 0;
                    startDate: "2021-06-13";
                },
            ];
            salesByAsin: readonly [
                {
                    asin: "B123456789";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1000; currencyCode: "USD" };
                    orderedUnits: 25;
                    shippedCogs: { amount: 50; currencyCode: "USD" };
                    shippedRevenue: { amount: 150; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
                {
                    asin: "B987654321";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 500; currencyCode: "USD" };
                    orderedUnits: 50;
                    shippedCogs: { amount: 40; currencyCode: "USD" };
                    shippedRevenue: { amount: 50; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
                {
                    asin: "B123456789";
                    customerReturns: 0;
                    endDate: "2021-06-19";
                    orderedRevenue: { amount: 0; currencyCode: "USD" };
                    orderedUnits: 0;
                    shippedCogs: { amount: 0; currencyCode: "USD" };
                    shippedRevenue: { amount: 0; currencyCode: "USD" };
                    shippedUnits: 0;
                    startDate: "2021-06-13";
                },
                {
                    asin: "B987654321";
                    customerReturns: 0;
                    endDate: "2021-06-19";
                    orderedRevenue: { amount: 0; currencyCode: "USD" };
                    orderedUnits: 0;
                    shippedCogs: { amount: 0; currencyCode: "USD" };
                    shippedRevenue: { amount: 0; currencyCode: "USD" };
                    shippedUnits: 0;
                    startDate: "2021-06-13";
                },
            ];
        },
        {
            reportSpecification: {
                dataEndTime: "2021-06-19";
                dataStartTime: "2021-06-06";
                lastUpdatedDate: "2021-06-20";
                marketplaceIds: readonly ["ATVPDKIKX0DER"];
                reportOptions: {
                    distributorView: "MANUFACTURING";
                    reportPeriod: "WEEK";
                    sellingProgram: "FRESH";
                };
                reportType: "GET_VENDOR_SALES_REPORT";
            };
            salesAggregate: readonly [
                {
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1500; currencyCode: "USD" };
                    orderedUnits: 75;
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
            ];
            salesByAsin: readonly [
                {
                    asin: "B123456789";
                    endDate: "2021-06-12";
                    orderedRevenue: { amount: 1500; currencyCode: "USD" };
                    orderedUnits: 75;
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
            ];
        },
        {
            reportSpecification: {
                dataEndTime: "2021-06-12";
                dataStartTime: "2021-06-06";
                lastUpdatedDate: "2021-06-20";
                marketplaceIds: readonly ["ATVPDKIKX0DER"];
                reportOptions: {
                    distributorView: "SOURCING";
                    reportPeriod: "WEEK";
                    sellingProgram: "RETAIL";
                };
                reportType: "GET_VENDOR_SALES_REPORT";
            };
            salesAggregate: readonly [
                {
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    shippedCogs: { amount: 90; currencyCode: "USD" };
                    shippedRevenue: { amount: 200; currencyCode: "USD" };
                    shippedUnits: 10;
                    startDate: "2021-06-06";
                },
            ];
            salesByAsin: readonly [
                {
                    asin: "B123456789";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    shippedCogs: { amount: 50; currencyCode: "USD" };
                    shippedRevenue: { amount: 150; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
                {
                    asin: "B987654321";
                    customerReturns: 0;
                    endDate: "2021-06-12";
                    shippedCogs: { amount: 40; currencyCode: "USD" };
                    shippedRevenue: { amount: 50; currencyCode: "USD" };
                    shippedUnits: 5;
                    startDate: "2021-06-06";
                },
            ];
        },
    ]
  • Readonlyproperties: {
        reportSpecification: {
            description: "The report summary including reporting date range, distributor view, selling program, and last updated date in the input.";
            examples: readonly [
                {
                    dataEndTime: "2021-06-19";
                    dataStartTime: "2021-06-06";
                    lastUpdatedDate: "2021-06-20";
                    marketplaceIds: readonly ["ATVPDKIKX0DER"];
                    reportOptions: {
                        distributorView: "MANUFACTURING";
                        reportPeriod: "WEEK";
                        sellingProgram: "RETAIL";
                    };
                    reportType: "GET_VENDOR_SALES_REPORT";
                },
            ];
            properties: {
                dataEndTime: {
                    description: "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod.";
                    examples: readonly ["2021-06-19"];
                    format: "date";
                    type: "string";
                };
                dataStartTime: {
                    description: "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod.";
                    examples: readonly ["2021-06-06"];
                    format: "date";
                    type: "string";
                };
                lastUpdatedDate: {
                    description: "The date when the report was last updated. Follows the <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> Date format of YYYY-MM-DD.";
                    examples: readonly ["2021-06-20"];
                    format: "date";
                    type: "string";
                };
                marketplaceIds: {
                    description: "This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to only one marketplaceId.";
                    examples: readonly [readonly ["ATVPDKIKX0DER"]];
                    items: { type: "string" };
                    type: "array";
                };
                reportOptions: {
                    description: "Report options specifying parameters such as reportPeriod, distributorView, and sellingProgram.";
                    examples: readonly [
                        {
                            distributorView: "MANUFACTURING";
                            reportPeriod: "WEEK";
                            sellingProgram: "RETAIL";
                        },
                    ];
                    properties: {
                        distributorView: {
                            description: "The distributor view.";
                            enum: readonly ["MANUFACTURING", "SOURCING"];
                            type: "string";
                        };
                        reportPeriod: {
                            description: "Determines what granularity of data is expected in the report. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR.";
                            enum: readonly ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"];
                            type: "string";
                        };
                        sellingProgram: {
                            description: "The selling program.";
                            enum: readonly ["RETAIL", "BUSINESS", "FRESH"];
                            type: "string";
                        };
                    };
                    required: readonly ["distributorView", "reportPeriod", "sellingProgram"];
                    type: "object";
                };
                reportType: {
                    description: "The report type.";
                    enum: readonly ["GET_VENDOR_SALES_REPORT"];
                    type: "string";
                };
            };
            required: readonly [
                "reportType",
                "reportOptions",
                "lastUpdatedDate",
                "dataStartTime",
                "dataEndTime",
                "marketplaceIds",
            ];
            type: "object";
        };
        salesAggregate: {
            items: { $ref: "#/definitions/SalesAggregate" };
            type: "array";
        };
        salesByAsin: {
            items: { $ref: "#/definitions/SalesByAsin" };
            type: "array";
        };
    }
  • Readonlyrequired: readonly ["reportSpecification", "salesAggregate", "salesByAsin"]
  • Readonlytype: "object"