@sp-api-sdk/fulfillment-inbound-api-2024-03-20
Version:
The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon's fulfillment network. The API has interoperability with the Send-to-Amazon user inte
1,428 lines (1,357 loc) • 297 kB
TypeScript
import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
import * as axios from 'axios';
import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
interface AWSv4Configuration {
options?: {
region?: string;
service?: string;
};
credentials?: {
accessKeyId?: string;
secretAccessKey?: string;
sessionToken?: string;
};
}
interface ConfigurationParameters {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
username?: string;
password?: string;
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
awsv4?: AWSv4Configuration;
basePath?: string;
serverIndex?: number;
baseOptions?: any;
formDataCtor?: new () => any;
}
declare class Configuration {
/**
* parameter for apiKey security
* @param name security name
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for basic security
*/
username?: string;
/**
* parameter for basic security
*/
password?: string;
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/**
* parameter for aws4 signature security
* @param {Object} AWS4Signature - AWS4 Signature security
* @param {string} options.region - aws region
* @param {string} options.service - name of the service.
* @param {string} credentials.accessKeyId - aws access key id
* @param {string} credentials.secretAccessKey - aws access key
* @param {string} credentials.sessionToken - aws session token
* @memberof Configuration
*/
awsv4?: AWSv4Configuration;
/**
* override base path
*/
basePath?: string;
/**
* override server index
*/
serverIndex?: number;
/**
* base options for axios calls
*/
baseOptions?: any;
/**
* The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that
* do not support the FormData class can still run the generated client.
*
* @type {new () => FormData}
*/
formDataCtor?: new () => any;
constructor(param?: ConfigurationParameters);
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
isJsonMime(mime: string): boolean;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
interface RequestArgs {
url: string;
options: RawAxiosRequestConfig;
}
declare class BaseAPI {
protected basePath: string;
protected axios: AxiosInstance;
protected configuration: Configuration | undefined;
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Specific details to identify a place.
*/
interface Address {
/**
* Street address information.
*/
'addressLine1': string;
/**
* Additional street address information.
*/
'addressLine2'?: string;
/**
* The city.
*/
'city': string;
/**
* The name of the business.
*/
'companyName'?: string;
/**
* The country code in two-character ISO 3166-1 alpha-2 format.
*/
'countryCode': string;
/**
* The district or county.
*/
'districtOrCounty'?: string;
/**
* The email address.
*/
'email'?: string;
/**
* The name of the individual who is the primary contact.
*/
'name': string;
/**
* The phone number.
*/
'phoneNumber'?: string;
/**
* The postal code.
*/
'postalCode': string;
/**
* The state or province code.
*/
'stateOrProvinceCode'?: string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Specific details to identify a place.
*/
interface AddressInput {
/**
* Street address information.
*/
'addressLine1': string;
/**
* Additional street address information.
*/
'addressLine2'?: string;
/**
* The city.
*/
'city': string;
/**
* The name of the business.
*/
'companyName'?: string;
/**
* The country code in two-character ISO 3166-1 alpha-2 format.
*/
'countryCode': string;
/**
* The district or county.
*/
'districtOrCounty'?: string;
/**
* The email address.
*/
'email'?: string;
/**
* The name of the individual who is the primary contact.
*/
'name': string;
/**
* The phone number.
*/
'phoneNumber': string;
/**
* The postal code.
*/
'postalCode': string;
/**
* The state or province code.
*/
'stateOrProvinceCode'?: string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* A constraint that applies to all owners. If no constraint is specified, defer to any individual owner constraints.
*/
declare const AllOwnersConstraint: {
readonly MustMatch: "MUST_MATCH";
};
type AllOwnersConstraint = typeof AllOwnersConstraint[keyof typeof AllOwnersConstraint];
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* An appointment slot time with start and end.
*/
interface AppointmentSlotTime {
/**
* The end timestamp of the appointment in UTC.
*/
'endTime': string;
/**
* The start timestamp of the appointment in UTC.
*/
'startTime': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The fulfillment center appointment slot for the transportation option.
*/
interface AppointmentSlot {
/**
* An identifier to a self-ship appointment slot.
*/
'slotId': string;
'slotTime': AppointmentSlotTime;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Indication of how box content is meant to be provided.
*/
declare const BoxContentInformationSource: {
readonly BoxContentProvided: "BOX_CONTENT_PROVIDED";
readonly ManualProcess: "MANUAL_PROCESS";
readonly Barcode2D: "BARCODE_2D";
};
type BoxContentInformationSource = typeof BoxContentInformationSource[keyof typeof BoxContentInformationSource];
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Unit of linear measure.
*/
declare const UnitOfMeasurement: {
readonly In: "IN";
readonly Cm: "CM";
};
type UnitOfMeasurement = typeof UnitOfMeasurement[keyof typeof UnitOfMeasurement];
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Measurement of a package\'s dimensions.
*/
interface Dimensions {
/**
* The height of a package.
*/
'height': number;
/**
* The length of a package.
*/
'length': number;
'unitOfMeasurement': UnitOfMeasurement;
/**
* The width of a package.
*/
'width': number;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The type and amount of currency.
*/
interface Currency {
/**
* Decimal value of the currency.
*/
'amount': number;
/**
* ISO 4217 standard of a currency code.
*/
'code': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Information pertaining to the preparation of inbound goods.
*/
interface PrepInstruction {
'fee'?: Currency;
/**
* In some situations, special preparations are required for items and this field reflects the owner of the preparations. Options include `AMAZON`, `SELLER` or `NONE`.
*/
'prepOwner'?: string;
/**
* Type of preparation that should be done. Possible values: `ITEM_LABELING`, `ITEM_BUBBLEWRAP`, `ITEM_POLYBAGGING`, `ITEM_TAPING`, `ITEM_BLACK_SHRINKWRAP`, `ITEM_HANG_GARMENT`, `ITEM_BOXING`, `ITEM_SETCREAT`, `ITEM_RMOVHANG`, `ITEM_SUFFOSTK`, `ITEM_CAP_SEALING`, `ITEM_DEBUNDLE`, `ITEM_SETSTK`, `ITEM_SIOC`, `ITEM_NO_PREP`, `ADULT`, `BABY`, `TEXTILE`, `HANGER`, `FRAGILE`, `LIQUID`, `SHARP`, `SMALL`, `PERFORATED`, `GRANULAR`, `SET`, `FC_PROVIDED`, `UNKNOWN`, `NONE`.
*/
'prepType'?: string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Information associated with a single SKU in the seller\'s catalog.
*/
interface Item {
/**
* The Amazon Standard Identification Number (ASIN) of the item.
*/
'asin': string;
/**
* The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern`YYYY-MM-DD`. The same MSKU with different expiration dates cannot go into the same box.
*/
'expiration'?: string;
/**
* A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.
*/
'fnsku': string;
/**
* Specifies who will label the items. Options include `AMAZON`, `SELLER`, and `NONE`. `AMAZON` is not an accepted value in the US marketplace.
*/
'labelOwner': string;
/**
* The manufacturing lot code.
*/
'manufacturingLotCode'?: string;
/**
* The merchant-defined SKU ID.
*/
'msku': string;
/**
* Special preparations that are required for an item.
*/
'prepInstructions': Array<PrepInstruction>;
/**
* The number of the specified MSKU.
*/
'quantity': number;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Representation of a location used within the inbounding experience.
*/
interface Region {
/**
* ISO 3166 standard alpha-2 country code.
*/
'countryCode'?: string;
/**
* State.
*/
'state'?: string;
/**
* An identifier for a warehouse, such as a FC, IXD, upstream storage.
*/
'warehouseId'?: string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Unit of the weight being measured.
*/
declare const UnitOfWeight: {
readonly Lb: "LB";
readonly Kg: "KG";
};
type UnitOfWeight = typeof UnitOfWeight[keyof typeof UnitOfWeight];
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The weight of a package.
*/
interface Weight {
'unit': UnitOfWeight;
/**
* Value of a weight.
*/
'value': number;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Contains information about a box that is used in the inbound plan. The box is a container that holds multiple items.
*/
interface Box {
/**
* The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which is generated after transportation has been confirmed) and the index of the box.
*/
'boxId'?: string;
'contentInformationSource'?: BoxContentInformationSource;
'destinationRegion'?: Region;
'dimensions'?: Dimensions;
/**
* The external identifier for this container / box.
*/
'externalContainerIdentifier'?: string;
/**
* Type of the external identifier used. Can be: `AMAZON`, `SSCC`.
*/
'externalContainerIdentifierType'?: string;
/**
* Items contained within the box.
*/
'items'?: Array<Item>;
/**
* Primary key to uniquely identify a Package (Box or Pallet).
*/
'packageId': string;
/**
* The number of containers where all other properties like weight or dimensions are identical.
*/
'quantity'?: number;
/**
* Template name of the box.
*/
'templateName'?: string;
'weight'?: Weight;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Specifies who will label the items. Options include `AMAZON`, `SELLER` or `NONE`.
*/
declare const LabelOwner: {
readonly Amazon: "AMAZON";
readonly Seller: "SELLER";
readonly None: "NONE";
};
type LabelOwner = typeof LabelOwner[keyof typeof LabelOwner];
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The owner of the preparations, if special preparations are required.
*/
declare const PrepOwner: {
readonly Amazon: "AMAZON";
readonly Seller: "SELLER";
readonly None: "NONE";
};
type PrepOwner = typeof PrepOwner[keyof typeof PrepOwner];
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Defines an item\'s input parameters.
*/
interface ItemInput {
/**
* The expiration date of the MSKU. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `YYYY-MM-DD`. Items with the same MSKU but different expiration dates cannot go into the same box.
*/
'expiration'?: string;
'labelOwner': LabelOwner;
/**
* The manufacturing lot code.
*/
'manufacturingLotCode'?: string;
/**
* The merchant SKU, a merchant-supplied identifier of a specific SKU.
*/
'msku': string;
'prepOwner': PrepOwner;
/**
* The number of units of the specified MSKU that will be shipped.
*/
'quantity': number;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Input information for a given box.
*/
interface BoxInput {
'contentInformationSource': BoxContentInformationSource;
'dimensions': Dimensions;
/**
* The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`.
*/
'items'?: Array<ItemInput>;
/**
* The number of containers where all other properties like weight or dimensions are identical.
*/
'quantity': number;
'weight': Weight;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The range of weights that are allowed for a package.
*/
interface WeightRange {
/**
* Maximum allowed weight.
*/
'maximum': number;
/**
* Minimum allowed weight.
*/
'minimum': number;
'unit': UnitOfWeight;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The requirements for a box in the packing option.
*/
interface BoxRequirements {
'weight': WeightRange;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Input information for updating a box
*/
interface BoxUpdateInput {
'contentInformationSource': BoxContentInformationSource;
'dimensions': Dimensions;
/**
* The items and their quantity in the box. This must be empty if the box `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`.
*/
'items'?: Array<ItemInput>;
/**
* Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not provided will be treated as to-be-removed
*/
'packageId'?: string;
/**
* The number of containers where all other properties like weight or dimensions are identical.
*/
'quantity': number;
'weight': Weight;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `cancelInboundPlan` response.
*/
interface CancelInboundPlanResponse {
/**
* UUID for the given operation.
*/
'operationId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Reason for cancelling or rescheduling a self-ship appointment.
*/
declare const ReasonComment: {
readonly AppointmentRequestedByMistake: "APPOINTMENT_REQUESTED_BY_MISTAKE";
readonly VehicleDelay: "VEHICLE_DELAY";
readonly SlotNotSuitable: "SLOT_NOT_SUITABLE";
readonly OutsideCarrierBusinessHours: "OUTSIDE_CARRIER_BUSINESS_HOURS";
readonly UnfavourableExternalConditions: "UNFAVOURABLE_EXTERNAL_CONDITIONS";
readonly ProcurementDelay: "PROCUREMENT_DELAY";
readonly ShippingPlanChanged: "SHIPPING_PLAN_CHANGED";
readonly IncreasedQuantity: "INCREASED_QUANTITY";
readonly Other: "OTHER";
};
type ReasonComment = typeof ReasonComment[keyof typeof ReasonComment];
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `cancelSelfShipAppointment` request.
*/
interface CancelSelfShipAppointmentRequest {
'reasonComment'?: ReasonComment;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `CancelSelfShipAppointment` response.
*/
interface CancelSelfShipAppointmentResponse {
/**
* UUID for the given operation.
*/
'operationId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The carrier for the inbound shipment.
*/
interface Carrier {
/**
* The carrier code. For example, USPS or DHLEX.
*/
'alphaCode'?: string;
/**
* The name of the carrier.
*/
'name'?: string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an indicator for when a transportation carrier is accepting shipments to be picked up.
*/
interface CarrierAppointment {
/**
* The end timestamp of the appointment in UTC.
*/
'endTime': string;
/**
* The start timestamp of the appointment in UTC.
*/
'startTime': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Contains the type and rate of tax.
*/
interface TaxRate {
/**
* Rate of cess tax.
*/
'cessRate'?: number;
/**
* Rate of gst tax.
*/
'gstRate'?: number;
/**
* Type of tax. Possible values: `CGST`, `SGST`, `IGST`, `TOTAL_TAX`.
*/
'taxType'?: string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Information used to determine the tax compliance.
*/
interface TaxDetails {
'declaredValue'?: Currency;
/**
* Harmonized System of Nomenclature code.
*/
'hsnCode'?: string;
/**
* List of tax rates.
*/
'taxRates'?: Array<TaxRate>;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Contains item identifiers and related tax information.
*/
interface ComplianceDetail {
/**
* The Amazon Standard Identification Number, which identifies the detail page identifier.
*/
'asin'?: string;
/**
* The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and condition.
*/
'fnsku'?: string;
/**
* The merchant SKU, a merchant-supplied identifier for a specific SKU.
*/
'msku'?: string;
'taxDetails'?: TaxDetails;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `confirmDeliveryWindowOptions` response.
*/
interface ConfirmDeliveryWindowOptionsResponse {
/**
* UUID for the given operation.
*/
'operationId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `confirmPackingOption` response.
*/
interface ConfirmPackingOptionResponse {
/**
* UUID for the given operation.
*/
'operationId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `confirmPlacementOption` response.
*/
interface ConfirmPlacementOptionResponse {
/**
* UUID for the given operation.
*/
'operationId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `confirmShipmentContentUpdatePreview` response.
*/
interface ConfirmShipmentContentUpdatePreviewResponse {
/**
* UUID for the given operation.
*/
'operationId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The seller\'s contact information.
*/
interface ContactInformation {
/**
* The email address.
*/
'email'?: string;
/**
* The contact\'s name.
*/
'name': string;
/**
* The phone number.
*/
'phoneNumber': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The transportation option selected to confirm.
*/
interface TransportationSelection {
'contactInformation'?: ContactInformation;
/**
* Shipment ID that the transportation Option is for.
*/
'shipmentId': string;
/**
* Transportation option being selected for the provided shipment.
*/
'transportationOptionId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `confirmTransportationOptions` request.
*/
interface ConfirmTransportationOptionsRequest {
/**
* Information needed to confirm one of the available transportation options.
*/
'transportationSelections': Array<TransportationSelection>;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `confirmTransportationOptions` response.
*/
interface ConfirmTransportationOptionsResponse {
/**
* UUID for the given operation.
*/
'operationId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Objects that were included in the update request.
*/
interface RequestedUpdates {
/**
* A list of boxes that will be present in the shipment after the update.
*/
'boxes'?: Array<BoxUpdateInput>;
/**
* A list of all items that will be present in the shipment after the update.
*/
'items'?: Array<ItemInput>;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The estimated shipping cost associated with the transportation option.
*/
interface Quote {
'cost': Currency;
/**
* The time at which this transportation option quote expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
*/
'expiration'?: string;
/**
* Voidable until timestamp.
*/
'voidableUntil'?: string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Contains information pertaining to a transportation option and the related carrier.
*/
interface TransportationOption {
'carrier': Carrier;
'carrierAppointment'?: CarrierAppointment;
/**
* Identifies a list of preconditions for confirming the transportation option.
*/
'preconditions': Array<string>;
'quote'?: Quote;
/**
* Identifier of a shipment. A shipment contains the boxes and units being inbounded.
*/
'shipmentId': string;
/**
* Mode of shipment transportation that this option will provide. Possible values: `GROUND_SMALL_PARCEL`, `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`, `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`.
*/
'shippingMode': string;
/**
* Shipping program for the option. Possible values: `AMAZON_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`.
*/
'shippingSolution': string;
/**
* Identifier of a transportation option. A transportation option represent one option for how to send a shipment.
*/
'transportationOptionId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Preview of the changes that will be applied to the shipment.
*/
interface ContentUpdatePreview {
/**
* Identifier of a content update preview.
*/
'contentUpdatePreviewId': string;
/**
* The time at which the content update expires. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern `yyyy-MM-ddTHH:mm:ss.sssZ`.
*/
'expiration': string;
'requestedUpdates': RequestedUpdates;
'transportationOption': TransportationOption;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `createInboundPlan` request.
*/
interface CreateInboundPlanRequest {
/**
* Marketplaces where the items need to be shipped to. Currently only one marketplace can be selected in this request.
*/
'destinationMarketplaces': Array<string>;
/**
* Items included in this plan.
*/
'items': Array<ItemInput>;
/**
* Name for the Inbound Plan. If one isn\'t provided, a default name will be provided.
*/
'name'?: string;
'sourceAddress': AddressInput;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The `createInboundPlan` response.
*/
interface CreateInboundPlanResponse {
/**
* Identifier of an inbound plan.
*/
'inboundPlanId': string;
/**
* UUID for the given operation.
*/
'operationId': string;
}
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The page type to use to print the labels. Possible values: \'A4_21\', \'A4_24\', \'A4_24_64x33\', \'A4_24_66x35\', \'A4_24_70x36\', \'A4_24_70x37\', \'A4_24i\', \'A4_27\', \'A4_40_52x29\', \'A4_44_48x25\', \'Letter_30\'.
*/
declare const ItemLabelPageType: {
readonly A421: "A4_21";
readonly A424: "A4_24";
readonly A42464x33: "A4_24_64x33";
readonly A42466x35: "A4_24_66x35";
readonly A42470x36: "A4_24_70x36";
readonly A42470x37: "A4_24_70x37";
readonly A424i: "A4_24i";
readonly A427: "A4_27";
readonly A44052x29: "A4_40_52x29";
readonly A44448x25: "A4_44_48x25";
readonly Letter30: "Letter_30";
};
type ItemLabelPageType = typeof ItemLabelPageType[keyof typeof ItemLabelPageType];
/**
* The Selling Partner API for FBA inbound operations.
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
*
* The version of the OpenAPI document: 2024-03-20
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Indicates the type of print type for a given label.
*/
declare const LabelPrintType: {
readonly StandardFormat: "STANDARD_FORMAT";
readonly ThermalPrinting: "THERMAL_PRIN