@whitebox-co/walmart-marketplace-api
Version:
A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API
1,818 lines (1,817 loc) • 193 kB
TypeScript
/**
* Settings Management
* Settings Management API
*
* 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 AccountConfig
*/
export interface AccountConfig {
/**
* Name of the configuration. Allowed value is ACCOUNT
* @type {string}
* @memberof AccountConfig
*/
configurationName?: string;
/**
*
* @type {AccountConfigConfiguration}
* @memberof AccountConfig
*/
configuration?: AccountConfigConfiguration;
}
/**
*
* @export
* @interface AccountConfigConfiguration
*/
export interface AccountConfigConfiguration {
/**
* Status of Seller Account
* @type {string}
* @memberof AccountConfigConfiguration
*/
status?: AccountConfigConfigurationStatusEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum AccountConfigConfigurationStatusEnum {
Active = "ACTIVE",
OnboardingActive = "ONBOARDING_ACTIVE",
OnboardingInactive = "ONBOARDING_INACTIVE",
Suspended = "SUSPENDED",
TnsDeclined = "TNS_DECLINED",
Terminated = "TERMINATED"
}
/**
*
* @export
* @interface AccountInfoDTO
*/
export interface AccountInfoDTO {
/**
* Status of Seller Account
* @type {string}
* @memberof AccountInfoDTO
*/
status?: AccountInfoDTOStatusEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum AccountInfoDTOStatusEnum {
Active = "ACTIVE",
OnboardingActive = "ONBOARDING_ACTIVE",
OnboardingInactive = "ONBOARDING_INACTIVE",
Suspended = "SUSPENDED",
TnsDeclined = "TNS_DECLINED",
Terminated = "TERMINATED"
}
/**
*
* @export
* @interface Associate3PFulfillmentCenterRequest
*/
export interface Associate3PFulfillmentCenterRequest {
/**
*
* @type {V3SettingsShippingShipnodesShipNodeHeader}
* @memberof Associate3PFulfillmentCenterRequest
*/
shipNodeHeader?: V3SettingsShippingShipnodesShipNodeHeader;
/**
*
* @type {Array<V3SettingsShipping3plshipnodesShipNode>}
* @memberof Associate3PFulfillmentCenterRequest
*/
shipNode?: Array<V3SettingsShipping3plshipnodesShipNode>;
}
/**
* Calendar day promise details. For examples, please refer to \'Sample 2 - Calendar Day Configurations\' in request & response samples.
* @export
* @interface CalendarDayConfiguration
*/
export interface CalendarDayConfiguration {
/**
*
* @type {V3SettingsShippingShipnodesShipNodeCalendarDayConfigurationStandardProcessingSchedule}
* @memberof CalendarDayConfiguration
*/
standardProcessingSchedule: V3SettingsShippingShipnodesShipNodeCalendarDayConfigurationStandardProcessingSchedule;
/**
* List of additional days on which the fulfillment center is closed. For example, if the fulfillment center is closed on New Year’s Day, then add the date in the list. If there are no additional off days, then this list will be empty. Use ISO 8601 format for date. For example: \'2021-07-16\'(yyyy-MM-dd)
* @type {Array<string>}
* @memberof CalendarDayConfiguration
*/
additionalDaysOff: Array<string>;
/**
*
* @type {V3SettingsShippingShipnodesCalendarDayConfigurationCarrierWeekendCalendar}
* @memberof CalendarDayConfiguration
*/
carrierWeekendCalendar?: V3SettingsShippingShipnodesCalendarDayConfigurationCarrierWeekendCalendar;
}
/**
* Calendar day promise details. For examples, please refer to \'Sample 2 - Calendar Day Configurations\' in request & response samples.
* @export
* @interface CalendarDayConfigurationRequest
*/
export interface CalendarDayConfigurationRequest {
/**
*
* @type {V3SettingsShippingShipnodesShipNodeCalendarDayConfigurationStandardProcessingSchedule}
* @memberof CalendarDayConfigurationRequest
*/
standardProcessingSchedule: V3SettingsShippingShipnodesShipNodeCalendarDayConfigurationStandardProcessingSchedule;
/**
* List of additional days on which the fulfillment center is closed. For example, if the fulfillment center is closed on New Year’s Day, then add the date in the list. If there are no additional off days, then this list will be empty. Use ISO 8601 format for date. For example: \'2021-07-16\'(yyyy-MM-dd)
* @type {Array<string>}
* @memberof CalendarDayConfigurationRequest
*/
additionalDaysOff: Array<string>;
}
/**
* Calendar day promise details. For examples, please refer to \'Sample 2 - Calendar Day Configurations\' in request & response samples.
* @export
* @interface CalendarDayConfigurationResponse
*/
export interface CalendarDayConfigurationResponse {
/**
*
* @type {V3SettingsShippingShipnodesCalendarDayConfigurationStandardProcessingSchedule}
* @memberof CalendarDayConfigurationResponse
*/
standardProcessingSchedule?: V3SettingsShippingShipnodesCalendarDayConfigurationStandardProcessingSchedule;
/**
* List of additional days on which the fulfillment center is closed. If there are no additional off days, then this list will be empty. Format for Date is ISO 8601. For example: \'2021-07-16\'(yyyy-MM-dd)
* @type {Array<string>}
* @memberof CalendarDayConfigurationResponse
*/
additionalDaysOff?: Array<string>;
/**
*
* @type {V3SettingsShippingShipnodesCalendarDayConfigurationCarrierWeekendCalendar}
* @memberof CalendarDayConfigurationResponse
*/
carrierWeekendCalendar?: V3SettingsShippingShipnodesCalendarDayConfigurationCarrierWeekendCalendar;
}
/**
* Calendar day promise details. For examples, please refer to \'Sample 2 - Calendar Day Configurations\' in request & response samples.
* @export
* @interface CalendarDayConfigurationResponseCreate
*/
export interface CalendarDayConfigurationResponseCreate {
/**
*
* @type {V3SettingsShippingShipnodesCalendarDayConfigurationStandardProcessingSchedule}
* @memberof CalendarDayConfigurationResponseCreate
*/
standardProcessingSchedule?: V3SettingsShippingShipnodesCalendarDayConfigurationStandardProcessingSchedule;
/**
* List of additional days on which the fulfillment center is closed. If there are no additional off days, then this list will be empty. Format for Date is ISO 8601. For example: \'2021-07-16\'(yyyy-MM-dd)
* @type {Array<string>}
* @memberof CalendarDayConfigurationResponseCreate
*/
additionalDaysOff?: Array<string>;
}
/**
*
* @export
* @interface CalendarDayShift
*/
export interface CalendarDayShift {
/**
* Flag to specify if shipNode is operational on the specified day of each week. Allowed values are true or false.
* @type {boolean}
* @memberof CalendarDayShift
*/
isWorkingDay: boolean;
/**
* Order processing cutoff time. Please note that cutoff time is respective of the seller’s time zone. If not provided in the request body, then by default it will be set to \'14:00\'. Example: \'09:30\'(HH:mm)
* @type {string}
* @memberof CalendarDayShift
*/
cutOffTime?: string;
}
/**
*
* @export
* @interface CalendarDayShiftResponse
*/
export interface CalendarDayShiftResponse {
/**
* Flag to specify if shipNode is operational on the specified day of each week. Allowed values are true or false.
* @type {boolean}
* @memberof CalendarDayShiftResponse
*/
isWorkingDay?: boolean;
/**
* Order processing cutoff time. Please note that cutoff time is respective of the seller’s time zone. Example: \'09:30\'(HH:mm)
* @type {string}
* @memberof CalendarDayShiftResponse
*/
cutOffTime?: string;
}
/**
* Shipping type provided.
* @export
* @interface CarrierDetail1
*/
export interface CarrierDetail1 {
/**
* Name of the shipping carrier. Carrier names can be retrieved from the Get carrier methods API.
* @type {string}
* @memberof CarrierDetail1
*/
carrierMethodName?: string;
/**
* Shipping method.
* @type {string}
* @memberof CarrierDetail1
*/
carrierMethodType?: string;
}
/**
*
* @export
* @interface CarrierDetail2
*/
export interface CarrierDetail2 {
/**
* Carrier Id
* @type {string}
* @memberof CarrierDetail2
*/
carrierMethodId?: string;
/**
* Carrier Name
* @type {string}
* @memberof CarrierDetail2
*/
carrierMethodName?: string;
/**
* Shipping method. Allowed Value is GROUND.
* @type {string}
* @memberof CarrierDetail2
*/
carrierMethodType?: string;
/**
* A description for the method carrier.
* @type {string}
* @memberof CarrierDetail2
*/
carrierMethodDescription?: string;
}
/**
* Operating Schedule for the carrier
* @export
* @interface CarrierWeekendCalendar
*/
export interface CarrierWeekendCalendar {
/**
*
* @type {V3SettingsShippingShipnodesCalendarDayConfigurationCarrierWeekendCalendarSunday}
* @memberof CarrierWeekendCalendar
*/
sunday?: V3SettingsShippingShipnodesCalendarDayConfigurationCarrierWeekendCalendarSunday;
/**
*
* @type {V3SettingsShippingShipnodesCalendarDayConfigurationCarrierWeekendCalendarSunday}
* @memberof CarrierWeekendCalendar
*/
saturday?: V3SettingsShippingShipnodesCalendarDayConfigurationCarrierWeekendCalendarSunday;
}
/**
*
* @export
* @interface CarrierWeekendCalendarDay
*/
export interface CarrierWeekendCalendarDay {
/**
* Flag to specify if carrier is operational on the specified day of each week. Allowed values are true or false.
* @type {boolean}
* @memberof CarrierWeekendCalendarDay
*/
workingDay?: boolean;
}
/**
*
* @export
* @interface CategoriesLagTimeDTO
*/
export interface CategoriesLagTimeDTO {
/**
* List of item setup category level lag time exceptions configured for seller
* @type {Array<CategoriesLagTimeDTOCategories>}
* @memberof CategoriesLagTimeDTO
*/
categories?: Array<CategoriesLagTimeDTOCategories>;
}
/**
* List of item setup category level lag time exceptions configured for seller
* @export
* @interface CategoriesLagTimeDTOCategories
*/
export interface CategoriesLagTimeDTOCategories {
/**
* Name of the item setup category which was used to request lag time exception
* @type {string}
* @memberof CategoriesLagTimeDTOCategories
*/
name?: string;
/**
* Maximum lag time configured for the item setup category
* @type {number}
* @memberof CategoriesLagTimeDTOCategories
*/
fulfillmentLagTime?: number;
}
/**
* List of item setup category level lag time exceptions configured for seller
* @export
* @interface CategoryLagTimeDTO
*/
export interface CategoryLagTimeDTO {
/**
* Name of the item setup category which was used to request lag time exception
* @type {string}
* @memberof CategoryLagTimeDTO
*/
name?: string;
/**
* Maximum lag time configured for the item setup category
* @type {number}
* @memberof CategoryLagTimeDTO
*/
fulfillmentLagTime?: number;
}
/**
* Per Weight Charge
* @export
* @interface ChargePerItem
*/
export interface ChargePerItem {
/**
* Charge Per Item, value USD
* @type {number}
* @memberof ChargePerItem
*/
amount: number;
/**
* Currency, eg. USD
* @type {string}
* @memberof ChargePerItem
*/
currency: string;
}
/**
* Per Item Charge
* @export
* @interface ChargePerWeight
*/
export interface ChargePerWeight {
/**
* Charge Per weight, value USD
* @type {number}
* @memberof ChargePerWeight
*/
amount: number;
/**
* Currency, eg. USD
* @type {string}
* @memberof ChargePerWeight
*/
currency: string;
}
/**
*
* @export
* @interface CreateAutomatedShippingTemplateRequest
*/
export interface CreateAutomatedShippingTemplateRequest {
/**
* Fulfillment Center Name
* @type {string}
* @memberof CreateAutomatedShippingTemplateRequest
*/
fulfillmentCenterName?: string;
/**
* Fulfillment Center Zipcode
* @type {string}
* @memberof CreateAutomatedShippingTemplateRequest
*/
fulfillmentCenterZipCode?: string;
/**
* Carrier Method Name. Supported carrier methods are: FEDEX_GROUND
* @type {string}
* @memberof CreateAutomatedShippingTemplateRequest
*/
carrierMethodName?: string;
}
/**
*
* @export
* @interface CreateFulfillmentCenterRequest
*/
export interface CreateFulfillmentCenterRequest {
/**
*
* @type {V3SettingsShippingShipnodesShipNodeHeader}
* @memberof CreateFulfillmentCenterRequest
*/
shipNodeHeader?: V3SettingsShippingShipnodesShipNodeHeader;
/**
*
* @type {Array<V3SettingsShippingShipnodesShipNode1>}
* @memberof CreateFulfillmentCenterRequest
*/
shipNode?: Array<V3SettingsShippingShipnodesShipNode1>;
}
/**
*
* @export
* @interface CreateShippingTemplateRequest
*/
export interface CreateShippingTemplateRequest {
/**
* Shipping Template Name
* @type {string}
* @memberof CreateShippingTemplateRequest
*/
name?: string;
/**
* Shipping Template Type, should be CUSTOM or 3PL Specific
* @type {string}
* @memberof CreateShippingTemplateRequest
*/
type?: string;
/**
* This is the shipping model type. TIERED_PRICING: This model means that you charge shipping based on the price of the item PER_SHIPMENT_PRICING: This model means that you charge shipping based on the weight of your items (per pound), or you charge shipping based on the number of items purchased in an order
* @type {string}
* @memberof CreateShippingTemplateRequest
*/
rateModelType?: string;
/**
* Shipping Template Status, Can be ACTIVE or INACTIVE status
* @type {string}
* @memberof CreateShippingTemplateRequest
*/
status?: string;
/**
* Array of different ship methods of a Shipping Template
* @type {Array<InlineResponse200ShippingMethods>}
* @memberof CreateShippingTemplateRequest
*/
shippingMethods?: Array<InlineResponse200ShippingMethods>;
}
/**
*
* @export
* @interface FeedConfig
*/
export interface FeedConfig {
/**
* Name of the configuration. Allowed value is FEED
* @type {string}
* @memberof FeedConfig
*/
configurationName?: string;
/**
*
* @type {FeedConfigConfiguration}
* @memberof FeedConfig
*/
configuration?: FeedConfigConfiguration;
}
/**
*
* @export
* @interface FeedConfigConfiguration
*/
export interface FeedConfigConfiguration {
/**
* List of feed throttling configurations
* @type {Array<FeedConfigConfigurationValues>}
* @memberof FeedConfigConfiguration
*/
values?: Array<FeedConfigConfigurationValues>;
}
/**
* The maximum allowed size of the feed file
* @export
* @interface FeedConfigConfigurationFileSize
*/
export interface FeedConfigConfigurationFileSize {
/**
* The number representing file size
* @type {number}
* @memberof FeedConfigConfigurationFileSize
*/
value?: number;
/**
* The unit of measurement. Example: \'BYTES\'
* @type {string}
* @memberof FeedConfigConfigurationFileSize
*/
unitOfMeasurement?: FeedConfigConfigurationFileSizeUnitOfMeasurementEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum FeedConfigConfigurationFileSizeUnitOfMeasurementEnum {
Bytes = "BYTES"
}
/**
* API call Rate
* @export
* @interface FeedConfigConfigurationRate
*/
export interface FeedConfigConfigurationRate {
/**
* Number of API calls that can be made in every replenish time window
* @type {number}
* @memberof FeedConfigConfigurationRate
*/
count?: number;
/**
*
* @type {FeedConfigConfigurationRateReplenishTimeWindow}
* @memberof FeedConfigConfigurationRate
*/
replenishTimeWindow?: FeedConfigConfigurationRateReplenishTimeWindow;
}
/**
* A time period set for throttling of number of API calls
* @export
* @interface FeedConfigConfigurationRateReplenishTimeWindow
*/
export interface FeedConfigConfigurationRateReplenishTimeWindow {
/**
* The number representing size of time window
* @type {number}
* @memberof FeedConfigConfigurationRateReplenishTimeWindow
*/
value?: number;
/**
* The unit of measurement. Example: \'SECOND\'
* @type {string}
* @memberof FeedConfigConfigurationRateReplenishTimeWindow
*/
unitOfMeasurement?: FeedConfigConfigurationRateReplenishTimeWindowUnitOfMeasurementEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum FeedConfigConfigurationRateReplenishTimeWindowUnitOfMeasurementEnum {
Second = "SECOND"
}
/**
* Details of throttling configurations
* @export
* @interface FeedConfigConfigurationThrottleConfigurations
*/
export interface FeedConfigConfigurationThrottleConfigurations {
/**
* Type of the throttling configuration. Example \'SELLER\' means throttling configurations at Seller level only.
* @type {string}
* @memberof FeedConfigConfigurationThrottleConfigurations
*/
type?: FeedConfigConfigurationThrottleConfigurationsTypeEnum;
/**
*
* @type {FeedConfigConfigurationRate}
* @memberof FeedConfigConfigurationThrottleConfigurations
*/
rate?: FeedConfigConfigurationRate;
/**
*
* @type {FeedConfigConfigurationFileSize}
* @memberof FeedConfigConfigurationThrottleConfigurations
*/
fileSize?: FeedConfigConfigurationFileSize;
}
/**
* @export
* @enum {string}
*/
export declare enum FeedConfigConfigurationThrottleConfigurationsTypeEnum {
Seller = "SELLER"
}
/**
* List of feed throttling configurations
* @export
* @interface FeedConfigConfigurationValues
*/
export interface FeedConfigConfigurationValues {
/**
* The feed Type
* @type {string}
* @memberof FeedConfigConfigurationValues
*/
feedType?: FeedConfigConfigurationValuesFeedTypeEnum;
/**
* Details of throttling configurations
* @type {Array<FeedConfigConfigurationThrottleConfigurations>}
* @memberof FeedConfigConfigurationValues
*/
throttleConfigurations?: Array<FeedConfigConfigurationThrottleConfigurations>;
}
/**
* @export
* @enum {string}
*/
export declare enum FeedConfigConfigurationValuesFeedTypeEnum {
Item = "item",
RetireItem = "RETIRE_ITEM",
MpItem = "MP_ITEM",
MpWfsItem = "MP_WFS_ITEM",
MpMaintenance = "MP_MAINTENANCE",
SkuTemplateMap = "SKU_TEMPLATE_MAP",
ShippingOverrides = "SHIPPING_OVERRIDES",
Price = "price",
CptSellerEligibility = "CPT_SELLER_ELIGIBILITY",
Promo = "promo",
ReturnsOverrides = "RETURNS_OVERRIDES",
Inventory = "inventory",
Lagtime = "lagtime"
}
/**
*
* @export
* @interface FeedThrottlingConfigValues
*/
export interface FeedThrottlingConfigValues {
/**
* List of feed throttling configurations
* @type {Array<FeedConfigConfigurationValues>}
* @memberof FeedThrottlingConfigValues
*/
values?: Array<FeedConfigConfigurationValues>;
}
/**
* List of feed throttling configurations
* @export
* @interface FeedThrottlingDTO
*/
export interface FeedThrottlingDTO {
/**
* The feed Type
* @type {string}
* @memberof FeedThrottlingDTO
*/
feedType?: FeedThrottlingDTOFeedTypeEnum;
/**
* Details of throttling configurations
* @type {Array<FeedConfigConfigurationThrottleConfigurations>}
* @memberof FeedThrottlingDTO
*/
throttleConfigurations?: Array<FeedConfigConfigurationThrottleConfigurations>;
}
/**
* @export
* @enum {string}
*/
export declare enum FeedThrottlingDTOFeedTypeEnum {
Item = "item",
RetireItem = "RETIRE_ITEM",
MpItem = "MP_ITEM",
MpWfsItem = "MP_WFS_ITEM",
MpMaintenance = "MP_MAINTENANCE",
SkuTemplateMap = "SKU_TEMPLATE_MAP",
ShippingOverrides = "SHIPPING_OVERRIDES",
Price = "price",
CptSellerEligibility = "CPT_SELLER_ELIGIBILITY",
Promo = "promo",
ReturnsOverrides = "RETURNS_OVERRIDES",
Inventory = "inventory",
Lagtime = "lagtime"
}
/**
* The maximum allowed size of the feed file
* @export
* @interface FileSize
*/
export interface FileSize {
/**
* The number representing file size
* @type {number}
* @memberof FileSize
*/
value?: number;
/**
* The unit of measurement. Example: \'BYTES\'
* @type {string}
* @memberof FileSize
*/
unitOfMeasurement?: FileSizeUnitOfMeasurementEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum FileSizeUnitOfMeasurementEnum {
Bytes = "BYTES"
}
/**
*
* @export
* @interface FulfillmentCenterCoverageDetail
*/
export interface FulfillmentCenterCoverageDetail {
/**
* The fulfillment center or ship node Id which uniquely identifies each facility and is autogenerated during the creation of fulfillment center. Every time a facility is added, a new ship node id is generated.
* @type {string}
* @memberof FulfillmentCenterCoverageDetail
*/
shipNode?: string;
/**
* Name of the fulfillment center.
* @type {string}
* @memberof FulfillmentCenterCoverageDetail
*/
shipNodeName?: string;
/**
* Two day shipping regions defined by Walmart for sellers.
* @type {Array<string>}
* @memberof FulfillmentCenterCoverageDetail
*/
coverageArea?: Array<string>;
}
/**
*
* @export
* @interface InlineObject
*/
export interface InlineObject {
/**
* Shipping Template Name
* @type {string}
* @memberof InlineObject
*/
name: string;
/**
* Shipping Template Type, should be CUSTOM or 3PL Specific
* @type {string}
* @memberof InlineObject
*/
type: InlineObjectTypeEnum;
/**
* This is the shipping model type. TIERED_PRICING: This model means that you charge shipping based on the price of the item PER_SHIPMENT_PRICING: This model means that you charge shipping based on the weight of your items (per pound), or you charge shipping based on the number of items purchased in an order
* @type {string}
* @memberof InlineObject
*/
rateModelType: InlineObjectRateModelTypeEnum;
/**
* Shipping Template Status, Can be ACTIVE or INACTIVE status
* @type {string}
* @memberof InlineObject
*/
status: InlineObjectStatusEnum;
/**
* Array of different ship methods of a Shipping Template
* @type {Array<InlineResponse200ShippingMethods>}
* @memberof InlineObject
*/
shippingMethods: Array<InlineResponse200ShippingMethods>;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineObjectTypeEnum {
Default = "DEFAULT",
Custom = "CUSTOM",
Deliverr = "DELIVERR"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineObjectRateModelTypeEnum {
TieredPricing = "TIERED_PRICING",
PerShipmentPricing = "PER_SHIPMENT_PRICING"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineObjectStatusEnum {
Active = "ACTIVE",
Inactive = "INACTIVE"
}
/**
*
* @export
* @interface InlineObject1
*/
export interface InlineObject1 {
/**
*
* @type {V3SettingsShippingShipnodesShipNodeHeader}
* @memberof InlineObject1
*/
shipNodeHeader?: V3SettingsShippingShipnodesShipNodeHeader;
/**
*
* @type {V3SettingsShippingShipnodesShipNode}
* @memberof InlineObject1
*/
shipNode?: V3SettingsShippingShipnodesShipNode;
}
/**
*
* @export
* @interface InlineObject2
*/
export interface InlineObject2 {
/**
*
* @type {V3SettingsShippingShipnodesShipNodeHeader}
* @memberof InlineObject2
*/
shipNodeHeader?: V3SettingsShippingShipnodesShipNodeHeader;
/**
*
* @type {Array<V3SettingsShippingShipnodesShipNode1>}
* @memberof InlineObject2
*/
shipNode?: Array<V3SettingsShippingShipnodesShipNode1>;
}
/**
*
* @export
* @interface InlineObject3
*/
export interface InlineObject3 {
/**
* Shipping Template Name
* @type {string}
* @memberof InlineObject3
*/
name?: string;
/**
* Shipping Template Type, should be CUSTOM or 3PL Specific
* @type {string}
* @memberof InlineObject3
*/
type?: string;
/**
* This is the shipping model type. TIERED_PRICING: This model means that you charge shipping based on the price of the item PER_SHIPMENT_PRICING: This model means that you charge shipping based on the weight of your items (per pound), or you charge shipping based on the number of items purchased in an order
* @type {string}
* @memberof InlineObject3
*/
rateModelType?: string;
/**
* Shipping Template Status, Can be ACTIVE or INACTIVE status
* @type {string}
* @memberof InlineObject3
*/
status?: string;
/**
* Array of different ship methods of a Shipping Template
* @type {Array<InlineResponse200ShippingMethods>}
* @memberof InlineObject3
*/
shippingMethods?: Array<InlineResponse200ShippingMethods>;
}
/**
*
* @export
* @interface InlineObject4
*/
export interface InlineObject4 {
/**
* Fulfillment Center Name
* @type {string}
* @memberof InlineObject4
*/
fulfillmentCenterName?: string;
/**
* Fulfillment Center Zipcode
* @type {string}
* @memberof InlineObject4
*/
fulfillmentCenterZipCode?: string;
/**
* Carrier Method Name. Supported carrier methods are: FEDEX_GROUND
* @type {string}
* @memberof InlineObject4
*/
carrierMethodName?: string;
}
/**
*
* @export
* @interface InlineObject5
*/
export interface InlineObject5 {
/**
*
* @type {V3SettingsShippingShipnodesShipNodeHeader}
* @memberof InlineObject5
*/
shipNodeHeader?: V3SettingsShippingShipnodesShipNodeHeader;
/**
*
* @type {Array<V3SettingsShipping3plshipnodesShipNode>}
* @memberof InlineObject5
*/
shipNode?: Array<V3SettingsShipping3plshipnodesShipNode>;
}
/**
*
* @export
* @interface InlineResponse200
*/
export interface InlineResponse200 {
/**
* Shipping Template ID
* @type {string}
* @memberof InlineResponse200
*/
id?: string;
/**
* Shipping Template Name
* @type {string}
* @memberof InlineResponse200
*/
name: string;
/**
* Shipping Template Type, should be CUSTOM or 3PL Specific
* @type {string}
* @memberof InlineResponse200
*/
type: InlineResponse200TypeEnum;
/**
* This is the shipping model type. TIERED_PRICING: This model means that you charge shipping based on the price of the item PER_SHIPMENT_PRICING: This model means that you charge shipping based on the weight of your items (per pound), or you charge shipping based on the number of items purchased in an order
* @type {string}
* @memberof InlineResponse200
*/
rateModelType: InlineResponse200RateModelTypeEnum;
/**
* Shipping Template Status, Can be ACTIVE or INACTIVE status
* @type {string}
* @memberof InlineResponse200
*/
status: InlineResponse200StatusEnum;
/**
* Array of different ship methods of a Shipping Template
* @type {Array<InlineResponse200ShippingMethods>}
* @memberof InlineResponse200
*/
shippingMethods: Array<InlineResponse200ShippingMethods>;
/**
*
* @type {string}
* @memberof InlineResponse200
*/
createdBy?: string;
/**
*
* @type {string}
* @memberof InlineResponse200
*/
modifiedBy?: string;
/**
*
* @type {number}
* @memberof InlineResponse200
*/
createdDate?: number;
/**
*
* @type {number}
* @memberof InlineResponse200
*/
modifiedDate?: number;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200TypeEnum {
Default = "DEFAULT",
Custom = "CUSTOM",
Deliverr = "DELIVERR"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200RateModelTypeEnum {
TieredPricing = "TIERED_PRICING",
PerShipmentPricing = "PER_SHIPMENT_PRICING"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200StatusEnum {
Active = "ACTIVE",
Inactive = "INACTIVE"
}
/**
*
* @export
* @interface InlineResponse2001
*/
export interface InlineResponse2001 {
/**
* Shipping Template ID
* @type {string}
* @memberof InlineResponse2001
*/
id?: string;
}
/**
*
* @export
* @interface InlineResponse20010
*/
export interface InlineResponse20010 {
/**
*
* @type {InlineResponse2005Partner}
* @memberof InlineResponse20010
*/
partner?: InlineResponse2005Partner;
/**
* List of seller configurations like Seller Account & feed throttling values
* @type {Array<object>}
* @memberof InlineResponse20010
*/
configurations?: Array<object>;
}
/**
*
* @export
* @interface InlineResponse2002
*/
export interface InlineResponse2002 {
/**
* The fulfillment center or ship node Id which uniquely identifies each facility and is autogenerated during the creation of fulfillment center. Every time a facility is added, a new ship node id is generated.
* @type {string}
* @memberof InlineResponse2002
*/
shipNode?: string;
/**
* Defines if the fulfillment center is virtual, seller owned or third party owned. Allowed values: PHYSICAL, VIRTUAL, 3PL.
* @type {string}
* @memberof InlineResponse2002
*/
nodeType?: string;
/**
* Name of the fulfillment center.
* @type {string}
* @memberof InlineResponse2002
*/
shipNodeName?: string;
/**
* Status of fulfillment center. Allowed values: ACTIVE, INACTIVE..
* @type {string}
* @memberof InlineResponse2002
*/
status?: string;
/**
* Time zone that the seller ships from.Allowed timezones are PST, EST, CST, MST.
* @type {string}
* @memberof InlineResponse2002
*/
timeZone?: string;
/**
* The services supported by the defined physical ship node . The allowed values: TWO_DAY_DELIVERY.
* @type {Array<string>}
* @memberof InlineResponse2002
*/
distributorSupportedServices?: Array<string>;
/**
* Custom node identifier provided by seller. Allowed values are alphanumeric | String
* @type {string}
* @memberof InlineResponse2002
*/
customNodeId?: string;
/**
*
* @type {V3SettingsShippingShipnodesPostalAddress}
* @memberof InlineResponse2002
*/
postalAddress?: V3SettingsShippingShipnodesPostalAddress;
/**
* Shipping Details.
* @type {Array<V3SettingsShippingShipnodesShippingDetails>}
* @memberof InlineResponse2002
*/
shippingDetails?: Array<V3SettingsShippingShipnodesShippingDetails>;
/**
*
* @type {V3SettingsShippingShipnodesCalendarDayConfiguration}
* @memberof InlineResponse2002
*/
calendarDayConfiguration?: V3SettingsShippingShipnodesCalendarDayConfiguration;
}
/**
*
* @export
* @interface InlineResponse2003
*/
export interface InlineResponse2003 {
/**
* The fulfillment center or ship node Id which uniquely identifies each facility and is autogenerated during the creation of fulfillment center. Every time a facility is added, a new ship node id is generated.
* @type {string}
* @memberof InlineResponse2003
*/
shipNode?: string;
/**
* Defines if the fulfillment center is virtual, seller owned or third party owned. Allowed values: PHYSICAL, VIRTUAL, 3PL.
* @type {string}
* @memberof InlineResponse2003
*/
nodeType?: string;
/**
* Name of the fulfillment center.
* @type {string}
* @memberof InlineResponse2003
*/
shipNodeName?: string;
/**
* Status of fulfillment center. Allowed values: ACTIVE, INACTIVE..
* @type {string}
* @memberof InlineResponse2003
*/
status?: string;
/**
* Time zone that the seller ships from.Allowed timezones are PST, EST, CST, MST.
* @type {string}
* @memberof InlineResponse2003
*/
timeZone?: string;
/**
* The services supported by the defined physical ship node . The allowed values: TWO_DAY_DELIVERY.
* @type {Array<string>}
* @memberof InlineResponse2003
*/
distributorSupportedServices?: Array<string>;
/**
* Custom node identifier provided by seller. Allowed values are alphanumeric | String
* @type {string}
* @memberof InlineResponse2003
*/
customNodeId?: string;
/**
*
* @type {V3SettingsShippingShipnodesPostalAddress}
* @memberof InlineResponse2003
*/
postalAddress?: V3SettingsShippingShipnodesPostalAddress;
/**
* Shipping Details.
* @type {Array<V3SettingsShippingShipnodesShippingDetails>}
* @memberof InlineResponse2003
*/
shippingDetails?: Array<V3SettingsShippingShipnodesShippingDetails>;
/**
*
* @type {V3SettingsShippingShipnodesCalendarDayConfiguration2}
* @memberof InlineResponse2003
*/
calendarDayConfiguration?: V3SettingsShippingShipnodesCalendarDayConfiguration2;
}
/**
*
* @export
* @interface InlineResponse2004
*/
export interface InlineResponse2004 {
/**
* Array of Shipping Templates
* @type {Array<InlineResponse2004ShippingTemplates>}
* @memberof InlineResponse2004
*/
shippingTemplates?: Array<InlineResponse2004ShippingTemplates>;
/**
* Total Number of records in the response of the API
* @type {number}
* @memberof InlineResponse2004
*/
totalRecords?: number;
}
/**
* Array of Shipping Templates
* @export
* @interface InlineResponse2004ShippingTemplates
*/
export interface InlineResponse2004ShippingTemplates {
/**
* Shipping Template ID
* @type {string}
* @memberof InlineResponse2004ShippingTemplates
*/
id?: string;
/**
* Shipping Template Name
* @type {string}
* @memberof InlineResponse2004ShippingTemplates
*/
name?: string;
/**
* Shipping Template Type
* @type {string}
* @memberof InlineResponse2004ShippingTemplates
*/
type?: InlineResponse2004ShippingTemplatesTypeEnum;
/**
* Shipping Template/ Configurations active or inactive status
* @type {string}
* @memberof InlineResponse2004ShippingTemplates
*/
status?: InlineResponse2004ShippingTemplatesStatusEnum;
/**
*
* @type {string}
* @memberof InlineResponse2004ShippingTemplates
*/
rateModelType?: InlineResponse2004ShippingTemplatesRateModelTypeEnum;
/**
*
* @type {string}
* @memberof InlineResponse2004ShippingTemplates
*/
createdBy?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004ShippingTemplates
*/
modifiedBy?: string;
/**
* Template Creation Date
* @type {number}
* @memberof InlineResponse2004ShippingTemplates
*/
createdDate?: number;
/**
* Template Modified Date
* @type {number}
* @memberof InlineResponse2004ShippingTemplates
*/
modifiedDate?: number;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2004ShippingTemplatesTypeEnum {
Default = "DEFAULT",
Custom = "CUSTOM",
Deliverr = "DELIVERR"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2004ShippingTemplatesStatusEnum {
Active = "ACTIVE",
Inactive = "INACTIVE"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2004ShippingTemplatesRateModelTypeEnum {
TieredPricing = "TIERED_PRICING",
PerShipmentPricing = "PER_SHIPMENT_PRICING"
}
/**
*
* @export
* @interface InlineResponse2005
*/
export interface InlineResponse2005 {
/**
*
* @type {InlineResponse2005Partner}
* @memberof InlineResponse2005
*/
partner?: InlineResponse2005Partner;
/**
* List of seller configurations like Lag Time
* @type {Array<object>}
* @memberof InlineResponse2005
*/
configurations?: Array<object>;
}
/**
* Details of partner
* @export
* @interface InlineResponse2005Partner
*/
export interface InlineResponse2005Partner {
/**
* The seller ID
* @type {string}
* @memberof InlineResponse2005Partner
*/
partnerId?: string;
/**
* The seller\'s legal name
* @type {string}
* @memberof InlineResponse2005Partner
*/
partnerName?: string;
/**
* The seller name shown on walmart.com
* @type {string}
* @memberof InlineResponse2005Partner
*/
partnerDisplayName?: string;
/**
* Partner/Seller ID for Walmart store URL
* @type {string}
* @memberof InlineResponse2005Partner
*/
partnerStoreId?: string;
}
/**
*
* @export
* @interface InlineResponse2006
*/
export interface InlineResponse2006 {
/**
* Shipping Template Activation Status, possible values can be NOT_ACTIVATED or ACTIVATED
* @type {string}
* @memberof InlineResponse2006
*/
activationStatus?: string;
/**
* Activation Date
* @type {number}
* @memberof InlineResponse2006
*/
createdDate?: number;
/**
* Activation Status Last Modified Date
* @type {number}
* @memberof InlineResponse2006
*/
modifiedDate?: number;
}
/**
*
* @export
* @interface InlineResponse2007
*/
export interface InlineResponse2007 {
/**
* The fulfillment center or ship node Id which uniquely identifies each facility and is autogenerated during the creation of fulfillment center. Every time a facility is added, a new ship node id is generated.
* @type {string}
* @memberof InlineResponse2007
*/
shipNode?: string;
/**
* Name of the fulfillment center.
* @type {string}
* @memberof InlineResponse2007
*/
shipNodeName?: string;
/**
* Two day shipping regions defined by Walmart for sellers.
* @type {Array<string>}
* @memberof InlineResponse2007
*/
coverageArea?: Array<string>;
}
/**
*
* @export
* @interface InlineResponse2008
*/
export interface InlineResponse2008 {
/**
* Carrier Id
* @type {string}
* @memberof InlineResponse2008
*/
carrierMethodId?: string;
/**
* Carrier Name
* @type {string}
* @memberof InlineResponse2008
*/
carrierMethodName?: string;
/**
* Shipping method. Allowed Value is GROUND.
* @type {string}
* @memberof InlineResponse2008
*/
carrierMethodType?: string;
/**
* A description for the method carrier.
* @type {string}
* @memberof InlineResponse2008
*/
carrierMethodDescription?: string;
}
/**
*
* @export
* @interface InlineResponse2009
*/
export interface InlineResponse2009 {
/**
* The fulfillment center or ship node Id which uniquely identifies each facility and is autogenerated during the creation of fulfillment center. Every time a facility is added, a new ship node id is generated.
* @type {string}
* @memberof InlineResponse2009
*/
shipNode?: string;
/**
* Name of the fulfillment center.
* @type {string}
* @memberof InlineResponse2009
*/
shipNodeName?: string;
}
/**
* Contains an array of Regions, an array of Address Type, Transit Time and Per shipping charge or array of Tired Shipping Charge
* @export
* @interface InlineResponse200Configurations
*/
export interface InlineResponse200Configurations {
/**
* Supported Regions includes 48 State Street, 48 State – Street Po Box/Street, AK and HI – Street etc
* @type {Array<InlineResponse200Regions>}
* @memberof InlineResponse200Configurations
*/
regions: Array<InlineResponse200Regions>;
/**
* Supported address types like PO_BOX STREET MILITARY
* @type {Array<string>}
* @memberof InlineResponse200Configurations
*/
addressTypes: Array<InlineResponse200ConfigurationsAddressTypesEnum>;
/**
* Time in transit
* @type {number}
* @memberof InlineResponse200Configurations
*/
transitTime: number;
/**
*
* @type {InlineResponse200PerShippingCharge}
* @memberof InlineResponse200Configurations
*/
perShippingCharge?: InlineResponse200PerShippingCharge;
/**
* Tiered Shipping Charges
* @type {Array<InlineResponse200TieredShippingCharges>}
* @memberof InlineResponse200Configurations
*/
tieredShippingCharges?: Array<InlineResponse200TieredShippingCharges>;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200ConfigurationsAddressTypesEnum {
PoBox = "PO_BOX",
Military = "MILITARY",
Street = "STREET"
}
/**
* Charge per shipping
* @export
* @interface InlineResponse200PerShippingCharge
*/
export interface InlineResponse200PerShippingCharge {
/**
* Unit of Measure eg. LB
* @type {string}
* @memberof InlineResponse200PerShippingCharge
*/
unitOfMeasure: string;
/**
*
* @type {InlineResponse200PerShippingChargeShippingAndHandling}
* @memberof InlineResponse200PerShippingCharge
*/
shippingAndHandling?: InlineResponse200PerShippingChargeShippingAndHandling;
/**
*
* @type {InlineResponse200PerShippingChargeChargePerWeight}
* @memberof InlineResponse200PerShippingCharge
*/
chargePerWeight?: InlineResponse200PerShippingChargeChargePerWeight;
/**
*
* @type {InlineResponse200PerShippingChargeChargePerItem}
* @memberof InlineResponse200PerShippingCharge
*/
chargePerItem?: InlineResponse200PerShippingChargeChargePerItem;
}
/**
* Per Weight Charge
* @export
* @interface InlineResponse200PerShippingChargeChargePerItem
*/
export interface InlineResponse200PerShippingChargeChargePerItem {
/**
* Charge Per Item, value USD
* @type {number}
* @memberof InlineResponse200PerShippingChargeChargePerItem
*/
amount: number;
/**
* Currency, eg. USD
* @type {string}
* @memberof InlineResponse200PerShippingChargeChargePerItem
*/
currency: string;
}
/**
* Per Item Charge
* @export
* @interface InlineResponse200PerShippingChargeChargePerWeight
*/
export interface InlineResponse200PerShippingChargeChargePerWeight {
/**
* Charge Per weight, value USD
* @type {number}
* @memberof InlineResponse200PerShippingChargeChargePerWeight
*/
amount: number;
/**
* Currency, eg. USD
* @type {string}
* @memberof InlineResponse200PerShippingChargeChargePerWeight
*/
currency: string;
}
/**
* Shipping and Handling Charge
* @export
* @interface InlineResponse200PerShippingChargeShippingAndHandling
*/
export interface InlineResponse200PerShippingChargeShippingAndHandling {
/**
* The numerical amount for that charge. Example: 9.99
* @type {number}
* @memberof InlineResponse200PerShippingChargeShippingAndHandling
*/
amount: number;
/**
* The type of currency for the charge. Example: USD for US Dollars
* @type {string}
* @memberof InlineResponse200PerShippingChargeShippingAndHandling
*/
currency: string;
}
/**
* Supported Regions includes 48 State Street, 48 State – Street Po Box/Street, AK and HI – Street etc
* @export
* @interface InlineResponse200Regions
*/
export interface InlineResponse200Regions {
/**
*
* @type {string}
* @memberof InlineResponse200Regions
*/
regionCode: string;
/**
*
* @type {string}
* @memberof InlineResponse200Regions
*/
regionName?: string;
/**
*
* @type {Array<InlineResponse200SubRegions>}
* @memberof InlineResponse200Regions
*/
subRegions?: Array<InlineResponse200SubRegions>;
}
/**
* Details of Shipping Charge
* @export
* @interface InlineResponse200ShipCharge
*/
export interface InlineResponse200ShipCharge {
/**
* Charge Per Item, value USD
* @type {number}
* @memberof InlineResponse200ShipCharge
*/
amount: number;
/**
* Currency, eg. USD
* @type {string}
* @memberof InlineResponse200ShipCharge
*/
currency: string;
}
/**
* Array of different ship methods of a Shipping Template
* @export
* @interface InlineResponse200ShippingMethods
*/
export interface InlineResponse200ShippingMethods {
/**
* | Attribute | Description | Data Type | | ---- | ----------------- | ------- | | VALUE | All Marketplace Sellers must offer Value shipping to Walmart.com customers for items that can\'t ship within expected transit times for standard shipping. | string | | STANDARD | You are required to offer standard shipping to Walmart.com customers. | string | | TWO_DAY | If approved for this option, you\'ll provide free 2-day shipping to customers and your items will be enabled with the TwoDay delivery tag. | string | | FREIGHT | Heavy items which takes 6,7,8,9,10 days. | string |
* @type {string}
* @memberof InlineResponse200ShippingMethods
*/
shipMethod: InlineResponse200ShippingMethodsShipMethodEnum;
/**
* Shipping Method Status, Can be ACTIVE or INACTIVE status
* @type {string}
* @memberof InlineResponse200ShippingMethods
*/
status: InlineResponse200ShippingMethodsStatusEnum;
/**
* Contains an array of Regions, an array of Address Type, Transit Time and Per shipping charge or array of Tired Shipping Charge
* @type {Array<InlineResponse200Configurations>}
* @memberof InlineResponse200ShippingMethods
*/
configurations: Array<InlineResponse200Configurations>;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200ShippingMethodsShipMethodEnum {
Value = "VALUE",
Standard = "STANDARD",
ThreeDay = "THREE_DAY",
TwoDay = "TWO_DAY",
Freight = "FREIGHT"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200ShippingMethodsStatusEnum {
Active = "ACTIVE",
Inactive = "INACTIVE"
}
/**
*
* @export
* @interface InlineResponse200StateSubregions
*/
export interface InlineResponse200StateSubregions {
/**
*
* @type {string}
* @memberof InlineResponse200StateSubregions
*/
stateSubregionCode: string;
/**
*
* @type {string}
* @memberof InlineResponse200StateSubregions
*/
stateSubregionName?: string;
}
/**
*
* @export
* @interface InlineResponse200States
*/
export interface InlineResponse200States {
/**
*
* @type {string}
* @memberof InlineResponse200States
*/
stateCode: string;
/**
*
* @type {string}
* @memberof InlineResponse200States
*/
stateName?: string;
/**
*
* @type {Array<InlineResponse200StateSubregions>}
* @memberof InlineResponse200States
*/
stateSubregions?: Array<InlineResponse200StateSubregions>;
}
/**
*
* @export
* @interface InlineResponse200SubRegions
*/
export interface InlineResponse200SubRegions {
/**
*
* @type {string}
* @memberof InlineResponse200SubRegions
*/
subRegionCode: string;
/**
*
* @type {string}
* @memberof InlineResponse200SubRegions
*/
subRegionName?: string;
/**
*
* @type {Array<InlineResponse200States>}
* @memberof InlineResponse200SubRegions
*/
states?: Array<InlineResponse200States>;
}
/**
* Tiered Shipping Charges
* @export
* @interface InlineResponse200TieredShippingCharges
*/
export interface InlineResponse200TieredShippingCharges {
/**
* Minimum Limit
* @type {number}
* @memberof InlineResponse200TieredShippingCharges
*/
minLimit: number;
/**
* Maximum Limit
* @type {number}
* @memberof InlineResponse200TieredShippingCharges
*/
maxLimit: number;
/**
*
* @type {InlineResponse200ShipCharge}
* @memberof InlineResponse200TieredShippingCharges
*/
shipCharge?: InlineResponse200ShipCharge;
}
/**
*
* @export
* @interface LagTimeConfig
*/
export interface LagTimeConfig {
/**
* Name of the configuration
* @type {string}
* @memberof LagTimeConfig
*/
configurationName?: LagTimeConfigConfigurationNameEnum;
/**
*
* @type {LagTimeConfigConfiguration}
* @memberof LagTimeConfig
*/
configuration?: LagTimeConfigConfiguration;
}
/**
* @export
* @enum {string}
*/
export declare enum LagTimeConfigConfigurationNameEnum {
LagTime = "LAG_TIME"
}
/**
*
* @export
* @interface LagTimeConfigConfiguration
*/
export interface LagTimeConfigConfiguration {
/**
* List of item setup category level lag time exceptions configured for seller
* @type {Array<CategoriesLagTimeDTOCategories>}
* @memberof LagTimeConfigConfiguration
*/
categories?: Array<CategoriesLagTimeDTOCategories>;
}
/**
* List of seller configurations like Seller Account & feed throttling values
* @export
* @interface PartnerConfig
*/
export interface PartnerConfig {
/**
* Name of the configuration. Allowed value is FEED
* @type {string}
* @memberof PartnerConfig
*/
configurationName?: string;
/**