@whitebox-co/walmart-marketplace-api
Version:
A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API
2,146 lines • 165 kB
TypeScript
/**
* Item Management
* The Item Management APIs enable you to set up and manage items on Walmart.com. Once you have completed Registration and have access to your Consumer ID and Private Key, you can get started with the integration process
*
* 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';
/**
* Item Associations like shippingTemplate, shipNode.
* @export
* @interface Association
*/
export interface Association {
/**
*
* @type {InlineResponse2001ShippingTemplate}
* @memberof Association
*/
shippingTemplate?: InlineResponse2001ShippingTemplate;
/**
* Name of the fulfillment center.
* @type {string}
* @memberof Association
*/
shipNodeName?: string;
/**
* 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 Association
*/
shipNode?: string;
}
/**
*
* @export
* @interface CategoryPayload
*/
export interface CategoryPayload {
/**
* Type of item
* @type {string}
* @memberof CategoryPayload
*/
category?: string;
/**
* Specific kind of category
* @type {Array<InlineResponse2005Subcategory>}
* @memberof CategoryPayload
*/
subcategory?: Array<InlineResponse2005Subcategory>;
}
/**
*
* @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 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 Filter
*/
export interface Filter {
/**
* | Attribute | Description | Data Type | --- | ----------- | ------- | num_reviews | The reviewed times for Items | string | | customerRating | Customer rating | string | | lifecycleStatus | The lifecycle status of an item describes where the item listing is in the overall lifecycle | string | | publishedStatus | The published status of an item describes where the item is in the submission process | string | | unpublishedReasons | It outlines the reason for an item when unpublished | string | | inventoryStatus | It indicates whether the product is in stock or not | string | | price | Price of the Item | string | | fulfillmentType | Fulfillment information | string |
* @type {string}
* @memberof Filter
*/
field?: FilterFieldEnum;
/**
*
* @type {string}
* @memberof Filter
*/
op?: FilterOpEnum;
/**
*
* @type {Array<string>}
* @memberof Filter
*/
values?: Array<string>;
}
/**
* @export
* @enum {string}
*/
export declare enum FilterFieldEnum {
NumReviews = "num_reviews",
CustomerRating = "customerRating",
LifecycleStatus = "lifecycleStatus",
PublishedStatus = "publishedStatus",
UnpublishedReasons = "unpublishedReasons",
InventoryStatus = "inventoryStatus",
Price = "price",
FulfillmentType = "fulfillmentType"
}
/**
* @export
* @enum {string}
*/
export declare enum FilterOpEnum {
Equals = "equals",
Between = "between",
GreaterThan = "greater_than",
LessThan = "less_than"
}
/**
*
* @export
* @interface GatewayError
*/
export interface GatewayError {
/**
*
* @type {string}
* @memberof GatewayError
*/
code: string;
/**
*
* @type {string}
* @memberof GatewayError
*/
field?: string;
/**
*
* @type {string}
* @memberof GatewayError
*/
description?: string;
/**
*
* @type {string}
* @memberof GatewayError
*/
info?: string;
/**
*
* @type {string}
* @memberof GatewayError
*/
severity?: GatewayErrorSeverityEnum;
/**
*
* @type {string}
* @memberof GatewayError
*/
category?: GatewayErrorCategoryEnum;
/**
*
* @type {Array<InlineResponse2001Causes>}
* @memberof GatewayError
*/
causes?: Array<InlineResponse2001Causes>;
/**
*
* @type {{ [key: string]: object; }}
* @memberof GatewayError
*/
errorIdentifiers?: {
[key: string]: object;
};
/**
*
* @type {string}
* @memberof GatewayError
*/
component?: string;
/**
*
* @type {string}
* @memberof GatewayError
*/
type?: string;
/**
*
* @type {string}
* @memberof GatewayError
*/
serviceName?: string;
/**
*
* @type {string}
* @memberof GatewayError
*/
gatewayErrorCategory?: GatewayErrorGatewayErrorCategoryEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum GatewayErrorSeverityEnum {
Info = "INFO",
Warn = "WARN",
Error = "ERROR"
}
/**
* @export
* @enum {string}
*/
export declare enum GatewayErrorCategoryEnum {
Application = "APPLICATION",
System = "SYSTEM",
Request = "REQUEST",
Data = "DATA"
}
/**
* @export
* @enum {string}
*/
export declare enum GatewayErrorGatewayErrorCategoryEnum {
InternalDataError = "INTERNAL_DATA_ERROR",
ExternalDataError = "EXTERNAL_DATA_ERROR",
SystemError = "SYSTEM_ERROR"
}
/**
*
* @export
* @interface GenericAttributeValue
*/
export interface GenericAttributeValue {
/**
*
* @type {string}
* @memberof GenericAttributeValue
*/
value: string;
/**
*
* @type {string}
* @memberof GenericAttributeValue
*/
group?: string;
/**
*
* @type {string}
* @memberof GenericAttributeValue
*/
source?: string;
/**
*
* @type {number}
* @memberof GenericAttributeValue
*/
rank?: number;
/**
*
* @type {boolean}
* @memberof GenericAttributeValue
*/
isVariant?: boolean;
}
/**
* The list of variant attributes used to create the variant item
* @export
* @interface GroupingAttributes
*/
export interface GroupingAttributes {
/**
* Returns true if the item is a primary variant
* @type {string}
* @memberof GroupingAttributes
*/
name?: string;
/**
* The list of variant attributes used to create the variant item
* @type {string}
* @memberof GroupingAttributes
*/
value?: string;
}
/**
* Provides images associated with the item product listing.
* @export
* @interface Image
*/
export interface Image {
/**
*
* @type {string}
* @memberof Image
*/
url?: string;
}
/**
*
* @export
* @interface InlineObject
*/
export interface InlineObject {
/**
*
* @type {V3ItemsCatalogSearchQuery}
* @memberof InlineObject
*/
query?: V3ItemsCatalogSearchQuery;
/**
*
* @type {Array<V3ItemsCatalogSearchFilters>}
* @memberof InlineObject
*/
filters?: Array<V3ItemsCatalogSearchFilters>;
/**
*
* @type {V3ItemsCatalogSearchSort}
* @memberof InlineObject
*/
sort?: V3ItemsCatalogSearchSort;
}
/**
*
* @export
* @interface InlineObject1
*/
export interface InlineObject1 {
/**
* List of items whose associations need to be fetched. It should not have more than 50 items.
* @type {Array<V3ItemsAssociationsItems>}
* @memberof InlineObject1
*/
items: Array<V3ItemsAssociationsItems>;
}
/**
*
* @export
* @interface InlineResponse200
*/
export interface InlineResponse200 {
/**
* Response Status
* @type {string}
* @memberof InlineResponse200
*/
status?: string;
/**
* Items included in the response list
* @type {Array<InlineResponse200Payload>}
* @memberof InlineResponse200
*/
payload?: Array<InlineResponse200Payload>;
/**
* Total items for the query
* @type {number}
* @memberof InlineResponse200
*/
totalItems?: number;
/**
* Number of items shown in this page
* @type {number}
* @memberof InlineResponse200
*/
limit?: number;
/**
* Used for pagination to fetch the next set of items
* @type {string}
* @memberof InlineResponse200
*/
nextCursor?: string;
/**
*
* @type {string}
* @memberof InlineResponse200
*/
statuss?: string;
}
/**
*
* @export
* @interface InlineResponse2001
*/
export interface InlineResponse2001 {
/**
*
* @type {Array<InlineResponse2001Items>}
* @memberof InlineResponse2001
*/
items: Array<InlineResponse2001Items>;
}
/**
* Item Associations like shippingTemplate, shipNode.
* @export
* @interface InlineResponse2001Associations
*/
export interface InlineResponse2001Associations {
/**
*
* @type {InlineResponse2001ShippingTemplate}
* @memberof InlineResponse2001Associations
*/
shippingTemplate?: InlineResponse2001ShippingTemplate;
/**
* Name of the fulfillment center.
* @type {string}
* @memberof InlineResponse2001Associations
*/
shipNodeName?: string;
/**
* 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 InlineResponse2001Associations
*/
shipNode?: string;
}
/**
*
* @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"
}
/**
*
* @export
* @interface InlineResponse2001Items
*/
export interface InlineResponse2001Items {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InlineResponse2001Items
*/
sku: string;
/**
* Item Associations like shippingTemplate, shipNode.
* @type {Array<InlineResponse2001Associations>}
* @memberof InlineResponse2001Items
*/
associations?: Array<InlineResponse2001Associations>;
/**
*
* @type {Array<InlineResponse2001Errors>}
* @memberof InlineResponse2001Items
*/
errors?: Array<InlineResponse2001Errors>;
}
/**
* Information about Shipping Template
* @export
* @interface InlineResponse2001ShippingTemplate
*/
export interface InlineResponse2001ShippingTemplate {
/**
* Shipping Template Name
* @type {string}
* @memberof InlineResponse2001ShippingTemplate
*/
name?: string;
/**
* Shipping Template Type
* @type {string}
* @memberof InlineResponse2001ShippingTemplate
*/
type?: InlineResponse2001ShippingTemplateTypeEnum;
/**
* Shipping Template ID
* @type {string}
* @memberof InlineResponse2001ShippingTemplate
*/
id?: string;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2001ShippingTemplateTypeEnum {
Default = "DEFAULT",
Custom = "CUSTOM",
Deliverr = "DELIVERR"
}
/**
*
* @export
* @interface InlineResponse2002
*/
export interface InlineResponse2002 {
/**
* A unique ID, returned from the Bulk Upload API, used for tracking the feed file
* @type {string}
* @memberof InlineResponse2002
*/
feedId?: string;
/**
*
* @type {object}
* @memberof InlineResponse2002
*/
additionalAttributes?: object | null;
/**
*
* @type {object}
* @memberof InlineResponse2002
*/
errors?: object | null;
}
/**
*
* @export
* @interface InlineResponse2003
*/
export interface InlineResponse2003 {
/**
*
* @type {Array<InlineResponse2003Errors>}
* @memberof InlineResponse2003
*/
errors?: Array<InlineResponse2003Errors>;
/**
* Items included in the response list
* @type {Array<InlineResponse2003ItemResponse>}
* @memberof InlineResponse2003
*/
ItemResponse: Array<InlineResponse2003ItemResponse>;
/**
*
* @type {InlineResponse2003AdditionalAttributes}
* @memberof InlineResponse2003
*/
additionalAttributes?: InlineResponse2003AdditionalAttributes;
/**
* Total items for the query
* @type {number}
* @memberof InlineResponse2003
*/
totalItems?: number;
/**
* Used for pagination to fetch the next set of items
* @type {string}
* @memberof InlineResponse2003
*/
nextCursor?: string;
}
/**
* Bag of additional attributes
* @export
* @interface InlineResponse2003AdditionalAttributes
*/
export interface InlineResponse2003AdditionalAttributes {
/**
*
* @type {Array<InlineResponse2003AdditionalAttributesNameValueAttribute>}
* @memberof InlineResponse2003AdditionalAttributes
*/
nameValueAttribute?: Array<InlineResponse2003AdditionalAttributesNameValueAttribute>;
}
/**
*
* @export
* @interface InlineResponse2003AdditionalAttributesNameValueAttribute
*/
export interface InlineResponse2003AdditionalAttributesNameValueAttribute {
/**
*
* @type {string}
* @memberof InlineResponse2003AdditionalAttributesNameValueAttribute
*/
name: string;
/**
*
* @type {string}
* @memberof InlineResponse2003AdditionalAttributesNameValueAttribute
*/
type: InlineResponse2003AdditionalAttributesNameValueAttributeTypeEnum;
/**
*
* @type {boolean}
* @memberof InlineResponse2003AdditionalAttributesNameValueAttribute
*/
isVariant?: boolean;
/**
*
* @type {string}
* @memberof InlineResponse2003AdditionalAttributesNameValueAttribute
*/
variantResourceType?: string;
/**
*
* @type {Array<InlineResponse2003AdditionalAttributesValue>}
* @memberof InlineResponse2003AdditionalAttributesNameValueAttribute
*/
value: Array<InlineResponse2003AdditionalAttributesValue>;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2003AdditionalAttributesNameValueAttributeTypeEnum {
LocalizableText = "LOCALIZABLE_TEXT",
String = "STRING",
Boolean = "BOOLEAN",
Integer = "INTEGER",
Decimal = "DECIMAL",
Date = "DATE",
Timestamp = "TIMESTAMP"
}
/**
*
* @export
* @interface InlineResponse2003AdditionalAttributesValue
*/
export interface InlineResponse2003AdditionalAttributesValue {
/**
*
* @type {string}
* @memberof InlineResponse2003AdditionalAttributesValue
*/
value: string;
/**
*
* @type {string}
* @memberof InlineResponse2003AdditionalAttributesValue
*/
group?: string;
/**
*
* @type {string}
* @memberof InlineResponse2003AdditionalAttributesValue
*/
source?: string;
/**
*
* @type {number}
* @memberof InlineResponse2003AdditionalAttributesValue
*/
rank?: number;
/**
*
* @type {boolean}
* @memberof InlineResponse2003AdditionalAttributesValue
*/
isVariant?: boolean;
}
/**
*
* @export
* @interface InlineResponse2003Errors
*/
export interface InlineResponse2003Errors {
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
code: string;
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
field?: string;
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
description?: string;
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
info?: string;
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
severity?: InlineResponse2003ErrorsSeverityEnum;
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
category?: InlineResponse2003ErrorsCategoryEnum;
/**
*
* @type {Array<InlineResponse2001Causes>}
* @memberof InlineResponse2003Errors
*/
causes?: Array<InlineResponse2001Causes>;
/**
*
* @type {{ [key: string]: object; }}
* @memberof InlineResponse2003Errors
*/
errorIdentifiers?: {
[key: string]: object;
};
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
component?: string;
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
type?: string;
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
serviceName?: string;
/**
*
* @type {string}
* @memberof InlineResponse2003Errors
*/
gatewayErrorCategory?: InlineResponse2003ErrorsGatewayErrorCategoryEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2003ErrorsSeverityEnum {
Info = "INFO",
Warn = "WARN",
Error = "ERROR"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2003ErrorsCategoryEnum {
Application = "APPLICATION",
System = "SYSTEM",
Request = "REQUEST",
Data = "DATA"
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2003ErrorsGatewayErrorCategoryEnum {
InternalDataError = "INTERNAL_DATA_ERROR",
ExternalDataError = "EXTERNAL_DATA_ERROR",
SystemError = "SYSTEM_ERROR"
}
/**
*
* @export
* @interface InlineResponse2003ItemResponse
*/
export interface InlineResponse2003ItemResponse {
/**
* The marketplace name. Example: Walmart_US
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
mart?: InlineResponse2003ItemResponseMartEnum;
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
sku: string;
/**
* The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
wpid?: string;
/**
* The 12-digit bar code used extensively for retail packaging in the United States
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
upc?: string;
/**
* The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
gtin?: string;
/**
* A seller-specified, alphanumeric string uniquely identifying the product name. Example: \'Sterling Silver Blue Diamond Heart Pendant with 18in Chain\'
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
productName?: string;
/**
* Walmart assigned an item shelf name
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
shelf?: string;
/**
* A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: \'Diamond\'
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
productType?: string;
/**
*
* @type {InlineResponse2003Price}
* @memberof InlineResponse2003ItemResponse
*/
price?: InlineResponse2003Price;
/**
* The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
publishedStatus?: string;
/**
*
* @type {InlineResponse2003AdditionalAttributes}
* @memberof InlineResponse2003ItemResponse
*/
additionalAttributes?: InlineResponse2003AdditionalAttributes;
/**
*
* @type {InlineResponse2003UnpublishedReasons}
* @memberof InlineResponse2003ItemResponse
*/
unpublishedReasons?: InlineResponse2003UnpublishedReasons;
/**
* The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
lifecycleStatus?: string;
/**
* Variant Id if the item is of type Variant
* @type {string}
* @memberof InlineResponse2003ItemResponse
*/
variantGroupId?: string;
/**
*
* @type {InlineResponse200VariantGroupInfo}
* @memberof InlineResponse2003ItemResponse
*/
variantGroupInfo?: InlineResponse200VariantGroupInfo;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2003ItemResponseMartEnum {
WalmartUs = "WALMART_US",
WalmartCa = "WALMART_CA",
AsdaGm = "ASDA_GM",
WalmartMexico = "WALMART_MEXICO"
}
/**
* Specifies item purchase price information, including currency and amount.
* @export
* @interface InlineResponse2003Price
*/
export interface InlineResponse2003Price {
/**
* The currency type. Example: USD for US Dollars
* @type {string}
* @memberof InlineResponse2003Price
*/
currency?: InlineResponse2003PriceCurrencyEnum;
/**
* The numerical amount of the price. Example: 9.99
* @type {number}
* @memberof InlineResponse2003Price
*/
amount?: number;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse2003PriceCurrencyEnum {
Aed = "AED",
Afn = "AFN",
All = "ALL",
Amd = "AMD",
Ang = "ANG",
Aoa = "AOA",
Ars = "ARS",
Aud = "AUD",
Awg = "AWG",
Azn = "AZN",
Bam = "BAM",
Bbd = "BBD",
Bdt = "BDT",
Bgn = "BGN",
Bhd = "BHD",
Bif = "BIF",
Bmd = "BMD",
Bnd = "BND",
Bob = "BOB",
Brl = "BRL",
Bsd = "BSD",
Btn = "BTN",
Bwp = "BWP",
Byr = "BYR",
Bzd = "BZD",
Cad = "CAD",
Cdf = "CDF",
Chf = "CHF",
Clp = "CLP",
Cny = "CNY",
Cop = "COP",
Crc = "CRC",
Cup = "CUP",
Cve = "CVE",
Czk = "CZK",
Djf = "DJF",
Dkk = "DKK",
Dop = "DOP",
Dzd = "DZD",
Egp = "EGP",
Ern = "ERN",
Etb = "ETB",
Eur = "EUR",
Fjd = "FJD",
Fkp = "FKP",
Gbp = "GBP",
Gel = "GEL",
Ghs = "GHS",
Gip = "GIP",
Gmd = "GMD",
Gnf = "GNF",
Gtq = "GTQ",
Gyd = "GYD",
Hkd = "HKD",
Hnl = "HNL",
Hrk = "HRK",
Htg = "HTG",
Huf = "HUF",
Idr = "IDR",
Ils = "ILS",
Inr = "INR",
Iqd = "IQD",
Irr = "IRR",
Isk = "ISK",
Jmd = "JMD",
Jod = "JOD",
Jpy = "JPY",
Kes = "KES",
Kgs = "KGS",
Khr = "KHR",
Kmf = "KMF",
Kpw = "KPW",
Krw = "KRW",
Kwd = "KWD",
Kyd = "KYD",
Kzt = "KZT",
Lak = "LAK",
Lbp = "LBP",
Lkr = "LKR",
Lrd = "LRD",
Lsl = "LSL",
Ltl = "LTL",
Lvl = "LVL",
Lyd = "LYD",
Mad = "MAD",
Mdl = "MDL",
Mga = "MGA",
Mkd = "MKD",
Mmk = "MMK",
Mnt = "MNT",
Mop = "MOP",
Mro = "MRO",
Mur = "MUR",
Mvr = "MVR",
Mwk = "MWK",
Mxn = "MXN",
Myr = "MYR",
Mzn = "MZN",
Nad = "NAD",
Ngn = "NGN",
Nio = "NIO",
Nok = "NOK",
Npr = "NPR",
Nzd = "NZD",
Omr = "OMR",
Pab = "PAB",
Pen = "PEN",
Pgk = "PGK",
Php = "PHP",
Pkr = "PKR",
Pln = "PLN",
Pyg = "PYG",
Qar = "QAR",
Ron = "RON",
Rsd = "RSD",
Rub = "RUB",
Rur = "RUR",
Rwf = "RWF",
Sar = "SAR",
Sbd = "SBD",
Scr = "SCR",
Sdg = "SDG",
Sek = "SEK",
Sgd = "SGD",
Shp = "SHP",
Sll = "SLL",
Sos = "SOS",
Srd = "SRD",
Std = "STD",
Syp = "SYP",
Szl = "SZL",
Thb = "THB",
Tjs = "TJS",
Tmt = "TMT",
Tnd = "TND",
Top = "TOP",
Try = "TRY",
Ttd = "TTD",
Twd = "TWD",
Tzs = "TZS",
Uah = "UAH",
Ugx = "UGX",
Usd = "USD",
Uyu = "UYU",
Uzs = "UZS",
Vef = "VEF",
Vnd = "VND",
Vuv = "VUV",
Wst = "WST",
Xaf = "XAF",
Xag = "XAG",
Xau = "XAU",
Xba = "XBA",
Xbb = "XBB",
Xbc = "XBC",
Xbd = "XBD",
Xcd = "XCD",
Xdr = "XDR",
Xfu = "XFU",
Xof = "XOF",
Xpd = "XPD",
Xpf = "XPF",
Xpt = "XPT",
Xts = "XTS",
Xxx = "XXX",
Yer = "YER",
Zar = "ZAR",
Zmk = "ZMK",
Zwl = "ZWL"
}
/**
* It outlines the reason for an item when unpublished ,that is, when \'publishedStatus\' is set to \'UNPUBLISHED\'.
* @export
* @interface InlineResponse2003UnpublishedReasons
*/
export interface InlineResponse2003UnpublishedReasons {
/**
*
* @type {Array<string>}
* @memberof InlineResponse2003UnpublishedReasons
*/
reason?: Array<string>;
}
/**
*
* @export
* @interface InlineResponse2004
*/
export interface InlineResponse2004 {
/**
* Suggested queries to narrow down search results.
* @type {Array<InlineResponse2004RelatedQueries>}
* @memberof InlineResponse2004
*/
relatedQueries?: Array<InlineResponse2004RelatedQueries>;
/**
*
* @type {Array<InlineResponse2004Items>}
* @memberof InlineResponse2004
*/
items?: Array<InlineResponse2004Items>;
}
/**
* Provides images associated with the item product listing.
* @export
* @interface InlineResponse2004Images
*/
export interface InlineResponse2004Images {
/**
*
* @type {string}
* @memberof InlineResponse2004Images
*/
url?: string;
}
/**
*
* @export
* @interface InlineResponse2004Items
*/
export interface InlineResponse2004Items {
/**
* Specifies the item identifier generated by Walmart.
* @type {string}
* @memberof InlineResponse2004Items
*/
itemId?: string;
/**
* Specifies whether or not this item is available by other sellers in the Marketplace.
* @type {boolean}
* @memberof InlineResponse2004Items
*/
isMarketPlaceItem?: boolean;
/**
* Provides images associated with the item product listing.
* @type {Array<InlineResponse2004Images>}
* @memberof InlineResponse2004Items
*/
images?: Array<InlineResponse2004Images>;
/**
*
* @type {string}
* @memberof InlineResponse2004Items
*/
customerRating?: string;
/**
* Specifies whether or not the item is eligible for free shipping.
* @type {boolean}
* @memberof InlineResponse2004Items
*/
freeShipping?: boolean;
/**
* Specifies the number of active offers on the item.
* @type {number}
* @memberof InlineResponse2004Items
*/
offerCount?: number;
/**
*
* @type {InlineResponse2004Price}
* @memberof InlineResponse2004Items
*/
price?: InlineResponse2004Price;
/**
* Specifies the catalog item description.
* @type {string}
* @memberof InlineResponse2004Items
*/
description?: string;
/**
* Provides the seller-specified alphanumeric string that uniquely identifies the product name. Example: \'Sterling Silver Blue Diamond Heart Pendant with 18in Chain\'.
* @type {string}
* @memberof InlineResponse2004Items
*/
title?: string;
/**
* Specifies the item brand.
* @type {string}
* @memberof InlineResponse2004Items
*/
brand?: string;
/**
* Provides the seller-specified alphanumeric string that uniquely identifies the Product Type. Example: \'Diamond\'.
* @type {string}
* @memberof InlineResponse2004Items
*/
productType?: string;
/**
*
* @type {InlineResponse2004Properties}
* @memberof InlineResponse2004Items
*/
properties?: InlineResponse2004Properties;
}
/**
* Specifies item purchase price information, including currency and amount.
* @export
* @interface InlineResponse2004Price
*/
export interface InlineResponse2004Price {
/**
*
* @type {string}
* @memberof InlineResponse2004Price
*/
amount?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004Price
*/
currency?: string;
}
/**
*
* @export
* @interface InlineResponse2004Properties
*/
export interface InlineResponse2004Properties {
/**
*
* @type {string}
* @memberof InlineResponse2004Properties
*/
variant_items_num?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004Properties
*/
num_reviews?: string;
/**
*
* @type {Array<string>}
* @memberof InlineResponse2004Properties
*/
categories?: Array<string>;
/**
*
* @type {InlineResponse2004PropertiesVariants}
* @memberof InlineResponse2004Properties
*/
variants?: InlineResponse2004PropertiesVariants;
/**
*
* @type {boolean}
* @memberof InlineResponse2004Properties
*/
next_day_eligible?: boolean;
}
/**
*
* @export
* @interface InlineResponse2004PropertiesVariants
*/
export interface InlineResponse2004PropertiesVariants {
/**
*
* @type {Array<InlineResponse2004PropertiesVariantsVariantMeta>}
* @memberof InlineResponse2004PropertiesVariants
*/
variantMeta?: Array<InlineResponse2004PropertiesVariantsVariantMeta>;
/**
*
* @type {Array<InlineResponse2004PropertiesVariantsVariantData>}
* @memberof InlineResponse2004PropertiesVariants
*/
variantData?: Array<InlineResponse2004PropertiesVariantsVariantData>;
}
/**
*
* @export
* @interface InlineResponse2004PropertiesVariantsVariantData
*/
export interface InlineResponse2004PropertiesVariantsVariantData {
/**
*
* @type {string}
* @memberof InlineResponse2004PropertiesVariantsVariantData
*/
productImageUrl?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004PropertiesVariantsVariantData
*/
itemId?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004PropertiesVariantsVariantData
*/
isAvailable?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004PropertiesVariantsVariantData
*/
title?: string;
/**
*
* @type {Array<InlineResponse2004PropertiesVariantsVariantValues>}
* @memberof InlineResponse2004PropertiesVariantsVariantData
*/
variantValues?: Array<InlineResponse2004PropertiesVariantsVariantValues>;
}
/**
*
* @export
* @interface InlineResponse2004PropertiesVariantsVariantMeta
*/
export interface InlineResponse2004PropertiesVariantsVariantMeta {
/**
*
* @type {string}
* @memberof InlineResponse2004PropertiesVariantsVariantMeta
*/
name?: string;
}
/**
*
* @export
* @interface InlineResponse2004PropertiesVariantsVariantValues
*/
export interface InlineResponse2004PropertiesVariantsVariantValues {
/**
*
* @type {string}
* @memberof InlineResponse2004PropertiesVariantsVariantValues
*/
name?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004PropertiesVariantsVariantValues
*/
value?: string;
}
/**
* Suggested queries to narrow down search results.
* @export
* @interface InlineResponse2004RelatedQueries
*/
export interface InlineResponse2004RelatedQueries {
/**
*
* @type {string}
* @memberof InlineResponse2004RelatedQueries
*/
suggested?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004RelatedQueries
*/
suggestedUrl?: string;
}
/**
*
* @export
* @interface InlineResponse2005
*/
export interface InlineResponse2005 {
/**
*
* @type {string}
* @memberof InlineResponse2005
*/
status?: string;
/**
*
* @type {Array<InlineResponse2005Payload>}
* @memberof InlineResponse2005
*/
payload?: Array<InlineResponse2005Payload>;
}
/**
*
* @export
* @interface InlineResponse2005Payload
*/
export interface InlineResponse2005Payload {
/**
* Type of item
* @type {string}
* @memberof InlineResponse2005Payload
*/
category?: string;
/**
* Specific kind of category
* @type {Array<InlineResponse2005Subcategory>}
* @memberof InlineResponse2005Payload
*/
subcategory?: Array<InlineResponse2005Subcategory>;
}
/**
* Specific kind of category
* @export
* @interface InlineResponse2005Subcategory
*/
export interface InlineResponse2005Subcategory {
/**
* Name of specific kind of category
* @type {string}
* @memberof InlineResponse2005Subcategory
*/
subCategoryName?: string;
/**
* ID of specific kind of category
* @type {string}
* @memberof InlineResponse2005Subcategory
*/
subCategoryId?: string;
}
/**
*
* @export
* @interface InlineResponse2006
*/
export interface InlineResponse2006 {
/**
* Response Status
* @type {string}
* @memberof InlineResponse2006
*/
status?: string;
/**
* Items included in the response list
* @type {Array<InlineResponse2006Payload>}
* @memberof InlineResponse2006
*/
payload?: Array<InlineResponse2006Payload>;
}
/**
* Items included in the response list
* @export
* @interface InlineResponse2006Payload
*/
export interface InlineResponse2006Payload {
/**
* variant group id used to create the groups
* @type {string}
* @memberof InlineResponse2006Payload
*/
variantGroupId?: string;
/**
* count of items having the same variant group id
* @type {string}
* @memberof InlineResponse2006Payload
*/
count?: string;
}
/**
*
* @export
* @interface InlineResponse2007
*/
export interface InlineResponse2007 {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InlineResponse2007
*/
sku: string;
/**
* Message confirming the deletion or retirement of an item from the Walmart Catalog
* @type {string}
* @memberof InlineResponse2007
*/
message?: string;
}
/**
* Items included in the response list
* @export
* @interface InlineResponse200Payload
*/
export interface InlineResponse200Payload {
/**
* The marketplace name. Example: Walmart_US
* @type {string}
* @memberof InlineResponse200Payload
*/
mart?: InlineResponse200PayloadMartEnum;
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InlineResponse200Payload
*/
sku?: string;
/**
* The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
* @type {string}
* @memberof InlineResponse200Payload
*/
wpid?: string;
/**
* The 12-digit bar code used extensively for retail packaging in the United States
* @type {string}
* @memberof InlineResponse200Payload
*/
upc?: string;
/**
* International Standard Book Number
* @type {string}
* @memberof InlineResponse200Payload
*/
isbn?: string;
/**
* Product ID, EANs must be 13 digits in length.
* @type {string}
* @memberof InlineResponse200Payload
*/
ean?: string;
/**
* The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
* @type {string}
* @memberof InlineResponse200Payload
*/
gtin?: string;
/**
* A unique Id which identifies the item.
* @type {string}
* @memberof InlineResponse200Payload
*/
itemId?: string;
/**
* A seller-specified, alphanumeric string uniquely identifying the product name. Example: \'Sterling Silver Blue Diamond Heart Pendant with 18in Chain\'
* @type {string}
* @memberof InlineResponse200Payload
*/
productName?: string;
/**
* Walmart assigned an item shelf name
* @type {string}
* @memberof InlineResponse200Payload
*/
shelf?: string;
/**
* A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: \'Diamond\'
* @type {string}
* @memberof InlineResponse200Payload
*/
productType?: string;
/**
*
* @type {InlineResponse200Price}
* @memberof InlineResponse200Payload
*/
price?: InlineResponse200Price;
/**
* Brand of Item.
* @type {string}
* @memberof InlineResponse200Payload
*/
brand?: string;
/**
* The reviewed times for Items.
* @type {string}
* @memberof InlineResponse200Payload
*/
num_reviews?: string;
/**
* Customer rating.
* @type {string}
* @memberof InlineResponse200Payload
*/
customerRating?: string;
/**
* manufacturer of Item.
* @type {string}
* @memberof InlineResponse200Payload
*/
manufacturer?: string;
/**
* Fulfillment information.
* @type {string}
* @memberof InlineResponse200Payload
*/
fulfillmentType?: string;
/**
*
* @type {InlineResponse200PublishedStatus}
* @memberof InlineResponse200Payload
*/
publishedStatus?: InlineResponse200PublishedStatus;
/**
* It indicates whether the product is in stock or not.
* @type {string}
* @memberof InlineResponse200Payload
*/
inventoryStatus?: string;
/**
* The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
* @type {string}
* @memberof InlineResponse200Payload
*/
lifecycleStatus?: string;
/**
*
* @type {string}
* @memberof InlineResponse200Payload
*/
shop_ref?: string;
/**
*
* @type {string}
* @memberof InlineResponse200Payload
*/
shop_product_id?: string;
/**
*
* @type {string}
* @memberof InlineResponse200Payload
*/
shop_variant_id?: string;
/**
* Variant Id if the item is of type Variant
* @type {string}
* @memberof InlineResponse200Payload
*/
variantGroupId?: string;
/**
*
* @type {InlineResponse200VariantGroupInfo}
* @memberof InlineResponse200Payload
*/
variantGroupInfo?: InlineResponse200VariantGroupInfo;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200PayloadMartEnum {
WalmartUs = "WALMART_US",
WalmartCa = "WALMART_CA",
AsdaGm = "ASDA_GM",
WalmartMexico = "WALMART_MEXICO"
}
/**
* Specifies item purchase price information, including currency and amount.
* @export
* @interface InlineResponse200Price
*/
export interface InlineResponse200Price {
/**
* The currency type. Example: USD for US Dollars
* @type {string}
* @memberof InlineResponse200Price
*/
unit?: InlineResponse200PriceUnitEnum;
/**
* The numerical amount of the price. Example: 9.99
* @type {number}
* @memberof InlineResponse200Price
*/
amount?: number;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200PriceUnitEnum {
Aed = "AED",
Afn = "AFN",
All = "ALL",
Amd = "AMD",
Ang = "ANG",
Aoa = "AOA",
Ars = "ARS",
Aud = "AUD",
Awg = "AWG",
Azn = "AZN",
Bam = "BAM",
Bbd = "BBD",
Bdt = "BDT",
Bgn = "BGN",
Bhd = "BHD",
Bif = "BIF",
Bmd = "BMD",
Bnd = "BND",
Bob = "BOB",
Brl = "BRL",
Bsd = "BSD",
Btn = "BTN",
Bwp = "BWP",
Byr = "BYR",
Bzd = "BZD",
Cad = "CAD",
Cdf = "CDF",
Chf = "CHF",
Clp = "CLP",
Cny = "CNY",
Cop = "COP",
Crc = "CRC",
Cup = "CUP",
Cve = "CVE",
Czk = "CZK",
Djf = "DJF",
Dkk = "DKK",
Dop = "DOP",
Dzd = "DZD",
Egp = "EGP",
Ern = "ERN",
Etb = "ETB",
Eur = "EUR",
Fjd = "FJD",
Fkp = "FKP",
Gbp = "GBP",
Gel = "GEL",
Ghs = "GHS",
Gip = "GIP",
Gmd = "GMD",
Gnf = "GNF",
Gtq = "GTQ",
Gyd = "GYD",
Hkd = "HKD",
Hnl = "HNL",
Hrk = "HRK",
Htg = "HTG",
Huf = "HUF",
Idr = "IDR",
Ils = "ILS",
Inr = "INR",
Iqd = "IQD",
Irr = "IRR",
Isk = "ISK",
Jmd = "JMD",
Jod = "JOD",
Jpy = "JPY",
Kes = "KES",
Kgs = "KGS",
Khr = "KHR",
Kmf = "KMF",
Kpw = "KPW",
Krw = "KRW",
Kwd = "KWD",
Kyd = "KYD",
Kzt = "KZT",
Lak = "LAK",
Lbp = "LBP",
Lkr = "LKR",
Lrd = "LRD",
Lsl = "LSL",
Ltl = "LTL",
Lvl = "LVL",
Lyd = "LYD",
Mad = "MAD",
Mdl = "MDL",
Mga = "MGA",
Mkd = "MKD",
Mmk = "MMK",
Mnt = "MNT",
Mop = "MOP",
Mro = "MRO",
Mur = "MUR",
Mvr = "MVR",
Mwk = "MWK",
Mxn = "MXN",
Myr = "MYR",
Mzn = "MZN",
Nad = "NAD",
Ngn = "NGN",
Nio = "NIO",
Nok = "NOK",
Npr = "NPR",
Nzd = "NZD",
Omr = "OMR",
Pab = "PAB",
Pen = "PEN",
Pgk = "PGK",
Php = "PHP",
Pkr = "PKR",
Pln = "PLN",
Pyg = "PYG",
Qar = "QAR",
Ron = "RON",
Rsd = "RSD",
Rub = "RUB",
Rur = "RUR",
Rwf = "RWF",
Sar = "SAR",
Sbd = "SBD",
Scr = "SCR",
Sdg = "SDG",
Sek = "SEK",
Sgd = "SGD",
Shp = "SHP",
Sll = "SLL",
Sos = "SOS",
Srd = "SRD",
Std = "STD",
Syp = "SYP",
Szl = "SZL",
Thb = "THB",
Tjs = "TJS",
Tmt = "TMT",
Tnd = "TND",
Top = "TOP",
Try = "TRY",
Ttd = "TTD",
Twd = "TWD",
Tzs = "TZS",
Uah = "UAH",
Ugx = "UGX",
Usd = "USD",
Uyu = "UYU",
Uzs = "UZS",
Vef = "VEF",
Vnd = "VND",
Vuv = "VUV",
Wst = "WST",
Xaf = "XAF",
Xag = "XAG",
Xau = "XAU",
Xba = "XBA",
Xbb = "XBB",
Xbc = "XBC",
Xbd = "XBD",
Xcd = "XCD",
Xdr = "XDR",
Xfu = "XFU",
Xof = "XOF",
Xpd = "XPD",
Xpf = "XPF",
Xpt = "XPT",
Xts = "XTS",
Xxx = "XXX",
Yer = "YER",
Zar = "ZAR",
Zmk = "ZMK",
Zwl = "ZWL"
}
/**
* The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.
* @export
* @interface InlineResponse200PublishedStatus
*/
export interface InlineResponse200PublishedStatus {
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof InlineResponse200PublishedStatus
*/
status?: string;
/**
* The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
* @type {Array<string>}
* @memberof InlineResponse200PublishedStatus
*/
reasons?: Array<string>;
}
/**
* Additional variant group information if the item is of type Variant
* @export
* @interface InlineResponse200VariantGroupInfo
*/
export interface InlineResponse200VariantGroupInfo {
/**
* Returns true if the item is a primary variant
* @type {boolean}
* @memberof InlineResponse200VariantGroupInfo
*/
isPrimary?: boolean;
/**
*
* @type {InlineResponse200VariantGroupInfoGroupingAttributes}
* @memberof InlineResponse200VariantGroupInfo
*/
groupingAttributes?: InlineResponse200VariantGroupInfoGroupingAttributes;
/**
*
* @type {boolean}
* @memberof InlineResponse200VariantGroupInfo
*/
primary?: boolean;
}
/**
* The list of variant attributes used to create the variant item
* @export
* @interface InlineResponse200VariantGroupInfoGroupingAttributes
*/
export interface InlineResponse200VariantGroupInfoGroupingAttributes {
/**
* Returns true if the item is a primary variant
* @type {string}
* @memberof InlineResponse200VariantGroupInfoGroupingAttributes
*/
name?: string;
/**
* The list of variant attributes used to create the variant item
* @type {string}
* @memberof InlineResponse200VariantGroupInfoGroupingAttributes
*/
value?: string;
}
/**
*
* @export
* @interface Item
*/
export interface Item {
/**
* Specifies the item identifier generated by Walmart.
* @type {string}
* @memberof Item
*/
itemId?: string;
/**
* Specifies whether or not this item is available by other sellers in the Marketplace.
* @type {boolean}
* @memberof Item
*/
isMarketPlaceItem?: boolean;
/**
* Provides images associated with the item product listing.
* @type {Array<InlineResponse2004Images>}
* @memberof Item
*/
images?: Array<InlineResponse2004Images>;
/**
*
* @type {string}
* @memberof Item
*/
customerRating?: string;
/**
* Specifies whether or not the item is eligible for free shipping.
* @type {boolean}
* @memberof Item
*/
freeShipping?: boolean;
/**
* Specifies the number of active offers on the item.
* @type {number}
* @memberof Item
*/
offerCount?: number;
/**
*
* @type {InlineResponse2004Price}
* @memberof Item
*/
price?: InlineResponse2004Price;
/**
* Specifies the catalog item description.
* @type {string}
* @memberof Item
*/
description?: string;
/**
* Provides the seller-specified alphanumeric string that uniquely identifies the product name. Example: \'Sterling Silver Blue Diamond Heart Pendant with 18in Chain\'.
* @type {string}
* @memberof Item
*/
title?: string;
/**
* Specifies the item brand.
* @type {string}
* @memberof Item
*/
brand?: string;
/**
* Provides the seller-specified alphanumeric string that uniquely identifies the Product Type. Example: \'Diamond\'.
* @type {string}
* @memberof Item
*/
productType?: string;
/**
*
* @type {InlineResponse2004Properties}
* @memberof Item
*/
properties?: InlineResponse2004Properties;
}
/**
* Items included in the response list
* @export
* @interface ItemCatalogResponse
*/
export interface ItemCatalogResponse {
/**
* The marketplace name. Example: Walmart_US
* @type {string}
* @memberof ItemCatalogResponse
*/
mart?: ItemCatalogResponseMartEnum;
/**
* An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
* @type {string}
* @memberof ItemCatalogResponse
*/
sku?: string;
/**
* The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
* @type {string}
* @memberof ItemCatalogResponse
*/
wpid?: string;
/**
* The 12-digit bar code used extensively for retail packaging in the United States
* @type {string}
* @memberof ItemCatalogResponse
*/
upc?: string;
/**
* International Standard Book Number
* @type {string}
* @memberof ItemCatalogResponse
*/
isbn?: string;
/**
* Product ID, EANs must be 13 digits in length.
* @type {string}
* @memberof ItemCatalogResponse
*/
ean?: string;
/**
* The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits