Variable vendorInventoryReportConst
vendorInventoryReport: {
definitions: {
Amount: {
examples: readonly [
{ amount: -10; currencyCode: "USD" },
{ 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";
};
InventoryAggregate: {
description: "Describes the aggregated inventory metrics for all ASINs in the vendor's account.";
examples: readonly [
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
averageVendorLeadTimeDays: 10.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 2345.5; currencyCode: "USD" };
netReceivedInventoryUnits: 278;
openPurchaseOrderUnits: 123;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 5490;
sellThroughRate: 0.88;
startDate: "2021-06-06";
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 123.45; currencyCode: "USD" };
unhealthyInventoryUnits: 114;
unsellableOnHandInventoryCost: { amount: 2345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.88;
},
];
properties: {
aged90PlusDaysSellableInventoryCost: {
$ref: "#/definitions/Amount";
description: "The cost of the inventory in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative cost, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon. ";
};
aged90PlusDaysSellableInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon.";
examples: readonly [2234];
type: "integer";
};
averageVendorLeadTimeDays: {
description: "Average number of days between the submission of each purchase order unit and the time of receipt in Amazon's fulfillment centers.";
examples: readonly [10.12];
minimum: 0;
type: "number";
};
endDate: {
description: "The end date of the aggregated data.";
examples: readonly ["2021-06-12"];
format: "date";
type: "string";
};
netReceivedInventoryCost: {
$ref: "#/definitions/Amount";
description: "Cost of the inventory that Amazon received from the vendor, minus the cost of the inventory that was returned to the vendor. The cost returned to the vendor takes into account any products that were returned due to damaged merchandise. This number can be negative if more cost was returned than received.";
};
netReceivedInventoryUnits: {
description: "Units received from the vendor minus any units that were returned to the vendor. This number can be negative if more units were returned than received.";
examples: readonly [25];
type: "integer";
};
openPurchaseOrderUnits: {
description: "Number of units contained in Amazon’s confirmed purchase orders that are not yet received by Amazon. This number can be negative if the vendor has shipped more units than Amazon has requested.";
examples: readonly [123];
type: "integer";
};
procurableProductOutOfStockRate: {
description: "The out of stock rate on all products that are procurable. This is calculated by out of stock glance views on a procurable ASIN divided by the total glance views.";
examples: readonly [0.28, 0.92];
minimum: 0;
type: "number";
};
receiveFillRate: {
description: "The purchase order units received by Amazon in comparison to the purchase order units confirmed by the vendor. This is calculated as the received quantity divided by the confirmed quantity.";
examples: readonly [1, 0.12];
minimum: 0;
type: "number";
};
sellableOnHandInventoryCost: {
$ref: "#/definitions/Amount";
description: "The cost of the inventory in Amazon fulfillment centers that is in a sellable condition on the last day of the selected time window. Backorders count as a negative cost, and can cause this value to be negative overall.";
};
sellableOnHandInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall.";
examples: readonly [5490];
type: "integer";
};
sellThroughRate: {
description: "The number of units shipped (less customer returns), divided by the sum of the number of units held by Amazon at the beginning of this time window and the number of units received during this time window. This number could be negative if more units were returned than were shipped. This number can be greater than 1 if some inventory was sold while in transit between fulfillment centers.";
examples: readonly [0.88];
type: "number";
};
startDate: {
description: "The start date of the aggregated data.";
examples: readonly ["2021-06-06"];
format: "date";
type: "string";
};
uft: {
description: "The percentage of time an ASIN is available to be shipped to the customer from a fulfillment center, versus the selection Amazon intended to carry.";
examples: readonly [0.88, 1];
minimum: 0;
type: "number";
};
unfilledCustomerOrderedUnits: {
description: "The number of units that have been ordered (or pre-ordered) but have not yet shipped.";
examples: readonly [114];
minimum: 0;
type: "integer";
};
unhealthyInventoryCost: {
$ref: "#/definitions/PositiveAmount";
description: "The cost of the excess inventory on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.";
};
unhealthyInventoryUnits: {
description: "The number of excess inventory units on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.";
examples: readonly [114];
minimum: 0;
type: "integer";
};
unsellableOnHandInventoryCost: {
$ref: "#/definitions/PositiveAmount";
description: "The cost of the inventory in Amazon fulfillment centers that is in unsellable condition on the last day of the selected time window.";
};
unsellableOnHandInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that are in unsellable condition on the last day of the selected time window.";
examples: readonly [881];
minimum: 0;
type: "integer";
};
vendorConfirmationRate: {
description: "The number of units that were confirmed by the vendor, divided by the number of units Amazon asked for. This rate will be 1 if all units that were requested during this time window were confirmed. This rate can be larger than 1 if the vendor has confirmed a greater quantity of units than Amazon requested.";
examples: readonly [0.88, 1.12];
minimum: 0;
type: "number";
};
};
required: readonly [
"startDate",
"endDate",
"netReceivedInventoryCost",
"netReceivedInventoryUnits",
"openPurchaseOrderUnits",
"sellableOnHandInventoryCost",
"sellableOnHandInventoryUnits",
];
type: "object";
};
InventoryByAsin: {
description: "Describes ASIN-aggregated inventory metrics for the vendor's account.";
examples: readonly [
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
asin: "B123456789";
averageVendorLeadTimeDays: 10.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 2345.5; currencyCode: "USD" };
netReceivedInventoryUnits: 278;
openPurchaseOrderUnits: 123;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 5490;
sellThroughRate: 0.88;
startDate: "2021-06-06";
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 123.45; currencyCode: "USD" };
unhealthyInventoryUnits: 114;
unsellableOnHandInventoryCost: { amount: 2345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.88;
},
];
properties: {
aged90PlusDaysSellableInventoryCost: {
$ref: "#/definitions/Amount";
description: "The cost of the inventory in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as a negative cost, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon. ";
};
aged90PlusDaysSellableInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon.";
examples: readonly [2234];
type: "integer";
};
asin: {
description: "The Amazon Standard Identification Number.";
examples: readonly ["B123456789"];
type: "string";
};
averageVendorLeadTimeDays: {
description: "Average number of days between the submission of each purchase order unit and the time of receipt in Amazon's fulfillment centers.";
examples: readonly [10.12];
minimum: 0;
type: "number";
};
endDate: {
description: "The end date of the aggregated data.";
examples: readonly ["2021-06-12"];
format: "date";
type: "string";
};
netReceivedInventoryCost: {
$ref: "#/definitions/Amount";
description: "Cost of the inventory that Amazon received from the vendor, minus the cost of the inventory that was returned to the vendor. The cost returned to the vendor takes into account any products that were returned due to damaged merchandise. This number can be negative if more cost was returned than received.";
};
netReceivedInventoryUnits: {
description: "Units received from the vendor minus any units that were returned to the vendor. This number can be negative if more units were returned than received.";
examples: readonly [25];
type: "integer";
};
openPurchaseOrderUnits: {
description: "Number of units contained in Amazon’s confirmed purchase orders that are not yet received by Amazon. This number can be negative if the vendor has shipped more units than Amazon has requested.";
examples: readonly [123];
type: "integer";
};
sellableOnHandInventoryCost: {
$ref: "#/definitions/Amount";
description: "The cost of the inventory in Amazon fulfillment centers that is in sellable condition on the last day of the selected time window. Backorders count as negative cost, and can cause this value to be negative overall.";
};
sellableOnHandInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that is in sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall.";
examples: readonly [5490];
type: "integer";
};
sellThroughRate: {
description: "The number of units shipped (less customer returns), divided by the sum of the number of units held by Amazon at the beginning of this time window and the number of units received during this time window. This number could be negative if more units were returned than were shipped. This number can be greater than 1 if some inventory was sold while in transit between fulfillment centers.";
examples: readonly [0.88];
type: "number";
};
startDate: {
description: "The start date of the aggregated data.";
examples: readonly ["2021-06-06"];
format: "date";
type: "string";
};
unfilledCustomerOrderedUnits: {
description: "Number of units that have been ordered (or pre-ordered) but have not yet shipped.";
examples: readonly [114];
minimum: 0;
type: "integer";
};
unhealthyInventoryCost: {
$ref: "#/definitions/PositiveAmount";
description: "The cost of the excess inventory on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.";
};
unhealthyInventoryUnits: {
description: "The number of excess inventory units on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.";
examples: readonly [114];
minimum: 0;
type: "integer";
};
unsellableOnHandInventoryCost: {
$ref: "#/definitions/PositiveAmount";
description: "The cost of the inventory in Amazon fulfillment centers that is in unsellable condition on the last day of the selected time window.";
};
unsellableOnHandInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that are in unsellable condition on the last day of the selected time window.";
examples: readonly [881];
minimum: 0;
type: "integer";
};
vendorConfirmationRate: {
description: "The number of units that were confirmed by the vendor, divided by the number of units Amazon asked for. This rate will be 1 if all units that were requested during this time window were confirmed. This rate can be larger than 1 if the vendor has confirmed a greater quantity of units than Amazon requested.";
examples: readonly [0.88, 1.12];
minimum: 0;
type: "number";
};
};
required: readonly [
"startDate",
"endDate",
"asin",
"netReceivedInventoryCost",
"netReceivedInventoryUnits",
"openPurchaseOrderUnits",
"sellableOnHandInventoryCost",
"sellableOnHandInventoryUnits",
];
type: "object";
};
PositiveAmount: {
examples: readonly [
{ amount: 0; currencyCode: "USD" },
{ amount: 20; currencyCode: "EUR" },
];
properties: {
amount: {
description: "The amount.";
examples: readonly [20];
minimum: 0;
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";
};
};
description: "This report shares inventory data of a 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. For example, if the customer specified reportPeriod=WEEK and a dataStartTime and dataEndTime that are 3 weeks apart, the report would contain data for each of those 3 contiguous weeks.";
examples: readonly [
{
inventoryAggregate: readonly [
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
averageVendorLeadTimeDays: 10.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 2345.5; currencyCode: "USD" };
netReceivedInventoryUnits: 278;
openPurchaseOrderUnits: 123;
procurableProductOutOfStockRate: 0.72;
receiveFillRate: 0.67;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 5490;
sellThroughRate: 0.88;
startDate: "2021-06-06";
uft: 0.19;
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 123.45; currencyCode: "USD" };
unhealthyInventoryUnits: 114;
unsellableOnHandInventoryCost: { amount: 2345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.88;
},
{
aged90PlusDaysSellableInventoryCost: {
amount: 323.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
averageVendorLeadTimeDays: 5.2;
endDate: "2021-06-19";
netReceivedInventoryCost: { amount: 4335.5; currencyCode: "USD" };
netReceivedInventoryUnits: 123;
openPurchaseOrderUnits: 422;
procurableProductOutOfStockRate: 0.73;
receiveFillRate: 0.77;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 4490;
sellThroughRate: 0.98;
startDate: "2021-06-13";
uft: 0.18;
unfilledCustomerOrderedUnits: 3;
unhealthyInventoryCost: { amount: 323.45; currencyCode: "USD" };
unhealthyInventoryUnits: 314;
unsellableOnHandInventoryCost: { amount: 3345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.98;
},
];
inventoryByAsin: readonly [
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
asin: "B123456789";
averageVendorLeadTimeDays: 10.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 2345.5; currencyCode: "USD" };
netReceivedInventoryUnits: 278;
openPurchaseOrderUnits: 123;
procurableProductOutOfStockRate: 0.47;
receiveFillRate: 0.98;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 5490;
sellThroughRate: 0.88;
startDate: "2021-06-06";
uft: 0.26;
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 123.45; currencyCode: "USD" };
unhealthyInventoryUnits: 114;
unsellableOnHandInventoryCost: { amount: 2345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.88;
},
{
aged90PlusDaysSellableInventoryCost: {
amount: 13.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 234;
asin: "B987654321";
averageVendorLeadTimeDays: 1.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 235.5; currencyCode: "USD" };
netReceivedInventoryUnits: 78;
openPurchaseOrderUnits: 23;
procurableProductOutOfStockRate: 0.25;
receiveFillRate: 0.81;
sellableOnHandInventoryCost: { amount: 123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 590;
sellThroughRate: 0.28;
startDate: "2021-06-06";
uft: 0.49;
unfilledCustomerOrderedUnits: 1;
unhealthyInventoryCost: { amount: 23.45; currencyCode: "USD" };
unhealthyInventoryUnits: 14;
unsellableOnHandInventoryCost: { amount: 245.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 81;
vendorConfirmationRate: 0.22;
},
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2134;
asin: "B123456789";
averageVendorLeadTimeDays: 15.2;
endDate: "2021-06-19";
netReceivedInventoryCost: { amount: 2325.5; currencyCode: "USD" };
netReceivedInventoryUnits: 728;
openPurchaseOrderUnits: 13;
procurableProductOutOfStockRate: 0.89;
receiveFillRate: 0.45;
sellableOnHandInventoryCost: { amount: 1223.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 90;
sellThroughRate: 0.128;
startDate: "2021-06-13";
uft: 0.67;
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 231.45; currencyCode: "USD" };
unhealthyInventoryUnits: 141;
unsellableOnHandInventoryCost: { amount: 1245.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 811;
vendorConfirmationRate: 0.12;
},
{
aged90PlusDaysSellableInventoryCost: {
amount: 1123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 1134;
asin: "B987654321";
averageVendorLeadTimeDays: 5.2;
endDate: "2021-06-19";
netReceivedInventoryCost: { amount: 1325.5; currencyCode: "USD" };
netReceivedInventoryUnits: 7228;
openPurchaseOrderUnits: 113;
procurableProductOutOfStockRate: 0.33;
receiveFillRate: 0.11;
sellableOnHandInventoryCost: { amount: 12223.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 900;
sellThroughRate: 1.128;
startDate: "2021-06-13";
uft: 0.22;
unfilledCustomerOrderedUnits: 122;
unhealthyInventoryCost: { amount: 2231.45; currencyCode: "USD" };
unhealthyInventoryUnits: 241;
unsellableOnHandInventoryCost: { amount: 11245.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 1811;
vendorConfirmationRate: 0.412;
},
];
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_INVENTORY_REPORT";
};
},
];
properties: {
inventoryAggregate: {
items: { $ref: "#/definitions/InventoryAggregate" };
type: "array";
};
inventoryByAsin: {
items: { $ref: "#/definitions/InventoryByAsin" };
type: "array";
};
reportSpecification: {
description: "The report summary including a 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_INVENTORY_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", "FRESH"];
type: "string";
};
};
required: readonly [
"distributorView",
"reportPeriod",
"sellingProgram",
];
type: "object";
};
reportType: {
description: "The type of report.";
enum: readonly ["GET_VENDOR_INVENTORY_REPORT"];
type: "string";
};
};
required: readonly [
"reportType",
"reportOptions",
"lastUpdatedDate",
"dataStartTime",
"dataEndTime",
"marketplaceIds",
];
type: "object";
};
};
required: readonly [
"reportSpecification",
"inventoryAggregate",
"inventoryByAsin",
];
type: "object";
} = ...
Type declaration
Readonly
definitions: {
Amount: {
examples: readonly [
{ amount: -10; currencyCode: "USD" },
{ 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";
};
InventoryAggregate: {
description: "Describes the aggregated inventory metrics for all ASINs in the vendor's account.";
examples: readonly [
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
averageVendorLeadTimeDays: 10.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 2345.5; currencyCode: "USD" };
netReceivedInventoryUnits: 278;
openPurchaseOrderUnits: 123;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 5490;
sellThroughRate: 0.88;
startDate: "2021-06-06";
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 123.45; currencyCode: "USD" };
unhealthyInventoryUnits: 114;
unsellableOnHandInventoryCost: { amount: 2345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.88;
},
];
properties: {
aged90PlusDaysSellableInventoryCost: {
$ref: "#/definitions/Amount";
description: "The cost of the inventory in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative cost, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon. ";
};
aged90PlusDaysSellableInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon.";
examples: readonly [2234];
type: "integer";
};
averageVendorLeadTimeDays: {
description: "Average number of days between the submission of each purchase order unit and the time of receipt in Amazon's fulfillment centers.";
examples: readonly [10.12];
minimum: 0;
type: "number";
};
endDate: {
description: "The end date of the aggregated data.";
examples: readonly ["2021-06-12"];
format: "date";
type: "string";
};
netReceivedInventoryCost: {
$ref: "#/definitions/Amount";
description: "Cost of the inventory that Amazon received from the vendor, minus the cost of the inventory that was returned to the vendor. The cost returned to the vendor takes into account any products that were returned due to damaged merchandise. This number can be negative if more cost was returned than received.";
};
netReceivedInventoryUnits: {
description: "Units received from the vendor minus any units that were returned to the vendor. This number can be negative if more units were returned than received.";
examples: readonly [25];
type: "integer";
};
openPurchaseOrderUnits: {
description: "Number of units contained in Amazon’s confirmed purchase orders that are not yet received by Amazon. This number can be negative if the vendor has shipped more units than Amazon has requested.";
examples: readonly [123];
type: "integer";
};
procurableProductOutOfStockRate: {
description: "The out of stock rate on all products that are procurable. This is calculated by out of stock glance views on a procurable ASIN divided by the total glance views.";
examples: readonly [0.28, 0.92];
minimum: 0;
type: "number";
};
receiveFillRate: {
description: "The purchase order units received by Amazon in comparison to the purchase order units confirmed by the vendor. This is calculated as the received quantity divided by the confirmed quantity.";
examples: readonly [1, 0.12];
minimum: 0;
type: "number";
};
sellableOnHandInventoryCost: {
$ref: "#/definitions/Amount";
description: "The cost of the inventory in Amazon fulfillment centers that is in a sellable condition on the last day of the selected time window. Backorders count as a negative cost, and can cause this value to be negative overall.";
};
sellableOnHandInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall.";
examples: readonly [5490];
type: "integer";
};
sellThroughRate: {
description: "The number of units shipped (less customer returns), divided by the sum of the number of units held by Amazon at the beginning of this time window and the number of units received during this time window. This number could be negative if more units were returned than were shipped. This number can be greater than 1 if some inventory was sold while in transit between fulfillment centers.";
examples: readonly [0.88];
type: "number";
};
startDate: {
description: "The start date of the aggregated data.";
examples: readonly ["2021-06-06"];
format: "date";
type: "string";
};
uft: {
description: "The percentage of time an ASIN is available to be shipped to the customer from a fulfillment center, versus the selection Amazon intended to carry.";
examples: readonly [0.88, 1];
minimum: 0;
type: "number";
};
unfilledCustomerOrderedUnits: {
description: "The number of units that have been ordered (or pre-ordered) but have not yet shipped.";
examples: readonly [114];
minimum: 0;
type: "integer";
};
unhealthyInventoryCost: {
$ref: "#/definitions/PositiveAmount";
description: "The cost of the excess inventory on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.";
};
unhealthyInventoryUnits: {
description: "The number of excess inventory units on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.";
examples: readonly [114];
minimum: 0;
type: "integer";
};
unsellableOnHandInventoryCost: {
$ref: "#/definitions/PositiveAmount";
description: "The cost of the inventory in Amazon fulfillment centers that is in unsellable condition on the last day of the selected time window.";
};
unsellableOnHandInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that are in unsellable condition on the last day of the selected time window.";
examples: readonly [881];
minimum: 0;
type: "integer";
};
vendorConfirmationRate: {
description: "The number of units that were confirmed by the vendor, divided by the number of units Amazon asked for. This rate will be 1 if all units that were requested during this time window were confirmed. This rate can be larger than 1 if the vendor has confirmed a greater quantity of units than Amazon requested.";
examples: readonly [0.88, 1.12];
minimum: 0;
type: "number";
};
};
required: readonly [
"startDate",
"endDate",
"netReceivedInventoryCost",
"netReceivedInventoryUnits",
"openPurchaseOrderUnits",
"sellableOnHandInventoryCost",
"sellableOnHandInventoryUnits",
];
type: "object";
};
InventoryByAsin: {
description: "Describes ASIN-aggregated inventory metrics for the vendor's account.";
examples: readonly [
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
asin: "B123456789";
averageVendorLeadTimeDays: 10.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 2345.5; currencyCode: "USD" };
netReceivedInventoryUnits: 278;
openPurchaseOrderUnits: 123;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 5490;
sellThroughRate: 0.88;
startDate: "2021-06-06";
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 123.45; currencyCode: "USD" };
unhealthyInventoryUnits: 114;
unsellableOnHandInventoryCost: { amount: 2345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.88;
},
];
properties: {
aged90PlusDaysSellableInventoryCost: {
$ref: "#/definitions/Amount";
description: "The cost of the inventory in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as a negative cost, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon. ";
};
aged90PlusDaysSellableInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon.";
examples: readonly [2234];
type: "integer";
};
asin: {
description: "The Amazon Standard Identification Number.";
examples: readonly ["B123456789"];
type: "string";
};
averageVendorLeadTimeDays: {
description: "Average number of days between the submission of each purchase order unit and the time of receipt in Amazon's fulfillment centers.";
examples: readonly [10.12];
minimum: 0;
type: "number";
};
endDate: {
description: "The end date of the aggregated data.";
examples: readonly ["2021-06-12"];
format: "date";
type: "string";
};
netReceivedInventoryCost: {
$ref: "#/definitions/Amount";
description: "Cost of the inventory that Amazon received from the vendor, minus the cost of the inventory that was returned to the vendor. The cost returned to the vendor takes into account any products that were returned due to damaged merchandise. This number can be negative if more cost was returned than received.";
};
netReceivedInventoryUnits: {
description: "Units received from the vendor minus any units that were returned to the vendor. This number can be negative if more units were returned than received.";
examples: readonly [25];
type: "integer";
};
openPurchaseOrderUnits: {
description: "Number of units contained in Amazon’s confirmed purchase orders that are not yet received by Amazon. This number can be negative if the vendor has shipped more units than Amazon has requested.";
examples: readonly [123];
type: "integer";
};
sellableOnHandInventoryCost: {
$ref: "#/definitions/Amount";
description: "The cost of the inventory in Amazon fulfillment centers that is in sellable condition on the last day of the selected time window. Backorders count as negative cost, and can cause this value to be negative overall.";
};
sellableOnHandInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that is in sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall.";
examples: readonly [5490];
type: "integer";
};
sellThroughRate: {
description: "The number of units shipped (less customer returns), divided by the sum of the number of units held by Amazon at the beginning of this time window and the number of units received during this time window. This number could be negative if more units were returned than were shipped. This number can be greater than 1 if some inventory was sold while in transit between fulfillment centers.";
examples: readonly [0.88];
type: "number";
};
startDate: {
description: "The start date of the aggregated data.";
examples: readonly ["2021-06-06"];
format: "date";
type: "string";
};
unfilledCustomerOrderedUnits: {
description: "Number of units that have been ordered (or pre-ordered) but have not yet shipped.";
examples: readonly [114];
minimum: 0;
type: "integer";
};
unhealthyInventoryCost: {
$ref: "#/definitions/PositiveAmount";
description: "The cost of the excess inventory on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.";
};
unhealthyInventoryUnits: {
description: "The number of excess inventory units on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.";
examples: readonly [114];
minimum: 0;
type: "integer";
};
unsellableOnHandInventoryCost: {
$ref: "#/definitions/PositiveAmount";
description: "The cost of the inventory in Amazon fulfillment centers that is in unsellable condition on the last day of the selected time window.";
};
unsellableOnHandInventoryUnits: {
description: "The number of units in Amazon fulfillment centers that are in unsellable condition on the last day of the selected time window.";
examples: readonly [881];
minimum: 0;
type: "integer";
};
vendorConfirmationRate: {
description: "The number of units that were confirmed by the vendor, divided by the number of units Amazon asked for. This rate will be 1 if all units that were requested during this time window were confirmed. This rate can be larger than 1 if the vendor has confirmed a greater quantity of units than Amazon requested.";
examples: readonly [0.88, 1.12];
minimum: 0;
type: "number";
};
};
required: readonly [
"startDate",
"endDate",
"asin",
"netReceivedInventoryCost",
"netReceivedInventoryUnits",
"openPurchaseOrderUnits",
"sellableOnHandInventoryCost",
"sellableOnHandInventoryUnits",
];
type: "object";
};
PositiveAmount: {
examples: readonly [
{ amount: 0; currencyCode: "USD" },
{ amount: 20; currencyCode: "EUR" },
];
properties: {
amount: {
description: "The amount.";
examples: readonly [20];
minimum: 0;
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";
};
}
Readonly
description: "This report shares inventory data of a 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. For example, if the customer specified reportPeriod=WEEK and a dataStartTime and dataEndTime that are 3 weeks apart, the report would contain data for each of those 3 contiguous weeks."
Readonly
examples: readonly [
{
inventoryAggregate: readonly [
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
averageVendorLeadTimeDays: 10.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 2345.5; currencyCode: "USD" };
netReceivedInventoryUnits: 278;
openPurchaseOrderUnits: 123;
procurableProductOutOfStockRate: 0.72;
receiveFillRate: 0.67;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 5490;
sellThroughRate: 0.88;
startDate: "2021-06-06";
uft: 0.19;
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 123.45; currencyCode: "USD" };
unhealthyInventoryUnits: 114;
unsellableOnHandInventoryCost: { amount: 2345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.88;
},
{
aged90PlusDaysSellableInventoryCost: {
amount: 323.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
averageVendorLeadTimeDays: 5.2;
endDate: "2021-06-19";
netReceivedInventoryCost: { amount: 4335.5; currencyCode: "USD" };
netReceivedInventoryUnits: 123;
openPurchaseOrderUnits: 422;
procurableProductOutOfStockRate: 0.73;
receiveFillRate: 0.77;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 4490;
sellThroughRate: 0.98;
startDate: "2021-06-13";
uft: 0.18;
unfilledCustomerOrderedUnits: 3;
unhealthyInventoryCost: { amount: 323.45; currencyCode: "USD" };
unhealthyInventoryUnits: 314;
unsellableOnHandInventoryCost: { amount: 3345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.98;
},
];
inventoryByAsin: readonly [
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2234;
asin: "B123456789";
averageVendorLeadTimeDays: 10.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 2345.5; currencyCode: "USD" };
netReceivedInventoryUnits: 278;
openPurchaseOrderUnits: 123;
procurableProductOutOfStockRate: 0.47;
receiveFillRate: 0.98;
sellableOnHandInventoryCost: { amount: 43123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 5490;
sellThroughRate: 0.88;
startDate: "2021-06-06";
uft: 0.26;
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 123.45; currencyCode: "USD" };
unhealthyInventoryUnits: 114;
unsellableOnHandInventoryCost: { amount: 2345.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 881;
vendorConfirmationRate: 0.88;
},
{
aged90PlusDaysSellableInventoryCost: {
amount: 13.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 234;
asin: "B987654321";
averageVendorLeadTimeDays: 1.2;
endDate: "2021-06-12";
netReceivedInventoryCost: { amount: 235.5; currencyCode: "USD" };
netReceivedInventoryUnits: 78;
openPurchaseOrderUnits: 23;
procurableProductOutOfStockRate: 0.25;
receiveFillRate: 0.81;
sellableOnHandInventoryCost: { amount: 123.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 590;
sellThroughRate: 0.28;
startDate: "2021-06-06";
uft: 0.49;
unfilledCustomerOrderedUnits: 1;
unhealthyInventoryCost: { amount: 23.45; currencyCode: "USD" };
unhealthyInventoryUnits: 14;
unsellableOnHandInventoryCost: { amount: 245.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 81;
vendorConfirmationRate: 0.22;
},
{
aged90PlusDaysSellableInventoryCost: {
amount: 123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 2134;
asin: "B123456789";
averageVendorLeadTimeDays: 15.2;
endDate: "2021-06-19";
netReceivedInventoryCost: { amount: 2325.5; currencyCode: "USD" };
netReceivedInventoryUnits: 728;
openPurchaseOrderUnits: 13;
procurableProductOutOfStockRate: 0.89;
receiveFillRate: 0.45;
sellableOnHandInventoryCost: { amount: 1223.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 90;
sellThroughRate: 0.128;
startDate: "2021-06-13";
uft: 0.67;
unfilledCustomerOrderedUnits: 12;
unhealthyInventoryCost: { amount: 231.45; currencyCode: "USD" };
unhealthyInventoryUnits: 141;
unsellableOnHandInventoryCost: { amount: 1245.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 811;
vendorConfirmationRate: 0.12;
},
{
aged90PlusDaysSellableInventoryCost: {
amount: 1123.5;
currencyCode: "USD";
};
aged90PlusDaysSellableInventoryUnits: 1134;
asin: "B987654321";
averageVendorLeadTimeDays: 5.2;
endDate: "2021-06-19";
netReceivedInventoryCost: { amount: 1325.5; currencyCode: "USD" };
netReceivedInventoryUnits: 7228;
openPurchaseOrderUnits: 113;
procurableProductOutOfStockRate: 0.33;
receiveFillRate: 0.11;
sellableOnHandInventoryCost: { amount: 12223.99; currencyCode: "USD" };
sellableOnHandInventoryUnits: 900;
sellThroughRate: 1.128;
startDate: "2021-06-13";
uft: 0.22;
unfilledCustomerOrderedUnits: 122;
unhealthyInventoryCost: { amount: 2231.45; currencyCode: "USD" };
unhealthyInventoryUnits: 241;
unsellableOnHandInventoryCost: { amount: 11245.5; currencyCode: "USD" };
unsellableOnHandInventoryUnits: 1811;
vendorConfirmationRate: 0.412;
},
];
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_INVENTORY_REPORT";
};
},
]
Readonly
properties: {
inventoryAggregate: {
items: { $ref: "#/definitions/InventoryAggregate" };
type: "array";
};
inventoryByAsin: {
items: { $ref: "#/definitions/InventoryByAsin" };
type: "array";
};
reportSpecification: {
description: "The report summary including a 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_INVENTORY_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", "FRESH"];
type: "string";
};
};
required: readonly ["distributorView", "reportPeriod", "sellingProgram"];
type: "object";
};
reportType: {
description: "The type of report.";
enum: readonly ["GET_VENDOR_INVENTORY_REPORT"];
type: "string";
};
};
required: readonly [
"reportType",
"reportOptions",
"lastUpdatedDate",
"dataStartTime",
"dataEndTime",
"marketplaceIds",
];
type: "object";
};
}
Readonly
required: readonly ["reportSpecification", "inventoryAggregate", "inventoryByAsin"]
Readonly
type: "object"