Variable endUserDataReportConst
endUserDataReport: {
definitions: {
AsinMetrics: {
description: "Page view and GMS metrics of the end user.";
properties: {
asin: {
description: "ASIN for which the metrics are provided. Only ASINs with an active offer from the Seller are included.";
examples: readonly ["B00EZ1IGCO"];
type: "string";
};
currencyCode: {
description: "The ISO 4217 currency code in which GMS is calculated.";
examples: readonly ["EUR"];
type: "string";
};
endDate: {
description: "End date of the aggregation window.";
examples: readonly ["2023-01-23"];
format: "date";
type: "string";
};
gms: {
description: "End user's GMS for the ASIN. GMS = (Product Price * Quantity) + Shipping + Giftwrap - Returns - Promotional Discounts.";
examples: readonly [15.23];
minimum: 0;
type: "number";
};
marketplaceId: {
description: "Marketplace for which the metrics are provided.";
examples: readonly ["A1PA6795UKMFR9"];
type: "string";
};
pageViews: {
description: "End user's page views (count) for the ASIN.";
examples: readonly [12352];
minimum: 0;
type: "integer";
};
startDate: {
description: "Start date of the aggregation window.";
examples: readonly ["2023-01-16"];
format: "date";
type: "string";
};
};
required: readonly ["startDate", "endDate", "marketplaceId", "asin"];
type: "object";
};
EndUserData: {
description: "Contains end user contact information, page view and GMS metrics.";
properties: {
asinMetrics: {
description: "A list of Asin Page View and GMS metrics of an end user.";
items: { $ref: "#/definitions/AsinMetrics" };
type: "array";
};
fullName: { description: "Full Name of the end user."; type: "string" };
mailingAddress: {
description: "Mailing address of the end user.";
properties: {
addressLine1: {
description: "The first line of the address.";
type: "string";
};
addressLine2: { description: "Additional address."; type: "string" };
addressLine3: { description: "Additional address."; type: "string" };
city: { description: "City."; type: "string" };
countryCode: {
description: "The two letter ISO 3166-1 alpha-2 country code.";
examples: readonly ["IT", "DE", "FR"];
type: "string";
};
districtOrCounty: {
description: "District or County.";
type: "string";
};
postalCode: { description: "Postal code."; type: "string" };
stateOrRegion: { description: "State or Region."; type: "string" };
};
type: "object";
};
primaryEmail: {
description: "Primary email of the end user.";
type: "string";
};
};
required: readonly [
"fullName",
"mailingAddress",
"primaryEmail",
"asinMetrics",
];
type: "object";
};
};
description: "Provides end user (customer) data to DE, FR, IT, ES, NL, PL, SE and BE (EU-8) Selling Partners. This data contains customer personal data, including contact information, page view (glance view), and order data for customers who have elected to share this data with specific sellers. This data is accessible across various reporting periods, including DAY, WEEK and MONTH. Developers can choose to define start and end dates, along with the desired reporting period for data retrieval and aggregation. Please note that the report will not generate any data if no customers have elected to share their data.";
examples: readonly [
{
endUserData: readonly [
{
asinMetrics: readonly [
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-09-16";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-09-10";
},
{
asin: "A0DEZ1IKDB";
currencyCode: "EUR";
endDate: "2023-09-16";
gms: 98.8;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 432;
startDate: "2023-09-10";
},
];
fullName: "John Doe";
mailingAddress: {
addressLine1: "ABC Blvd";
addressLine2: "Apartment 000";
addressLine3: "";
city: "Berlin";
countryCode: "DE";
districtOrCounty: "";
postalCode: "10115";
stateOrRegion: "Berlin";
};
primaryEmail: "jdoe@xyz.com";
},
{
asinMetrics: readonly [
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-09-16";
gms: 145.2;
marketplaceId: "APJ6JRA9NG5V4";
pageViews: 12352;
startDate: "2023-09-10";
},
{
asin: "A0DEZ1IKDB";
currencyCode: "EUR";
endDate: "2023-09-16";
gms: 98.8;
marketplaceId: "APJ6JRA9NG5V4";
pageViews: 432;
startDate: "2023-09-10";
},
];
fullName: "Oliver Smith";
mailingAddress: {
addressLine1: "000 XYZ Street";
addressLine2: "";
addressLine3: "";
city: "Rome";
countryCode: "IT";
districtOrCounty: "";
postalCode: "39100";
stateOrRegion: "Lazio";
};
primaryEmail: "osmith@xyz.com";
},
];
reportSpecification: {
dataEndTime: "2023-09-16";
dataStartTime: "2023-09-10";
marketplaceIds: readonly ["A1PA6795UKMFR9", "APJ6JRA9NG5V4"];
reportOptions: { reportPeriod: "WEEK" };
reportType: "END_USER_DATA_REPORT";
};
},
{
endUserData: readonly [
{
asinMetrics: readonly [
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-09-30";
gms: 125.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 1256;
startDate: "2023-09-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-08-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-08-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-07-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-07-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-06-30";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-06-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-05-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-05-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-04-30";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-04-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-03-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-03-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-02-28";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-02-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-01-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-01-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2022-12-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2022-12-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2022-11-30";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2022-11-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2022-10-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2022-10-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2022-09-30";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2022-09-01";
},
];
fullName: "John Doe";
mailingAddress: {
addressLine1: "ABC Blvd";
addressLine2: "Apartment 000";
addressLine3: "";
city: "Berlin";
countryCode: "DE";
districtOrCounty: "";
postalCode: "10115";
stateOrRegion: "Berlin";
};
primaryEmail: "jdoe@xyz.com";
},
];
reportSpecification: {
dataEndTime: "2023-10-05";
dataStartTime: "2022-08-15";
marketplaceIds: readonly ["A1PA6795UKMFR9"];
reportType: "END_USER_DATA_REPORT";
};
},
];
properties: {
endUserData: {
description: "A list of consented end users (buyers) and their data.";
items: { $ref: "#/definitions/EndUserData" };
type: "array";
};
reportSpecification: {
description: "Summarizes the report request.";
properties: {
dataEndTime: {
description: "Determines the end date of the report - the time component is ignored. If the provided end date occurs mid-week or mid-month, the preceding Saturday for weekly reporting periods or the last day of the previous month for monthly reporting periods will be used instead. Additionally if the end date differs from the start date by more than 365 days, it will be adjusted to the closest end date with a maximum 365 day difference based on the selected reporting period.";
examples: readonly ["2021-06-19"];
format: "date";
type: "string";
};
dataStartTime: {
description: "Determines the start date of the report - the time component is ignored. If the provided start date occurs mid-week or mid-month, the following Sunday for weekly reporting periods or the first day of the next month for monthly reporting periods will be used instead.";
examples: readonly ["2023-06-06"];
format: "date";
type: "string";
};
marketplaceIds: {
description: "Any of the EU(8) marketplaces. DE, FR, IT, ES, NL, PL, SE and BE";
items: {
description: "Any EU(8) Marketplace ID. DE, FR, IT, ES, NL, PL, SE and BE. The ID for the marketplace can be found on the SP-API documentation. - https://developer-docs.amazon.com/sp-api/docs/marketplace-ids";
type: "string";
};
type: "array";
};
reportOptions: {
description: "Used to specify the report period.";
properties: {
reportPeriod: {
description: "The granularity of the data in the report. Valid values are: DAY, WEEK, and MONTH. If no granularity is specified, reportPeriod defaults to MONTH.";
enum: readonly ["DAY", "WEEK", "MONTH"];
type: "string";
};
};
type: "object";
};
reportType: { description: "The report type."; type: "string" };
};
required: readonly [
"reportType",
"marketplaceIds",
"dataStartTime",
"dataEndTime",
];
type: "object";
};
};
required: readonly ["reportSpecification", "endUserData"];
type: "object";
} = ...
Type declaration
Readonlydefinitions: {
AsinMetrics: {
description: "Page view and GMS metrics of the end user.";
properties: {
asin: {
description: "ASIN for which the metrics are provided. Only ASINs with an active offer from the Seller are included.";
examples: readonly ["B00EZ1IGCO"];
type: "string";
};
currencyCode: {
description: "The ISO 4217 currency code in which GMS is calculated.";
examples: readonly ["EUR"];
type: "string";
};
endDate: {
description: "End date of the aggregation window.";
examples: readonly ["2023-01-23"];
format: "date";
type: "string";
};
gms: {
description: "End user's GMS for the ASIN. GMS = (Product Price * Quantity) + Shipping + Giftwrap - Returns - Promotional Discounts.";
examples: readonly [15.23];
minimum: 0;
type: "number";
};
marketplaceId: {
description: "Marketplace for which the metrics are provided.";
examples: readonly ["A1PA6795UKMFR9"];
type: "string";
};
pageViews: {
description: "End user's page views (count) for the ASIN.";
examples: readonly [12352];
minimum: 0;
type: "integer";
};
startDate: {
description: "Start date of the aggregation window.";
examples: readonly ["2023-01-16"];
format: "date";
type: "string";
};
};
required: readonly ["startDate", "endDate", "marketplaceId", "asin"];
type: "object";
};
EndUserData: {
description: "Contains end user contact information, page view and GMS metrics.";
properties: {
asinMetrics: {
description: "A list of Asin Page View and GMS metrics of an end user.";
items: { $ref: "#/definitions/AsinMetrics" };
type: "array";
};
fullName: { description: "Full Name of the end user."; type: "string" };
mailingAddress: {
description: "Mailing address of the end user.";
properties: {
addressLine1: {
description: "The first line of the address.";
type: "string";
};
addressLine2: { description: "Additional address."; type: "string" };
addressLine3: { description: "Additional address."; type: "string" };
city: { description: "City."; type: "string" };
countryCode: {
description: "The two letter ISO 3166-1 alpha-2 country code.";
examples: readonly ["IT", "DE", "FR"];
type: "string";
};
districtOrCounty: {
description: "District or County.";
type: "string";
};
postalCode: { description: "Postal code."; type: "string" };
stateOrRegion: { description: "State or Region."; type: "string" };
};
type: "object";
};
primaryEmail: {
description: "Primary email of the end user.";
type: "string";
};
};
required: readonly [
"fullName",
"mailingAddress",
"primaryEmail",
"asinMetrics",
];
type: "object";
};
}
Readonlydescription: "Provides end user (customer) data to DE, FR, IT, ES, NL, PL, SE and BE (EU-8) Selling Partners. This data contains customer personal data, including contact information, page view (glance view), and order data for customers who have elected to share this data with specific sellers. This data is accessible across various reporting periods, including DAY, WEEK and MONTH. Developers can choose to define start and end dates, along with the desired reporting period for data retrieval and aggregation. Please note that the report will not generate any data if no customers have elected to share their data."
Readonlyexamples: readonly [
{
endUserData: readonly [
{
asinMetrics: readonly [
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-09-16";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-09-10";
},
{
asin: "A0DEZ1IKDB";
currencyCode: "EUR";
endDate: "2023-09-16";
gms: 98.8;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 432;
startDate: "2023-09-10";
},
];
fullName: "John Doe";
mailingAddress: {
addressLine1: "ABC Blvd";
addressLine2: "Apartment 000";
addressLine3: "";
city: "Berlin";
countryCode: "DE";
districtOrCounty: "";
postalCode: "10115";
stateOrRegion: "Berlin";
};
primaryEmail: "jdoe@xyz.com";
},
{
asinMetrics: readonly [
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-09-16";
gms: 145.2;
marketplaceId: "APJ6JRA9NG5V4";
pageViews: 12352;
startDate: "2023-09-10";
},
{
asin: "A0DEZ1IKDB";
currencyCode: "EUR";
endDate: "2023-09-16";
gms: 98.8;
marketplaceId: "APJ6JRA9NG5V4";
pageViews: 432;
startDate: "2023-09-10";
},
];
fullName: "Oliver Smith";
mailingAddress: {
addressLine1: "000 XYZ Street";
addressLine2: "";
addressLine3: "";
city: "Rome";
countryCode: "IT";
districtOrCounty: "";
postalCode: "39100";
stateOrRegion: "Lazio";
};
primaryEmail: "osmith@xyz.com";
},
];
reportSpecification: {
dataEndTime: "2023-09-16";
dataStartTime: "2023-09-10";
marketplaceIds: readonly ["A1PA6795UKMFR9", "APJ6JRA9NG5V4"];
reportOptions: { reportPeriod: "WEEK" };
reportType: "END_USER_DATA_REPORT";
};
},
{
endUserData: readonly [
{
asinMetrics: readonly [
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-09-30";
gms: 125.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 1256;
startDate: "2023-09-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-08-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-08-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-07-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-07-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-06-30";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-06-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-05-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-05-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-04-30";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-04-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-03-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-03-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-02-28";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-02-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2023-01-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2023-01-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2022-12-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2022-12-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2022-11-30";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2022-11-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2022-10-31";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2022-10-01";
},
{
asin: "B00EZ1IGCO";
currencyCode: "EUR";
endDate: "2022-09-30";
gms: 145.2;
marketplaceId: "A1PA6795UKMFR9";
pageViews: 12352;
startDate: "2022-09-01";
},
];
fullName: "John Doe";
mailingAddress: {
addressLine1: "ABC Blvd";
addressLine2: "Apartment 000";
addressLine3: "";
city: "Berlin";
countryCode: "DE";
districtOrCounty: "";
postalCode: "10115";
stateOrRegion: "Berlin";
};
primaryEmail: "jdoe@xyz.com";
},
];
reportSpecification: {
dataEndTime: "2023-10-05";
dataStartTime: "2022-08-15";
marketplaceIds: readonly ["A1PA6795UKMFR9"];
reportType: "END_USER_DATA_REPORT";
};
},
]
Readonlyproperties: {
endUserData: {
description: "A list of consented end users (buyers) and their data.";
items: { $ref: "#/definitions/EndUserData" };
type: "array";
};
reportSpecification: {
description: "Summarizes the report request.";
properties: {
dataEndTime: {
description: "Determines the end date of the report - the time component is ignored. If the provided end date occurs mid-week or mid-month, the preceding Saturday for weekly reporting periods or the last day of the previous month for monthly reporting periods will be used instead. Additionally if the end date differs from the start date by more than 365 days, it will be adjusted to the closest end date with a maximum 365 day difference based on the selected reporting period.";
examples: readonly ["2021-06-19"];
format: "date";
type: "string";
};
dataStartTime: {
description: "Determines the start date of the report - the time component is ignored. If the provided start date occurs mid-week or mid-month, the following Sunday for weekly reporting periods or the first day of the next month for monthly reporting periods will be used instead.";
examples: readonly ["2023-06-06"];
format: "date";
type: "string";
};
marketplaceIds: {
description: "Any of the EU(8) marketplaces. DE, FR, IT, ES, NL, PL, SE and BE";
items: {
description: "Any EU(8) Marketplace ID. DE, FR, IT, ES, NL, PL, SE and BE. The ID for the marketplace can be found on the SP-API documentation. - https://developer-docs.amazon.com/sp-api/docs/marketplace-ids";
type: "string";
};
type: "array";
};
reportOptions: {
description: "Used to specify the report period.";
properties: {
reportPeriod: {
description: "The granularity of the data in the report. Valid values are: DAY, WEEK, and MONTH. If no granularity is specified, reportPeriod defaults to MONTH.";
enum: readonly ["DAY", "WEEK", "MONTH"];
type: "string";
};
};
type: "object";
};
reportType: { description: "The report type."; type: "string" };
};
required: readonly [
"reportType",
"marketplaceIds",
"dataStartTime",
"dataEndTime",
];
type: "object";
};
}
Readonlyrequired: readonly ["reportSpecification", "endUserData"]
Readonlytype: "object"