@whitebox-co/walmart-marketplace-api
Version:
A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API
1,776 lines • 132 kB
TypeScript
/**
* Rules Management
* Rules Management
*
* 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';
/**
*
* @export
* @interface ActivateDeactivateRuleInfo
*/
export interface ActivateDeactivateRuleInfo {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof ActivateDeactivateRuleInfo
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof ActivateDeactivateRuleInfo
*/
ruleStatus?: string;
}
/**
*
* @export
* @interface ActivateRuleRequest
*/
export interface ActivateRuleRequest {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof ActivateRuleRequest
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {Array<V3RulesInactivateRules>}
* @memberof ActivateRuleRequest
*/
rules?: Array<V3RulesInactivateRules>;
}
/**
*
* @export
* @interface ActivateRuleResponse
*/
export interface ActivateRuleResponse {
/**
* Message and ruleId
* @type {string}
* @memberof ActivateRuleResponse
*/
message?: string;
/**
* status
* @type {string}
* @memberof ActivateRuleResponse
*/
status?: string;
}
/**
*
* @export
* @interface AreaEntity
*/
export interface AreaEntity {
/**
* states.
* @type {Array<InlineResponse2009PayloadStates>}
* @memberof AreaEntity
*/
states?: Array<InlineResponse2009PayloadStates>;
/**
* regionCode
* @type {string}
* @memberof AreaEntity
*/
regionCode?: string;
/**
* regionName
* @type {string}
* @memberof AreaEntity
*/
regionName?: string;
}
/**
*
* @export
* @interface CategoryInfo
*/
export interface CategoryInfo {
/**
* category
* @type {string}
* @memberof CategoryInfo
*/
category?: string;
/**
* subCategory
* @type {Array<InlineResponse2008Subcategory>}
* @memberof CategoryInfo
*/
subcategory?: Array<InlineResponse2008Subcategory>;
}
/**
*
* @export
* @interface ChangeAssortmentPayload
*/
export interface ChangeAssortmentPayload {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof ChangeAssortmentPayload
*/
id?: string;
}
/**
*
* @export
* @interface ChangeAssortmentResponse
*/
export interface ChangeAssortmentResponse {
/**
*
* @type {string}
* @memberof ChangeAssortmentResponse
*/
status?: string;
/**
*
* @type {InlineResponse2003Payload}
* @memberof ChangeAssortmentResponse
*/
payload?: InlineResponse2003Payload;
}
/**
* Seller creates conditions while defining the custom rule assortment.There are three condition which a seller can use : subCategories, price, weight.
* @export
* @interface Condition
*/
export interface Condition {
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof Condition
*/
name?: string;
/**
* Seller uses operator while defining conditions in the rule. Operators allowed for condition price and weight: EQUALS, GREATER_THAN, LESS_THAN,GREATER_THAN_OR_EQUALS,LESS_THAN_OR_EQUALS. and for condition subcategories : IN .
* @type {string}
* @memberof Condition
*/
operator?: string;
/**
* Values for each condition. Value can be a comma separated strings for subcategories and numerical value for price and weight.
* @type {string}
* @memberof Condition
*/
value?: string;
}
/**
*
* @export
* @interface CreateOverrideExceptionRequest
*/
export interface CreateOverrideExceptionRequest {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof CreateOverrideExceptionRequest
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {V3RulesExceptionsRules}
* @memberof CreateOverrideExceptionRequest
*/
rules?: V3RulesExceptionsRules;
}
/**
*
* @export
* @interface CreateOverrideExceptionResponse
*/
export interface CreateOverrideExceptionResponse {
/**
* A unique ID, returned from the Create Override Exception API, used for tracking a feed file
* @type {string}
* @memberof CreateOverrideExceptionResponse
*/
feedId?: string;
/**
* status
* @type {string}
* @memberof CreateOverrideExceptionResponse
*/
status?: string;
}
/**
*
* @export
* @interface CreateRuleRequest
*/
export interface CreateRuleRequest {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof CreateRuleRequest
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {V3RulesCreateRules}
* @memberof CreateRuleRequest
*/
rules?: V3RulesCreateRules;
}
/**
*
* @export
* @interface CreateRuleResponse
*/
export interface CreateRuleResponse {
/**
*
* @type {Array<InlineResponse2006Rules>}
* @memberof CreateRuleResponse
*/
rules?: Array<InlineResponse2006Rules>;
/**
*
* @type {string}
* @memberof CreateRuleResponse
*/
status?: string;
}
/**
*
* @export
* @interface DeleteExceptionRequest
*/
export interface DeleteExceptionRequest {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof DeleteExceptionRequest
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {V3RulesExceptionsRules}
* @memberof DeleteExceptionRequest
*/
rules?: V3RulesExceptionsRules;
}
/**
*
* @export
* @interface DeleteExceptionResponse
*/
export interface DeleteExceptionResponse {
/**
* A unique ID, returned from the Create Override Exception API, used for tracking a feed file
* @type {string}
* @memberof DeleteExceptionResponse
*/
feedId?: string;
/**
* status
* @type {string}
* @memberof DeleteExceptionResponse
*/
status?: string;
}
/**
*
* @export
* @interface DeleteRuleResponse
*/
export interface DeleteRuleResponse {
/**
* Message and status of deletion
* @type {string}
* @memberof DeleteRuleResponse
*/
message?: string;
/**
* status
* @type {string}
* @memberof DeleteRuleResponse
*/
status?: string;
}
/**
*
* @export
* @interface ExceptionInfo
*/
export interface ExceptionInfo {
/**
*
* @type {Array<V3RulesExceptionsRulesSkus>}
* @memberof ExceptionInfo
*/
skus?: Array<V3RulesExceptionsRulesSkus>;
}
/**
*
* @export
* @interface GetAllAreasPayload
*/
export interface GetAllAreasPayload {
/**
*
* @type {Array<InlineResponse2009PayloadEntities>}
* @memberof GetAllAreasPayload
*/
entities?: Array<InlineResponse2009PayloadEntities>;
}
/**
*
* @export
* @interface GetAllAreasResponse
*/
export interface GetAllAreasResponse {
/**
* Status of the rule post the rule creation.
* @type {string}
* @memberof GetAllAreasResponse
*/
status?: string;
/**
*
* @type {InlineResponse2009Payload}
* @memberof GetAllAreasResponse
*/
payload?: InlineResponse2009Payload;
}
/**
*
* @export
* @interface GetAllExceptionsResponse
*/
export interface GetAllExceptionsResponse {
/**
* A seller-provided Product ID.
* @type {Array<string>}
* @memberof GetAllExceptionsResponse
*/
skuIds?: Array<string>;
/**
*
* @type {string}
* @memberof GetAllExceptionsResponse
*/
status?: string;
}
/**
*
* @export
* @interface GetAllRulesResponse
*/
export interface GetAllRulesResponse {
/**
*
* @type {Array<InlineResponse2005Rules>}
* @memberof GetAllRulesResponse
*/
rules?: Array<InlineResponse2005Rules>;
/**
* status
* @type {string}
* @memberof GetAllRulesResponse
*/
status?: string;
}
/**
*
* @export
* @interface GetAllSubCategoriesResponse
*/
export interface GetAllSubCategoriesResponse {
/**
*
* @type {string}
* @memberof GetAllSubCategoriesResponse
*/
status?: string;
/**
*
* @type {Array<InlineResponse2008Payload>}
* @memberof GetAllSubCategoriesResponse
*/
payload?: Array<InlineResponse2008Payload>;
}
/**
*
* @export
* @interface GetSimulationCountResponse
*/
export interface GetSimulationCountResponse {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof GetSimulationCountResponse
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof GetSimulationCountResponse
*/
ruleStatus?: string;
/**
* Number of items that would be set for two-day if the rule gets activated.
* @type {string}
* @memberof GetSimulationCountResponse
*/
simulationCount?: string;
}
/**
*
* @export
* @interface InactivateRuleRequest
*/
export interface InactivateRuleRequest {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof InactivateRuleRequest
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {Array<V3RulesInactivateRules>}
* @memberof InactivateRuleRequest
*/
rules?: Array<V3RulesInactivateRules>;
}
/**
*
* @export
* @interface InactivateRuleResponse
*/
export interface InactivateRuleResponse {
/**
* Message and status of inactivation of rule
* @type {string}
* @memberof InactivateRuleResponse
*/
message?: string;
/**
* status
* @type {string}
* @memberof InactivateRuleResponse
*/
status?: string;
}
/**
*
* @export
* @interface InlineObject
*/
export interface InlineObject {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof InlineObject
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {Array<V3RulesInactivateRules>}
* @memberof InlineObject
*/
rules?: Array<V3RulesInactivateRules>;
}
/**
*
* @export
* @interface InlineObject1
*/
export interface InlineObject1 {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof InlineObject1
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {V3RulesExceptionsRules}
* @memberof InlineObject1
*/
rules?: V3RulesExceptionsRules;
}
/**
*
* @export
* @interface InlineObject2
*/
export interface InlineObject2 {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof InlineObject2
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {V3RulesExceptionsRules}
* @memberof InlineObject2
*/
rules?: V3RulesExceptionsRules;
}
/**
*
* @export
* @interface InlineObject3
*/
export interface InlineObject3 {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof InlineObject3
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {Array<V3RulesInactivateRules>}
* @memberof InlineObject3
*/
rules?: Array<V3RulesInactivateRules>;
}
/**
*
* @export
* @interface InlineObject4
*/
export interface InlineObject4 {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof InlineObject4
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {V3RulesActionsRules}
* @memberof InlineObject4
*/
rules?: V3RulesActionsRules;
}
/**
*
* @export
* @interface InlineObject5
*/
export interface InlineObject5 {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof InlineObject5
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {Array<V3RulesRules>}
* @memberof InlineObject5
*/
rules?: Array<V3RulesRules>;
}
/**
*
* @export
* @interface InlineObject6
*/
export interface InlineObject6 {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof InlineObject6
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {V3RulesCreateRules}
* @memberof InlineObject6
*/
rules?: V3RulesCreateRules;
}
/**
*
* @export
* @interface InlineResponse200
*/
export interface InlineResponse200 {
/**
* Message and status of inactivation of rule
* @type {string}
* @memberof InlineResponse200
*/
message?: string;
/**
* status
* @type {string}
* @memberof InlineResponse200
*/
status?: string;
}
/**
*
* @export
* @interface InlineResponse2001
*/
export interface InlineResponse2001 {
/**
* A seller-provided Product ID.
* @type {Array<string>}
* @memberof InlineResponse2001
*/
skuIds?: Array<string>;
/**
*
* @type {string}
* @memberof InlineResponse2001
*/
status?: string;
}
/**
*
* @export
* @interface InlineResponse20010
*/
export interface InlineResponse20010 {
/**
* Message and status of deletion
* @type {string}
* @memberof InlineResponse20010
*/
message?: string;
/**
* status
* @type {string}
* @memberof InlineResponse20010
*/
status?: string;
}
/**
*
* @export
* @interface InlineResponse2002
*/
export interface InlineResponse2002 {
/**
* A unique ID, returned from the Create Override Exception API, used for tracking a feed file
* @type {string}
* @memberof InlineResponse2002
*/
feedId?: string;
/**
* status
* @type {string}
* @memberof InlineResponse2002
*/
status?: string;
}
/**
*
* @export
* @interface InlineResponse2003
*/
export interface InlineResponse2003 {
/**
*
* @type {string}
* @memberof InlineResponse2003
*/
status?: string;
/**
*
* @type {InlineResponse2003Payload}
* @memberof InlineResponse2003
*/
payload?: InlineResponse2003Payload;
}
/**
*
* @export
* @interface InlineResponse2003Payload
*/
export interface InlineResponse2003Payload {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2003Payload
*/
id?: string;
}
/**
*
* @export
* @interface InlineResponse2004
*/
export interface InlineResponse2004 {
/**
* Message and ruleId
* @type {string}
* @memberof InlineResponse2004
*/
message?: string;
/**
* status
* @type {string}
* @memberof InlineResponse2004
*/
status?: string;
}
/**
*
* @export
* @interface InlineResponse2005
*/
export interface InlineResponse2005 {
/**
*
* @type {Array<InlineResponse2005Rules>}
* @memberof InlineResponse2005
*/
rules?: Array<InlineResponse2005Rules>;
/**
* status
* @type {string}
* @memberof InlineResponse2005
*/
status?: string;
}
/**
* Seller creates conditions while defining the custom rule assortment.There are three condition which a seller can use : subCategories, price, weight.
* @export
* @interface InlineResponse2005Conditions
*/
export interface InlineResponse2005Conditions {
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2005Conditions
*/
name?: string;
/**
* Seller uses operator while defining conditions in the rule. Operators allowed for condition price and weight: EQUALS, GREATER_THAN, LESS_THAN,GREATER_THAN_OR_EQUALS,LESS_THAN_OR_EQUALS. and for condition subcategories : IN .
* @type {string}
* @memberof InlineResponse2005Conditions
*/
operator?: string;
/**
* Values for each condition. Value can be a comma separated strings for subcategories and numerical value for price and weight.
* @type {string}
* @memberof InlineResponse2005Conditions
*/
value?: string;
}
/**
*
* @export
* @interface InlineResponse2005Rules
*/
export interface InlineResponse2005Rules {
/**
* Seller creates conditions while defining the custom rule assortment.There are three condition which a seller can use : subCategories, price, weight.
* @type {Array<InlineResponse2005Conditions>}
* @memberof InlineResponse2005Rules
*/
conditions?: Array<InlineResponse2005Conditions>;
/**
* Description of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2005Rules
*/
description?: string;
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2005Rules
*/
name?: string;
/**
* Priority of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2005Rules
*/
priority?: string;
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2005Rules
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof InlineResponse2005Rules
*/
ruleStatus?: string;
/**
* When the rule gets activated, skuProcessingStatus represents the state of all items being processed for two-day. The two values for skuProcessingStatus are Processing and Completed.
* @type {string}
* @memberof InlineResponse2005Rules
*/
skuProcessingStatus?: string;
/**
*
* @type {V3RulesActionsRulesActions}
* @memberof InlineResponse2005Rules
*/
ruleAction?: V3RulesActionsRulesActions;
}
/**
*
* @export
* @interface InlineResponse2006
*/
export interface InlineResponse2006 {
/**
*
* @type {Array<InlineResponse2006Rules>}
* @memberof InlineResponse2006
*/
rules?: Array<InlineResponse2006Rules>;
/**
*
* @type {string}
* @memberof InlineResponse2006
*/
status?: string;
}
/**
*
* @export
* @interface InlineResponse2006Rules
*/
export interface InlineResponse2006Rules {
/**
* Seller creates conditions while defining the custom rule assortment.There are three condition which a seller can use : subCategories, price, weight.
* @type {Array<InlineResponse2005Conditions>}
* @memberof InlineResponse2006Rules
*/
conditions?: Array<InlineResponse2005Conditions>;
/**
* Description of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2006Rules
*/
description?: string;
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2006Rules
*/
name?: string;
/**
* Priority of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2006Rules
*/
priority?: string;
/**
* Defines the two day state coverage areas.
* @type {string}
* @memberof InlineResponse2006Rules
*/
ruleAction?: string;
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2006Rules
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof InlineResponse2006Rules
*/
ruleStatus?: string;
/**
* When the rule gets activated, skuProcessingStatus represents the state of all items being processed for two-day. The two values for skuProcessingStatus are Processing and Completed.
* @type {string}
* @memberof InlineResponse2006Rules
*/
skuProcessingStatus?: string;
}
/**
*
* @export
* @interface InlineResponse2007
*/
export interface InlineResponse2007 {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof InlineResponse2007
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof InlineResponse2007
*/
ruleStatus?: string;
/**
* Number of items that would be set for two-day if the rule gets activated.
* @type {string}
* @memberof InlineResponse2007
*/
simulationCount?: string;
}
/**
*
* @export
* @interface InlineResponse2008
*/
export interface InlineResponse2008 {
/**
*
* @type {string}
* @memberof InlineResponse2008
*/
status?: string;
/**
*
* @type {Array<InlineResponse2008Payload>}
* @memberof InlineResponse2008
*/
payload?: Array<InlineResponse2008Payload>;
}
/**
*
* @export
* @interface InlineResponse2008Payload
*/
export interface InlineResponse2008Payload {
/**
* category
* @type {string}
* @memberof InlineResponse2008Payload
*/
category?: string;
/**
* subCategory
* @type {Array<InlineResponse2008Subcategory>}
* @memberof InlineResponse2008Payload
*/
subcategory?: Array<InlineResponse2008Subcategory>;
}
/**
* subCategory
* @export
* @interface InlineResponse2008Subcategory
*/
export interface InlineResponse2008Subcategory {
/**
* Name of specific kind of category
* @type {string}
* @memberof InlineResponse2008Subcategory
*/
subCategoryName?: string;
/**
* ID of specific kind of category
* @type {string}
* @memberof InlineResponse2008Subcategory
*/
subCategoryId?: string;
}
/**
*
* @export
* @interface InlineResponse2009
*/
export interface InlineResponse2009 {
/**
* Status of the rule post the rule creation.
* @type {string}
* @memberof InlineResponse2009
*/
status?: string;
/**
*
* @type {InlineResponse2009Payload}
* @memberof InlineResponse2009
*/
payload?: InlineResponse2009Payload;
}
/**
*
* @export
* @interface InlineResponse2009Payload
*/
export interface InlineResponse2009Payload {
/**
*
* @type {Array<InlineResponse2009PayloadEntities>}
* @memberof InlineResponse2009Payload
*/
entities?: Array<InlineResponse2009PayloadEntities>;
}
/**
*
* @export
* @interface InlineResponse2009PayloadEntities
*/
export interface InlineResponse2009PayloadEntities {
/**
* states.
* @type {Array<InlineResponse2009PayloadStates>}
* @memberof InlineResponse2009PayloadEntities
*/
states?: Array<InlineResponse2009PayloadStates>;
/**
* regionCode
* @type {string}
* @memberof InlineResponse2009PayloadEntities
*/
regionCode?: string;
/**
* regionName
* @type {string}
* @memberof InlineResponse2009PayloadEntities
*/
regionName?: string;
}
/**
* statesubregions
* @export
* @interface InlineResponse2009PayloadStateSubregions
*/
export interface InlineResponse2009PayloadStateSubregions {
/**
* stateSubregionCode
* @type {string}
* @memberof InlineResponse2009PayloadStateSubregions
*/
stateSubregionCode?: string;
/**
* stateSubregionName
* @type {string}
* @memberof InlineResponse2009PayloadStateSubregions
*/
stateSubregionName?: string;
}
/**
* states.
* @export
* @interface InlineResponse2009PayloadStates
*/
export interface InlineResponse2009PayloadStates {
/**
* statesubregions
* @type {Array<InlineResponse2009PayloadStateSubregions>}
* @memberof InlineResponse2009PayloadStates
*/
stateSubregions?: Array<InlineResponse2009PayloadStateSubregions>;
}
/**
*
* @export
* @interface OverrideItem
*/
export interface OverrideItem {
/**
* 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. Other characters don\'t need to be encoded.
* @type {string}
* @memberof OverrideItem
*/
sku?: string;
}
/**
* Defines the two day state coverage areas.
* @export
* @interface RuleAction
*/
export interface RuleAction {
/**
* List of two-day regions.
* @type {Array<V3RulesActionsRulesTwoDayShippingRegions>}
* @memberof RuleAction
*/
twoDayShippingRegions?: Array<V3RulesActionsRulesTwoDayShippingRegions>;
}
/**
*
* @export
* @interface RuleHeader
*/
export interface RuleHeader {
/**
*
* @type {string}
* @memberof RuleHeader
*/
version?: string;
}
/**
*
* @export
* @interface RuleInfo
*/
export interface RuleInfo {
/**
* Seller creates conditions while defining the custom rule assortment.There are three condition which a seller can use : subCategories, price, weight.
* @type {Array<InlineResponse2005Conditions>}
* @memberof RuleInfo
*/
conditions?: Array<InlineResponse2005Conditions>;
/**
* Description of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleInfo
*/
description?: string;
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleInfo
*/
name?: string;
/**
* Priority of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleInfo
*/
priority?: string;
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleInfo
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof RuleInfo
*/
ruleStatus?: string;
/**
* When the rule gets activated, skuProcessingStatus represents the state of all items being processed for two-day. The two values for skuProcessingStatus are Processing and Completed.
* @type {string}
* @memberof RuleInfo
*/
skuProcessingStatus?: string;
/**
*
* @type {V3RulesActionsRulesActions}
* @memberof RuleInfo
*/
ruleAction?: V3RulesActionsRulesActions;
}
/**
*
* @export
* @interface RuleRequest
*/
export interface RuleRequest {
/**
*
* @type {Array<InlineResponse2005Conditions>}
* @memberof RuleRequest
*/
conditions?: Array<InlineResponse2005Conditions>;
/**
* Description of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleRequest
*/
description?: string;
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleRequest
*/
name?: string;
/**
* Priority of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleRequest
*/
priority?: string;
}
/**
*
* @export
* @interface RuleResponse
*/
export interface RuleResponse {
/**
* Seller creates conditions while defining the custom rule assortment.There are three condition which a seller can use : subCategories, price, weight.
* @type {Array<InlineResponse2005Conditions>}
* @memberof RuleResponse
*/
conditions?: Array<InlineResponse2005Conditions>;
/**
* Description of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleResponse
*/
description?: string;
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleResponse
*/
name?: string;
/**
* Priority of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleResponse
*/
priority?: string;
/**
* Defines the two day state coverage areas.
* @type {string}
* @memberof RuleResponse
*/
ruleAction?: string;
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleResponse
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof RuleResponse
*/
ruleStatus?: string;
/**
* When the rule gets activated, skuProcessingStatus represents the state of all items being processed for two-day. The two values for skuProcessingStatus are Processing and Completed.
* @type {string}
* @memberof RuleResponse
*/
skuProcessingStatus?: string;
}
/**
*
* @export
* @interface RuleToUpdate
*/
export interface RuleToUpdate {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof RuleToUpdate
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof RuleToUpdate
*/
ruleStatus?: string;
/**
* Defines the two day state coverage areas.
* @type {Array<V3RulesActionsRulesActions>}
* @memberof RuleToUpdate
*/
actions?: Array<V3RulesActionsRulesActions>;
}
/**
* states.
* @export
* @interface State
*/
export interface State {
/**
* statesubregions
* @type {Array<InlineResponse2009PayloadStateSubregions>}
* @memberof State
*/
stateSubregions?: Array<InlineResponse2009PayloadStateSubregions>;
}
/**
* statesubregions
* @export
* @interface StateSubRegion
*/
export interface StateSubRegion {
/**
* stateSubregionCode
* @type {string}
* @memberof StateSubRegion
*/
stateSubregionCode?: string;
/**
* stateSubregionName
* @type {string}
* @memberof StateSubRegion
*/
stateSubregionName?: string;
}
/**
* subCategory
* @export
* @interface SubCategory
*/
export interface SubCategory {
/**
* Name of specific kind of category
* @type {string}
* @memberof SubCategory
*/
subCategoryName?: string;
/**
* ID of specific kind of category
* @type {string}
* @memberof SubCategory
*/
subCategoryId?: string;
}
/**
*
* @export
* @interface SubRegionCode
*/
export interface SubRegionCode {
/**
* subRegionCode
* @type {string}
* @memberof SubRegionCode
*/
subRegionCode?: string;
}
/**
* List of two-day regions.
* @export
* @interface SubRegions
*/
export interface SubRegions {
/**
* regionCode
* @type {string}
* @memberof SubRegions
*/
regionCode?: string;
/**
*
* @type {Array<V3RulesActionsRulesSubRegions>}
* @memberof SubRegions
*/
subRegions?: Array<V3RulesActionsRulesSubRegions>;
}
/**
*
* @export
* @interface UpdateRuleInfo
*/
export interface UpdateRuleInfo {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof UpdateRuleInfo
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof UpdateRuleInfo
*/
ruleStatus?: string;
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof UpdateRuleInfo
*/
name?: string;
/**
* Description of the rule created for custom rule assortment.
* @type {string}
* @memberof UpdateRuleInfo
*/
description?: string;
/**
* Priority of the rule created for custom rule assortment.
* @type {string}
* @memberof UpdateRuleInfo
*/
priority?: string;
/**
* Seller creates conditions while defining the custom rule assortment.There are three condition which a seller can use : subCategories, price, weight.
* @type {Array<InlineResponse2005Conditions>}
* @memberof UpdateRuleInfo
*/
conditions?: Array<InlineResponse2005Conditions>;
}
/**
*
* @export
* @interface UpdateRuleRequest
*/
export interface UpdateRuleRequest {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof UpdateRuleRequest
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {Array<V3RulesRules>}
* @memberof UpdateRuleRequest
*/
rules?: Array<V3RulesRules>;
}
/**
*
* @export
* @interface UpdateShippingAreaToRulesRequest
*/
export interface UpdateShippingAreaToRulesRequest {
/**
*
* @type {V3RulesInactivateRuleHeader}
* @memberof UpdateShippingAreaToRulesRequest
*/
ruleHeader?: V3RulesInactivateRuleHeader;
/**
*
* @type {V3RulesActionsRules}
* @memberof UpdateShippingAreaToRulesRequest
*/
rules?: V3RulesActionsRules;
}
/**
*
* @export
* @interface V3RulesActionsRules
*/
export interface V3RulesActionsRules {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof V3RulesActionsRules
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof V3RulesActionsRules
*/
ruleStatus?: string;
/**
* Defines the two day state coverage areas.
* @type {Array<V3RulesActionsRulesActions>}
* @memberof V3RulesActionsRules
*/
actions?: Array<V3RulesActionsRulesActions>;
}
/**
* Defines the two day state coverage areas.
* @export
* @interface V3RulesActionsRulesActions
*/
export interface V3RulesActionsRulesActions {
/**
* List of two-day regions.
* @type {Array<V3RulesActionsRulesTwoDayShippingRegions>}
* @memberof V3RulesActionsRulesActions
*/
twoDayShippingRegions?: Array<V3RulesActionsRulesTwoDayShippingRegions>;
}
/**
*
* @export
* @interface V3RulesActionsRulesSubRegions
*/
export interface V3RulesActionsRulesSubRegions {
/**
* subRegionCode
* @type {string}
* @memberof V3RulesActionsRulesSubRegions
*/
subRegionCode?: string;
}
/**
* List of two-day regions.
* @export
* @interface V3RulesActionsRulesTwoDayShippingRegions
*/
export interface V3RulesActionsRulesTwoDayShippingRegions {
/**
* regionCode
* @type {string}
* @memberof V3RulesActionsRulesTwoDayShippingRegions
*/
regionCode?: string;
/**
*
* @type {Array<V3RulesActionsRulesSubRegions>}
* @memberof V3RulesActionsRulesTwoDayShippingRegions
*/
subRegions?: Array<V3RulesActionsRulesSubRegions>;
}
/**
*
* @export
* @interface V3RulesCreateRules
*/
export interface V3RulesCreateRules {
/**
*
* @type {Array<InlineResponse2005Conditions>}
* @memberof V3RulesCreateRules
*/
conditions?: Array<InlineResponse2005Conditions>;
/**
* Description of the rule created for custom rule assortment.
* @type {string}
* @memberof V3RulesCreateRules
*/
description?: string;
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof V3RulesCreateRules
*/
name?: string;
/**
* Priority of the rule created for custom rule assortment.
* @type {string}
* @memberof V3RulesCreateRules
*/
priority?: string;
}
/**
*
* @export
* @interface V3RulesExceptionsRules
*/
export interface V3RulesExceptionsRules {
/**
*
* @type {Array<V3RulesExceptionsRulesSkus>}
* @memberof V3RulesExceptionsRules
*/
skus?: Array<V3RulesExceptionsRulesSkus>;
}
/**
*
* @export
* @interface V3RulesExceptionsRulesSkus
*/
export interface V3RulesExceptionsRulesSkus {
/**
* 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. Other characters don\'t need to be encoded.
* @type {string}
* @memberof V3RulesExceptionsRulesSkus
*/
sku?: string;
}
/**
*
* @export
* @interface V3RulesInactivateRuleHeader
*/
export interface V3RulesInactivateRuleHeader {
/**
*
* @type {string}
* @memberof V3RulesInactivateRuleHeader
*/
version?: string;
}
/**
*
* @export
* @interface V3RulesInactivateRules
*/
export interface V3RulesInactivateRules {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof V3RulesInactivateRules
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof V3RulesInactivateRules
*/
ruleStatus?: string;
}
/**
*
* @export
* @interface V3RulesRules
*/
export interface V3RulesRules {
/**
* Unique identifier of the rule created for custom rule assortment.
* @type {string}
* @memberof V3RulesRules
*/
ruleId?: string;
/**
* Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @type {string}
* @memberof V3RulesRules
*/
ruleStatus?: string;
/**
* Name of the rule created for custom rule assortment.
* @type {string}
* @memberof V3RulesRules
*/
name?: string;
/**
* Description of the rule created for custom rule assortment.
* @type {string}
* @memberof V3RulesRules
*/
description?: string;
/**
* Priority of the rule created for custom rule assortment.
* @type {string}
* @memberof V3RulesRules
*/
priority?: string;
/**
* Seller creates conditions while defining the custom rule assortment.There are three condition which a seller can use : subCategories, price, weight.
* @type {Array<InlineResponse2005Conditions>}
* @memberof V3RulesRules
*/
conditions?: Array<InlineResponse2005Conditions>;
}
/**
* RulesApi - axios parameter creator
* @export
*/
export declare const RulesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* This API is used to activate a rule for a specific ruleId and ruleStatus. Only Rules which are in submitted and inactive state can be activated.
* @summary Activate rule
* @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 {InlineObject3} inlineObject3
* @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}
*/
activateRule: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject3: InlineObject3, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* This API helps you enable or disable the two-day assortment type.
* @summary Change assortment type
* @param {boolean} enable
* @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 {object} body
* @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}
*/
changeAssortmentType: (enable: boolean, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, body: object, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* This API is used to create a rule by selecting any combination of conditions for Sub-category, Price and Weight.
* @summary Create a new Rule
* @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 {InlineObject6} inlineObject6
* @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}
*/
createItemRule: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject6: InlineObject6, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* This API is used if any SKU is required to be removed from Two-day delivery settings
* @summary Create override exceptions
* @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 {InlineObject2} inlineObject2
* @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}
*/
createOverrideExceptions: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject2: InlineObject2, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* This API is used to bring back any SKU to Two-day Delivery settings.
* @summary Delete exceptions
* @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}
*/
deleteExceptions: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, inlineObject1: InlineObject1, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* This API is used to delete a rule for a specific ruleId and ruleStatus
* @summary Delete rule
* @param {string} ruleId Unique identifier of the rule created for custom rule assortment.
* @param {string} ruleStatus Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @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} [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}
*/
deleteRule: (ruleId: string, ruleStatus: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* You can use this API to get list of the items defined using \"Create Override Exceptions\".
* @summary Download exceptions
* @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} [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}
*/
downloadExceptions: (authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* You can use this API to download the count of items shortlisted for two-day shipping for a specific rule defined by ruleId and ruleStatus
* @summary Download simulation result
* @param {string} ruleId Unique identifier of the rule created for custom rule assortment.
* @param {string} ruleStatus Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @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} [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}
*/
downloadSimulationResult: (ruleId: string, ruleStatus: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* Retrieves a rule detail for a specific ruleId and ruleStatus.
* @summary Get a rule
* @param {string} ruleId Unique identifier of the rule created for custom rule assortment.
* @param {string} ruleStatus Status of the rule post the rule creation. Allowed values are Active, Inactive, Submitted.
* @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} [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}
*/
getARule: (ruleId: string, ruleStatus: string, authorization: string, wMSECACCESSTOKEN: string, wMQOSCORRELATIONID: string, wMSVCNAME: string, wMCONSUMERCHANNELTYPE?: string, options?: any) => Promise<RequestArgs>;
/**
* This API provides you the list of states on which you can provide two-day shipping of an item.
* @summary Get all areas
* @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 ca