Variable vendorRealTimeInventoryReportConst
vendorRealTimeInventoryReport: {
definitions: {
ReportData: {
description: "Contains details about ASIN and inventory count combinations for the specified time range.";
properties: {
asin: {
description: "The Amazon Standard Identification Number (ASIN).";
examples: readonly ["B123456789"];
type: "string";
};
endTime: {
description: "The end of a date-time range in UTC representing the end of the hour for this object.";
examples: readonly ["2022-04-20T21:00:00Z", "2022-04-20T09:00:00Z"];
format: "date-time";
type: "string";
};
highlyAvailableInventory: {
description: "The number of units available to be sold on the website, based on units in Amazon fulfillment centers that are in sellable condition less units in customer shopping carts or otherwise bound for other orders (e.g. known subscribe-and-save orders).";
examples: readonly [75, 4790];
minimum: 0;
type: "integer";
};
startTime: {
description: "The start of a date-time range in UTC representing the beginning of the hour for this object.";
examples: readonly ["2022-04-20T20:00:00Z", "2022-04-20T08:00:00Z"];
format: "date-time";
type: "string";
};
};
required: readonly [
"startTime",
"endTime",
"asin",
"highlyAvailableInventory",
];
type: "object";
};
};
description: "This report shares inventory data at an ASIN level, aggregated to an hourly granularity. Requests can span multiple date range periods, including the current day.";
examples: readonly [
{
reportData: readonly [
{
asin: "B123456789";
endTime: "2022-10-01T01:00:00Z";
highlyAvailableInventory: 270;
startTime: "2022-10-01T00:00:00Z";
},
{
asin: "B987654321";
endTime: "2022-10-01T01:00:00Z";
highlyAvailableInventory: 650;
startTime: "2022-10-01T00:00:00Z";
},
{
asin: "B123456789";
endTime: "2022-10-01T02:00:00Z";
highlyAvailableInventory: 250;
startTime: "2022-10-01T01:00:00Z";
},
{
asin: "B987654321";
endTime: "2022-10-01T02:00:00Z";
highlyAvailableInventory: 550;
startTime: "2022-10-01T01:00:00Z";
},
];
reportSpecification: {
dataEndTime: "2022-10-01T02:00:00Z";
dataStartTime: "2022-10-01T00:00:00Z";
marketplaceIds: readonly ["ATVPDKIKX0DER"];
reportType: "GET_VENDOR_REAL_TIME_INVENTORY_REPORT";
};
},
];
properties: {
reportData: {
description: "List of ASIN and inventory count combinations.";
items: { $ref: "#/definitions/ReportData" };
type: "array";
};
reportSpecification: {
description: "Summarizes the original report request.";
properties: {
dataEndTime: {
description: "The end of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range. End time should not be more than 24 hours from the start time.";
examples: readonly ["2022-10-01T00:00:00Z", "2022-10-31T23:59:59Z"];
format: "date-time";
type: "string";
};
dataStartTime: {
description: "The start of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range. Start time can be up to 168 hours before the time of the request.";
examples: readonly ["2022-10-01T00:00:00Z", "2022-10-31T23:59:59Z"];
format: "date-time";
type: "string";
};
marketplaceIds: {
description: "Marketplace IDs as specified in the report request.";
examples: readonly [readonly ["ATVPDKIKX0DER"]];
items: { type: "string" };
type: "array";
};
reportType: {
description: "The report type.";
enum: readonly ["GET_VENDOR_REAL_TIME_INVENTORY_REPORT"];
type: "string";
};
};
required: readonly [
"reportType",
"dataStartTime",
"dataEndTime",
"marketplaceIds",
];
type: "object";
};
};
required: readonly ["reportSpecification", "reportData"];
type: "object";
} = ...
Type declaration
Readonly
definitions: {
ReportData: {
description: "Contains details about ASIN and inventory count combinations for the specified time range.";
properties: {
asin: {
description: "The Amazon Standard Identification Number (ASIN).";
examples: readonly ["B123456789"];
type: "string";
};
endTime: {
description: "The end of a date-time range in UTC representing the end of the hour for this object.";
examples: readonly ["2022-04-20T21:00:00Z", "2022-04-20T09:00:00Z"];
format: "date-time";
type: "string";
};
highlyAvailableInventory: {
description: "The number of units available to be sold on the website, based on units in Amazon fulfillment centers that are in sellable condition less units in customer shopping carts or otherwise bound for other orders (e.g. known subscribe-and-save orders).";
examples: readonly [75, 4790];
minimum: 0;
type: "integer";
};
startTime: {
description: "The start of a date-time range in UTC representing the beginning of the hour for this object.";
examples: readonly ["2022-04-20T20:00:00Z", "2022-04-20T08:00:00Z"];
format: "date-time";
type: "string";
};
};
required: readonly [
"startTime",
"endTime",
"asin",
"highlyAvailableInventory",
];
type: "object";
};
}
Readonly
description: "This report shares inventory data at an ASIN level, aggregated to an hourly granularity. Requests can span multiple date range periods, including the current day."
Readonly
examples: readonly [
{
reportData: readonly [
{
asin: "B123456789";
endTime: "2022-10-01T01:00:00Z";
highlyAvailableInventory: 270;
startTime: "2022-10-01T00:00:00Z";
},
{
asin: "B987654321";
endTime: "2022-10-01T01:00:00Z";
highlyAvailableInventory: 650;
startTime: "2022-10-01T00:00:00Z";
},
{
asin: "B123456789";
endTime: "2022-10-01T02:00:00Z";
highlyAvailableInventory: 250;
startTime: "2022-10-01T01:00:00Z";
},
{
asin: "B987654321";
endTime: "2022-10-01T02:00:00Z";
highlyAvailableInventory: 550;
startTime: "2022-10-01T01:00:00Z";
},
];
reportSpecification: {
dataEndTime: "2022-10-01T02:00:00Z";
dataStartTime: "2022-10-01T00:00:00Z";
marketplaceIds: readonly ["ATVPDKIKX0DER"];
reportType: "GET_VENDOR_REAL_TIME_INVENTORY_REPORT";
};
},
]
Readonly
properties: {
reportData: {
description: "List of ASIN and inventory count combinations.";
items: { $ref: "#/definitions/ReportData" };
type: "array";
};
reportSpecification: {
description: "Summarizes the original report request.";
properties: {
dataEndTime: {
description: "The end of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range. End time should not be more than 24 hours from the start time.";
examples: readonly ["2022-10-01T00:00:00Z", "2022-10-31T23:59:59Z"];
format: "date-time";
type: "string";
};
dataStartTime: {
description: "The start of a date-time range in UTC used to determine hours to report on. Output will include all full hours that fall within the range. Start time can be up to 168 hours before the time of the request.";
examples: readonly ["2022-10-01T00:00:00Z", "2022-10-31T23:59:59Z"];
format: "date-time";
type: "string";
};
marketplaceIds: {
description: "Marketplace IDs as specified in the report request.";
examples: readonly [readonly ["ATVPDKIKX0DER"]];
items: { type: "string" };
type: "array";
};
reportType: {
description: "The report type.";
enum: readonly ["GET_VENDOR_REAL_TIME_INVENTORY_REPORT"];
type: "string";
};
};
required: readonly [
"reportType",
"dataStartTime",
"dataEndTime",
"marketplaceIds",
];
type: "object";
};
}
Readonly
required: readonly ["reportSpecification", "reportData"]
Readonly
type: "object"