UNPKG

@whitebox-co/walmart-marketplace-api

Version:

A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API

1,993 lines 179 kB
/** * Order Management * The Walmart Order Management APIs help Sellers to manage customer’s Sales Orders and to stay up-to-date on orders fulfillment, which orders to fulfill, and when to fulfill them. * * 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 AsnType */ export interface AsnType { /** * * @type {string} * @memberof AsnType */ packageASN: string; /** * * @type {string} * @memberof AsnType */ palletASN?: string; } /** * List of details about the cancellation status update * @export * @interface CancelLineStatusType */ export interface CancelLineStatusType { /** * Use \'Cancelled\' * @type {string} * @memberof CancelLineStatusType */ status: CancelLineStatusTypeStatusEnum; /** * Reason for cancellation. Example: \'CUSTOMER_REQUESTED_SELLER_TO_CANCEL\'. Cancellation reason should not be \"CUSTOMER_REQUESTED_SELLER_TO_CANCEL\" for non intent to cancel orders\' * @type {string} * @memberof CancelLineStatusType */ cancellationReason: CancelLineStatusTypeCancellationReasonEnum; /** * * @type {V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesStatusQuantity} * @memberof CancelLineStatusType */ statusQuantity: V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesStatusQuantity; } /** * @export * @enum {string} */ export declare enum CancelLineStatusTypeStatusEnum { Created = "Created", Acknowledged = "Acknowledged", Shipped = "Shipped", Delivered = "Delivered", Cancelled = "Cancelled", Refund = "Refund" } /** * @export * @enum {string} */ export declare enum CancelLineStatusTypeCancellationReasonEnum { CustomerRequestedSellerToCancel = "CUSTOMER_REQUESTED_SELLER_TO_CANCEL", SellerCancelPricingError = "SELLER_CANCEL_PRICING_ERROR", SellerCancelOutOfStock = "SELLER_CANCEL_OUT_OF_STOCK", SellerCancelFraudStopShipment = "SELLER_CANCEL_FRAUD_STOP_SHIPMENT", SellerCancelAddressNotServiceable = "SELLER_CANCEL_ADDRESS_NOT_SERVICEABLE" } /** * A list of statuses which should contain the new cancellation status * @export * @interface CancelLineStatusesType */ export interface CancelLineStatusesType { /** * List of details about the cancellation status update * @type {Array<V3OrdersPurchaseOrderIdCancelOrderCancellationOrderLinesOrderLineStatusesOrderLineStatus>} * @memberof CancelLineStatusesType */ orderLineStatus: Array<V3OrdersPurchaseOrderIdCancelOrderCancellationOrderLinesOrderLineStatusesOrderLineStatus>; } /** * Information to update the orderLine with cancellation details * @export * @interface CancelLineType */ export interface CancelLineType { /** * * @type {string} * @memberof CancelLineType */ lineNumber: string; /** * * @type {V3OrdersPurchaseOrderIdCancelOrderCancellationOrderLinesOrderLineStatuses} * @memberof CancelLineType */ orderLineStatuses: V3OrdersPurchaseOrderIdCancelOrderCancellationOrderLinesOrderLineStatuses; } /** * A list of orderLines to be cancelled * @export * @interface CancelLinesType */ export interface CancelLinesType { /** * Information to update the orderLine with cancellation details * @type {Array<V3OrdersPurchaseOrderIdCancelOrderCancellationOrderLinesOrderLine>} * @memberof CancelLinesType */ orderLine: Array<V3OrdersPurchaseOrderIdCancelOrderCancellationOrderLinesOrderLine>; } /** * Information about the package carrier(s) * @export * @interface CarrierNameType */ export interface CarrierNameType { /** * Other carrier name, When otherCarrier is used, trackingUrl must also be provided * @type {string} * @memberof CarrierNameType */ otherCarrier?: string; /** * The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO. * @type {string} * @memberof CarrierNameType */ carrier?: CarrierNameTypeCarrierEnum; } /** * @export * @enum {string} */ export declare enum CarrierNameTypeCarrierEnum { Ups = "UPS", Usps = "USPS", FedEx = "FedEx", Airborne = "Airborne", OnTrac = "OnTrac", DhlEcommerceUs = "DHL Ecommerce - US", Ls = "LS", Uds = "UDS", Upsmi = "UPSMI", Fdx = "FDX", Pilot = "PILOT", Estes = "ESTES", Saia = "SAIA", FdsExpress = "FDS Express", SekoWorldwide = "Seko Worldwide", HitDelivery = "HIT Delivery", Fedexsp = "FEDEXSP", RlCarriers = "RL Carriers", MetropolitanWarehouseDelivery = "Metropolitan Warehouse & Delivery", ChinaPost = "China Post", YunExpress = "YunExpress", YellowFreightSys = "Yellow Freight Sys", AitWorldwideLogistics = "AIT Worldwide Logistics", Chukou1 = "Chukou1", Sendle = "Sendle", LandmarkGlobal = "Landmark Global", Sunyou = "Sunyou", Yanwen = "Yanwen", _4Px = "4PX", Gls = "GLS", OsmWorldwide = "OSM Worldwide", FirstMile = "FIRST MILE", AmTrucking = "AM Trucking", Ceva = "CEVA", IndiaPost = "India Post", SfExpress = "SF Express", Cne = "CNE", TForceFreight = "TForce Freight", AxleHire = "AxleHire", Lso = "LSO" } /** * * @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; } /** * List of elements that make up a charge * @export * @interface ChargeType */ export interface ChargeType { /** * The charge type for line items can be one of the following: PRODUCT or SHIPPING For details, refer to \'Charge Types\' * @type {string} * @memberof ChargeType */ chargeType: string; /** * If chargeType is PRODUCT, chargeName is Item Price. If chargeType is SHIPPING, chargeName is Shipping * @type {string} * @memberof ChargeType */ chargeName: string; /** * * @type {InlineResponse200OrderOrderLinesChargesChargeAmount} * @memberof ChargeType */ chargeAmount: InlineResponse200OrderOrderLinesChargesChargeAmount; /** * * @type {InlineResponse200OrderOrderLinesChargesTax} * @memberof ChargeType */ tax?: InlineResponse200OrderOrderLinesChargesTax; } /** * Information relating to the charge for the orderLine * @export * @interface ChargesType */ export interface ChargesType { /** * Information relating to the charge for the orderLine * @type {Array<InlineResponse200OrderOrderLinesChargesCharge>} * @memberof ChargesType */ charge?: Array<InlineResponse200OrderOrderLinesChargesCharge>; } /** * Information about the purchase order * @export * @interface ElementsType */ export interface ElementsType { /** * Purchase Order List * @type {Array<InlineResponse200Order>} * @memberof ElementsType */ order?: Array<InlineResponse200Order>; } /** * fulfillment information * @export * @interface FulfillmentType */ export interface FulfillmentType { /** * Example : S2H, S2S, etc. * @type {string} * @memberof FulfillmentType */ fulfillmentOption?: string; /** * Example : Value, Expedited, Standard, Rush, etc. * @type {string} * @memberof FulfillmentType */ shipMethod?: string; /** * Store Id * @type {string} * @memberof FulfillmentType */ storeId?: string; /** * Gives pick up datetime information * @type {number} * @memberof FulfillmentType */ pickUpDateTime?: number; /** * Gives pick up by information * @type {string} * @memberof FulfillmentType */ pickUpBy?: string; /** * Gives shipping program information. Examples TWO_DAY, THREE_DAY * @type {string} * @memberof FulfillmentType */ shippingProgramType?: string; } /** * * @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<InlineResponse2001ListCauses>} * @memberof GatewayError */ causes?: Array<InlineResponse2001ListCauses>; /** * * @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 GetOrderResponse */ export interface GetOrderResponse { /** * * @type {InlineResponse200Order} * @memberof GetOrderResponse */ order?: InlineResponse200Order; } /** * Information about the purchase order * @export * @interface GetOrderResponseRecord */ export interface GetOrderResponseRecord { /** * A unique ID associated with the seller\'s purchase order * @type {string} * @memberof GetOrderResponseRecord */ purchaseOrderId: string; /** * A unique ID associated with the sales order for specified customer * @type {string} * @memberof GetOrderResponseRecord */ customerOrderId: string; /** * The email address of the customer for the sales order * @type {string} * @memberof GetOrderResponseRecord */ customerEmailId: string; /** * Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. * @type {string} * @memberof GetOrderResponseRecord */ orderType?: string; /** * customer order ID of the original customer order on which the replacement is created. * @type {string} * @memberof GetOrderResponseRecord */ originalCustomerOrderID?: string; /** * The date the customer submitted the sales order * @type {number} * @memberof GetOrderResponseRecord */ orderDate: number; /** * Unique ID associated with the specified buyer * @type {string} * @memberof GetOrderResponseRecord */ buyerId?: string; /** * Mart information * @type {string} * @memberof GetOrderResponseRecord */ mart?: string; /** * Indicates a guest customer * @type {boolean} * @memberof GetOrderResponseRecord */ isGuest?: boolean; /** * * @type {InlineResponse200OrderShippingInfo} * @memberof GetOrderResponseRecord */ shippingInfo: InlineResponse200OrderShippingInfo; /** * * @type {InlineResponse200OrderOrderLines} * @memberof GetOrderResponseRecord */ orderLines: InlineResponse200OrderOrderLines; /** * Payment Types * @type {Array<string>} * @memberof GetOrderResponseRecord */ paymentTypes?: Array<string>; /** * * @type {InlineResponse200OrderOrderSummary} * @memberof GetOrderResponseRecord */ orderSummary?: InlineResponse200OrderOrderSummary; /** * List of pickup persons * @type {Array<InlineResponse200OrderPickupPersons>} * @memberof GetOrderResponseRecord */ pickupPersons?: Array<InlineResponse200OrderPickupPersons>; /** * * @type {InlineResponse200OrderShipNode} * @memberof GetOrderResponseRecord */ shipNode?: InlineResponse200OrderShipNode; } /** * * @export * @interface InlineObject */ export interface InlineObject { /** * * @type {V3OrdersPurchaseOrderIdShippingOrderShipment} * @memberof InlineObject */ orderShipment?: V3OrdersPurchaseOrderIdShippingOrderShipment; } /** * * @export * @interface InlineObject1 */ export interface InlineObject1 { /** * * @type {string} * @memberof InlineObject1 */ purchaseOrderId: string; /** * * @type {V3OrdersPurchaseOrderIdRefundOrderLines} * @memberof InlineObject1 */ orderLines: V3OrdersPurchaseOrderIdRefundOrderLines; } /** * * @export * @interface InlineObject2 */ export interface InlineObject2 { /** * * @type {V3OrdersPurchaseOrderIdCancelOrderCancellation} * @memberof InlineObject2 */ orderCancellation?: V3OrdersPurchaseOrderIdCancelOrderCancellation; } /** * * @export * @interface InlineResponse200 */ export interface InlineResponse200 { /** * * @type {InlineResponse200Order} * @memberof InlineResponse200 */ order?: InlineResponse200Order; } /** * * @export * @interface InlineResponse2001 */ export interface InlineResponse2001 { /** * * @type {InlineResponse2001List} * @memberof InlineResponse2001 */ list?: InlineResponse2001List; } /** * List of purchase orders in created state * @export * @interface InlineResponse2001List */ export interface InlineResponse2001List { /** * * @type {Array<InlineResponse2001ListErrors>} * @memberof InlineResponse2001List */ errors?: Array<InlineResponse2001ListErrors>; /** * * @type {InlineResponse2001ListMeta} * @memberof InlineResponse2001List */ meta: InlineResponse2001ListMeta; /** * * @type {InlineResponse2001ListElements} * @memberof InlineResponse2001List */ elements: InlineResponse2001ListElements; } /** * * @export * @interface InlineResponse2001ListCauses */ export interface InlineResponse2001ListCauses { /** * * @type {string} * @memberof InlineResponse2001ListCauses */ code?: string; /** * * @type {string} * @memberof InlineResponse2001ListCauses */ field?: string; /** * * @type {string} * @memberof InlineResponse2001ListCauses */ type?: string; /** * * @type {string} * @memberof InlineResponse2001ListCauses */ description?: string; } /** * Information about the purchase order * @export * @interface InlineResponse2001ListElements */ export interface InlineResponse2001ListElements { /** * Purchase Order List * @type {Array<InlineResponse200Order>} * @memberof InlineResponse2001ListElements */ order?: Array<InlineResponse200Order>; } /** * * @export * @interface InlineResponse2001ListErrors */ export interface InlineResponse2001ListErrors { /** * * @type {string} * @memberof InlineResponse2001ListErrors */ code: string; /** * * @type {string} * @memberof InlineResponse2001ListErrors */ field?: string; /** * * @type {string} * @memberof InlineResponse2001ListErrors */ description?: string; /** * * @type {string} * @memberof InlineResponse2001ListErrors */ info?: string; /** * * @type {string} * @memberof InlineResponse2001ListErrors */ severity?: InlineResponse2001ListErrorsSeverityEnum; /** * * @type {string} * @memberof InlineResponse2001ListErrors */ category?: InlineResponse2001ListErrorsCategoryEnum; /** * * @type {Array<InlineResponse2001ListCauses>} * @memberof InlineResponse2001ListErrors */ causes?: Array<InlineResponse2001ListCauses>; /** * * @type {{ [key: string]: object; }} * @memberof InlineResponse2001ListErrors */ errorIdentifiers?: { [key: string]: object; }; /** * * @type {string} * @memberof InlineResponse2001ListErrors */ component?: string; /** * * @type {string} * @memberof InlineResponse2001ListErrors */ type?: string; /** * * @type {string} * @memberof InlineResponse2001ListErrors */ serviceName?: string; /** * * @type {string} * @memberof InlineResponse2001ListErrors */ gatewayErrorCategory?: InlineResponse2001ListErrorsGatewayErrorCategoryEnum; } /** * @export * @enum {string} */ export declare enum InlineResponse2001ListErrorsSeverityEnum { Info = "INFO", Warn = "WARN", Error = "ERROR" } /** * @export * @enum {string} */ export declare enum InlineResponse2001ListErrorsCategoryEnum { Application = "APPLICATION", System = "SYSTEM", Request = "REQUEST", Data = "DATA" } /** * @export * @enum {string} */ export declare enum InlineResponse2001ListErrorsGatewayErrorCategoryEnum { InternalDataError = "INTERNAL_DATA_ERROR", ExternalDataError = "EXTERNAL_DATA_ERROR", SystemError = "SYSTEM_ERROR" } /** * Meta data about the list * @export * @interface InlineResponse2001ListMeta */ export interface InlineResponse2001ListMeta { /** * Total no of purchase orders. * @type {number} * @memberof InlineResponse2001ListMeta */ totalCount?: number; /** * Number of purchase orders in the current page. * @type {number} * @memberof InlineResponse2001ListMeta */ limit?: number; /** * String to be used as query parameter for getting next set of purchase orders, when more than 200 orders are retrieved. * @type {string} * @memberof InlineResponse2001ListMeta */ nextCursor?: string; } /** * Information about the purchase order * @export * @interface InlineResponse2002 */ export interface InlineResponse2002 { /** * A unique ID associated with the seller\'s purchase order * @type {string} * @memberof InlineResponse2002 */ purchaseOrderId: string; /** * A unique ID associated with the sales order for specified customer * @type {string} * @memberof InlineResponse2002 */ customerOrderId: string; /** * The email address of the customer for the sales order * @type {string} * @memberof InlineResponse2002 */ customerEmailId: string; /** * The date the customer submitted the sales order * @type {string} * @memberof InlineResponse2002 */ orderDate: string; /** * Unique ID associated with the specified buyer * @type {string} * @memberof InlineResponse2002 */ buyerId?: string; /** * Mart information * @type {string} * @memberof InlineResponse2002 */ mart?: string; /** * Indicates a guest customer * @type {boolean} * @memberof InlineResponse2002 */ isGuest?: boolean; /** * * @type {InlineResponse200OrderShippingInfo} * @memberof InlineResponse2002 */ shippingInfo: InlineResponse200OrderShippingInfo; /** * * @type {InlineResponse200OrderOrderLines} * @memberof InlineResponse2002 */ orderLines: InlineResponse200OrderOrderLines; /** * Payment Types * @type {Array<string>} * @memberof InlineResponse2002 */ paymentTypes?: Array<string>; /** * * @type {InlineResponse200OrderOrderSummary} * @memberof InlineResponse2002 */ orderSummary?: InlineResponse200OrderOrderSummary; /** * List of pickup persons * @type {Array<InlineResponse200OrderPickupPersons>} * @memberof InlineResponse2002 */ pickupPersons?: Array<InlineResponse200OrderPickupPersons>; /** * * @type {InlineResponse200OrderShipNode} * @memberof InlineResponse2002 */ shipNode?: InlineResponse200OrderShipNode; } /** * Information about the purchase order * @export * @interface InlineResponse200Order */ export interface InlineResponse200Order { /** * A unique ID associated with the seller\'s purchase order * @type {string} * @memberof InlineResponse200Order */ purchaseOrderId: string; /** * A unique ID associated with the sales order for specified customer * @type {string} * @memberof InlineResponse200Order */ customerOrderId: string; /** * The email address of the customer for the sales order * @type {string} * @memberof InlineResponse200Order */ customerEmailId: string; /** * Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. * @type {string} * @memberof InlineResponse200Order */ orderType?: string; /** * customer order ID of the original customer order on which the replacement is created. * @type {string} * @memberof InlineResponse200Order */ originalCustomerOrderID?: string; /** * The date the customer submitted the sales order * @type {number} * @memberof InlineResponse200Order */ orderDate: number; /** * Unique ID associated with the specified buyer * @type {string} * @memberof InlineResponse200Order */ buyerId?: string; /** * Mart information * @type {string} * @memberof InlineResponse200Order */ mart?: string; /** * Indicates a guest customer * @type {boolean} * @memberof InlineResponse200Order */ isGuest?: boolean; /** * * @type {InlineResponse200OrderShippingInfo} * @memberof InlineResponse200Order */ shippingInfo: InlineResponse200OrderShippingInfo; /** * * @type {InlineResponse200OrderOrderLines} * @memberof InlineResponse200Order */ orderLines: InlineResponse200OrderOrderLines; /** * Payment Types * @type {Array<string>} * @memberof InlineResponse200Order */ paymentTypes?: Array<string>; /** * * @type {InlineResponse200OrderOrderSummary} * @memberof InlineResponse200Order */ orderSummary?: InlineResponse200OrderOrderSummary; /** * List of pickup persons * @type {Array<InlineResponse200OrderPickupPersons>} * @memberof InlineResponse200Order */ pickupPersons?: Array<InlineResponse200OrderPickupPersons>; /** * * @type {InlineResponse200OrderShipNode} * @memberof InlineResponse200Order */ shipNode?: InlineResponse200OrderShipNode; } /** * * @export * @interface InlineResponse200OrderName */ export interface InlineResponse200OrderName { /** * * @type {string} * @memberof InlineResponse200OrderName */ completeName?: string; /** * * @type {string} * @memberof InlineResponse200OrderName */ firstName?: string; /** * * @type {string} * @memberof InlineResponse200OrderName */ middleName?: string; /** * * @type {string} * @memberof InlineResponse200OrderName */ lastName?: string; /** * * @type {string} * @memberof InlineResponse200OrderName */ generalSuffix?: string; /** * * @type {string} * @memberof InlineResponse200OrderName */ maturitySuffix?: string; /** * * @type {string} * @memberof InlineResponse200OrderName */ titleOfRespect?: string; /** * * @type {boolean} * @memberof InlineResponse200OrderName */ empty?: boolean; } /** * A list of order lines in the order * @export * @interface InlineResponse200OrderOrderLines */ export interface InlineResponse200OrderOrderLines { /** * A list of order lines in the order * @type {Array<InlineResponse200OrderOrderLinesOrderLine>} * @memberof InlineResponse200OrderOrderLines */ orderLine?: Array<InlineResponse200OrderOrderLinesOrderLine>; } /** * Information relating to the charge for the orderLine * @export * @interface InlineResponse200OrderOrderLinesCharges */ export interface InlineResponse200OrderOrderLinesCharges { /** * Information relating to the charge for the orderLine * @type {Array<InlineResponse200OrderOrderLinesChargesCharge>} * @memberof InlineResponse200OrderOrderLinesCharges */ charge?: Array<InlineResponse200OrderOrderLinesChargesCharge>; } /** * List of elements that make up a charge * @export * @interface InlineResponse200OrderOrderLinesChargesCharge */ export interface InlineResponse200OrderOrderLinesChargesCharge { /** * The charge type for line items can be one of the following: PRODUCT or SHIPPING For details, refer to \'Charge Types\' * @type {string} * @memberof InlineResponse200OrderOrderLinesChargesCharge */ chargeType: string; /** * If chargeType is PRODUCT, chargeName is Item Price. If chargeType is SHIPPING, chargeName is Shipping * @type {string} * @memberof InlineResponse200OrderOrderLinesChargesCharge */ chargeName: string; /** * * @type {InlineResponse200OrderOrderLinesChargesChargeAmount} * @memberof InlineResponse200OrderOrderLinesChargesCharge */ chargeAmount: InlineResponse200OrderOrderLinesChargesChargeAmount; /** * * @type {InlineResponse200OrderOrderLinesChargesTax} * @memberof InlineResponse200OrderOrderLinesChargesCharge */ tax?: InlineResponse200OrderOrderLinesChargesTax; } /** * The details for the amount of the tax charge * @export * @interface InlineResponse200OrderOrderLinesChargesChargeAmount */ export interface InlineResponse200OrderOrderLinesChargesChargeAmount { /** * The type of currency for the charge. Example: USD for US Dollars * @type {string} * @memberof InlineResponse200OrderOrderLinesChargesChargeAmount */ currency: InlineResponse200OrderOrderLinesChargesChargeAmountCurrencyEnum; /** * The numerical amount for that charge. Example: 9.99 * @type {number} * @memberof InlineResponse200OrderOrderLinesChargesChargeAmount */ amount: number; } /** * @export * @enum {string} */ export declare enum InlineResponse200OrderOrderLinesChargesChargeAmountCurrencyEnum { 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" } /** * Tax information for the charge, including taxName and taxAmount * @export * @interface InlineResponse200OrderOrderLinesChargesTax */ export interface InlineResponse200OrderOrderLinesChargesTax { /** * The name associated with the tax. Example: \'Sales Tax\' * @type {string} * @memberof InlineResponse200OrderOrderLinesChargesTax */ taxName: string; /** * * @type {InlineResponse200OrderOrderLinesChargesChargeAmount} * @memberof InlineResponse200OrderOrderLinesChargesTax */ taxAmount: InlineResponse200OrderOrderLinesChargesChargeAmount; } /** * fulfillment information * @export * @interface InlineResponse200OrderOrderLinesFulfillment */ export interface InlineResponse200OrderOrderLinesFulfillment { /** * Example : S2H, S2S, etc. * @type {string} * @memberof InlineResponse200OrderOrderLinesFulfillment */ fulfillmentOption?: string; /** * Example : Value, Expedited, Standard, Rush, etc. * @type {string} * @memberof InlineResponse200OrderOrderLinesFulfillment */ shipMethod?: string; /** * Store Id * @type {string} * @memberof InlineResponse200OrderOrderLinesFulfillment */ storeId?: string; /** * Gives pick up datetime information * @type {number} * @memberof InlineResponse200OrderOrderLinesFulfillment */ pickUpDateTime?: number; /** * Gives pick up by information * @type {string} * @memberof InlineResponse200OrderOrderLinesFulfillment */ pickUpBy?: string; /** * Gives shipping program information. Examples TWO_DAY, THREE_DAY * @type {string} * @memberof InlineResponse200OrderOrderLinesFulfillment */ shippingProgramType?: string; } /** * The information for the item on the orderLine * @export * @interface InlineResponse200OrderOrderLinesItem */ export interface InlineResponse200OrderOrderLinesItem { /** * The name of the product associated with the line item. Example: \'Kenmore CF1\' or \'2086883 Canister Secondary Filter Generic 2 Pack\' * @type {string} * @memberof InlineResponse200OrderOrderLinesItem */ productName: string; /** * An arbitrary alphanumeric unique ID, assigned to each item in the item file * @type {string} * @memberof InlineResponse200OrderOrderLinesItem */ sku: string; /** * Optional. Web URL for the image of the item. * @type {string} * @memberof InlineResponse200OrderOrderLinesItem */ imageUrl?: string; /** * * @type {InlineResponse200OrderOrderLinesItemWeight} * @memberof InlineResponse200OrderOrderLinesItem */ weight?: InlineResponse200OrderOrderLinesItemWeight; } /** * Optional. Weight information for the item. * @export * @interface InlineResponse200OrderOrderLinesItemWeight */ export interface InlineResponse200OrderOrderLinesItemWeight { /** * Numerical amount of weight parameter. * @type {string} * @memberof InlineResponse200OrderOrderLinesItemWeight */ value: string; /** * Standard value of measurement of the item. Example: \'Pounds\' * @type {string} * @memberof InlineResponse200OrderOrderLinesItemWeight */ unit: string; } /** * Purchase Order line information for each item * @export * @interface InlineResponse200OrderOrderLinesOrderLine */ export interface InlineResponse200OrderOrderLinesOrderLine { /** * The line number associated with the details for each individual item in the purchase order * @type {string} * @memberof InlineResponse200OrderOrderLinesOrderLine */ lineNumber: string; /** * * @type {InlineResponse200OrderOrderLinesItem} * @memberof InlineResponse200OrderOrderLinesOrderLine */ item: InlineResponse200OrderOrderLinesItem; /** * * @type {InlineResponse200OrderOrderLinesCharges} * @memberof InlineResponse200OrderOrderLinesOrderLine */ charges: InlineResponse200OrderOrderLinesCharges; /** * * @type {V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesStatusQuantity} * @memberof InlineResponse200OrderOrderLinesOrderLine */ orderLineQuantity: V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesStatusQuantity; /** * The date shown on the recent order status * @type {number} * @memberof InlineResponse200OrderOrderLinesOrderLine */ statusDate: number; /** * * @type {InlineResponse200OrderOrderLinesOrderLineStatuses} * @memberof InlineResponse200OrderOrderLinesOrderLine */ orderLineStatuses: InlineResponse200OrderOrderLinesOrderLineStatuses; /** * Id of the return order created in case of a full refund * @type {string} * @memberof InlineResponse200OrderOrderLinesOrderLine */ returnOrderId?: string; /** * * @type {InlineResponse200OrderOrderLinesRefund} * @memberof InlineResponse200OrderOrderLinesOrderLine */ refund?: InlineResponse200OrderOrderLinesRefund; /** * Ship method stamped at order line level when order is placed * @type {string} * @memberof InlineResponse200OrderOrderLinesOrderLine */ originalCarrierMethod?: string; /** * Reference line Id * @type {string} * @memberof InlineResponse200OrderOrderLinesOrderLine */ referenceLineId?: string; /** * * @type {InlineResponse200OrderOrderLinesFulfillment} * @memberof InlineResponse200OrderOrderLinesOrderLine */ fulfillment?: InlineResponse200OrderOrderLinesFulfillment; /** * * @type {string} * @memberof InlineResponse200OrderOrderLinesOrderLine */ intentToCancel?: string; /** * Sets ConfigID for Personalised orders * @type {string} * @memberof InlineResponse200OrderOrderLinesOrderLine */ configId?: string; /** * A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters * @type {string} * @memberof InlineResponse200OrderOrderLinesOrderLine */ sellerOrderId?: string; } /** * A list of statuses for the Order Line * @export * @interface InlineResponse200OrderOrderLinesOrderLineStatuses */ export interface InlineResponse200OrderOrderLinesOrderLineStatuses { /** * Detail List of Order Line status * @type {Array<InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatus>} * @memberof InlineResponse200OrderOrderLinesOrderLineStatuses */ orderLineStatus?: Array<InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatus>; } /** * Detail List of Order Line status * @export * @interface InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatus */ export interface InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatus { /** * Should be \'Created\' * @type {string} * @memberof InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatus */ status: InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatusStatusEnum; /** * * @type {V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesStatusQuantity} * @memberof InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatus */ statusQuantity: V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesStatusQuantity; /** * If order is cancelled, cancellationReason will explain the reason * @type {string} * @memberof InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatus */ cancellationReason?: string; /** * * @type {V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesTrackingInfo} * @memberof InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatus */ trackingInfo?: V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesTrackingInfo; /** * * @type {V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesReturnCenterAddress} * @memberof InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatus */ returnCenterAddress?: V3OrdersPurchaseOrderIdShippingOrderShipmentOrderLinesOrderLineStatusesReturnCenterAddress; } /** * @export * @enum {string} */ export declare enum InlineResponse200OrderOrderLinesOrderLineStatusesOrderLineStatusStatusEnum { Created = "Created", Acknowledged = "Acknowledged", Shipped = "Shipped", Delivered = "Delivered", Cancelled = "Cancelled", Refund = "Refund" } /** * Details about any partial refund on the order * @export * @interface InlineResponse200OrderOrderLinesRefund */ export interface InlineResponse200OrderOrderLinesRefund { /** * * @type {string} * @memberof InlineResponse200OrderOrderLinesRefund */ refundId?: string; /** * * @type {string} * @memberof InlineResponse200OrderOrderLinesRefund */ refundComments?: string; /** * * @type {InlineResponse200OrderOrderLinesRefundRefundCharges} * @memberof InlineResponse200OrderOrderLinesRefund */ refundCharges: InlineResponse200OrderOrderLinesRefundRefundCharges; } /** * * @export * @interface InlineResponse200OrderOrderLinesRefundRefundCharges */ export interface InlineResponse200OrderOrderLinesRefundRefundCharges { /** * * @type {Array<InlineResponse200OrderOrderLinesRefundRefundChargesRefundCharge>} * @memberof InlineResponse200OrderOrderLinesRefundRefundCharges */ refundCharge?: Array<InlineResponse200OrderOrderLinesRefundRefundChargesRefundCharge>; } /** * * @export * @interface InlineResponse200OrderOrderLinesRefundRefundChargesRefundCharge */ export interface InlineResponse200OrderOrderLinesRefundRefundChargesRefundCharge { /** * * @type {string} * @memberof InlineResponse200OrderOrderLinesRefundRefundChargesRefundCharge */ refundReason: InlineResponse200OrderOrderLinesRefundRefundChargesRefundChargeRefundReasonEnum; /** * * @type {InlineResponse200OrderOrderLinesChargesCharge} * @memberof InlineResponse200OrderOrderLinesRefundRefundChargesRefundCharge */ charge: InlineResponse200OrderOrderLinesChargesCharge; } /** * @export * @enum {string} */ export declare enum InlineResponse200OrderOrderLinesRefundRefundChargesRefundChargeRefundReasonEnum { BillingError = "BillingError", TaxExemptCustomer = "TaxExemptCustomer", ItemNotAsAdvertised = "ItemNotAsAdvertised", IncorrectItemReceived = "IncorrectItemReceived", CancelledYetShipped = "CancelledYetShipped", ItemNotReceivedByCustomer = "ItemNotReceivedByCustomer", IncorrectShippingPrice = "IncorrectShippingPrice", DamagedItem = "DamagedItem", DefectiveItem = "DefectiveItem", CustomerChangedMind = "CustomerChangedMind", CustomerReceivedItemLate = "CustomerReceivedItemLate", MissingPartsInstructions = "Missing Parts / Instructions", FinanceGoodwill = "Finance -> Goodwill", FinanceRollback = "Finance -> Rollback", BuyerCanceled = "Buyer canceled", CustomerReturnedItem = "Customer returned item", GeneralAdjustment = "General adjustment", MerchandiseNotReceived = "Merchandise not received", QualityMissingPartsInstructions = "Quality -> Missing Parts / Instructions", ShippingDeliveryDamaged = "Shipping & Delivery -> Damaged", ShippingDeliveryShippingPriceDiscrepancy = "Shipping & Delivery -> Shipping Price Discrepancy", Others = "Others" } /** * Order Summary * @export * @interface InlineResponse200OrderOrderSummary */ export interface InlineResponse200OrderOrderSummary { /** * * @type {InlineResponse200OrderOrderSummaryTotalAmount} * @memberof InlineResponse200OrderOrderSummary */ totalAmount?: InlineResponse200OrderOrderSummaryTotalAmount; /** * * @type {Array<InlineResponse200OrderOrderSummaryOrderSubTotals>} * @memberof InlineResponse200OrderOrderSummary */ orderSubTotals?: Array<InlineResponse200OrderOrderSummaryOrderSubTotals>; } /** * * @export * @interface InlineResponse200OrderOrderSummaryOrderSubTotals */ export interface InlineResponse200OrderOrderSummaryOrderSubTotals { /** * * @type {string} * @memberof InlineResponse200OrderOrderSummaryOrderSubTotals */ subTotalType?: string; /** * * @type {InlineResponse200OrderOrderSummaryTotalAmount} * @memberof InlineResponse200OrderOrderSummaryOrderSubTotals */ totalAmount?: InlineResponse200OrderOrderSummaryTotalAmount; } /** * * @export * @interface InlineResponse200OrderOrderSummaryTotalAmount */ export interface InlineResponse200OrderOrderSummaryTotalAmount { /** * * @type {number} * @memberof InlineResponse200OrderOrderSummaryTotalAmount */ currencyAmount: number; /** * * @type {string} * @memberof InlineResponse200OrderOrderSummaryTotalAmount */ currencyUnit: InlineResponse200OrderOrderSummaryTotalAmountCurrencyUnitEnum; } /** * @export * @enum {string} */ export declare enum InlineResponse200OrderOrderSummaryTotalAmountCurrencyUnitEnum { 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" } /** * * @export * @interface InlineResponse200OrderPhone */ export interface InlineResponse200OrderPhone { /** * * @type {string} * @memberof InlineResponse200OrderPhone */ id?: string; /** * * @type {string} * @memberof InlineResponse200OrderPhone */ areaCode?: string; /** * * @type {string} * @memberof InlineResponse200OrderPhone */ extension?: string; /** * * @type {string} * @memberof InlineResponse200OrderPhone */ completeNumber?: string; /** * * @type {string} * @memberof InlineResponse200OrderPhone */ type?: InlineResponse200OrderPhoneTypeEnum; /** * * @type {string} * @memberof InlineResponse200OrderPhone */ subscriberNumber?: string; /** * * @type {string} * @memberof InlineResponse200OrderPhone */ countryCode?: string; } /** * @export * @enum {string} */ export declare enum InlineResponse200OrderPhoneTypeEnum { Mobile = "MOBILE", Home = "HOME", Work = "WORK" } /** * List of pickup persons * @export * @interface InlineResponse200OrderPickupPersons */ export interface InlineResponse200OrderPickupPersons { /** * * @type {InlineResponse200OrderName} * @memberof InlineResponse200OrderPickupPersons */ name?: InlineResponse200OrderName; /** * * @type {InlineResponse200OrderPhone} * @memberof InlineResponse200OrderPickupPersons */ phone?: InlineResponse200OrderPhone; } /** * Specifies the type of shipNode * @export * @interface InlineResponse200OrderShipNode */ export interface InlineResponse200OrderShipNode { /** * Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. * @type {string} * @memberof InlineResponse200OrderShipNode */ type?: string; /** * * @type {string} * @memberof InlineResponse200OrderShipNode */ name?: string; /** * * @type {string} * @memberof InlineResponse200OrderShipNode */ id?: string; } /** * The shipping information provided by the customer to the seller * @export * @interface InlineResponse200OrderShippingInfo */ export interface Inl