@sp-api-sdk/schemas
Version:
Selling Parner API additional schema types
344 lines (343 loc) • 24.5 kB
TypeScript
import { type FromSchema } from 'json-schema-to-ts';
export declare const fbaInventoryAvailabilityChangeNotification: {
readonly $id: "http://example.com/example.json";
readonly type: "object";
readonly title: "The root schema";
readonly description: "The root schema comprises the entire JSON document.";
readonly default: {};
readonly properties: {
readonly NotificationVersion: {
readonly $id: "#/properties/NotificationVersion";
readonly type: "string";
readonly title: "Notification Version";
readonly description: "The version of this notification.";
readonly examples: readonly ["1.0"];
};
readonly NotificationType: {
readonly $id: "#/properties/NotificationType";
readonly type: "string";
readonly title: "Notification Type";
readonly description: "The type of this notification";
readonly enum: readonly ["FBA_INVENTORY_AVAILABILITY_CHANGES"];
};
readonly PayloadVersion: {
readonly $id: "#/properties/PayloadVersion";
readonly type: "string";
readonly title: "Payload Version";
readonly description: "The version of the payload.";
readonly examples: readonly ["1.0"];
};
readonly EventTime: {
readonly $id: "#/properties/EventTime";
readonly type: "string";
readonly format: "date-time";
readonly title: "Event Time";
readonly description: "Timestamp of the event. Formatted as ISO 8601 date-time.";
readonly default: "";
readonly examples: readonly ["2020-07-13T19:42:04.284Z"];
};
readonly Payload: {
readonly $id: "#/properties/Payload";
readonly type: "object";
readonly title: "Payload";
readonly description: "The details of this notification.";
readonly additionalProperties: true;
readonly required: readonly ["SellerId", "FNSKU", "ASIN", "SKU", "FulfillmentInventoryByMarketplace"];
readonly examples: readonly [{
readonly SellerId: "A3TH9S8BH6GOGM";
readonly FNSKU: "X001ABCDEF";
readonly ASIN: "B00001ABCD";
readonly SKU: "SELLERSKU-1";
readonly FulfillmentInventoryByMarketplace: readonly [{
readonly MarketplaceId: "ATVPDKIKX0DER";
readonly ItemName: "Product Title";
readonly FulfillmentInventory: {
readonly InboundQuantityBreakdown: {
readonly Working: 0;
readonly Shipped: 5;
readonly Receiving: 10;
};
readonly Fulfillable: 50;
readonly Unfulfillable: 0;
readonly Researching: 0;
readonly ReservedQuantityBreakdown: {
readonly WarehouseProcessing: 5;
readonly WarehouseTransfer: 15;
readonly PendingCustomerOrder: 10;
};
readonly FutureSupplyBuyable: 10;
readonly PendingCustomerOrderInTransit: 0;
};
readonly Stores: readonly ["Low-Cost Store"];
}, {
readonly MarketplaceId: "A2EUQ1WTGCTBG2";
readonly ItemName: "Product Title";
readonly FulfillmentInventory: {
readonly InboundQuantityBreakdown: {
readonly Working: 1;
readonly Shipped: 2;
readonly Receiving: 3;
};
readonly Fulfillable: 40;
readonly Unfulfillable: 0;
readonly Researching: 0;
readonly ReservedQuantityBreakdown: {
readonly WarehouseProcessing: 5;
readonly WarehouseTransfer: 15;
readonly PendingCustomerOrder: 10;
};
readonly FutureSupplyBuyable: 0;
readonly PendingCustomerOrderInTransit: 0;
};
readonly Stores: readonly ["Low-Cost Store"];
}];
}];
readonly properties: {
readonly SellerId: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/SellerId";
readonly type: "string";
readonly title: "Seller Id";
readonly description: "Selling partner identifier, such as a merchant account, for the affected inventory item.";
readonly examples: readonly ["A3TH9S8BH6GOGM"];
};
readonly FNSKU: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FNSKU";
readonly type: "string";
readonly title: "FNSKU";
readonly description: "The Fulfillment Network SKU of the affected inventory item.";
readonly examples: readonly ["X001ABCDEF"];
};
readonly ASIN: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/ASIN";
readonly type: "string";
readonly title: "ASIN";
readonly description: "Amazon Standard Identification Number of the affected inventory item.";
readonly examples: readonly ["B00001ABCD"];
};
readonly SKU: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/SKU";
readonly type: "string";
readonly title: "SKU";
readonly description: "Seller SKU of the affected inventory item.";
readonly examples: readonly ["SELLERSKU-1"];
};
readonly FulfillmentInventoryByMarketplace: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace";
readonly type: "array";
readonly title: "Fulfillment Inventory Details By Marketplace";
readonly description: "List of Fulfillment Inventory Details for each marketplace.";
readonly examples: readonly [readonly [{
readonly MarketplaceId: "ATVPDKIKX0DER";
readonly ItemName: "Product Title";
readonly FulfillmentInventory: {
readonly InboundQuantityBreakdown: {
readonly Working: 0;
readonly Shipped: 5;
readonly Receiving: 10;
};
readonly Fulfillable: 50;
readonly Unfulfillable: 0;
readonly Researching: 0;
readonly ReservedQuantityBreakdown: {
readonly WarehouseProcessing: 5;
readonly WarehouseTransfer: 15;
readonly PendingCustomerOrder: 10;
};
readonly FutureSupplyBuyable: 10;
readonly PendingCustomerOrderInTransit: 0;
};
readonly Stores: readonly ["Low-Cost Store"];
}, {
readonly MarketplaceId: "A2EUQ1WTGCTBG2";
readonly ItemName: "Product Title";
readonly FulfillmentInventory: {
readonly InboundQuantityBreakdown: {
readonly Working: 1;
readonly Shipped: 2;
readonly Receiving: 3;
};
readonly Fulfillable: 40;
readonly Unfulfillable: 0;
readonly Researching: 0;
readonly ReservedQuantityBreakdown: {
readonly WarehouseProcessing: 5;
readonly WarehouseTransfer: 15;
readonly PendingCustomerOrder: 10;
};
readonly FutureSupplyBuyable: 0;
readonly PendingCustomerOrderInTransit: 0;
};
readonly Stores: readonly ["Low-Cost Store"];
}]];
readonly items: {
readonly type: "object";
readonly required: readonly ["MarketplaceId", "ItemName", "FulfillmentInventory"];
readonly additionalProperties: true;
readonly properties: {
readonly MarketplaceId: {
readonly type: "string";
readonly title: "MarketplaceId";
readonly description: "The marketplace identifier for the destination where the affected inventory can be used to fulfill the order.";
readonly examples: readonly ["ATVPDKIKX0DER"];
};
readonly ItemName: {
readonly type: "string";
readonly title: "Item Name";
readonly description: "The product title of the affected inventory item.";
readonly examples: readonly ["Product Title"];
};
readonly FulfillmentInventory: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory";
readonly type: "object";
readonly title: "Fulfillment Inventory Details";
readonly description: "Detail of the affected item's inventory availability";
readonly examples: readonly [{
readonly InboundQuantityBreakdown: {
readonly Working: 0;
readonly Shipped: 5;
readonly Receiving: 10;
};
readonly Fulfillable: 50;
readonly Unfulfillable: 0;
readonly Researching: 0;
readonly ReservedQuantityBreakdown: {
readonly WarehouseProcessing: 5;
readonly WarehouseTransfer: 15;
readonly PendingCustomerOrder: 10;
};
readonly FutureSupplyBuyable: 10;
readonly PendingCustomerOrderInTransit: 0;
}];
readonly required: readonly ["InboundQuantityBreakdown", "Fulfillable", "Unfulfillable", "Researching", "ReservedQuantityBreakdown", "FutureSupplyBuyable", "PendingCustomerOrderInTransit"];
readonly properties: {
readonly InboundQuantityBreakdown: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown";
readonly type: "object";
readonly title: "Inbound Quantity Breakdown";
readonly description: "Details of the affected item's inbound units, which are either still in WORKING status or on the way to be received in Amazon warehouses.";
readonly examples: readonly [{
readonly Working: 0;
readonly Shipped: 5;
readonly Receiving: 10;
}];
readonly required: readonly ["Working", "Shipped", "Receiving"];
readonly properties: {
readonly Working: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/Working";
readonly type: "integer";
readonly title: "Working";
readonly description: "The number of units of the affected item that are currently residing in a WORKING status shipment.";
readonly examples: readonly [0];
};
readonly Shipped: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/Shipped";
readonly type: "integer";
readonly title: "Shipped";
readonly description: "The number of units of the affected item that are currently residing in a SHIPPED, IN_TRANSIT, DELIVERED or CHECKED_IN status shipment.";
readonly examples: readonly [0];
};
readonly Receiving: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/Receiving";
readonly type: "integer";
readonly title: "Receiving";
readonly description: "The number of units of the affected item that has arrived and are in progress to be received in Amazon warehouses.";
readonly examples: readonly [0];
};
};
readonly additionalProperties: true;
};
readonly Fulfillable: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/Fulfillable";
readonly type: "integer";
readonly title: "Fulfillable";
readonly description: "The number of units of the affected item that can be used to fulfill orders in the given marketplace.";
readonly examples: readonly [0];
};
readonly Unfulfillable: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/Unfulfillable";
readonly type: "integer";
readonly title: "Unfulfillable";
readonly description: "The number of units of the affected item that can not be used to fulfill orders due to the item's current disposition.";
readonly default: 0;
readonly examples: readonly [0];
};
readonly Researching: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/Unfulfillable";
readonly type: "integer";
readonly title: "Researching";
readonly description: "The number of units of the affected item that are currently being investigated upon adjustments.";
readonly default: 0;
readonly examples: readonly [0];
};
readonly ReservedQuantityBreakdown: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/ReservedQuantityBreakdown";
readonly type: "object";
readonly title: "Reserved Quantity Breakdown";
readonly description: "Details of the inventory that is temporarily undergoing internal processes.";
readonly examples: readonly [{
readonly WarehouseProcessing: 5;
readonly WarehouseTransfer: 15;
readonly PendingCustomerOrder: 10;
}];
readonly required: readonly ["WarehouseProcessing", "WarehouseTransfer", "PendingCustomerOrder"];
readonly properties: {
readonly WarehouseProcessing: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/WarehouseProcessing";
readonly type: "integer";
readonly title: "Warehouse Processing";
readonly description: "The number of units of the affected item that are temporarily sidelined for internal processing.";
readonly default: 0;
readonly examples: readonly [0];
};
readonly WarehouseTransfer: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/WarehouseTransfer";
readonly type: "integer";
readonly title: "Warehouse Transfer";
readonly description: "The number of units of the affected item that are in progress to be trans-shipped to another Amazon Warehouse location.";
readonly default: 0;
readonly examples: readonly [0];
};
readonly PendingCustomerOrder: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/InboundQuantityBreakdown/PendingCustomerOrder";
readonly type: "integer";
readonly title: "Pending Customer Orders";
readonly description: "The number of units of the affected item that will soon be shipped out as customer order shipment.";
readonly default: 0;
readonly examples: readonly [0];
};
};
readonly additionalProperties: true;
};
readonly FutureSupplyBuyable: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/FutureSupplyBuyable";
readonly type: "integer";
readonly title: "Future Supply Buyable";
readonly description: "The number of units available for customers to find and buy while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start.";
readonly default: 0;
readonly examples: readonly [0];
};
readonly PendingCustomerOrderInTransit: {
readonly $id: "#/properties/Payload/properties/FulfillmentInventoryAvailabilityChangeNotification/properties/FulfillmentInventoryByMarketplace/FulfillmentInventory/PendingCustomerOrderInTransit";
readonly type: "integer";
readonly title: "Pending Customer Order In Transit";
readonly description: "The number of units that customers have purchased while inventory is on its way to an Amazon fulfillment center through In-Stock Head Start";
readonly default: 0;
readonly examples: readonly [0];
};
};
};
readonly Stores: {
readonly type: "array";
readonly title: "Stores";
readonly description: "List of seller-enrolled stores for the affected inventory item.";
readonly examples: readonly [readonly ["Low-Cost Store"], readonly []];
};
};
};
};
};
};
};
readonly additionalProperties: true;
};
export type FBAInventoryAvailabilityChangeNotification = FromSchema<typeof fbaInventoryAvailabilityChangeNotification>;