Variable accountHealthReport20201118Const
accountHealthReport20201118: {
definitions: {
DefectsCount: {
description: "The number of defects within a given reporting date range for 1 requested marketplace.";
examples: readonly [27833];
type: "integer";
};
ListingLevelViolation: {
description: "Seller's listing level violation metric within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
},
];
properties: {
defectsCount: { $ref: "#/definitions/DefectsCount" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"defectsCount",
"status",
"targetValue",
"targetCondition",
];
type: "object";
};
OrderCount: {
description: "The number of orders within a given reporting date range.";
examples: readonly [869118];
type: "integer";
};
OrderDefectRate: {
description: "Seller's order defect rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
},
];
properties: {
chargebacks: {
description: "Order defects due to chargebacks";
examples: readonly [{ count: 1061; status: "GOOD" }];
properties: {
count: {
description: "Order defects count.";
examples: readonly [27833];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
claims: {
description: "Order defects due to claims";
examples: readonly [{ count: 1061; status: "GOOD" }];
properties: {
count: {
description: "Order defects count.";
examples: readonly [27833];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
negativeFeedback: {
description: "Order defects due to negative feedback";
examples: readonly [{ count: 1061; status: "GOOD" }];
properties: {
count: {
description: "Order defects count.";
examples: readonly [27833];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
orderCount: { $ref: "#/definitions/OrderCount" };
orderWithDefects: {
description: "Order defects.";
examples: readonly [{ count: 1061; status: "GOOD" }];
properties: {
count: {
description: "Order defects count.";
examples: readonly [27833];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"orderCount",
"orderWithDefects",
"claims",
"chargebacks",
"negativeFeedback",
"fulfillmentType",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
Rate: {
description: "Performance metric rate in percentage within a given reporting date range for 1 requested marketplace.";
examples: readonly [0.005];
type: "number";
};
ReportingDateRange: {
description: "ReportingDateRange with start timestamp and end timestamp defined.";
examples: readonly [
{
reportingDateFrom: "2020-10-20T00:00Z";
reportingDateTo: "2020-11-18T23:59Z";
},
];
properties: {
reportingDateFrom: {
description: "Reporting start date in UTC.";
examples: readonly ["2020-10-20T00:00Z"];
type: "string";
};
reportingDateTo: {
description: "Reporting end date in UTC.";
examples: readonly ["2020-11-18T23:59Z"];
type: "string";
};
};
required: readonly ["reportingDateTo", "reportingDateFrom"];
type: "object";
};
Status: {
description: "Listing level violations status within a given reporting date range for 1 requested marketplace. It could be GOOD or BAD or NONE.";
enum: readonly ["GOOD", "BAD", "NONE"];
examples: readonly ["GOOD"];
type: "string";
};
TargetCondition: {
description: "Performance metric target condition to stay in good status. Possible values are GREATER_THAN, LESS_THAN and EQUALS.";
enum: readonly ["GREATER_THAN", "LESS_THAN", "EQUALS"];
examples: readonly ["EQUALS"];
type: "string";
};
TargetValue: {
description: "Performance metric target value to stay in good status.";
examples: readonly [0.04];
type: "number";
};
};
description: "The root schema comprises the entire JSON document.";
examples: readonly [
{
accountStatuses: readonly [
{ marketplaceId: "ATVPDKIKX0DER"; status: "AT_RISK" },
{ marketplaceId: "A2EUQ1WTGCTBG2"; status: "NORMAL" },
{ marketplaceId: "A1AM78C64UM0Y8"; status: "SUSPENDED" },
];
performanceMetrics: readonly [
{
accountHealthRating: {
ahrStatus: "WARNED";
reportingDateRange: {
reportingDateFrom: "2020-05-23T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
};
documentRequest: {
defectsCount: 8;
reportingDateRange: {
reportingDateFrom: "2020-11-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "EQUALS";
targetValue: 0;
};
foodAndProductSafetyIssues: {
defectsCount: 37;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
invoiceDefectRate: {
invoiceDefect: { count: 315; status: "GOOD" };
lateInvoice: { count: 101; status: "NONE" };
missingInvoice: { count: 214; status: "NONE" };
orderCount: 9001;
rate: 0.03499611;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-10-27T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.05;
};
lateShipmentRate: {
lateShipmentCount: 27896;
orderCount: 870669;
rate: 0.03203973037;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.04;
};
listingPolicyViolations: {
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
marketplaceId: "ATVPDKIKX0DER";
onTimeDeliveryRate: {
onTimeDeliveryCount: 847987;
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCountWithValidTracking: 808046;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
};
orderDefectRate: {
afn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
mfn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
};
otherPolicyViolations: {
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
prefulfillmentCancelRate: {
cancellationCount: 551;
orderCount: 17197;
rate: 0.005;
reportingDateRange: {
reportingDateFrom: "2020-11-12T00:00Z";
reportingDateTo: "2020-11-18T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
productAuthenticityCustomerComplaints: {
defectsCount: 212;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
productConditionCustomerComplaints: {
defectsCount: 337;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
productSafetyCustomerComplaints: {
defectsCount: 165;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
receivedIntellectualPropertyComplaints: {
defectsCount: 75;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
unitOnTimeDeliveryRate: {
rate: 0.8848;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.9;
totalUnitCount: 165;
unitOnTimeDeliveryCount: 146;
};
validTrackingRate: {
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCount: 878443;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
validTrackingCount: 896462;
};
warningState: readonly [
{ status: "BAD"; warningType: "spammingSellerMessaging" },
];
},
];
},
];
properties: {
accountStatuses: {
additionalItems: false;
description: "Seller's corresponding account status for each requested marketplace.";
examples: readonly [
readonly [
{ marketplaceId: "ATVPDKIKX0DER"; status: "AT_RISK" },
{ marketplaceId: "A2EUQ1WTGCTBG2"; status: "NORMAL" },
{ marketplaceId: "A1AM78C64UM0Y8"; status: "SUSPENDED" },
],
];
items: {
description: "Seller's corresponding account status for 1 requested marketplace.";
examples: readonly [
{ marketplaceId: "A1AM78C64UM0Y8"; status: "SUSPENDED" },
];
properties: {
marketplaceId: {
description: "A requested marketplace ID.";
examples: readonly ["ATVPDKIKX0DER"];
type: "string";
};
status: {
description: "Seller's account status for a requested marketplace.";
enum: readonly ["NORMAL", "AT_RISK", "DEACTIVATED"];
examples: readonly ["DEACTIVATED"];
type: "string";
};
};
required: readonly ["marketplaceId", "status"];
type: "object";
};
type: "array";
};
performanceMetrics: {
additionalItems: false;
description: "Seller's performance metrics for requeted marketpalces.";
examples: readonly [
{
accountHealthRating: {
ahrStatus: "WARNED";
reportingDateRange: {
reportingDateFrom: "2020-05-23T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
};
documentRequest: {
defectsCount: 8;
reportingDateRange: {
reportingDateFrom: "2020-11-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "EQUALS";
targetValue: 0;
};
foodAndProductSafetyIssues: {
defectsCount: 37;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
invoiceDefectRate: {
invoiceDefect: { count: 315; status: "GOOD" };
lateInvoice: { count: 101; status: "NONE" };
missingInvoice: { count: 214; status: "NONE" };
orderCount: 9001;
rate: 0.03499611;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-10-27T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.05;
};
lateShipmentRate: {
lateShipmentCount: 27896;
orderCount: 870669;
rate: 0.03203973037;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.04;
};
listingPolicyViolations: {
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
marketplaceId: "ATVPDKIKX0DER";
onTimeDeliveryRate: {
onTimeDeliveryCount: 847987;
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCountWithValidTracking: 808046;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
};
orderDefectRate: {
afn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
mfn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
};
otherPolicyViolations: {
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
prefulfillmentCancelRate: {
cancellationCount: 551;
orderCount: 17197;
rate: 0.005;
reportingDateRange: {
reportingDateFrom: "2020-11-12T00:00Z";
reportingDateTo: "2020-11-18T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
productAuthenticityCustomerComplaints: {
defectsCount: 212;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
productConditionCustomerComplaints: {
defectsCount: 337;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
productSafetyCustomerComplaints: {
defectsCount: 165;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
receivedIntellectualPropertyComplaints: {
defectsCount: 75;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
unitOnTimeDeliveryRate: {
rate: 0.8848;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.9;
totalUnitCount: 165;
unitOnTimeDeliveryCount: 146;
};
validTrackingRate: {
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCount: 878443;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
validTrackingCount: 896462;
};
warningState: readonly [
{ status: "BAD"; warningType: "spammingSellerMessaging" },
];
},
];
items: {
description: "Report data for the program.";
properties: {
accountHealthRating: {
description: "Seller's account health rating within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
ahrStatus: "WARNED";
reportingDateRange: {
dateOffset: { duration: 181; offset: 0 };
reportingDateFrom: "2020-05-23T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
},
];
properties: {
accountHealthRatingStatus: {
description: "Seller's overall Account Health Rating status within a given reporting date range for 1 requested marketplace. It could be GREAT or WARNED";
enum: readonly ["GREAT", "WARNED"];
examples: readonly ["WARNED"];
type: "string";
};
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
};
required: readonly ["ahrStatus", "reportingDateRange"];
type: "object";
};
documentRequests: { $ref: "#/definitions/ListingLevelViolation" };
foodAndProductSafetyIssues: {
$ref: "#/definitions/ListingLevelViolation";
};
invoiceDefectRate: {
description: "Seller's invoice defect rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
invoiceDefect: { count: 315; status: "GOOD" };
lateInvoice: { count: 101; status: "NONE" };
missingInvoice: { count: 214; status: "NONE" };
orderCount: 9001;
rate: 0.03499611;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-10-27T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.05;
},
];
properties: {
invoiceDefect: {
description: "Total invoice defects count due to missing invoice and late invoice.";
examples: readonly [{ count: 315; status: "GOOD" }];
properties: {
count: {
description: "Invoice defects count.";
examples: readonly [(...)];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
lateInvoice: {
description: "Total late invoice count in the time window.";
examples: readonly [{ count: 101; status: "GOOD" }];
properties: {
count: {
description: "Late invoice defects count.";
examples: readonly [(...)];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
missingInvoice: {
description: "Total missing invoice count in the time window.";
examples: readonly [{ count: 214; status: "GOOD" }];
properties: {
count: {
description: "Missing invoice defects count.";
examples: readonly [(...)];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
orderCount: { $ref: "#/definitions/OrderCount" };
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"orderCount",
"invoiceDefect",
"missingInvoice",
"lateInvoice",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
lateShipmentRate: {
description: "Seller's late shipment rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
lateShipmentCount: 27896;
orderCount: 870669;
rate: 0.03203973037;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.04;
},
];
properties: {
lateShipmentCount: {
description: "Order defects count due to late shipment.";
examples: readonly [27833];
type: "integer";
};
orderCount: { $ref: "#/definitions/OrderCount" };
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"orderCount",
"lateShipmentCount",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
listingPolicyViolations: {
$ref: "#/definitions/ListingLevelViolation";
};
marketplaceId: {
description: "A requested marketplace ID.";
type: "string";
};
onTimeDeliveryRate: {
description: "Seller's on-time delivery rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
onTimeDeliveryCount: 847987;
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCountWithValidTracking: 808046;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
},
];
properties: {
onTimeDeliveryCount: {
description: "On-time delivered shipment count within a given reporting date range for 1 requested marketplace.";
examples: readonly [1061];
type: "integer";
};
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
shipmentCountWithValidTracking: {
description: "The number of shipments with valid tracking associated within a given reporting date range for 1 requested marketplace.";
examples: readonly [1234];
type: "number";
};
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"shipmentCountWithValidTracking",
"onTimeDeliveryCount",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
orderDefectRate: {
description: "Seller's MFN/AFN order defect rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
afn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
mfn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
},
];
properties: {
afn: { $ref: "#/definitions/OrderDefectRate" };
mfn: { $ref: "#/definitions/OrderDefectRate" };
};
required: readonly ["mfn", "afn"];
type: "object";
};
otherPolicyViolations: { $ref: "#/definitions/ListingLevelViolation" };
preFulfillmentCancellationRate: {
description: "Seller's pre-fulfillment cancellation rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
cancellationCount: 551;
orderCount: 17197;
rate: 0.005;
reportingDateRange: {
reportingDateFrom: "2020-11-12T00:00Z";
reportingDateTo: "2020-11-18T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
},
];
properties: {
cancellationCount: {
description: "The number of seller faulted cancelled orders within a given reporting date range for 1 requested marketplace.";
examples: readonly [27833];
type: "integer";
};
orderCount: { $ref: "#/definitions/OrderCount" };
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"orderCount",
"cancellationCount",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
productAuthenticityCustomerComplaints: {
$ref: "#/definitions/ListingLevelViolation";
};
productConditionCustomerComplaints: {
$ref: "#/definitions/ListingLevelViolation";
};
productSafetyCustomerComplaints: {
$ref: "#/definitions/ListingLevelViolation";
};
receivedIntellectualPropertyComplaints: {
$ref: "#/definitions/ListingLevelViolation";
};
restrictedProductPolicyViolations: {
$ref: "#/definitions/ListingLevelViolation";
};
suspectedIntellectualPropertyViolations: {
$ref: "#/definitions/ListingLevelViolation";
};
unitOnTimeDeliveryRate: {
description: "The seller's on-time delivery rate at a unit level within a reporting date range for one marketplace that you specify. This metric is only available in the US marketplace.";
examples: readonly [
{
rate: 0.8848;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.9;
totalUnitCount: 165;
unitOnTimeDeliveryCount: 146;
},
];
properties: {
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
totalUnitCount: {
description: "The total unit count within a reporting date range for one marketplace that you specify.";
examples: readonly [2000];
type: "integer";
};
unitOnTimeDeliveryCount: {
description: "The on-time delivery unit count within a reporting date range for one marketplace that you specify.";
examples: readonly [1061];
type: "integer";
};
};
required: readonly [
"reportingDateRange",
"status",
"targetValue",
"targetCondition",
"unitOnTimeDeliveryCount",
"totalUnitCount",
"rate",
];
type: "object";
};
validTrackingRate: {
description: "Seller's valid tracking rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCount: 878443;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
validTrackingCount: 896462;
},
];
properties: {
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
shipmentCount: {
description: "The number of shipments within a given reporting date range for 1 requested marketplace.";
examples: readonly [1234];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
validTrackingCount: {
description: "Shipment with valid tracking count within a given reporting date range for 1 requested marketplace.";
examples: readonly [1061];
type: "integer";
};
};
required: readonly [
"reportingDateRange",
"shipmentCount",
"validTrackingCount",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
warningStates: {
additionalItems: false;
description: "A list of seller warning states for 1 requested marketplace.";
examples: readonly [
readonly [
{ status: "BAD"; warningType: "spammingSellerMessaging" },
],
];
items: {
description: "Seller account warning state for 1 requested marketplace.";
properties: {
status: {
description: "Seller account warning state status for 1 requested marketplace. It could be GOOD or BAD or NONE.";
enum: readonly ["GOOD", "BAD", "NONE"];
examples: readonly ["BAD"];
type: "string";
};
warningType: {
description: "Seller account warning type for 1 requested marketplace.";
examples: readonly ["spammingSellerMessaging"];
type: "string";
};
};
required: readonly ["warningType", "status"];
type: "object";
};
type: "array";
};
};
required: readonly [
"marketplaceId",
"invoiceDefectRate",
"lateShipmentRate",
"orderDefectRate",
"onTimeDeliveryRate",
"unitOnTimeDeliveryRate",
"validTrackingRate",
"preFulfillmentCancellationRate",
"warningStates",
"accountHealthRating",
"listingPolicyViolations",
"productAuthenticityCustomerComplaints",
"productConditionCustomerComplaints",
"productSafetyCustomerComplaints",
"receivedIntellectualPropertyComplaints",
"restrictedProductPolicyViolations",
"suspectedIntellectualPropertyViolations",
"foodAndProductSafetyIssues",
"otherPolicyViolations",
"documentRequests",
];
type: "object";
};
type: "array";
};
};
required: readonly ["accountStatuses", "performanceMetrics"];
type: "object";
} = ...
Type Declaration
Readonlydefinitions: {
DefectsCount: {
description: "The number of defects within a given reporting date range for 1 requested marketplace.";
examples: readonly [27833];
type: "integer";
};
ListingLevelViolation: {
description: "Seller's listing level violation metric within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
},
];
properties: {
defectsCount: { $ref: "#/definitions/DefectsCount" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"defectsCount",
"status",
"targetValue",
"targetCondition",
];
type: "object";
};
OrderCount: {
description: "The number of orders within a given reporting date range.";
examples: readonly [869118];
type: "integer";
};
OrderDefectRate: {
description: "Seller's order defect rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
},
];
properties: {
chargebacks: {
description: "Order defects due to chargebacks";
examples: readonly [{ count: 1061; status: "GOOD" }];
properties: {
count: {
description: "Order defects count.";
examples: readonly [27833];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
claims: {
description: "Order defects due to claims";
examples: readonly [{ count: 1061; status: "GOOD" }];
properties: {
count: {
description: "Order defects count.";
examples: readonly [27833];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
negativeFeedback: {
description: "Order defects due to negative feedback";
examples: readonly [{ count: 1061; status: "GOOD" }];
properties: {
count: {
description: "Order defects count.";
examples: readonly [27833];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
orderCount: { $ref: "#/definitions/OrderCount" };
orderWithDefects: {
description: "Order defects.";
examples: readonly [{ count: 1061; status: "GOOD" }];
properties: {
count: {
description: "Order defects count.";
examples: readonly [27833];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"orderCount",
"orderWithDefects",
"claims",
"chargebacks",
"negativeFeedback",
"fulfillmentType",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
Rate: {
description: "Performance metric rate in percentage within a given reporting date range for 1 requested marketplace.";
examples: readonly [0.005];
type: "number";
};
ReportingDateRange: {
description: "ReportingDateRange with start timestamp and end timestamp defined.";
examples: readonly [
{
reportingDateFrom: "2020-10-20T00:00Z";
reportingDateTo: "2020-11-18T23:59Z";
},
];
properties: {
reportingDateFrom: {
description: "Reporting start date in UTC.";
examples: readonly ["2020-10-20T00:00Z"];
type: "string";
};
reportingDateTo: {
description: "Reporting end date in UTC.";
examples: readonly ["2020-11-18T23:59Z"];
type: "string";
};
};
required: readonly ["reportingDateTo", "reportingDateFrom"];
type: "object";
};
Status: {
description: "Listing level violations status within a given reporting date range for 1 requested marketplace. It could be GOOD or BAD or NONE.";
enum: readonly ["GOOD", "BAD", "NONE"];
examples: readonly ["GOOD"];
type: "string";
};
TargetCondition: {
description: "Performance metric target condition to stay in good status. Possible values are GREATER_THAN, LESS_THAN and EQUALS.";
enum: readonly ["GREATER_THAN", "LESS_THAN", "EQUALS"];
examples: readonly ["EQUALS"];
type: "string";
};
TargetValue: {
description: "Performance metric target value to stay in good status.";
examples: readonly [0.04];
type: "number";
};
}
Readonlydescription: "The root schema comprises the entire JSON document."
Readonlyexamples: readonly [
{
accountStatuses: readonly [
{ marketplaceId: "ATVPDKIKX0DER"; status: "AT_RISK" },
{ marketplaceId: "A2EUQ1WTGCTBG2"; status: "NORMAL" },
{ marketplaceId: "A1AM78C64UM0Y8"; status: "SUSPENDED" },
];
performanceMetrics: readonly [
{
accountHealthRating: {
ahrStatus: "WARNED";
reportingDateRange: {
reportingDateFrom: "2020-05-23T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
};
documentRequest: {
defectsCount: 8;
reportingDateRange: {
reportingDateFrom: "2020-11-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "EQUALS";
targetValue: 0;
};
foodAndProductSafetyIssues: {
defectsCount: 37;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
invoiceDefectRate: {
invoiceDefect: { count: 315; status: "GOOD" };
lateInvoice: { count: 101; status: "NONE" };
missingInvoice: { count: 214; status: "NONE" };
orderCount: 9001;
rate: 0.03499611;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-10-27T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.05;
};
lateShipmentRate: {
lateShipmentCount: 27896;
orderCount: 870669;
rate: 0.03203973037;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.04;
};
listingPolicyViolations: {
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
marketplaceId: "ATVPDKIKX0DER";
onTimeDeliveryRate: {
onTimeDeliveryCount: 847987;
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCountWithValidTracking: 808046;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
};
orderDefectRate: {
afn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
mfn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
};
otherPolicyViolations: {
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
prefulfillmentCancelRate: {
cancellationCount: 551;
orderCount: 17197;
rate: 0.005;
reportingDateRange: {
reportingDateFrom: "2020-11-12T00:00Z";
reportingDateTo: "2020-11-18T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
productAuthenticityCustomerComplaints: {
defectsCount: 212;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
productConditionCustomerComplaints: {
defectsCount: 337;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
productSafetyCustomerComplaints: {
defectsCount: 165;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
receivedIntellectualPropertyComplaints: {
defectsCount: 75;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
unitOnTimeDeliveryRate: {
rate: 0.8848;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.9;
totalUnitCount: 165;
unitOnTimeDeliveryCount: 146;
};
validTrackingRate: {
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCount: 878443;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
validTrackingCount: 896462;
};
warningState: readonly [
{ status: "BAD"; warningType: "spammingSellerMessaging" },
];
},
];
},
]
Readonlyproperties: {
accountStatuses: {
additionalItems: false;
description: "Seller's corresponding account status for each requested marketplace.";
examples: readonly [
readonly [
{ marketplaceId: "ATVPDKIKX0DER"; status: "AT_RISK" },
{ marketplaceId: "A2EUQ1WTGCTBG2"; status: "NORMAL" },
{ marketplaceId: "A1AM78C64UM0Y8"; status: "SUSPENDED" },
],
];
items: {
description: "Seller's corresponding account status for 1 requested marketplace.";
examples: readonly [
{ marketplaceId: "A1AM78C64UM0Y8"; status: "SUSPENDED" },
];
properties: {
marketplaceId: {
description: "A requested marketplace ID.";
examples: readonly ["ATVPDKIKX0DER"];
type: "string";
};
status: {
description: "Seller's account status for a requested marketplace.";
enum: readonly ["NORMAL", "AT_RISK", "DEACTIVATED"];
examples: readonly ["DEACTIVATED"];
type: "string";
};
};
required: readonly ["marketplaceId", "status"];
type: "object";
};
type: "array";
};
performanceMetrics: {
additionalItems: false;
description: "Seller's performance metrics for requeted marketpalces.";
examples: readonly [
{
accountHealthRating: {
ahrStatus: "WARNED";
reportingDateRange: {
reportingDateFrom: "2020-05-23T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
};
documentRequest: {
defectsCount: 8;
reportingDateRange: {
reportingDateFrom: "2020-11-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "EQUALS";
targetValue: 0;
};
foodAndProductSafetyIssues: {
defectsCount: 37;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
invoiceDefectRate: {
invoiceDefect: { count: 315; status: "GOOD" };
lateInvoice: { count: 101; status: "NONE" };
missingInvoice: { count: 214; status: "NONE" };
orderCount: 9001;
rate: 0.03499611;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-10-27T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.05;
};
lateShipmentRate: {
lateShipmentCount: 27896;
orderCount: 870669;
rate: 0.03203973037;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.04;
};
listingPolicyViolations: {
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
marketplaceId: "ATVPDKIKX0DER";
onTimeDeliveryRate: {
onTimeDeliveryCount: 847987;
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCountWithValidTracking: 808046;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
};
orderDefectRate: {
afn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
mfn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
};
otherPolicyViolations: {
defectsCount: 86;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
prefulfillmentCancelRate: {
cancellationCount: 551;
orderCount: 17197;
rate: 0.005;
reportingDateRange: {
reportingDateFrom: "2020-11-12T00:00Z";
reportingDateTo: "2020-11-18T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
productAuthenticityCustomerComplaints: {
defectsCount: 212;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
productConditionCustomerComplaints: {
defectsCount: 337;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
productSafetyCustomerComplaints: {
defectsCount: 165;
reportingDateRange: {
reportingDateFrom: "2020-05-22T00:00Z";
reportingDateTo: "2020-11-17T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
receivedIntellectualPropertyComplaints: {
defectsCount: 75;
reportingDateRange: {
reportingDateFrom: "2020-05-24T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "BAD";
targetCondition: "EQUALS";
targetValue: 0;
};
unitOnTimeDeliveryRate: {
rate: 0.8848;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.9;
totalUnitCount: 165;
unitOnTimeDeliveryCount: 146;
};
validTrackingRate: {
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCount: 878443;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
validTrackingCount: 896462;
};
warningState: readonly [
{ status: "BAD"; warningType: "spammingSellerMessaging" },
];
},
];
items: {
description: "Report data for the program.";
properties: {
accountHealthRating: {
description: "Seller's account health rating within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
ahrStatus: "WARNED";
reportingDateRange: {
dateOffset: { duration: 181; offset: 0 };
reportingDateFrom: "2020-05-23T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
},
];
properties: {
accountHealthRatingStatus: {
description: "Seller's overall Account Health Rating status within a given reporting date range for 1 requested marketplace. It could be GREAT or WARNED";
enum: readonly ["GREAT", "WARNED"];
examples: readonly ["WARNED"];
type: "string";
};
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
};
required: readonly ["ahrStatus", "reportingDateRange"];
type: "object";
};
documentRequests: { $ref: "#/definitions/ListingLevelViolation" };
foodAndProductSafetyIssues: {
$ref: "#/definitions/ListingLevelViolation";
};
invoiceDefectRate: {
description: "Seller's invoice defect rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
invoiceDefect: { count: 315; status: "GOOD" };
lateInvoice: { count: 101; status: "NONE" };
missingInvoice: { count: 214; status: "NONE" };
orderCount: 9001;
rate: 0.03499611;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-10-27T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.05;
},
];
properties: {
invoiceDefect: {
description: "Total invoice defects count due to missing invoice and late invoice.";
examples: readonly [{ count: 315; status: "GOOD" }];
properties: {
count: {
description: "Invoice defects count.";
examples: readonly [(...)];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
lateInvoice: {
description: "Total late invoice count in the time window.";
examples: readonly [{ count: 101; status: "GOOD" }];
properties: {
count: {
description: "Late invoice defects count.";
examples: readonly [(...)];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
missingInvoice: {
description: "Total missing invoice count in the time window.";
examples: readonly [{ count: 214; status: "GOOD" }];
properties: {
count: {
description: "Missing invoice defects count.";
examples: readonly [(...)];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
};
required: readonly ["count", "status"];
type: "object";
};
orderCount: { $ref: "#/definitions/OrderCount" };
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"orderCount",
"invoiceDefect",
"missingInvoice",
"lateInvoice",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
lateShipmentRate: {
description: "Seller's late shipment rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
lateShipmentCount: 27896;
orderCount: 870669;
rate: 0.03203973037;
reportingDateRange: {
reportingDateFrom: "2020-10-21T00:00Z";
reportingDateTo: "2020-11-19T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.04;
},
];
properties: {
lateShipmentCount: {
description: "Order defects count due to late shipment.";
examples: readonly [27833];
type: "integer";
};
orderCount: { $ref: "#/definitions/OrderCount" };
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"orderCount",
"lateShipmentCount",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
listingPolicyViolations: { $ref: "#/definitions/ListingLevelViolation" };
marketplaceId: {
description: "A requested marketplace ID.";
type: "string";
};
onTimeDeliveryRate: {
description: "Seller's on-time delivery rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
onTimeDeliveryCount: 847987;
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCountWithValidTracking: 808046;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
},
];
properties: {
onTimeDeliveryCount: {
description: "On-time delivered shipment count within a given reporting date range for 1 requested marketplace.";
examples: readonly [1061];
type: "integer";
};
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
shipmentCountWithValidTracking: {
description: "The number of shipments with valid tracking associated within a given reporting date range for 1 requested marketplace.";
examples: readonly [1234];
type: "number";
};
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"shipmentCountWithValidTracking",
"onTimeDeliveryCount",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
orderDefectRate: {
description: "Seller's MFN/AFN order defect rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
afn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
mfn: {
chargebacks: { count: 15; status: "NONE" };
claims: { count: 442; status: "NONE" };
fulfillmentType: "mfn";
negativeFeedback: { count: 628; status: "NONE" };
orderCount: 539000;
orderWithDefects: { count: 1078; status: "GOOD" };
rate: 0.009;
reportingDateRange: {
reportingDateFrom: "2020-09-06T00:00Z";
reportingDateTo: "2020-11-04T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
};
},
];
properties: {
afn: { $ref: "#/definitions/OrderDefectRate" };
mfn: { $ref: "#/definitions/OrderDefectRate" };
};
required: readonly ["mfn", "afn"];
type: "object";
};
otherPolicyViolations: { $ref: "#/definitions/ListingLevelViolation" };
preFulfillmentCancellationRate: {
description: "Seller's pre-fulfillment cancellation rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
cancellationCount: 551;
orderCount: 17197;
rate: 0.005;
reportingDateRange: {
reportingDateFrom: "2020-11-12T00:00Z";
reportingDateTo: "2020-11-18T23:59Z";
};
status: "GOOD";
targetCondition: "LESS_THAN";
targetValue: 0.01;
},
];
properties: {
cancellationCount: {
description: "The number of seller faulted cancelled orders within a given reporting date range for 1 requested marketplace.";
examples: readonly [27833];
type: "integer";
};
orderCount: { $ref: "#/definitions/OrderCount" };
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
};
required: readonly [
"reportingDateRange",
"orderCount",
"cancellationCount",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
productAuthenticityCustomerComplaints: {
$ref: "#/definitions/ListingLevelViolation";
};
productConditionCustomerComplaints: {
$ref: "#/definitions/ListingLevelViolation";
};
productSafetyCustomerComplaints: {
$ref: "#/definitions/ListingLevelViolation";
};
receivedIntellectualPropertyComplaints: {
$ref: "#/definitions/ListingLevelViolation";
};
restrictedProductPolicyViolations: {
$ref: "#/definitions/ListingLevelViolation";
};
suspectedIntellectualPropertyViolations: {
$ref: "#/definitions/ListingLevelViolation";
};
unitOnTimeDeliveryRate: {
description: "The seller's on-time delivery rate at a unit level within a reporting date range for one marketplace that you specify. This metric is only available in the US marketplace.";
examples: readonly [
{
rate: 0.8848;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.9;
totalUnitCount: 165;
unitOnTimeDeliveryCount: 146;
},
];
properties: {
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
totalUnitCount: {
description: "The total unit count within a reporting date range for one marketplace that you specify.";
examples: readonly [2000];
type: "integer";
};
unitOnTimeDeliveryCount: {
description: "The on-time delivery unit count within a reporting date range for one marketplace that you specify.";
examples: readonly [1061];
type: "integer";
};
};
required: readonly [
"reportingDateRange",
"status",
"targetValue",
"targetCondition",
"unitOnTimeDeliveryCount",
"totalUnitCount",
"rate",
];
type: "object";
};
validTrackingRate: {
description: "Seller's valid tracking rate within a given reporting date range for 1 requested marketplace.";
examples: readonly [
{
rate: 0.9529;
reportingDateRange: {
reportingDateFrom: "2020-10-11T00:00Z";
reportingDateTo: "2020-11-09T23:59Z";
};
shipmentCount: 878443;
status: "GOOD";
targetCondition: "GREATER_THAN";
targetValue: 0.95;
validTrackingCount: 896462;
},
];
properties: {
rate: { $ref: "#/definitions/Rate" };
reportingDateRange: { $ref: "#/definitions/ReportingDateRange" };
shipmentCount: {
description: "The number of shipments within a given reporting date range for 1 requested marketplace.";
examples: readonly [1234];
type: "integer";
};
status: { $ref: "#/definitions/Status" };
targetCondition: { $ref: "#/definitions/TargetCondition" };
targetValue: { $ref: "#/definitions/TargetValue" };
validTrackingCount: {
description: "Shipment with valid tracking count within a given reporting date range for 1 requested marketplace.";
examples: readonly [1061];
type: "integer";
};
};
required: readonly [
"reportingDateRange",
"shipmentCount",
"validTrackingCount",
"status",
"rate",
"targetValue",
"targetCondition",
];
type: "object";
};
warningStates: {
additionalItems: false;
description: "A list of seller warning states for 1 requested marketplace.";
examples: readonly [
readonly [
{ status: "BAD"; warningType: "spammingSellerMessaging" },
],
];
items: {
description: "Seller account warning state for 1 requested marketplace.";
properties: {
status: {
description: "Seller account warning state status for 1 requested marketplace. It could be GOOD or BAD or NONE.";
enum: readonly ["GOOD", "BAD", "NONE"];
examples: readonly ["BAD"];
type: "string";
};
warningType: {
description: "Seller account warning type for 1 requested marketplace.";
examples: readonly ["spammingSellerMessaging"];
type: "string";
};
};
required: readonly ["warningType", "status"];
type: "object";
};
type: "array";
};
};
required: readonly [
"marketplaceId",
"invoiceDefectRate",
"lateShipmentRate",
"orderDefectRate",
"onTimeDeliveryRate",
"unitOnTimeDeliveryRate",
"validTrackingRate",
"preFulfillmentCancellationRate",
"warningStates",
"accountHealthRating",
"listingPolicyViolations",
"productAuthenticityCustomerComplaints",
"productConditionCustomerComplaints",
"productSafetyCustomerComplaints",
"receivedIntellectualPropertyComplaints",
"restrictedProductPolicyViolations",
"suspectedIntellectualPropertyViolations",
"foodAndProductSafetyIssues",
"otherPolicyViolations",
"documentRequests",
];
type: "object";
};
type: "array";
};
}
Readonlyrequired: readonly ["accountStatuses", "performanceMetrics"]
Readonlytype: "object"