@whitebox-co/walmart-marketplace-api
Version:
A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API
1,403 lines • 89.5 kB
TypeScript
/**
* Inventory Management
* Maintaining up-to-date inventory for your items on Walmart.com ensures a great experience for your customers and greater sales opportunities for you.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Configuration } from './configuration';
import { AxiosPromise, AxiosInstance } from 'axios';
import { RequestArgs, BaseAPI } from './base';
/**
* Quantity of an item that is available to be allocated to orders
* @export
* @interface AvailToSellQty
*/
export interface AvailToSellQty {
/**
* The unit of measurement. Example: \'EACH\'
* @type {string}
* @memberof AvailToSellQty
*/
unit: AvailToSellQtyUnitEnum;
/**
* Inventory Count
* @type {number}
* @memberof AvailToSellQty
*/
amount: number;
}
/**
* @export
* @enum {string}
*/
export declare enum AvailToSellQtyUnitEnum {
Each = "EACH"
}
/**
*
* @export
* @interface Cause
*/
export interface Cause {
/**
*
* @type {string}
* @memberof Cause
*/
code?: string;
/**
*
* @type {string}
* @memberof Cause
*/
field?: string;
/**
*
* @type {string}
* @memberof Cause
*/
type?: string;
/**
*
* @type {string}
* @memberof Cause
*/
description?: string;
}
/**
*
* @export
* @interface Elements
*/
export interface Elements {
/**
*
* @type {Array<InlineResponse2004ElementsInventories>}
* @memberof Elements
*/
inventories?: Array<InlineResponse2004ElementsInventories>;
}
/**
*
* @export
* @interface FeedId
*/
export interface FeedId {
/**
* A unique ID, returned from the Bulk Upload API, used for tracking the feed file
* @type {string}
* @memberof FeedId
*/
feedId?: string;
/**
*
* @type {object}
* @memberof FeedId
*/
additionalAttributes?: object | null;
/**
*
* @type {object}
* @memberof FeedId
*/
errors?: object | null;
}
/**
*
* @export
* @interface GetAllInventoriesDTO
*/
export interface GetAllInventoriesDTO {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof GetAllInventoriesDTO
*/
sku?: string;
/**
*
* @type {Array<InlineResponse2004ElementsNodes>}
* @memberof GetAllInventoriesDTO
*/
nodes?: Array<InlineResponse2004ElementsNodes>;
}
/**
*
* @export
* @interface GetAllInventoriesNodeDTO
*/
export interface GetAllInventoriesNodeDTO {
/**
* ShipNode Id of the ship node for which the inventory is requested
* @type {string}
* @memberof GetAllInventoriesNodeDTO
*/
shipNode?: string;
/**
*
* @type {InlineResponse2001InputQty}
* @memberof GetAllInventoriesNodeDTO
*/
inputQty?: InlineResponse2001InputQty;
/**
*
* @type {InlineResponse2001AvailToSellQty}
* @memberof GetAllInventoriesNodeDTO
*/
availToSellQty?: InlineResponse2001AvailToSellQty;
/**
*
* @type {InlineResponse200Quantity}
* @memberof GetAllInventoriesNodeDTO
*/
reservedQty?: InlineResponse200Quantity;
}
/**
*
* @export
* @interface Headers
*/
export interface Headers {
/**
* Total number of results for query.
* @type {number}
* @memberof Headers
*/
totalCount?: number;
/**
* Information about the quantity in inventory
* @type {number}
* @memberof Headers
*/
limit?: number;
/**
* Offset is the number of records you wish to skip before selecting results.
* @type {number}
* @memberof Headers
*/
offset?: number;
}
/**
*
* @export
* @interface InlineObject
*/
export interface InlineObject {
/**
* A seller-provided Product ID. Response will have decoded value.
* @type {string}
* @memberof InlineObject
*/
sku: string;
/**
*
* @type {InlineResponse200Quantity}
* @memberof InlineObject
*/
quantity: InlineResponse200Quantity;
}
/**
*
* @export
* @interface InlineObject1
*/
export interface InlineObject1 {
/**
*
* @type {V3InventoriesSkuInventories}
* @memberof InlineObject1
*/
inventories: V3InventoriesSkuInventories;
}
/**
*
* @export
* @interface InlineResponse200
*/
export interface InlineResponse200 {
/**
* A seller-provided Product ID. Response will have decoded value.
* @type {string}
* @memberof InlineResponse200
*/
sku: string;
/**
*
* @type {InlineResponse200Quantity}
* @memberof InlineResponse200
*/
quantity: InlineResponse200Quantity;
}
/**
*
* @export
* @interface InlineResponse2001
*/
export interface InlineResponse2001 {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InlineResponse2001
*/
sku?: string;
/**
*
* @type {Array<InlineResponse2001Nodes>}
* @memberof InlineResponse2001
*/
nodes?: Array<InlineResponse2001Nodes>;
}
/**
* Quantity of an item that is available to be allocated to orders
* @export
* @interface InlineResponse2001AvailToSellQty
*/
export interface InlineResponse2001AvailToSellQty {
/**
* The unit of measurement. Example: \'EACH\'
* @type {string}
* @memberof InlineResponse2001AvailToSellQty
*/
unit: InlineResponse2001AvailToSellQtyUnitEnum;
/**
* Inventory Count
* @type {number}
* @memberof InlineResponse2001AvailToSellQty
*/
amount: number;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2001AvailToSellQtyUnitEnum {
Each = "EACH"
}
/**
*
* @export
* @interface InlineResponse2001Causes
*/
export interface InlineResponse2001Causes {
/**
*
* @type {string}
* @memberof InlineResponse2001Causes
*/
code?: string;
/**
*
* @type {string}
* @memberof InlineResponse2001Causes
*/
field?: string;
/**
*
* @type {string}
* @memberof InlineResponse2001Causes
*/
type?: string;
/**
*
* @type {string}
* @memberof InlineResponse2001Causes
*/
description?: string;
}
/**
*
* @export
* @interface InlineResponse2001Errors
*/
export interface InlineResponse2001Errors {
/**
*
* @type {string}
* @memberof InlineResponse2001Errors
*/
code: string;
/**
*
* @type {string}
* @memberof InlineResponse2001Errors
*/
field?: string;
/**
*
* @type {string}
* @memberof InlineResponse2001Errors
*/
description?: string;
/**
*
* @type {string}
* @memberof InlineResponse2001Errors
*/
info?: string;
/**
*
* @type {string}
* @memberof InlineResponse2001Errors
*/
severity?: InlineResponse2001ErrorsSeverityEnum;
/**
*
* @type {string}
* @memberof InlineResponse2001Errors
*/
category?: InlineResponse2001ErrorsCategoryEnum;
/**
*
* @type {Array<InlineResponse2001Causes>}
* @memberof InlineResponse2001Errors
*/
causes?: Array<InlineResponse2001Causes>;
/**
*
* @type {{ [key: string]: object; }}
* @memberof InlineResponse2001Errors
*/
errorIdentifiers?: {
[key: string]: object;
};
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2001ErrorsSeverityEnum {
Info = "INFO",
Warn = "WARN",
Error = "ERROR"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2001ErrorsCategoryEnum {
Application = "APPLICATION",
System = "SYSTEM",
Request = "REQUEST",
Data = "DATA"
}
/**
* Quantity of an item that is input by the seller
* @export
* @interface InlineResponse2001InputQty
*/
export interface InlineResponse2001InputQty {
/**
* The unit of measurement. Example: \'EACH\'
* @type {string}
* @memberof InlineResponse2001InputQty
*/
unit: InlineResponse2001InputQtyUnitEnum;
/**
* Inventory Count
* @type {number}
* @memberof InlineResponse2001InputQty
*/
amount: number;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2001InputQtyUnitEnum {
Each = "EACH"
}
/**
*
* @export
* @interface InlineResponse2001Nodes
*/
export interface InlineResponse2001Nodes {
/**
* ShipNode Id of the ship node for which the inventory is requested
* @type {string}
* @memberof InlineResponse2001Nodes
*/
shipNode?: string;
/**
*
* @type {InlineResponse2001InputQty}
* @memberof InlineResponse2001Nodes
*/
inputQty?: InlineResponse2001InputQty;
/**
*
* @type {InlineResponse2001AvailToSellQty}
* @memberof InlineResponse2001Nodes
*/
availToSellQty?: InlineResponse2001AvailToSellQty;
/**
*
* @type {Array<InlineResponse2001Errors>}
* @memberof InlineResponse2001Nodes
*/
errors?: Array<InlineResponse2001Errors>;
/**
*
* @type {InlineResponse200Quantity}
* @memberof InlineResponse2001Nodes
*/
reservedQty?: InlineResponse200Quantity;
}
/**
*
* @export
* @interface InlineResponse2002
*/
export interface InlineResponse2002 {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InlineResponse2002
*/
sku?: string;
/**
*
* @type {Array<InlineResponse2002Nodes>}
* @memberof InlineResponse2002
*/
nodes?: Array<InlineResponse2002Nodes>;
}
/**
*
* @export
* @interface InlineResponse2002Nodes
*/
export interface InlineResponse2002Nodes {
/**
* ShipNode Id of the ship node for which the inventory is requested
* @type {string}
* @memberof InlineResponse2002Nodes
*/
shipNode?: string;
/**
* Node Update status. Example: \'Success\'
* @type {string}
* @memberof InlineResponse2002Nodes
*/
status?: string;
/**
* Node Update Error description.
* @type {Array<InlineResponse2001Errors>}
* @memberof InlineResponse2002Nodes
*/
errors?: Array<InlineResponse2001Errors>;
}
/**
*
* @export
* @interface InlineResponse2003
*/
export interface InlineResponse2003 {
/**
* A unique ID, returned from the Bulk Upload API, used for tracking the feed file
* @type {string}
* @memberof InlineResponse2003
*/
feedId?: string;
/**
*
* @type {object}
* @memberof InlineResponse2003
*/
additionalAttributes?: object | null;
/**
*
* @type {object}
* @memberof InlineResponse2003
*/
errors?: object | null;
}
/**
*
* @export
* @interface InlineResponse2004
*/
export interface InlineResponse2004 {
/**
*
* @type {InlineResponse2004Meta}
* @memberof InlineResponse2004
*/
meta?: InlineResponse2004Meta;
/**
*
* @type {InlineResponse2004Elements}
* @memberof InlineResponse2004
*/
elements?: InlineResponse2004Elements;
}
/**
*
* @export
* @interface InlineResponse2004Elements
*/
export interface InlineResponse2004Elements {
/**
*
* @type {Array<InlineResponse2004ElementsInventories>}
* @memberof InlineResponse2004Elements
*/
inventories?: Array<InlineResponse2004ElementsInventories>;
}
/**
*
* @export
* @interface InlineResponse2004ElementsInventories
*/
export interface InlineResponse2004ElementsInventories {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InlineResponse2004ElementsInventories
*/
sku?: string;
/**
*
* @type {Array<InlineResponse2004ElementsNodes>}
* @memberof InlineResponse2004ElementsInventories
*/
nodes?: Array<InlineResponse2004ElementsNodes>;
}
/**
*
* @export
* @interface InlineResponse2004ElementsNodes
*/
export interface InlineResponse2004ElementsNodes {
/**
* ShipNode Id of the ship node for which the inventory is requested
* @type {string}
* @memberof InlineResponse2004ElementsNodes
*/
shipNode?: string;
/**
*
* @type {InlineResponse2001InputQty}
* @memberof InlineResponse2004ElementsNodes
*/
inputQty?: InlineResponse2001InputQty;
/**
*
* @type {InlineResponse2001AvailToSellQty}
* @memberof InlineResponse2004ElementsNodes
*/
availToSellQty?: InlineResponse2001AvailToSellQty;
/**
*
* @type {InlineResponse200Quantity}
* @memberof InlineResponse2004ElementsNodes
*/
reservedQty?: InlineResponse200Quantity;
}
/**
*
* @export
* @interface InlineResponse2004Meta
*/
export interface InlineResponse2004Meta {
/**
* Total number of Skus of the Seller. Example: \'235\'
* @type {number}
* @memberof InlineResponse2004Meta
*/
totalCount?: number;
/**
* Used for pagination to fetch the next set of items.
* @type {string}
* @memberof InlineResponse2004Meta
*/
nextCursor?: string;
}
/**
*
* @export
* @interface InlineResponse2005
*/
export interface InlineResponse2005 {
/**
*
* @type {InlineResponse2005Headers}
* @memberof InlineResponse2005
*/
headers?: InlineResponse2005Headers;
/**
*
* @type {InlineResponse2005Payload}
* @memberof InlineResponse2005
*/
payload?: InlineResponse2005Payload;
}
/**
*
* @export
* @interface InlineResponse2005Headers
*/
export interface InlineResponse2005Headers {
/**
* Total number of results for query.
* @type {number}
* @memberof InlineResponse2005Headers
*/
totalCount?: number;
/**
* Information about the quantity in inventory
* @type {number}
* @memberof InlineResponse2005Headers
*/
limit?: number;
/**
* Offset is the number of records you wish to skip before selecting results.
* @type {number}
* @memberof InlineResponse2005Headers
*/
offset?: number;
}
/**
*
* @export
* @interface InlineResponse2005Payload
*/
export interface InlineResponse2005Payload {
/**
*
* @type {Array<InlineResponse2005PayloadInventory>}
* @memberof InlineResponse2005Payload
*/
inventory?: Array<InlineResponse2005PayloadInventory>;
}
/**
*
* @export
* @interface InlineResponse2005PayloadInventory
*/
export interface InlineResponse2005PayloadInventory {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InlineResponse2005PayloadInventory
*/
sku?: string;
/**
*
* @type {Array<InlineResponse2005PayloadShipNodes>}
* @memberof InlineResponse2005PayloadInventory
*/
shipNodes?: Array<InlineResponse2005PayloadShipNodes>;
}
/**
*
* @export
* @interface InlineResponse2005PayloadShipNodes
*/
export interface InlineResponse2005PayloadShipNodes {
/**
* Last changes date for the item.
* @type {string}
* @memberof InlineResponse2005PayloadShipNodes
*/
modifiedDate?: string;
/**
* The available quantity is the quantity of an item that is available to be allocated to orders.
* @type {number}
* @memberof InlineResponse2005PayloadShipNodes
*/
availToSellQty?: number;
/**
* The on-hand balance is the quantity of active inventory stored at the warehouse.Active inventory is defined as the usable amount of an item that is in the warehouse.Inventory is active if it is not damaged, expired or being inspected.
* @type {number}
* @memberof InlineResponse2005PayloadShipNodes
*/
onHandQty?: number;
/**
* Identifies fulfillment aspect of invetory. Walmart, seller or 3PL fulfilled. Possible value is \'WFSFulfilled\'. In later phase we will also add seller fulfilled inventory.
* @type {string}
* @memberof InlineResponse2005PayloadShipNodes
*/
shipNodeType?: string;
}
/**
* Quantity that has been ordered by the customers but not yet shipped
* @export
* @interface InlineResponse200Quantity
*/
export interface InlineResponse200Quantity {
/**
* The unit of measurement. Example: \'EACH\'
* @type {string}
* @memberof InlineResponse200Quantity
*/
unit: InlineResponse200QuantityUnitEnum;
/**
* Inventory Count
* @type {number}
* @memberof InlineResponse200Quantity
*/
amount: number;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200QuantityUnitEnum {
Each = "EACH"
}
/**
* Quantity of an item that is input by the seller
* @export
* @interface InputQty
*/
export interface InputQty {
/**
* The unit of measurement. Example: \'EACH\'
* @type {string}
* @memberof InputQty
*/
unit: InputQtyUnitEnum;
/**
* Inventory Count
* @type {number}
* @memberof InputQty
*/
amount: number;
}
/**
* @export
* @enum {string}
*/
export declare enum InputQtyUnitEnum {
Each = "EACH"
}
/**
*
* @export
* @interface InventoriesDTO
*/
export interface InventoriesDTO {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InventoriesDTO
*/
sku?: string;
/**
*
* @type {Array<InlineResponse2001Nodes>}
* @memberof InventoriesDTO
*/
nodes?: Array<InlineResponse2001Nodes>;
}
/**
*
* @export
* @interface Inventory
*/
export interface Inventory {
/**
* A seller-provided Product ID. Response will have decoded value.
* @type {string}
* @memberof Inventory
*/
sku: string;
/**
*
* @type {InlineResponse200Quantity}
* @memberof Inventory
*/
quantity: InlineResponse200Quantity;
}
/**
*
* @export
* @interface InventoryWFS
*/
export interface InventoryWFS {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InventoryWFS
*/
sku?: string;
/**
*
* @type {Array<InlineResponse2005PayloadShipNodes>}
* @memberof InventoryWFS
*/
shipNodes?: Array<InlineResponse2005PayloadShipNodes>;
}
/**
*
* @export
* @interface Meta
*/
export interface Meta {
/**
* Total number of Skus of the Seller. Example: \'235\'
* @type {number}
* @memberof Meta
*/
totalCount?: number;
/**
* Used for pagination to fetch the next set of items.
* @type {string}
* @memberof Meta
*/
nextCursor?: string;
}
/**
*
* @export
* @interface ModelError
*/
export interface ModelError {
/**
*
* @type {string}
* @memberof ModelError
*/
code: string;
/**
*
* @type {string}
* @memberof ModelError
*/
field?: string;
/**
*
* @type {string}
* @memberof ModelError
*/
description?: string;
/**
*
* @type {string}
* @memberof ModelError
*/
info?: string;
/**
*
* @type {string}
* @memberof ModelError
*/
severity?: ModelErrorSeverityEnum;
/**
*
* @type {string}
* @memberof ModelError
*/
category?: ModelErrorCategoryEnum;
/**
*
* @type {Array<InlineResponse2001Causes>}
* @memberof ModelError
*/
causes?: Array<InlineResponse2001Causes>;
/**
*
* @type {{ [key: string]: object; }}
* @memberof ModelError
*/
errorIdentifiers?: {
[key: string]: object;
};
}
/**
* @export
* @enum {string}
*/
export declare enum ModelErrorSeverityEnum {
Info = "INFO",
Warn = "WARN",
Error = "ERROR"
}
/**
* @export
* @enum {string}
*/
export declare enum ModelErrorCategoryEnum {
Application = "APPLICATION",
System = "SYSTEM",
Request = "REQUEST",
Data = "DATA"
}
/**
*
* @export
* @interface MultiNodeInventoryFetchResponseDTO
*/
export interface MultiNodeInventoryFetchResponseDTO {
/**
*
* @type {InlineResponse2004Meta}
* @memberof MultiNodeInventoryFetchResponseDTO
*/
meta?: InlineResponse2004Meta;
/**
*
* @type {InlineResponse2004Elements}
* @memberof MultiNodeInventoryFetchResponseDTO
*/
elements?: InlineResponse2004Elements;
}
/**
*
* @export
* @interface MultiNodeInventoryUpdateRequestDTO
*/
export interface MultiNodeInventoryUpdateRequestDTO {
/**
*
* @type {V3InventoriesSkuInventories}
* @memberof MultiNodeInventoryUpdateRequestDTO
*/
inventories: V3InventoriesSkuInventories;
}
/**
*
* @export
* @interface MultiNodeInventoryUpdateResponseDTO
*/
export interface MultiNodeInventoryUpdateResponseDTO {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof MultiNodeInventoryUpdateResponseDTO
*/
sku?: string;
/**
*
* @type {Array<InlineResponse2002Nodes>}
* @memberof MultiNodeInventoryUpdateResponseDTO
*/
nodes?: Array<InlineResponse2002Nodes>;
}
/**
*
* @export
* @interface NodeDTO
*/
export interface NodeDTO {
/**
* ShipNode Id of the ship node for which the inventory is requested
* @type {string}
* @memberof NodeDTO
*/
shipNode?: string;
/**
*
* @type {InlineResponse2001InputQty}
* @memberof NodeDTO
*/
inputQty?: InlineResponse2001InputQty;
/**
*
* @type {InlineResponse2001AvailToSellQty}
* @memberof NodeDTO
*/
availToSellQty?: InlineResponse2001AvailToSellQty;
/**
*
* @type {Array<InlineResponse2001Errors>}
* @memberof NodeDTO
*/
errors?: Array<InlineResponse2001Errors>;
/**
*
* @type {InlineResponse200Quantity}
* @memberof NodeDTO
*/
reservedQty?: InlineResponse200Quantity;
}
/**
*
* @export
* @interface Payload
*/
export interface Payload {
/**
*
* @type {Array<InlineResponse2005PayloadInventory>}
* @memberof Payload
*/
inventory?: Array<InlineResponse2005PayloadInventory>;
}
/**
* Quantity that has been ordered by the customers but not yet shipped
* @export
* @interface ReservedQty
*/
export interface ReservedQty {
/**
* The unit of measurement. Example: \'EACH\'
* @type {string}
* @memberof ReservedQty
*/
unit: ReservedQtyUnitEnum;
/**
* Inventory Count
* @type {number}
* @memberof ReservedQty
*/
amount: number;
}
/**
* @export
* @enum {string}
*/
export declare enum ReservedQtyUnitEnum {
Each = "EACH"
}
/**
*
* @export
* @interface ShipNodes
*/
export interface ShipNodes {
/**
* Last changes date for the item.
* @type {string}
* @memberof ShipNodes
*/
modifiedDate?: string;
/**
* The available quantity is the quantity of an item that is available to be allocated to orders.
* @type {number}
* @memberof ShipNodes
*/
availToSellQty?: number;
/**
* The on-hand balance is the quantity of active inventory stored at the warehouse.Active inventory is defined as the usable amount of an item that is in the warehouse.Inventory is active if it is not damaged, expired or being inspected.
* @type {number}
* @memberof ShipNodes
*/
onHandQty?: number;
/**
* Identifies fulfillment aspect of invetory. Walmart, seller or 3PL fulfilled. Possible value is \'WFSFulfilled\'. In later phase we will also add seller fulfilled inventory.
* @type {string}
* @memberof ShipNodes
*/
shipNodeType?: string;
}
/**
* Quantity that has been ordered by the customers but not yet shipped
* @export
* @interface SupplyQuantity
*/
export interface SupplyQuantity {
/**
* The unit of measurement. Example: \'EACH\'
* @type {string}
* @memberof SupplyQuantity
*/
unit: SupplyQuantityUnitEnum;
/**
* Inventory Count
* @type {number}
* @memberof SupplyQuantity
*/
amount: number;
}
/**
* @export
* @enum {string}
*/
export declare enum SupplyQuantityUnitEnum {
Each = "EACH"
}
/**
*
* @export
* @interface UpdateInventoriesRequestDTO
*/
export interface UpdateInventoriesRequestDTO {
/**
*
* @type {Array<V3InventoriesSkuInventoriesNodes>}
* @memberof UpdateInventoriesRequestDTO
*/
nodes: Array<V3InventoriesSkuInventoriesNodes>;
}
/**
*
* @export
* @interface UpdateInventoriesRequestNodeDTO
*/
export interface UpdateInventoriesRequestNodeDTO {
/**
* ShipNode Id of the ship node for which the inventory is requested
* @type {string}
* @memberof UpdateInventoriesRequestNodeDTO
*/
shipNode: string;
/**
*
* @type {InlineResponse200Quantity}
* @memberof UpdateInventoriesRequestNodeDTO
*/
inputQty: InlineResponse200Quantity;
}
/**
*
* @export
* @interface UpdateInventoriesResponseNodeDTO
*/
export interface UpdateInventoriesResponseNodeDTO {
/**
* ShipNode Id of the ship node for which the inventory is requested
* @type {string}
* @memberof UpdateInventoriesResponseNodeDTO
*/
shipNode?: string;
/**
* Node Update status. Example: \'Success\'
* @type {string}
* @memberof UpdateInventoriesResponseNodeDTO
*/
status?: string;
/**
* Node Update Error description.
* @type {Array<InlineResponse2001Errors>}
* @memberof UpdateInventoriesResponseNodeDTO
*/
errors?: Array<InlineResponse2001Errors>;
}
/**
*
* @export
* @interface V3InventoriesSkuInventories
*/
export interface V3InventoriesSkuInventories {
/**
*
* @type {Array<V3InventoriesSkuInventoriesNodes>}
* @memberof V3InventoriesSkuInventories
*/
nodes: Array<V3InventoriesSkuInventoriesNodes>;
}
/**
*
* @export
* @interface V3InventoriesSkuInventoriesNodes
*/
export interface V3InventoriesSkuInventoriesNodes {
/**
* ShipNode Id of the ship node for which the inventory is requested
* @type {string}
* @memberof V3InventoriesSkuInventoriesNodes
*/
shipNode: string;
/**
*
* @type {InlineResponse200Quantity}
* @memberof V3InventoriesSkuInventoriesNodes
*/
inputQty: InlineResponse200Quantity;
}
/**
*
* @export
* @interface WfsInventoryDTO
*/
export interface WfsInventoryDTO {
/**
*
* @type {InlineResponse2005Headers}
* @memberof WfsInventoryDTO
*/
headers?: InlineResponse2005Headers;
/**
*
* @type {InlineResponse2005Payload}
* @memberof WfsInventoryDTO
*/
payload?: InlineResponse2005Payload;
}
/**
* InventoryApi - axios parameter creator
* @export
*/
export declare const InventoryApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* You can use this API to get the inventory for a given item.
* @summary Inventory
* @param {string} sku An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: \':\', \'/\', \'?\', \'#\', \'[\', \']\', \'@\', \'!\', \'$\', \'&\', \"\'\", \'(\', \')\', \'*\', \'+\', \',\', \';\', \'=\', ‘ ’, \'{\', \'}\' as well as \'%\' itself if it\'s a part of sku. Make sure to encode space with %20. Other characters don\'t need to be encoded.
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {string} [shipNode] The shipNode for which the inventory is requested
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInventory: (sku: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, shipNode?: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* This API will retrieve the inventory count for all of a seller\'s items across all ship nodes by item to ship node mapping. Inventory can be zero or non-zero. Please note that NextCursor value changes and it needs to be passed on from the previous call to next call.
* @summary Multiple Item Inventory for All Ship Nodes
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {string} [limit] The number of items returned. Cannot be more than 50.
* @param {string} [nextCursor] String returned from initial API call to indicate pagination. Specify nextCursor value to retrieve the next 50 items.
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMultiNodeInventoryForAllSkuAndAllShipNodes: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, limit?: string, nextCursor?: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* This API will retrieve the inventory count for an item across all ship nodes or one specific ship node. You can specify the ship node for which you want to fetch the inventory
* @summary Single Item Inventory by Ship Node
* @param {string} sku An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: \':\', \'/\', \'?\', \'#\', \'[\', \']\', \'@\', \'!\', \'$\', \'&\', \"\'\", \'(\', \')\', \'*\', \'+\', \',\', \';\', \'=\', ‘ ’ as well as \'%\' itself if it\'s a part of sku. Make sure to encode space with %20. Other characters don\'t need to be encoded.
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {string} [shipNode] ShipNode Id of the ship node for which the inventory is requested
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMultiNodeInventoryForSkuAndAllShipnodes: (sku: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, shipNode?: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* You can use this API to get the current Available to Sell inventory quantities for all WFS items in your catalog. You can also query specific SKUs or filter to only items updated after a specific date in order to reduce the response size.
* @summary WFS Inventory
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {string} [sku] An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: \':\', \'/\', \'?\', \'#\', \'[\', \']\', \'@\', \'!\', \'$\', \'&\', \"\'\", \'(\', \')\', \'*\', \'+\', \',\', \';\', \'=\', ‘ ’ as well as \'%\' itself if it\'s a part of sku. Make sure to encode space with %20. Other characters don\'t need to be encoded.
* @param {string} [fromModifiedDate] last inventory modified date - starting range.
* @param {string} [toModifiedDate] last inventory modified date - starting range.
* @param {string} [limit] Number of Sku to be returned. Cannot be larger than 300.
* @param {string} [offset] Offset is the number of records you wish to skip before selecting records.
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWFSInventory: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, sku?: string, fromModifiedDate?: string, toModifiedDate?: string, limit?: string, offset?: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* Updates inventory for items in bulk. Seller Can either use feed type \"inventory\" or \"MP_INVENTORY\" * Inventory spec 1.4 feed type: inventory * Inventory spec 1.5 feed type: MP_INVENTORY Please Note: Multi Node Inventory Update Feed (feedType=MP_INVENTORY) only supports JSON Request and Responses. Refer to \"MultiNode_Bulk_Inventory_Update_Request.json\" for the corresponding request sample Refer to the <a href=\"https://developer.walmart.com/doc/us/us-mp/us-mp-inventory/\">guide section</a> for more detailed guide around each of the feed types Refer to the throttling limits before uploading the Feed Files.
* @summary Bulk Item Inventory Update
* @param {'inventory' | 'MP_INVENTORY'} feedType The feed Type
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {any} file Feed file to upload
* @param {string} [shipNode] The shipNode for which the inventory is to be updated. Not required in case of Multi Node Inventory Update Feed (feedType=MP_INVENTORY)
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateBulkInventory: (feedType: 'inventory' | 'MP_INVENTORY', authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, file: any, shipNode?: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* Updates the inventory for a given item.
* @summary Update inventory
* @param {string} sku An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: \':\', \'/\', \'?\', \'#\', \'[\', \']\', \'@\', \'!\', \'$\', \'&\', \"\'\", \'(\', \')\', \'*\', \'+\', \',\', \';\', \'=\', ‘ ’, \'{\', \'}\' as well as \'%\' itself if it\'s a part of sku. Make sure to encode space with %20. Other characters don\'t need to be encoded.
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {InlineObject} inlineObject
* @param {string} [shipNode] The shipNode for which the inventory is to be updated.
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateInventoryForAnItem: (sku: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject: InlineObject, shipNode?: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* This API will update the inventory for an item across one or more fulfillment centers, known as ship nodes.
* @summary Update Item Inventory per Ship Node
* @param {string} sku An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: \':\', \'/\', \'?\', \'#\', \'[\', \']\', \'@\', \'!\', \'$\', \'&\', \"\'\", \'(\', \')\', \'*\', \'+\', \',\', \';\', \'=\', ‘ ’ as well as \'%\' itself if it\'s a part of sku. Make sure to encode space with %20. Other characters don\'t need to be encoded.
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {InlineObject1} inlineObject1
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateMultiNodeInventory: (sku: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject1: InlineObject1, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
};
/**
* InventoryApi - functional programming interface
* @export
*/
export declare const InventoryApiFp: (configuration?: Configuration) => {
/**
* You can use this API to get the inventory for a given item.
* @summary Inventory
* @param {string} sku An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: \':\', \'/\', \'?\', \'#\', \'[\', \']\', \'@\', \'!\', \'$\', \'&\', \"\'\", \'(\', \')\', \'*\', \'+\', \',\', \';\', \'=\', ‘ ’, \'{\', \'}\' as well as \'%\' itself if it\'s a part of sku. Make sure to encode space with %20. Other characters don\'t need to be encoded.
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {string} [shipNode] The shipNode for which the inventory is requested
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInventory(sku: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, shipNode?: string, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
/**
* This API will retrieve the inventory count for all of a seller\'s items across all ship nodes by item to ship node mapping. Inventory can be zero or non-zero. Please note that NextCursor value changes and it needs to be passed on from the previous call to next call.
* @summary Multiple Item Inventory for All Ship Nodes
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {string} [limit] The number of items returned. Cannot be more than 50.
* @param {string} [nextCursor] String returned from initial API call to indicate pagination. Specify nextCursor value to retrieve the next 50 items.
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMultiNodeInventoryForAllSkuAndAllShipNodes(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, limit?: string, nextCursor?: string, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>;
/**
* This API will retrieve the inventory count for an item across all ship nodes or one specific ship node. You can specify the ship node for which you want to fetch the inventory
* @summary Single Item Inventory by Ship Node
* @param {string} sku An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: \':\', \'/\', \'?\', \'#\', \'[\', \']\', \'@\', \'!\', \'$\', \'&\', \"\'\", \'(\', \')\', \'*\', \'+\', \',\', \';\', \'=\', ‘ ’ as well as \'%\' itself if it\'s a part of sku. Make sure to encode space with %20. Other characters don\'t need to be encoded.
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {string} [shipNode] ShipNode Id of the ship node for which the inventory is requested
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMultiNodeInventoryForSkuAndAllShipnodes(sku: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, shipNode?: string, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>;
/**
* You can use this API to get the current Available to Sell inventory quantities for all WFS items in your catalog. You can also query specific SKUs or filter to only items updated after a specific date in order to reduce the response size.
* @summary WFS Inventory
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
* @param {string} wMSVCNAME Walmart Service Name
* @param {string} [sku] An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: \':\', \'/\', \'?\', \'#\', \'[\', \']\', \'@\', \'!\', \'$\', \'&\', \"\'\", \'(\', \')\', \'*\', \'+\', \',\', \';\', \'=\', ‘ ’ as well as \'%\' itself if it\'s a part of sku. Make sure to encode space with %20. Other characters don\'t need to be encoded.
* @param {string} [fromModifiedDate] last inventory modified date - starting range.
* @param {string} [toModifiedDate] last inventory modified date - starting range.
* @param {string} [limit] Number of Sku to be returned. Cannot be larger than 300.
* @param {string} [offset] Offset is the number of records you wish to skip before selecting records.
* @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWFSInventory(authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, sku?: string, fromModifiedDate?: string, toModifiedDate?: string, limit?: string, offset?: string, wMCONSUMERCHANNELTYPE?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2005>>;
/**
* Updates inventory for items in bulk. Seller Can either use feed type \"inventory\" or \"MP_INVENTORY\" * Inventory spec 1.4 feed type: inventory * Inventory spec 1.5 feed type: MP_INVENTORY Please Note: Multi Node Inventory Update Feed (feedType=MP_INVENTORY) only supports JSON Request and Responses. Refer to \"MultiNode_Bulk_Inventory_Update_Request.json\" for the corresponding request sample Refer to the <a href=\"https://developer.walmart.com/doc/us/us-mp/us-mp-inventory/\">guide section</a> for more detailed guide around each of the feed types Refer to the throttling limits before uploading the Feed Files.
* @summary Bulk Item Inventory Update
* @param {'inventory' | 'MP_INVENTORY'} feedType The feed Type
* @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
* @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call
* @param {string} wMQOSCORRELATIONID A unique ID which identifies