@whitebox-co/walmart-marketplace-api
Version:
A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API
2,275 lines • 239 kB
TypeScript
/**
* Fulfillment Management
* With Walmart Fulfillment Services, you can focus on sales while we expertly take care of fast shipping, seamless returns, and customer service. Simply send your inventory to Walmart fulfillment centers, where we will store your products securely and prepare them swiftly for shipping when an order is placed.
*
* 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 Address
*/
export interface Address {
/**
*
* @type {string}
* @memberof Address
*/
addressLine1: string;
/**
*
* @type {string}
* @memberof Address
*/
addressLine2?: string;
/**
*
* @type {string}
* @memberof Address
*/
city: string;
/**
*
* @type {string}
* @memberof Address
*/
stateCode: string;
/**
*
* @type {string}
* @memberof Address
*/
countryCode: string;
/**
*
* @type {string}
* @memberof Address
*/
postalCode: string;
/**
*
* @type {string}
* @memberof Address
*/
phone?: string;
}
/**
* request payload
* @export
* @interface CancelCustomerOrderRequestPayload
*/
export interface CancelCustomerOrderRequestPayload {
/**
*
* @type {string}
* @memberof CancelCustomerOrderRequestPayload
*/
sellerOrderId: string;
/**
*
* @type {Array<V3OrdersFulfillmentsCancelPayloadOrderItems>}
* @memberof CancelCustomerOrderRequestPayload
*/
orderItems: Array<V3OrdersFulfillmentsCancelPayloadOrderItems>;
}
/**
*
* @export
* @interface CancelCustomerOrderRequestWrapper
*/
export interface CancelCustomerOrderRequestWrapper {
/**
*
* @type {V3OrdersFulfillmentsHeader}
* @memberof CancelCustomerOrderRequestWrapper
*/
header: V3OrdersFulfillmentsHeader;
/**
*
* @type {V3OrdersFulfillmentsCancelPayload}
* @memberof CancelCustomerOrderRequestWrapper
*/
payload?: V3OrdersFulfillmentsCancelPayload;
}
/**
*
* @export
* @interface Carrier
*/
export interface Carrier {
/**
*
* @type {string}
* @memberof Carrier
*/
carrierId?: string;
/**
*
* @type {string}
* @memberof Carrier
*/
carrierName?: string;
}
/**
*
* @export
* @interface CarrierLabelRequestWrapper
*/
export interface CarrierLabelRequestWrapper {
/**
*
* @type {string}
* @memberof CarrierLabelRequestWrapper
*/
shipDate: string;
}
/**
*
* @export
* @interface CarrierQuoteConfirmRequestWrapper
*/
export interface CarrierQuoteConfirmRequestWrapper {
/**
*
* @type {string}
* @memberof CarrierQuoteConfirmRequestWrapper
*/
shipmentId: string;
}
/**
*
* @export
* @interface CarrierQuoteRequestV2Wrapper
*/
export interface CarrierQuoteRequestV2Wrapper {
/**
*
* @type {string}
* @memberof CarrierQuoteRequestV2Wrapper
*/
shipmentId: string;
/**
*
* @type {string}
* @memberof CarrierQuoteRequestV2Wrapper
*/
shipmentSource: string;
/**
*
* @type {string}
* @memberof CarrierQuoteRequestV2Wrapper
*/
pickupFromDateTime?: string;
/**
*
* @type {string}
* @memberof CarrierQuoteRequestV2Wrapper
*/
pickupToDateTime?: string;
/**
*
* @type {string}
* @memberof CarrierQuoteRequestV2Wrapper
*/
deliveryFromDateTime?: string;
/**
*
* @type {string}
* @memberof CarrierQuoteRequestV2Wrapper
*/
deliveryToDateTime?: string;
/**
*
* @type {V3OrdersFulfillmentsPayloadCustomer}
* @memberof CarrierQuoteRequestV2Wrapper
*/
customer: V3OrdersFulfillmentsPayloadCustomer;
/**
*
* @type {InlineResponse2004OriginLocation}
* @memberof CarrierQuoteRequestV2Wrapper
*/
originLocation: InlineResponse2004OriginLocation;
/**
*
* @type {InlineResponse2004OriginLocation}
* @memberof CarrierQuoteRequestV2Wrapper
*/
destinationLocation: InlineResponse2004OriginLocation;
/**
*
* @type {InlineResponse2004ReturnLocation}
* @memberof CarrierQuoteRequestV2Wrapper
*/
returnLocation: InlineResponse2004ReturnLocation;
/**
*
* @type {Array<InlineResponse2004ShipmentPackages>}
* @memberof CarrierQuoteRequestV2Wrapper
*/
shipmentPackages: Array<InlineResponse2004ShipmentPackages>;
/**
*
* @type {string}
* @memberof CarrierQuoteRequestV2Wrapper
*/
mode: string;
/**
*
* @type {string}
* @memberof CarrierQuoteRequestV2Wrapper
*/
freightClass?: string;
/**
*
* @type {number}
* @memberof CarrierQuoteRequestV2Wrapper
*/
declaredValue?: number;
/**
*
* @type {Array<V3FulfillmentCarrierRateQuotesLoadTypes>}
* @memberof CarrierQuoteRequestV2Wrapper
*/
loadTypes?: Array<V3FulfillmentCarrierRateQuotesLoadTypes>;
}
/**
*
* @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;
}
/**
* request payload
* @export
* @interface CreateCustomerOrderRequestPayload
*/
export interface CreateCustomerOrderRequestPayload {
/**
* Unique ID identifying channels from where the orders have been generated
* @type {string}
* @memberof CreateCustomerOrderRequestPayload
*/
orderChannelId: string;
/**
* Unique ID identifying customer order request
* @type {string}
* @memberof CreateCustomerOrderRequestPayload
*/
sellerOrderId: string;
/**
* Order placed time at respective channels
* @type {string}
* @memberof CreateCustomerOrderRequestPayload
*/
orderPlacedTime: string;
/**
* Flag to identify if confirmation is needed
* @type {boolean}
* @memberof CreateCustomerOrderRequestPayload
*/
needsConfirmation?: boolean;
/**
* Flag to identify if partial fulfilment is allowed
* @type {boolean}
* @memberof CreateCustomerOrderRequestPayload
*/
partialFulfillments?: boolean;
/**
*
* @type {V3OrdersFulfillmentsPayloadCustomer}
* @memberof CreateCustomerOrderRequestPayload
*/
customer: V3OrdersFulfillmentsPayloadCustomer;
/**
* Order items details
* @type {Array<V3OrdersFulfillmentsPayloadOrderItems>}
* @memberof CreateCustomerOrderRequestPayload
*/
orderItems: Array<V3OrdersFulfillmentsPayloadOrderItems>;
}
/**
*
* @export
* @interface CreateCustomerOrderRequestWrapper
*/
export interface CreateCustomerOrderRequestWrapper {
/**
*
* @type {V3OrdersFulfillmentsHeader}
* @memberof CreateCustomerOrderRequestWrapper
*/
header: V3OrdersFulfillmentsHeader;
/**
*
* @type {V3OrdersFulfillmentsPayload}
* @memberof CreateCustomerOrderRequestWrapper
*/
payload: V3OrdersFulfillmentsPayload;
}
/**
*
* @export
* @interface Customer
*/
export interface Customer {
/**
*
* @type {string}
* @memberof Customer
*/
customerId: string;
/**
*
* @type {string}
* @memberof Customer
*/
customerName: string;
}
/**
* header to support build and martId
* @export
* @interface CustomerOrderHeader
*/
export interface CustomerOrderHeader {
/**
*
* @type {V3OrdersFulfillmentsHeaderHeaderAttributes}
* @memberof CustomerOrderHeader
*/
headerAttributes?: V3OrdersFulfillmentsHeaderHeaderAttributes;
}
/**
* Header attributes
* @export
* @interface CustomerOrderHeaderAttributes
*/
export interface CustomerOrderHeaderAttributes {
/**
* martId of the seller
* @type {string}
* @memberof CustomerOrderHeaderAttributes
*/
martId?: string;
/**
* buId of the seller
* @type {string}
* @memberof CustomerOrderHeaderAttributes
*/
buId?: string;
}
/**
* response payload
* @export
* @interface CustomerOrderResponseWrapper
*/
export interface CustomerOrderResponseWrapper {
/**
* Unique ID identifying each request
* @type {string}
* @memberof CustomerOrderResponseWrapper
*/
requestId?: string;
}
/**
*
* @export
* @interface CustomerOrderResponseWrapperDTO
*/
export interface CustomerOrderResponseWrapperDTO {
/**
* status
* @type {string}
* @memberof CustomerOrderResponseWrapperDTO
*/
status?: string;
/**
*
* @type {V3OrdersFulfillmentsHeader}
* @memberof CustomerOrderResponseWrapperDTO
*/
header?: V3OrdersFulfillmentsHeader;
/**
*
* @type {InlineResponse2001Payload}
* @memberof CustomerOrderResponseWrapperDTO
*/
payload?: InlineResponse2001Payload;
}
/**
*
* @export
* @interface DestinationLocation
*/
export interface DestinationLocation {
/**
*
* @type {string}
* @memberof DestinationLocation
*/
locationName: string;
/**
*
* @type {InlineResponse2004OriginLocationAddress}
* @memberof DestinationLocation
*/
address: InlineResponse2004OriginLocationAddress;
/**
*
* @type {string}
* @memberof DestinationLocation
*/
locationId?: 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 | --- | ----------- | ------- | status | Item status | string
* @type {string}
* @memberof Filter
*/
field?: FilterFieldEnum;
/**
*
* @type {string}
* @memberof Filter
*/
op?: FilterOpEnum;
/**
*
* @type {Array<string>}
* @memberof Filter
*/
values?: Array<FilterValuesEnum>;
}
/**
* @export
* @enum {string}
*/
export declare enum FilterFieldEnum {
Status = "status"
}
/**
* @export
* @enum {string}
*/
export declare enum FilterOpEnum {
Equals = "equals"
}
/**
* @export
* @enum {string}
*/
export declare enum FilterValuesEnum {
Prohibited = "PROHIBITED",
InReview = "IN_REVIEW",
ActionNeeded = "ACTION_NEEDED"
}
/**
* Payload Section
* @export
* @interface GetInventoryLogsResponsePayload
*/
export interface GetInventoryLogsResponsePayload {
/**
* GTIN
* @type {string}
* @memberof GetInventoryLogsResponsePayload
*/
gtin?: string;
/**
* Vendor SKU
* @type {string}
* @memberof GetInventoryLogsResponsePayload
*/
vendorSku?: string;
/**
* Product Name
* @type {string}
* @memberof GetInventoryLogsResponsePayload
*/
productName?: string;
/**
* Inventory Log records
* @type {Array<InlineResponse2007PayloadInventoryLog>}
* @memberof GetInventoryLogsResponsePayload
*/
inventoryLog?: Array<InlineResponse2007PayloadInventoryLog>;
}
/**
*
* @export
* @interface GetRateQuoteInfoResponseWrapper
*/
export interface GetRateQuoteInfoResponseWrapper {
/**
*
* @type {string}
* @memberof GetRateQuoteInfoResponseWrapper
*/
shipmentId?: string;
/**
*
* @type {string}
* @memberof GetRateQuoteInfoResponseWrapper
*/
quoteId?: string;
/**
*
* @type {string}
* @memberof GetRateQuoteInfoResponseWrapper
*/
estimatedDeliveryDateTime?: string;
/**
*
* @type {string}
* @memberof GetRateQuoteInfoResponseWrapper
*/
quoteCreationDate?: string;
/**
*
* @type {InlineResponse2004Carrier}
* @memberof GetRateQuoteInfoResponseWrapper
*/
carrier?: InlineResponse2004Carrier;
/**
*
* @type {InlineResponse2004RateQuote}
* @memberof GetRateQuoteInfoResponseWrapper
*/
rateQuote?: InlineResponse2004RateQuote;
/**
*
* @type {Array<InlineResponse2004ShipmentPackages>}
* @memberof GetRateQuoteInfoResponseWrapper
*/
shipmentPackages?: Array<InlineResponse2004ShipmentPackages>;
/**
*
* @type {InlineResponse2004OriginLocation}
* @memberof GetRateQuoteInfoResponseWrapper
*/
originLocation?: InlineResponse2004OriginLocation;
/**
*
* @type {InlineResponse2004OriginLocation}
* @memberof GetRateQuoteInfoResponseWrapper
*/
destinationLocation?: InlineResponse2004OriginLocation;
/**
*
* @type {InlineResponse2004ReturnLocation}
* @memberof GetRateQuoteInfoResponseWrapper
*/
returnLocation?: InlineResponse2004ReturnLocation;
}
/**
*
* @export
* @interface GetShipmentItemsDTO
*/
export interface GetShipmentItemsDTO {
/**
*
* @type {InlineResponse2002Headers}
* @memberof GetShipmentItemsDTO
*/
headers?: InlineResponse2002Headers;
/**
* response payload
* @type {Array<InlineResponse2008Payload>}
* @memberof GetShipmentItemsDTO
*/
payload?: Array<InlineResponse2008Payload>;
}
/**
*
* @export
* @interface GetShipmentPlanDTO
*/
export interface GetShipmentPlanDTO {
/**
*
* @type {InlineResponse2002Headers}
* @memberof GetShipmentPlanDTO
*/
headers?: InlineResponse2002Headers;
/**
* response payload
* @type {Array<InlineResponse2002Payload>}
* @memberof GetShipmentPlanDTO
*/
payload?: Array<InlineResponse2002Payload>;
}
/**
*
* @export
* @interface Headers
*/
export interface Headers {
/**
* total number of POs for provided GET request.
* @type {number}
* @memberof Headers
*/
totalCount?: number;
/**
* provided limit value in the request
* @type {number}
* @memberof Headers
*/
limit?: number;
/**
* provided offset value in the request.
* @type {number}
* @memberof Headers
*/
offset?: number;
}
/**
* response payload
* @export
* @interface InboundShipmentCreateResponseWrapper
*/
export interface InboundShipmentCreateResponseWrapper {
/**
* Unique ID identifying each shipment
* @type {string}
* @memberof InboundShipmentCreateResponseWrapper
*/
shipmentId?: string;
/**
*
* @type {InlineResponse2002ShipToAddress}
* @memberof InboundShipmentCreateResponseWrapper
*/
shipToAddress?: InlineResponse2002ShipToAddress;
/**
* The items which needs to be send in the shipment
* @type {Array<InlineResponse2003ShipmentItems>}
* @memberof InboundShipmentCreateResponseWrapper
*/
shipmentItems?: Array<InlineResponse2003ShipmentItems>;
/**
* expected delivery date for inbounding shipment. Can be different from provided in the rquest based on network capacity
* @type {string}
* @memberof InboundShipmentCreateResponseWrapper
*/
expectedDeliveryDate?: string;
}
/**
*
* @export
* @interface InboundShipmentCreateResponseWrapperDTO
*/
export interface InboundShipmentCreateResponseWrapperDTO {
/**
*
* @type {string}
* @memberof InboundShipmentCreateResponseWrapperDTO
*/
status?: string;
/**
* response payload
* @type {Array<InlineResponse2003Payload>}
* @memberof InboundShipmentCreateResponseWrapperDTO
*/
payload?: Array<InlineResponse2003Payload>;
}
/**
*
* @export
* @interface InboundShipmentErrorResponseWrapperDTO
*/
export interface InboundShipmentErrorResponseWrapperDTO {
/**
*
* @type {InlineResponse2002Headers}
* @memberof InboundShipmentErrorResponseWrapperDTO
*/
headers?: InlineResponse2002Headers;
/**
* response payload
* @type {Array<InlineResponse2009Payload>}
* @memberof InboundShipmentErrorResponseWrapperDTO
*/
payload?: Array<InlineResponse2009Payload>;
}
/**
* response payload
* @export
* @interface InboundShipmentErrorsResponseWrapper
*/
export interface InboundShipmentErrorsResponseWrapper {
/**
* Unique ID identifying inbound shipment requests
* @type {string}
* @memberof InboundShipmentErrorsResponseWrapper
*/
inboundOrderId?: string;
/**
* created date for the request
* @type {string}
* @memberof InboundShipmentErrorsResponseWrapper
*/
createdDate?: string;
/**
*
* @type {InlineResponse2002ReturnAddress}
* @memberof InboundShipmentErrorsResponseWrapper
*/
returnAddress?: InlineResponse2002ReturnAddress;
/**
* inbound shipment request line items
* @type {Array<V3OrdersFulfillmentsPayloadOrderItems>}
* @memberof InboundShipmentErrorsResponseWrapper
*/
orderItems?: Array<V3OrdersFulfillmentsPayloadOrderItems>;
/**
* Error in inbound shipment creation
* @type {Array<InlineResponse200Errors>}
* @memberof InboundShipmentErrorsResponseWrapper
*/
errors?: Array<InlineResponse200Errors>;
}
/**
*
* @export
* @interface InboundShipmentRequestWrapper
*/
export interface InboundShipmentRequestWrapper {
/**
* Unique ID identifying inbound shipment request
* @type {string}
* @memberof InboundShipmentRequestWrapper
*/
inboundOrderId: string;
/**
*
* @type {InlineResponse2002ReturnAddress}
* @memberof InboundShipmentRequestWrapper
*/
returnAddress: InlineResponse2002ReturnAddress;
/**
* inbound shipment request line items
* @type {Array<V3OrdersFulfillmentsPayloadOrderItems>}
* @memberof InboundShipmentRequestWrapper
*/
orderItems?: Array<V3OrdersFulfillmentsPayloadOrderItems>;
}
/**
*
* @export
* @interface InboundShipmentUpdateQtyWrapper
*/
export interface InboundShipmentUpdateQtyWrapper {
/**
* Unique ID identifying inbound shipment request
* @type {string}
* @memberof InboundShipmentUpdateQtyWrapper
*/
inboundOrderId: string;
/**
* Unique ID identifying inbound shipment
* @type {string}
* @memberof InboundShipmentUpdateQtyWrapper
*/
shipmentId: string;
/**
* update shipment qty line items
* @type {Array<V3FulfillmentShipmentQuantitiesOrderItems>}
* @memberof InboundShipmentUpdateQtyWrapper
*/
orderItems?: Array<V3FulfillmentShipmentQuantitiesOrderItems>;
}
/**
*
* @export
* @interface InlineObject
*/
export interface InlineObject {
/**
* Unique ID identifying inbound shipment request
* @type {string}
* @memberof InlineObject
*/
inboundOrderId: string;
/**
* Unique ID identifying inbound shipment
* @type {string}
* @memberof InlineObject
*/
shipmentId: string;
/**
* update shipment qty line items
* @type {Array<V3FulfillmentShipmentQuantitiesOrderItems>}
* @memberof InlineObject
*/
orderItems?: Array<V3FulfillmentShipmentQuantitiesOrderItems>;
}
/**
*
* @export
* @interface InlineObject1
*/
export interface InlineObject1 {
/**
*
* @type {V3OrdersFulfillmentsHeader}
* @memberof InlineObject1
*/
header: V3OrdersFulfillmentsHeader;
/**
*
* @type {V3OrdersFulfillmentsPayload}
* @memberof InlineObject1
*/
payload: V3OrdersFulfillmentsPayload;
}
/**
*
* @export
* @interface InlineObject10
*/
export interface InlineObject10 {
/**
* Feed file to upload
* @type {any}
* @memberof InlineObject10
*/
file: any;
}
/**
*
* @export
* @interface InlineObject2
*/
export interface InlineObject2 {
/**
*
* @type {V3OrdersFulfillmentsHeader}
* @memberof InlineObject2
*/
header: V3OrdersFulfillmentsHeader;
/**
*
* @type {V3OrdersFulfillmentsCancelPayload}
* @memberof InlineObject2
*/
payload?: V3OrdersFulfillmentsCancelPayload;
}
/**
*
* @export
* @interface InlineObject3
*/
export interface InlineObject3 {
/**
*
* @type {V3ItemsOnholdSearchQuery}
* @memberof InlineObject3
*/
query?: V3ItemsOnholdSearchQuery;
/**
*
* @type {Array<V3ItemsOnholdSearchFilters>}
* @memberof InlineObject3
*/
filters?: Array<V3ItemsOnholdSearchFilters>;
/**
*
* @type {V3ItemsOnholdSearchSort}
* @memberof InlineObject3
*/
sort?: V3ItemsOnholdSearchSort;
}
/**
*
* @export
* @interface InlineObject4
*/
export interface InlineObject4 {
/**
*
* @type {string}
* @memberof InlineObject4
*/
shipmentId: string;
/**
*
* @type {string}
* @memberof InlineObject4
*/
carrierName: string;
/**
*
* @type {Array<string>}
* @memberof InlineObject4
*/
trackingInfo?: Array<string>;
}
/**
*
* @export
* @interface InlineObject5
*/
export interface InlineObject5 {
/**
*
* @type {string}
* @memberof InlineObject5
*/
shipmentId: string;
/**
*
* @type {string}
* @memberof InlineObject5
*/
labelSize?: string;
/**
*
* @type {string}
* @memberof InlineObject5
*/
labelFormat?: string;
/**
*
* @type {Array<V3FulfillmentShipmentLabelLoadTypes>}
* @memberof InlineObject5
*/
loadTypes?: Array<V3FulfillmentShipmentLabelLoadTypes>;
}
/**
*
* @export
* @interface InlineObject6
*/
export interface InlineObject6 {
/**
* Unique ID identifying inbound shipment request
* @type {string}
* @memberof InlineObject6
*/
inboundOrderId: string;
/**
*
* @type {InlineResponse2002ReturnAddress}
* @memberof InlineObject6
*/
returnAddress: InlineResponse2002ReturnAddress;
/**
* inbound shipment request line items
* @type {Array<V3OrdersFulfillmentsPayloadOrderItems>}
* @memberof InlineObject6
*/
orderItems?: Array<V3OrdersFulfillmentsPayloadOrderItems>;
}
/**
*
* @export
* @interface InlineObject7
*/
export interface InlineObject7 {
/**
*
* @type {string}
* @memberof InlineObject7
*/
shipmentId: string;
/**
*
* @type {string}
* @memberof InlineObject7
*/
shipmentSource: string;
/**
*
* @type {string}
* @memberof InlineObject7
*/
pickupFromDateTime?: string;
/**
*
* @type {string}
* @memberof InlineObject7
*/
pickupToDateTime?: string;
/**
*
* @type {string}
* @memberof InlineObject7
*/
deliveryFromDateTime?: string;
/**
*
* @type {string}
* @memberof InlineObject7
*/
deliveryToDateTime?: string;
/**
*
* @type {V3OrdersFulfillmentsPayloadCustomer}
* @memberof InlineObject7
*/
customer: V3OrdersFulfillmentsPayloadCustomer;
/**
*
* @type {InlineResponse2004OriginLocation}
* @memberof InlineObject7
*/
originLocation: InlineResponse2004OriginLocation;
/**
*
* @type {InlineResponse2004OriginLocation}
* @memberof InlineObject7
*/
destinationLocation: InlineResponse2004OriginLocation;
/**
*
* @type {InlineResponse2004ReturnLocation}
* @memberof InlineObject7
*/
returnLocation: InlineResponse2004ReturnLocation;
/**
*
* @type {Array<InlineResponse2004ShipmentPackages>}
* @memberof InlineObject7
*/
shipmentPackages: Array<InlineResponse2004ShipmentPackages>;
/**
*
* @type {string}
* @memberof InlineObject7
*/
mode: string;
/**
*
* @type {string}
* @memberof InlineObject7
*/
freightClass?: string;
/**
*
* @type {number}
* @memberof InlineObject7
*/
declaredValue?: number;
/**
*
* @type {Array<V3FulfillmentCarrierRateQuotesLoadTypes>}
* @memberof InlineObject7
*/
loadTypes?: Array<V3FulfillmentCarrierRateQuotesLoadTypes>;
}
/**
*
* @export
* @interface InlineObject8
*/
export interface InlineObject8 {
/**
*
* @type {string}
* @memberof InlineObject8
*/
shipmentId: string;
}
/**
*
* @export
* @interface InlineObject9
*/
export interface InlineObject9 {
/**
*
* @type {string}
* @memberof InlineObject9
*/
shipDate: string;
}
/**
*
* @export
* @interface InlineResponse200
*/
export interface InlineResponse200 {
/**
*
* @type {string}
* @memberof InlineResponse200
*/
status: InlineResponse200StatusEnum;
/**
*
* @type {InlineResponse200Header}
* @memberof InlineResponse200
*/
header?: InlineResponse200Header;
/**
*
* @type {Array<InlineResponse200Errors>}
* @memberof InlineResponse200
*/
errors?: Array<InlineResponse200Errors>;
/**
*
* @type {object}
* @memberof InlineResponse200
*/
payload?: object;
}
/**
* @export
* @enum {string}
*/
export declare enum InlineResponse200StatusEnum {
Ok = "OK",
Created = "CREATED",
Accepted = "ACCEPTED",
NoContent = "NO_CONTENT",
Partial = "PARTIAL",
MovedPermanent = "MOVED_PERMANENT",
Found = "FOUND",
SeeOther = "SEE_OTHER",
NotModified = "NOT_MODIFIED",
TemporaryRedirect = "TEMPORARY_REDIRECT",
BadRequest = "BAD_REQUEST",
Unauthorized = "UNAUTHORIZED",
Forbidden = "FORBIDDEN",
NotFound = "NOT_FOUND",
MethodNotAllowed = "METHOD_NOT_ALLOWED",
NotAcceptable = "NOT_ACCEPTABLE",
RequestTimeout = "REQUEST_TIMEOUT",
Conflict = "CONFLICT",
RequestEntityTooLarge = "REQUEST_ENTITY_TOO_LARGE",
UnsupportedMediaType = "UNSUPPORTED_MEDIA_TYPE",
UnprocessableEntity = "UNPROCESSABLE_ENTITY",
Fail = "FAIL",
BadGateway = "BAD_GATEWAY",
ServiceUnavailable = "SERVICE_UNAVAILABLE",
GatewayTimeout = "GATEWAY_TIMEOUT"
}
/**
*
* @export
* @interface InlineResponse2001
*/
export interface InlineResponse2001 {
/**
* status
* @type {string}
* @memberof InlineResponse2001
*/
status?: string;
/**
*
* @type {V3OrdersFulfillmentsHeader}
* @memberof InlineResponse2001
*/
header?: V3OrdersFulfillmentsHeader;
/**
*
* @type {InlineResponse2001Payload}
* @memberof InlineResponse2001
*/
payload?: InlineResponse2001Payload;
}
/**
* response payload
* @export
* @interface InlineResponse2001Payload
*/
export interface InlineResponse2001Payload {
/**
* Unique ID identifying each request
* @type {string}
* @memberof InlineResponse2001Payload
*/
requestId?: string;
}
/**
*
* @export
* @interface InlineResponse2002
*/
export interface InlineResponse2002 {
/**
*
* @type {InlineResponse2002Headers}
* @memberof InlineResponse2002
*/
headers?: InlineResponse2002Headers;
/**
* response payload
* @type {Array<InlineResponse2002Payload>}
* @memberof InlineResponse2002
*/
payload?: Array<InlineResponse2002Payload>;
}
/**
*
* @export
* @interface InlineResponse2002Headers
*/
export interface InlineResponse2002Headers {
/**
* total number of POs for provided GET request.
* @type {number}
* @memberof InlineResponse2002Headers
*/
totalCount?: number;
/**
* provided limit value in the request
* @type {number}
* @memberof InlineResponse2002Headers
*/
limit?: number;
/**
* provided offset value in the request.
* @type {number}
* @memberof InlineResponse2002Headers
*/
offset?: number;
}
/**
* response payload
* @export
* @interface InlineResponse2002Payload
*/
export interface InlineResponse2002Payload {
/**
* Unique ID identifying inbound shipment request
* @type {string}
* @memberof InlineResponse2002Payload
*/
inboundOrderId?: string;
/**
* Unique ID identifying inbound shipment
* @type {string}
* @memberof InlineResponse2002Payload
*/
shipmentId?: string;
/**
*
* @type {InlineResponse2002ShipToAddress}
* @memberof InlineResponse2002Payload
*/
shipToAddress?: InlineResponse2002ShipToAddress;
/**
*
* @type {InlineResponse2002ReturnAddress}
* @memberof InlineResponse2002Payload
*/
returnAddress?: InlineResponse2002ReturnAddress;
/**
* Current status of the shipment
* @type {string}
* @memberof InlineResponse2002Payload
*/
status?: string;
/**
* creation date for shipment
* @type {string}
* @memberof InlineResponse2002Payload
*/
createdDate?: string;
/**
* Total number of units in the shipment
* @type {number}
* @memberof InlineResponse2002Payload
*/
shipmentUnits?: number;
/**
* Total number of units recived in FC for the shipment
* @type {number}
* @memberof InlineResponse2002Payload
*/
receivedUnits?: number;
/**
* expected delivery date provided by seller
* @type {string}
* @memberof InlineResponse2002Payload
*/
expectedDeliveryDate?: string;
/**
* update expected delivery date based on network capacity
* @type {string}
* @memberof InlineResponse2002Payload
*/
updatedExpectedDeliveryDate?: string;
/**
* Actual delivery date of the shipment at FC
* @type {string}
* @memberof InlineResponse2002Payload
*/
actualDeliveryDate?: string;
/**
* Tracking info for the shipment
* @type {Array<string>}
* @memberof InlineResponse2002Payload
*/
trackingNo?: Array<string>;
/**
* Carrier of the shipment
* @type {string}
* @memberof InlineResponse2002Payload
*/
carrierName?: string;
}
/**
* return address of seller
* @export
* @interface InlineResponse2002ReturnAddress
*/
export interface InlineResponse2002ReturnAddress {
/**
* Address details
* @type {string}
* @memberof InlineResponse2002ReturnAddress
*/
addressLine1: string;
/**
* Address details continuation
* @type {string}
* @memberof InlineResponse2002ReturnAddress
*/
addressLine2?: string;
/**
* City name
* @type {string}
* @memberof InlineResponse2002ReturnAddress
*/
city: string;
/**
* State Code
* @type {string}
* @memberof InlineResponse2002ReturnAddress
*/
stateCode: string;
/**
* Country code
* @type {string}
* @memberof InlineResponse2002ReturnAddress
*/
countryCode: string;
/**
* Zip code
* @type {string}
* @memberof InlineResponse2002ReturnAddress
*/
postalCode: string;
}
/**
* The address to which sellers need to inbound items
* @export
* @interface InlineResponse2002ShipToAddress
*/
export interface InlineResponse2002ShipToAddress {
/**
* Facility name
* @type {string}
* @memberof InlineResponse2002ShipToAddress
*/
fcName?: string;
/**
* Address details
* @type {string}
* @memberof InlineResponse2002ShipToAddress
*/
addressLine1?: string;
/**
* Address details continuation
* @type {string}
* @memberof InlineResponse2002ShipToAddress
*/
addressLine2?: string;
/**
* City name
* @type {string}
* @memberof InlineResponse2002ShipToAddress
*/
city?: string;
/**
* State code
* @type {string}
* @memberof InlineResponse2002ShipToAddress
*/
stateCode?: string;
/**
* Country code
* @type {string}
* @memberof InlineResponse2002ShipToAddress
*/
countryCode?: string;
/**
* Zip code
* @type {string}
* @memberof InlineResponse2002ShipToAddress
*/
postalCode?: string;
}
/**
*
* @export
* @interface InlineResponse2003
*/
export interface InlineResponse2003 {
/**
*
* @type {string}
* @memberof InlineResponse2003
*/
status?: string;
/**
* response payload
* @type {Array<InlineResponse2003Payload>}
* @memberof InlineResponse2003
*/
payload?: Array<InlineResponse2003Payload>;
}
/**
* response payload
* @export
* @interface InlineResponse2003Payload
*/
export interface InlineResponse2003Payload {
/**
* Unique ID identifying each shipment
* @type {string}
* @memberof InlineResponse2003Payload
*/
shipmentId?: string;
/**
*
* @type {InlineResponse2002ShipToAddress}
* @memberof InlineResponse2003Payload
*/
shipToAddress?: InlineResponse2002ShipToAddress;
/**
* The items which needs to be send in the shipment
* @type {Array<InlineResponse2003ShipmentItems>}
* @memberof InlineResponse2003Payload
*/
shipmentItems?: Array<InlineResponse2003ShipmentItems>;
/**
* expected delivery date for inbounding shipment. Can be different from provided in the rquest based on network capacity
* @type {string}
* @memberof InlineResponse2003Payload
*/
expectedDeliveryDate?: string;
}
/**
* The items which needs to be send in the shipment
* @export
* @interface InlineResponse2003ShipmentItems
*/
export interface InlineResponse2003ShipmentItems {
/**
* Seller Item ID
* @type {string}
* @memberof InlineResponse2003ShipmentItems
*/
vendorSku?: string;
/**
* Total number of sellable units
* @type {number}
* @memberof InlineResponse2003ShipmentItems
*/
itemQty?: number;
}
/**
*
* @export
* @interface InlineResponse2004
*/
export interface InlineResponse2004 {
/**
*
* @type {string}
* @memberof InlineResponse2004
*/
shipmentId?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004
*/
quoteId?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004
*/
estimatedDeliveryDateTime?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004
*/
quoteCreationDate?: string;
/**
*
* @type {InlineResponse2004Carrier}
* @memberof InlineResponse2004
*/
carrier?: InlineResponse2004Carrier;
/**
*
* @type {InlineResponse2004RateQuote}
* @memberof InlineResponse2004
*/
rateQuote?: InlineResponse2004RateQuote;
/**
*
* @type {Array<InlineResponse2004ShipmentPackages>}
* @memberof InlineResponse2004
*/
shipmentPackages?: Array<InlineResponse2004ShipmentPackages>;
/**
*
* @type {InlineResponse2004OriginLocation}
* @memberof InlineResponse2004
*/
originLocation?: InlineResponse2004OriginLocation;
/**
*
* @type {InlineResponse2004OriginLocation}
* @memberof InlineResponse2004
*/
destinationLocation?: InlineResponse2004OriginLocation;
/**
*
* @type {InlineResponse2004ReturnLocation}
* @memberof InlineResponse2004
*/
returnLocation?: InlineResponse2004ReturnLocation;
}
/**
*
* @export
* @interface InlineResponse2004Carrier
*/
export interface InlineResponse2004Carrier {
/**
*
* @type {string}
* @memberof InlineResponse2004Carrier
*/
carrierId?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004Carrier
*/
carrierName?: string;
}
/**
*
* @export
* @interface InlineResponse2004LabelInformation
*/
export interface InlineResponse2004LabelInformation {
/**
*
* @type {string}
* @memberof InlineResponse2004LabelInformation
*/
labelData?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004LabelInformation
*/
labelFormat?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004LabelInformation
*/
trackingCode?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004LabelInformation
*/
referenceTrackingCode?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004LabelInformation
*/
epTrackerId?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004LabelInformation
*/
shipmentId?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004LabelInformation
*/
packageAsn?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004LabelInformation
*/
masterTrackingCode?: string;
/**
*
* @type {boolean}
* @memberof InlineResponse2004LabelInformation
*/
master?: boolean;
}
/**
*
* @export
* @interface InlineResponse2004OriginLocation
*/
export interface InlineResponse2004OriginLocation {
/**
*
* @type {string}
* @memberof InlineResponse2004OriginLocation
*/
locationName: string;
/**
*
* @type {InlineResponse2004OriginLocationAddress}
* @memberof InlineResponse2004OriginLocation
*/
address: InlineResponse2004OriginLocationAddress;
/**
*
* @type {string}
* @memberof InlineResponse2004OriginLocation
*/
locationId?: string;
}
/**
*
* @export
* @interface InlineResponse2004OriginLocationAddress
*/
export interface InlineResponse2004OriginLocationAddress {
/**
*
* @type {string}
* @memberof InlineResponse2004OriginLocationAddress
*/
addressLine1: string;
/**
*
* @type {string}
* @memberof InlineResponse2004OriginLocationAddress
*/
addressLine2?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004OriginLocationAddress
*/
city: string;
/**
*
* @type {string}
* @memberof InlineResponse2004OriginLocationAddress
*/
stateCode: string;
/**
*
* @type {string}
* @memberof InlineResponse2004OriginLocationAddress
*/
countryCode: string;
/**
*
* @type {string}
* @memberof InlineResponse2004OriginLocationAddress
*/
postalCode: string;
/**
*
* @type {string}
* @memberof InlineResponse2004OriginLocationAddress
*/
phone?: string;
}
/**
*
* @export
* @interface InlineResponse2004RateQuote
*/
export interface InlineResponse2004RateQuote {
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
quoteId?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
estimatedDeliveryDateTime?: string;
/**
*
* @type {InlineResponse2004Carrier}
* @memberof InlineResponse2004RateQuote
*/
carrier?: InlineResponse2004Carrier;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
currency?: string;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
discountCharge?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
netCharge?: number;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
surchargeType?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
surchargeValue?: string;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
totalBillingWeight?: number;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
status?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
transitDays?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
effectiveDate?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
expiryDate?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
mode?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
sellerFreightClassCode?: string;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
freightCharge?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
fuelCharge?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
totalWeight?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
totalVolume?: number;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
equipmentTypeCode?: string;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
serviceCode?: string;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
numberOfPallets?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
nominalCharge?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
assessorialCharge?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
serviceCharge?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
minimumCharge?: number;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
declaredValue?: string;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
mixedSKUs?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004RateQuote
*/
singleSKUs?: number;
/**
*
* @type {string}
* @memberof InlineResponse2004RateQuote
*/
freightReadyDate?: string;
}
/**
*
* @export
* @interface InlineResponse2004ReturnLocation
*/
export interface InlineResponse2004ReturnLocation {
/**
*
* @type {string}
* @memberof InlineResponse2004ReturnLocation
*/
locationName: string;
/**
*
* @type {InlineResponse2004OriginLocationAddress}
* @memberof InlineResponse2004ReturnLocation
*/
address: InlineResponse2004OriginLocationAddress;
}
/**
*
* @export
* @interface InlineResponse2004ShipmentPackages
*/
export interface InlineResponse2004ShipmentPackages {
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
packageSequenceNumber: number;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
weight: number;
/**
*
* @type {string}
* @memberof InlineResponse2004ShipmentPackages
*/
weightUOM: string;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
length: number;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
height: number;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
width: number;
/**
*
* @type {string}
* @memberof InlineResponse2004ShipmentPackages
*/
lengthUOM: string;
/**
*
* @type {InlineResponse2004LabelInformation}
* @memberof InlineResponse2004ShipmentPackages
*/
labelInformation?: InlineResponse2004LabelInformation;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
billingWeight?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
netCharge?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
nominalCharge?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
assessorialCharge?: number;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
serviceCharge?: number;
/**
*
* @type {string}
* @memberof InlineResponse2004ShipmentPackages
*/
packageType?: string;
/**
*
* @type {number}
* @memberof InlineResponse2004ShipmentPackages
*/
noOfPackages?: number;
/**
*
* @type {boolean}
* @memberof InlineResponse2004ShipmentPackages
*/
stackable?: boolean;
}
/**
*
* @export
* @interface InlineResponse2005
*/
export interface InlineResponse2005 {
/**
*
* @type {string}
* @memberof InlineResponse2005
*/
shipmentId?: string;
/**
*
* @type {string}
* @memberof InlineResponse2005
*/
shipmentNumber?: string;
/**
*
* @type {Array<InlineResponse2004RateQuote>}
* @memberof InlineResponse2005
*/
rateQuotes?: Array<InlineResponse2004RateQuote>;
}
/**
*
* @export
* @interface InlineResponse2006
*/
export interface InlineResponse2006 {
/**
* A unique ID, returned from the Bulk Upload API, used for tracking the feed file
* @type {string}
* @memberof InlineResponse2006
*/
feedId?: string;
/**
*
* @type {object}
* @memberof InlineResponse2006
*/
additionalAttributes?: object | null;
/**
*
* @type {object}
* @memberof InlineResponse2006
*/
errors?: object | null;
}
/**
*
* @export
* @interface InlineResponse2007
*/
export interface InlineResponse2007 {
/**
*
* @type {InlineResponse2007Headers}
* @memberof InlineResponse2007
*/
headers?: InlineResponse2007Headers;
/**
*
* @type {InlineResponse2007Payload}
* @memberof InlineResponse2007
*/
payload?: InlineResponse2007Payload;
}
/**
* Headers Section
* @export
* @interface InlineResponse2007Headers
*/
export interface InlineResponse2007Headers {
/**
* Number of records to be returned
* @type {number}
* @memberof InlineResponse2007Headers
*/
limit?: number;
/**
* Number of records you wish to skip before selecting records
* @type {number}
* @memberof InlineResponse2007Headers
*/
offset?: number;
/**
* Total Count of records this request yields
* @type {number}
* @memberof InlineResponse2007Headers
*/
totalCount?: number;
}
/**
* Payload Section
* @export
* @interface InlineResponse2007Payload
*/
export interface InlineResponse2007Payload {
/**
* GTIN
* @type {string}
* @memberof InlineResponse2007Payload
*/
gtin?: string;
/**
* Vendor SKU
* @type {string}
* @memberof InlineResponse2007Payload
*/
vendorSku?: string;
/**
* Product Name
* @type {string}
* @memberof InlineResponse2007Payload
*/
productName?: string;
/**
* Inventory Log records
* @type {Array<InlineResponse2007PayloadInventoryLog>}
* @memberof InlineResponse2007Payload
*/
inventoryLog?: Array<InlineResponse2007PayloadInventoryLog>;
}
/**
* Inventory Log records
* @export
* @interface InlineResponse2007PayloadInventoryLog
*/
export interface InlineResponse2007PayloadInventoryLog {
/**
* Unique Event Id
* @type {string}
* @memberof InlineResponse2007PayloadInventoryLog
*/
id?: string;
/**
* Fulfillment Center Short Name
* @type {string}
* @memberof InlineResponse2007PayloadInventoryLog
*/
fcName?: string;
/**
* Number of inventory units changed +/- in FC as a result of this transaction
* @type {number}
* @memberof InlineResponse2007PayloadInventoryLog
*/
changedUnits?: number;
/**
* Timestamp of transaction
* @type {string}
* @memberof InlineResponse2007PayloadInventoryLog
*/
transactionTime?: string;
/**
* Transaction Location
* @type {string}
* @memberof InlineResponse2007PayloadInventoryLog
*/
transactionLocation?: string;
/**
* Transaction Reason Code
* @type {string}
* @memberof InlineResponse2007PayloadInventoryLog
*/
transactionReasonCode?: string;
/**
* Transaction Reason Description
* @type {string}
* @memberof InlineResponse2007PayloadInventoryLog
*/
transactionReasonDesc?: string;
/**
* Transaction Type
* @type {string}
* @memberof InlineResponse2007PayloadInventoryLog
*/
transactionType?: string;
/**
* Shipment Id
* @type {string}
* @memberof InlineResponse2007PayloadInventoryLog
*/
shipmentId?: string;
}
/**
*
* @export
* @interface InlineResponse2008
*/
export interface InlineResponse2008 {
/**
*
* @type {InlineResponse2002Headers}
* @memberof InlineResponse2008
*/
headers?: InlineResponse2002Headers;
/**
* response payload
* @type {Array<InlineResponse2008Payload>}
* @memberof InlineResponse2008
*/
payload?: Array<Inlin