/** * Selling Partner API for Direct Fulfillment Shipping * Use the Selling Partner API for Direct Fulfillment Shipping to access a direct fulfillment vendor\'s shipping data. * * The version of the OpenAPI document: 2021-12-28 * * * 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'; /** * Address of the party. * @export * @interface Address */ export interface Address { /** * The name of the person, business or institution at that address. * @type {string} * @memberof Address */ name: string; /** * First line of the address. * @type {string} * @memberof Address */ addressLine1: string; /** * Additional street address information, if required. * @type {string} * @memberof Address */ addressLine2?: string; /** * Additional street address information, if required. * @type {string} * @memberof Address */ addressLine3?: string; /** * The city where the person, business or institution is located. * @type {string} * @memberof Address */ city?: string; /** * The county where person, business or institution is located. * @type {string} * @memberof Address */ county?: string; /** * The district where person, business or institution is located. * @type {string} * @memberof Address */ district?: string; /** * The state or region where person, business or institution is located. * @type {string} * @memberof Address */ stateOrRegion?: string; /** * The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation. * @type {string} * @memberof Address */ postalCode?: string; /** * The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format. * @type {string} * @memberof Address */ countryCode: string; /** * The phone number of the person, business or institution located at that address. * @type {string} * @memberof Address */ phone?: string; } /** * The unique carrier code for the carrier for whom container labels are requested. * @export * @enum {string} */ export declare enum CarrierId { Swa = "SWA" } /** * A container used for shipping and packing items. * @export * @interface Container */ export interface Container { /** * The type of container. * @type {string} * @memberof Container */ containerType: ContainerContainerTypeEnum | 'Carton' | 'Pallet'; /** * The container identifier. * @type {string} * @memberof Container */ containerIdentifier: string; /** * The tracking number. * @type {string} * @memberof Container */ trackingNumber?: string; /** * The manifest identifier. * @type {string} * @memberof Container */ manifestId?: string; /** * The date of the manifest. * @type {string} * @memberof Container */ manifestDate?: string; /** * The shipment method. This property is required when calling the `submitShipmentConfirmations` operation, and optional otherwise. * @type {string} * @memberof Container */ shipMethod?: string; /** * SCAC code required for NA VOC vendors only. * @type {string} * @memberof Container */ scacCode?: string; /** * Carrier required for EU VOC vendors only. * @type {string} * @memberof Container */ carrier?: string; /** * An integer that must be submitted for multi-box shipments only, where one item may come in separate packages. * @type {number} * @memberof Container */ containerSequenceNumber?: number; /** * * @type {Dimensions} * @memberof Container */ dimensions?: Dimensions; /** * * @type {Weight} * @memberof Container */ weight: Weight; /** * A list of packed items. * @type {Array} * @memberof Container */ packedItems: Array; } /** * @export * @enum {string} */ export declare enum ContainerContainerTypeEnum { Carton = "Carton", Pallet = "Pallet" } /** * The details of the container label. * @export * @interface ContainerLabel */ export interface ContainerLabel { /** * The container (pallet) tracking identifier from the shipping carrier. * @type {string} * @memberof ContainerLabel */ containerTrackingNumber?: string; /** * The `Base64encoded` string of the container label content. * @type {string} * @memberof ContainerLabel */ content: string; /** * * @type {ContainerLabelFormat} * @memberof ContainerLabel */ format: ContainerLabelFormat | 'PNG' | 'ZPL'; } /** * The format of the container label. * @export * @enum {string} */ export declare enum ContainerLabelFormat { Png = "PNG", Zpl = "ZPL" } /** * The request body schema for the `createContainerLabel` operation. * @export * @interface CreateContainerLabelRequest */ export interface CreateContainerLabelRequest { /** * * @type {PartyIdentification} * @memberof CreateContainerLabelRequest */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof CreateContainerLabelRequest */ shipFromParty: PartyIdentification; /** * * @type {CarrierId} * @memberof CreateContainerLabelRequest */ carrierId: CarrierId | 'SWA'; /** * The unique, vendor-provided identifier for the container. * @type {string} * @memberof CreateContainerLabelRequest */ vendorContainerId: string; /** * An array of package objects in a container. * @type {Array} * @memberof CreateContainerLabelRequest */ packages: Array; } /** * The response schema for the `createContainerLabel` operation. * @export * @interface CreateContainerLabelResponse */ export interface CreateContainerLabelResponse { /** * * @type {ContainerLabel} * @memberof CreateContainerLabelResponse */ containerLabel: ContainerLabel; } /** * The request body for the createShippingLabels operation. * @export * @interface CreateShippingLabelsRequest */ export interface CreateShippingLabelsRequest { /** * * @type {PartyIdentification} * @memberof CreateShippingLabelsRequest */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof CreateShippingLabelsRequest */ shipFromParty: PartyIdentification; /** * A list of the packages in this shipment. * @type {Array} * @memberof CreateShippingLabelsRequest */ containers?: Array; } /** * Represents a customer invoice associated with a purchase order. * @export * @interface CustomerInvoice */ export interface CustomerInvoice { /** * The purchase order number for this order. * @type {string} * @memberof CustomerInvoice */ purchaseOrderNumber: string; /** * The Base64encoded customer invoice. * @type {string} * @memberof CustomerInvoice */ content: string; } /** * Represents a list of customer invoices, potentially paginated. * @export * @interface CustomerInvoiceList */ export interface CustomerInvoiceList { /** * * @type {Pagination} * @memberof CustomerInvoiceList */ pagination?: Pagination; /** * Represents a customer invoice within the `CustomerInvoiceList`. * @type {Array} * @memberof CustomerInvoiceList */ customerInvoices?: Array; } /** * Physical dimensional measurements of a container. * @export * @interface Dimensions */ export interface Dimensions { /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\\\d*))(\\\\.\\\\d+)?([eE][+-]?\\\\d+)?$`. * @type {string} * @memberof Dimensions */ length: string; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\\\d*))(\\\\.\\\\d+)?([eE][+-]?\\\\d+)?$`. * @type {string} * @memberof Dimensions */ width: string; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\\\d*))(\\\\.\\\\d+)?([eE][+-]?\\\\d+)?$`. * @type {string} * @memberof Dimensions */ height: string; /** * The unit of measure for dimensions. * @type {string} * @memberof Dimensions */ unitOfMeasure: DimensionsUnitOfMeasureEnum | 'IN' | 'CM'; } /** * @export * @enum {string} */ export declare enum DimensionsUnitOfMeasureEnum { In = "IN", Cm = "CM" } /** * A list of error responses returned when a request is unsuccessful. * @export * @interface ErrorList */ export interface ErrorList { /** * An array of Error objects representing individual errors encountered during the request. * @type {Array} * @memberof ErrorList */ errors: Array; } /** * Details of the item being shipped. * @export * @interface Item */ export interface Item { /** * The sequence number of the item. The number must be the same as the order number of the item. * @type {number} * @memberof Item */ itemSequenceNumber: number; /** * The buyer\'s Amazon Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required. * @type {string} * @memberof Item */ buyerProductIdentifier?: string; /** * An item\'s product identifier, which the vendor selects. This identifier should be the same as the identifier, such as a SKU, in the purchase order. * @type {string} * @memberof Item */ vendorProductIdentifier?: string; /** * * @type {ItemQuantity} * @memberof Item */ shippedQuantity: ItemQuantity; } /** * Details of item quantity. * @export * @interface ItemQuantity */ export interface ItemQuantity { /** * Quantity of units shipped for a specific item at a shipment level. If the item is present only in certain packages or pallets within the shipment, please provide this at the appropriate package or pallet level. * @type {number} * @memberof ItemQuantity */ amount: number; /** * Unit of measure for the shipped quantity. * @type {string} * @memberof ItemQuantity */ unitOfMeasure: string; } /** * Details of the shipment label. * @export * @interface LabelData */ export interface LabelData { /** * Identifier for the package. The first package will be 001, the second 002, and so on. This number is used as a reference to refer to this package from the pallet level. * @type {string} * @memberof LabelData */ packageIdentifier?: string; /** * Package tracking identifier from the shipping carrier. * @type {string} * @memberof LabelData */ trackingNumber?: string; /** * Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation. * @type {string} * @memberof LabelData */ shipMethod?: string; /** * Shipping method name for internal reference. * @type {string} * @memberof LabelData */ shipMethodName?: string; /** * This field will contain the Base64encoded string of the shipment label content. * @type {string} * @memberof LabelData */ content: string; } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * The package that is associated with the container. * @export * @interface Package */ export interface Package { /** * The tracking number on the label of shipment package, that you can fetch from the `shippingLabels` response. You can also scan the bar code on the shipping label to get the tracking number. * @type {string} * @memberof Package */ packageTrackingNumber: string; } /** * An item that has been packed into a container for shipping. * @export * @interface PackedItem */ export interface PackedItem { /** * The sequence number of the item. The number must be the same as the order number of the item. * @type {number} * @memberof PackedItem */ itemSequenceNumber: number; /** * The buyer\'s Amazon Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required. * @type {string} * @memberof PackedItem */ buyerProductIdentifier?: string; /** * The piece number of the item in this container. This is required when the item is split across different containers. * @type {number} * @memberof PackedItem */ pieceNumber?: number; /** * An item\'s product identifier, which the vendor selects. This identifier should be the same as the identifier, such as a SKU, in the purchase order. * @type {string} * @memberof PackedItem */ vendorProductIdentifier?: string; /** * * @type {ItemQuantity} * @memberof PackedItem */ packedQuantity: ItemQuantity; } /** * Packing slip information. * @export * @interface PackingSlip */ export interface PackingSlip { /** * Purchase order number of the shipment that the packing slip is for. * @type {string} * @memberof PackingSlip */ purchaseOrderNumber: string; /** * A Base64encoded string of the packing slip PDF. * @type {string} * @memberof PackingSlip */ content: string; /** * The format of the file such as PDF, JPEG etc. * @type {string} * @memberof PackingSlip */ contentType?: PackingSlipContentTypeEnum | 'application/pdf'; } /** * @export * @enum {string} */ export declare enum PackingSlipContentTypeEnum { ApplicationPdf = "application/pdf" } /** * A list of packing slips. * @export * @interface PackingSlipList */ export interface PackingSlipList { /** * * @type {Pagination} * @memberof PackingSlipList */ pagination?: Pagination; /** * An array of packing slip objects. * @type {Array} * @memberof PackingSlipList */ packingSlips?: Array; } /** * The pagination elements required to retrieve the remaining data. * @export * @interface Pagination */ export interface Pagination { /** * Pagination occurs when a request produces a response that exceeds the `pageSize`. This means that the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. There is no `nextToken` in the pagination object on the last page. * @type {string} * @memberof Pagination */ nextToken?: string; } /** * The name, address, and tax details of a party. * @export * @interface PartyIdentification */ export interface PartyIdentification { /** * The identifier of the party. * @type {string} * @memberof PartyIdentification */ partyId: string; /** * * @type {Address} * @memberof PartyIdentification */ address?: Address; /** * The tax registration details of the party. * @type {Array} * @memberof PartyIdentification */ taxRegistrationDetails?: Array; } /** * Represents the confirmation details of a shipment, including the purchase order number and other shipment details. * @export * @interface ShipmentConfirmation */ export interface ShipmentConfirmation { /** * Purchase order number corresponding to the shipment. * @type {string} * @memberof ShipmentConfirmation */ purchaseOrderNumber: string; /** * * @type {ShipmentDetails} * @memberof ShipmentConfirmation */ shipmentDetails: ShipmentDetails; /** * * @type {PartyIdentification} * @memberof ShipmentConfirmation */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof ShipmentConfirmation */ shipFromParty: PartyIdentification; /** * Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package. * @type {Array} * @memberof ShipmentConfirmation */ items: Array; /** * Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package. * @type {Array} * @memberof ShipmentConfirmation */ containers?: Array; } /** * Details about a shipment. * @export * @interface ShipmentDetails */ export interface ShipmentDetails { /** * The date of the shipment\'s departure from vendor\'s location. Vendors send ASNs within 30 minutes of departure from their warehouse/distribution center or six hours prior to the appointment time at the Amazon destination warehouse. The shipped date mentioned in the shipment confirmation cannot be in the future. * @type {string} * @memberof ShipmentDetails */ shippedDate: string; /** * The shipment status. * @type {string} * @memberof ShipmentDetails */ shipmentStatus: ShipmentDetailsShipmentStatusEnum | 'SHIPPED' | 'FLOOR_DENIAL'; /** * Provide the priority of the shipment. * @type {boolean} * @memberof ShipmentDetails */ isPriorityShipment?: boolean; /** * The vendor order number is a unique identifier generated by a vendor for their reference. * @type {string} * @memberof ShipmentDetails */ vendorOrderNumber?: string; /** * The date on which the shipment is expected to reach the buyer\'s warehouse. The date is estimated based on the average transit time between the ship-from location and the destination. Usually, the exact appointment time is unknown when creating the shipment confirmation and is later provided by the buyer. * @type {string} * @memberof ShipmentDetails */ estimatedDeliveryDate?: string; } /** * @export * @enum {string} */ export declare enum ShipmentDetailsShipmentStatusEnum { Shipped = "SHIPPED", FloorDenial = "FLOOR_DENIAL" } /** * Details about the estimated delivery window. * @export * @interface ShipmentSchedule */ export interface ShipmentSchedule { /** * Date on which the shipment is expected to reach the customer delivery location. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00. * @type {string} * @memberof ShipmentSchedule */ estimatedDeliveryDateTime?: string; /** * The date and time at the start of the appointment window when the shipment is expected to be delivered. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00. * @type {string} * @memberof ShipmentSchedule */ apptWindowStartDateTime?: string; /** * The date and time at the end of the appointment window when the shipment is expected to be delivered. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00. * @type {string} * @memberof ShipmentSchedule */ apptWindowEndDateTime?: string; } /** * Represents an update to the status of a shipment. * @export * @interface ShipmentStatusUpdate */ export interface ShipmentStatusUpdate { /** * Purchase order number of the shipment for which to update the shipment status. * @type {string} * @memberof ShipmentStatusUpdate */ purchaseOrderNumber: string; /** * * @type {PartyIdentification} * @memberof ShipmentStatusUpdate */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof ShipmentStatusUpdate */ shipFromParty: PartyIdentification; /** * * @type {StatusUpdateDetails} * @memberof ShipmentStatusUpdate */ statusUpdateDetails: StatusUpdateDetails; } /** * Shipping label information for an order, including the purchase order number, selling party, ship from party, label format, and package details. * @export * @interface ShippingLabel */ export interface ShippingLabel { /** * This field will contain the Purchase Order Number for this order. * @type {string} * @memberof ShippingLabel */ purchaseOrderNumber: string; /** * * @type {PartyIdentification} * @memberof ShippingLabel */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof ShippingLabel */ shipFromParty: PartyIdentification; /** * Format of the label. * @type {string} * @memberof ShippingLabel */ labelFormat: ShippingLabelLabelFormatEnum | 'PNG' | 'ZPL'; /** * Provides the details of the packages in this shipment. * @type {Array} * @memberof ShippingLabel */ labelData: Array; } /** * @export * @enum {string} */ export declare enum ShippingLabelLabelFormatEnum { Png = "PNG", Zpl = "ZPL" } /** * Response payload with the list of shipping labels. * @export * @interface ShippingLabelList */ export interface ShippingLabelList { /** * * @type {Pagination} * @memberof ShippingLabelList */ pagination?: Pagination; /** * An array containing the details of the generated shipping labels. * @type {Array} * @memberof ShippingLabelList */ shippingLabels?: Array; } /** * Represents the request payload for creating a shipping label, containing the purchase order number, selling party, ship from party, and a list of containers or packages in the shipment. * @export * @interface ShippingLabelRequest */ export interface ShippingLabelRequest { /** * The purchase order number of the order for which to create a shipping label. * @type {string} * @memberof ShippingLabelRequest */ purchaseOrderNumber: string; /** * * @type {PartyIdentification} * @memberof ShippingLabelRequest */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof ShippingLabelRequest */ shipFromParty: PartyIdentification; /** * A list of the packages in this shipment. * @type {Array} * @memberof ShippingLabelRequest */ containers?: Array; } /** * Details for the shipment status update given by the vendor for the specific package. * @export * @interface StatusUpdateDetails */ export interface StatusUpdateDetails { /** * The shipment tracking number is required for every package and should match the `trackingNumber` sent for the shipment confirmation. * @type {string} * @memberof StatusUpdateDetails */ trackingNumber: string; /** * Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). * @type {string} * @memberof StatusUpdateDetails */ statusCode: string; /** * Provides a reason code for the status of the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation). * @type {string} * @memberof StatusUpdateDetails */ reasonCode: string; /** * The date and time when the shipment status was updated. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00. * @type {string} * @memberof StatusUpdateDetails */ statusDateTime: string; /** * * @type {Address} * @memberof StatusUpdateDetails */ statusLocationAddress: Address; /** * * @type {ShipmentSchedule} * @memberof StatusUpdateDetails */ shipmentSchedule?: ShipmentSchedule; } /** * The request schema for the submitShipmentConfirmations operation. * @export * @interface SubmitShipmentConfirmationsRequest */ export interface SubmitShipmentConfirmationsRequest { /** * Array of `ShipmentConfirmation` objects. Each `ShipmentConfirmation` object represents the confirmation details for a specific shipment. * @type {Array} * @memberof SubmitShipmentConfirmationsRequest */ shipmentConfirmations?: Array; } /** * The request schema for the `submitShipmentStatusUpdates` operation. * @export * @interface SubmitShipmentStatusUpdatesRequest */ export interface SubmitShipmentStatusUpdatesRequest { /** * Contains a list of one or more `ShipmentStatusUpdate` objects. Each `ShipmentStatusUpdate` object represents an update to the status of a specific shipment. * @type {Array} * @memberof SubmitShipmentStatusUpdatesRequest */ shipmentStatusUpdates?: Array; } /** * The request schema for the `submitShippingLabelRequest` operation. * @export * @interface SubmitShippingLabelsRequest */ export interface SubmitShippingLabelsRequest { /** * An array of shipping label requests to be processed. * @type {Array} * @memberof SubmitShippingLabelsRequest */ shippingLabelRequests?: Array; } /** * Tax registration details of the entity. * @export * @interface TaxRegistrationDetails */ export interface TaxRegistrationDetails { /** * Tax registration type for the entity. * @type {string} * @memberof TaxRegistrationDetails */ taxRegistrationType?: TaxRegistrationDetailsTaxRegistrationTypeEnum | 'VAT' | 'GST'; /** * Tax registration number for the party. For example, VAT ID. * @type {string} * @memberof TaxRegistrationDetails */ taxRegistrationNumber: string; /** * * @type {Address} * @memberof TaxRegistrationDetails */ taxRegistrationAddress?: Address; /** * Tax registration message that can be used for additional tax related details. * @type {string} * @memberof TaxRegistrationDetails */ taxRegistrationMessages?: string; } /** * @export * @enum {string} */ export declare enum TaxRegistrationDetailsTaxRegistrationTypeEnum { Vat = "VAT", Gst = "GST" } /** * Response containing the transaction ID. * @export * @interface TransactionReference */ export interface TransactionReference { /** * GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction. * @type {string} * @memberof TransactionReference */ transactionId?: string; } /** * The weight. * @export * @interface Weight */ export interface Weight { /** * The unit of measurement. * @type {string} * @memberof Weight */ unitOfMeasure: WeightUnitOfMeasureEnum | 'KG' | 'LB'; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
**Pattern** : `^-?(0|([1-9]\\\\d*))(\\\\.\\\\d+)?([eE][+-]?\\\\d+)?$`. * @type {string} * @memberof Weight */ value: string; } /** * @export * @enum {string} */ export declare enum WeightUnitOfMeasureEnum { Kg = "KG", Lb = "LB" } /** * CreateContainerLabelApi - axios parameter creator * @export */ export declare const CreateContainerLabelApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a container (pallet) label for the associated shipment package. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createContainerLabel * @param {CreateContainerLabelRequest} body Request body containing the container label data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContainerLabel: (body: CreateContainerLabelRequest, options?: any) => Promise; }; /** * CreateContainerLabelApi - functional programming interface * @export */ export declare const CreateContainerLabelApiFp: (configuration?: Configuration) => { /** * Creates a container (pallet) label for the associated shipment package. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createContainerLabel * @param {CreateContainerLabelRequest} body Request body containing the container label data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContainerLabel(body: CreateContainerLabelRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CreateContainerLabelApi - factory interface * @export */ export declare const CreateContainerLabelApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a container (pallet) label for the associated shipment package. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createContainerLabel * @param {CreateContainerLabelRequest} body Request body containing the container label data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createContainerLabel(body: CreateContainerLabelRequest, options?: any): AxiosPromise; }; /** * Request parameters for createContainerLabel operation in CreateContainerLabelApi. * @export * @interface CreateContainerLabelApiCreateContainerLabelRequest */ export interface CreateContainerLabelApiCreateContainerLabelRequest { /** * Request body containing the container label data. * @type {CreateContainerLabelRequest} * @memberof CreateContainerLabelApiCreateContainerLabel */ readonly body: CreateContainerLabelRequest; } /** * CreateContainerLabelApi - object-oriented interface * @export * @class CreateContainerLabelApi * @extends {BaseAPI} */ export declare class CreateContainerLabelApi extends BaseAPI { /** * Creates a container (pallet) label for the associated shipment package. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @summary createContainerLabel * @param {CreateContainerLabelApiCreateContainerLabelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreateContainerLabelApi */ createContainerLabel(requestParameters: CreateContainerLabelApiCreateContainerLabelRequest, options?: any): Promise>; } /** * CustomerInvoicesApi - axios parameter creator * @export */ export declare const CustomerInvoicesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getCustomerInvoice * @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomerInvoice: (purchaseOrderNumber: string, options?: any) => Promise; /** * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getCustomerInvoices * @param {string} createdAfter Orders that became available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} createdBefore Orders that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date. * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomerInvoices: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, options?: any) => Promise; }; /** * CustomerInvoicesApi - functional programming interface * @export */ export declare const CustomerInvoicesApiFp: (configuration?: Configuration) => { /** * Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getCustomerInvoice * @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomerInvoice(purchaseOrderNumber: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getCustomerInvoices * @param {string} createdAfter Orders that became available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} createdBefore Orders that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date. * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomerInvoices(createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CustomerInvoicesApi - factory interface * @export */ export declare const CustomerInvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getCustomerInvoice * @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomerInvoice(purchaseOrderNumber: string, options?: any): AxiosPromise; /** * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getCustomerInvoices * @param {string} createdAfter Orders that became available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} createdBefore Orders that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @param {number} [limit] The limit to the number of records returned * @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date. * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomerInvoices(createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, options?: any): AxiosPromise; }; /** * Request parameters for getCustomerInvoice operation in CustomerInvoicesApi. * @export * @interface CustomerInvoicesApiGetCustomerInvoiceRequest */ export interface CustomerInvoicesApiGetCustomerInvoiceRequest { /** * Purchase order number of the shipment for which to return the invoice. * @type {string} * @memberof CustomerInvoicesApiGetCustomerInvoice */ readonly purchaseOrderNumber: string; } /** * Request parameters for getCustomerInvoices operation in CustomerInvoicesApi. * @export * @interface CustomerInvoicesApiGetCustomerInvoicesRequest */ export interface CustomerInvoicesApiGetCustomerInvoicesRequest { /** * Orders that became available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof CustomerInvoicesApiGetCustomerInvoices */ readonly createdAfter: string; /** * Orders that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof CustomerInvoicesApiGetCustomerInvoices */ readonly createdBefore: string; /** * The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses. * @type {string} * @memberof CustomerInvoicesApiGetCustomerInvoices */ readonly shipFromPartyId?: string; /** * The limit to the number of records returned * @type {number} * @memberof CustomerInvoicesApiGetCustomerInvoices */ readonly limit?: number; /** * Sort ASC or DESC by order creation date. * @type {'ASC' | 'DESC'} * @memberof CustomerInvoicesApiGetCustomerInvoices */ readonly sortOrder?: 'ASC' | 'DESC'; /** * Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call. * @type {string} * @memberof CustomerInvoicesApiGetCustomerInvoices */ readonly nextToken?: string; } /** * CustomerInvoicesApi - object-oriented interface * @export * @class CustomerInvoicesApi * @extends {BaseAPI} */ export declare class CustomerInvoicesApi extends BaseAPI { /** * Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getCustomerInvoice * @param {CustomerInvoicesApiGetCustomerInvoiceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomerInvoicesApi */ getCustomerInvoice(requestParameters: CustomerInvoicesApiGetCustomerInvoiceRequest, options?: any): Promise>; /** * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getCustomerInvoices * @param {CustomerInvoicesApiGetCustomerInvoicesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CustomerInvoicesApi */ getCustomerInvoices(requestParameters: CustomerInvoicesApiGetCustomerInvoicesRequest, options?: any): Promise>; } /** * VendorShippingApi - axios parameter creator * @export */ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getPackingSlip * @param {string} purchaseOrderNumber The `purchaseOrderNumber` for the packing slip that you want. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPackingSlip: (purchaseOrderNumber: string, options?: any) => Promise; /** * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getPackingSlips * @param {string} createdAfter Packing slips that become available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses. * @param {number} [limit] The maximum number of records to return. * @param {'ASC' | 'DESC'} [sortOrder] The packing slip creation dates, which are sorted by ascending or descending order. * @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPackingSlips: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, options?: any) => Promise; /** * Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShipmentConfirmations * @param {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipmentConfirmations: (body: SubmitShipmentConfirmationsRequest, options?: any) => Promise; /** * This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShipmentStatusUpdates * @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipmentStatusUpdates: (body: SubmitShipmentStatusUpdatesRequest, options?: any) => Promise; }; /** * VendorShippingApi - functional programming interface * @export */ export declare const VendorShippingApiFp: (configuration?: Configuration) => { /** * Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getPackingSlip * @param {string} purchaseOrderNumber The `purchaseOrderNumber` for the packing slip that you want. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPackingSlip(purchaseOrderNumber: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getPackingSlips * @param {string} createdAfter Packing slips that become available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses. * @param {number} [limit] The maximum number of records to return. * @param {'ASC' | 'DESC'} [sortOrder] The packing slip creation dates, which are sorted by ascending or descending order. * @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPackingSlips(createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShipmentConfirmations * @param {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShipmentStatusUpdates * @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipmentStatusUpdates(body: SubmitShipmentStatusUpdatesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VendorShippingApi - factory interface * @export */ export declare const VendorShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getPackingSlip * @param {string} purchaseOrderNumber The `purchaseOrderNumber` for the packing slip that you want. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPackingSlip(purchaseOrderNumber: string, options?: any): AxiosPromise; /** * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getPackingSlips * @param {string} createdAfter Packing slips that become available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses. * @param {number} [limit] The maximum number of records to return. * @param {'ASC' | 'DESC'} [sortOrder] The packing slip creation dates, which are sorted by ascending or descending order. * @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPackingSlips(createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, options?: any): AxiosPromise; /** * Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShipmentConfirmations * @param {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: any): AxiosPromise; /** * This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShipmentStatusUpdates * @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShipmentStatusUpdates(body: SubmitShipmentStatusUpdatesRequest, options?: any): AxiosPromise; }; /** * Request parameters for getPackingSlip operation in VendorShippingApi. * @export * @interface VendorShippingApiGetPackingSlipRequest */ export interface VendorShippingApiGetPackingSlipRequest { /** * The `purchaseOrderNumber` for the packing slip that you want. * @type {string} * @memberof VendorShippingApiGetPackingSlip */ readonly purchaseOrderNumber: string; } /** * Request parameters for getPackingSlips operation in VendorShippingApi. * @export * @interface VendorShippingApiGetPackingSlipsRequest */ export interface VendorShippingApiGetPackingSlipsRequest { /** * Packing slips that become available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof VendorShippingApiGetPackingSlips */ readonly createdAfter: string; /** * Packing slips that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof VendorShippingApiGetPackingSlips */ readonly createdBefore: string; /** * The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses. * @type {string} * @memberof VendorShippingApiGetPackingSlips */ readonly shipFromPartyId?: string; /** * The maximum number of records to return. * @type {number} * @memberof VendorShippingApiGetPackingSlips */ readonly limit?: number; /** * The packing slip creation dates, which are sorted by ascending or descending order. * @type {'ASC' | 'DESC'} * @memberof VendorShippingApiGetPackingSlips */ readonly sortOrder?: 'ASC' | 'DESC'; /** * Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call. * @type {string} * @memberof VendorShippingApiGetPackingSlips */ readonly nextToken?: string; } /** * Request parameters for submitShipmentConfirmations operation in VendorShippingApi. * @export * @interface VendorShippingApiSubmitShipmentConfirmationsRequest */ export interface VendorShippingApiSubmitShipmentConfirmationsRequest { /** * Request body containing the shipment confirmations data. * @type {SubmitShipmentConfirmationsRequest} * @memberof VendorShippingApiSubmitShipmentConfirmations */ readonly body: SubmitShipmentConfirmationsRequest; } /** * Request parameters for submitShipmentStatusUpdates operation in VendorShippingApi. * @export * @interface VendorShippingApiSubmitShipmentStatusUpdatesRequest */ export interface VendorShippingApiSubmitShipmentStatusUpdatesRequest { /** * Request body containing the shipment status update data. * @type {SubmitShipmentStatusUpdatesRequest} * @memberof VendorShippingApiSubmitShipmentStatusUpdates */ readonly body: SubmitShipmentStatusUpdatesRequest; } /** * VendorShippingApi - object-oriented interface * @export * @class VendorShippingApi * @extends {BaseAPI} */ export declare class VendorShippingApi extends BaseAPI { /** * Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getPackingSlip * @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingApi */ getPackingSlip(requestParameters: VendorShippingApiGetPackingSlipRequest, options?: any): Promise>; /** * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getPackingSlips * @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingApi */ getPackingSlips(requestParameters: VendorShippingApiGetPackingSlipsRequest, options?: any): Promise>; /** * Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShipmentConfirmations * @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingApi */ submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: any): Promise>; /** * This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShipmentStatusUpdates * @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingApi */ submitShipmentStatusUpdates(requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest, options?: any): Promise>; } /** * VendorShippingLabelsApi - axios parameter creator * @export */ export declare const VendorShippingLabelsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates shipping labels for a purchase order and returns the labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary createShippingLabels * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping labels. It should be the same number as the `purchaseOrderNumber` in the order. * @param {CreateShippingLabelsRequest} body The request payload that contains the parameters for creating shipping labels. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createShippingLabels: (purchaseOrderNumber: string, body: CreateShippingLabelsRequest, options?: any) => Promise; /** * Returns a shipping label for the `purchaseOrderNumber` that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getShippingLabel * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` that you received in the order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShippingLabel: (purchaseOrderNumber: string, options?: any) => Promise; /** * Returns a list of shipping labels created during the time frame that you specify. Use the `createdAfter` and `createdBefore` parameters to define the time frame. You must use both of these parameters. The date range to search must not be more than seven days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getShippingLabels * @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses. * @param {number} [limit] The limit to the number of records returned. * @param {'ASC' | 'DESC'} [sortOrder] The sort order creation date. You can choose between ascending (`ASC`) or descending (`DESC`) sort order. * @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShippingLabels: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, options?: any) => Promise; /** * Creates a shipping label for a purchase order and returns a `transactionId` for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShippingLabelRequest * @param {SubmitShippingLabelsRequest} body The request body that contains the shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShippingLabelRequest: (body: SubmitShippingLabelsRequest, options?: any) => Promise; }; /** * VendorShippingLabelsApi - functional programming interface * @export */ export declare const VendorShippingLabelsApiFp: (configuration?: Configuration) => { /** * Creates shipping labels for a purchase order and returns the labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary createShippingLabels * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping labels. It should be the same number as the `purchaseOrderNumber` in the order. * @param {CreateShippingLabelsRequest} body The request payload that contains the parameters for creating shipping labels. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createShippingLabels(purchaseOrderNumber: string, body: CreateShippingLabelsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a shipping label for the `purchaseOrderNumber` that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getShippingLabel * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` that you received in the order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShippingLabel(purchaseOrderNumber: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of shipping labels created during the time frame that you specify. Use the `createdAfter` and `createdBefore` parameters to define the time frame. You must use both of these parameters. The date range to search must not be more than seven days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getShippingLabels * @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses. * @param {number} [limit] The limit to the number of records returned. * @param {'ASC' | 'DESC'} [sortOrder] The sort order creation date. You can choose between ascending (`ASC`) or descending (`DESC`) sort order. * @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShippingLabels(createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a shipping label for a purchase order and returns a `transactionId` for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShippingLabelRequest * @param {SubmitShippingLabelsRequest} body The request body that contains the shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShippingLabelRequest(body: SubmitShippingLabelsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VendorShippingLabelsApi - factory interface * @export */ export declare const VendorShippingLabelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates shipping labels for a purchase order and returns the labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary createShippingLabels * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping labels. It should be the same number as the `purchaseOrderNumber` in the order. * @param {CreateShippingLabelsRequest} body The request payload that contains the parameters for creating shipping labels. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createShippingLabels(purchaseOrderNumber: string, body: CreateShippingLabelsRequest, options?: any): AxiosPromise; /** * Returns a shipping label for the `purchaseOrderNumber` that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getShippingLabel * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` that you received in the order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShippingLabel(purchaseOrderNumber: string, options?: any): AxiosPromise; /** * Returns a list of shipping labels created during the time frame that you specify. Use the `createdAfter` and `createdBefore` parameters to define the time frame. You must use both of these parameters. The date range to search must not be more than seven days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getShippingLabels * @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses. * @param {number} [limit] The limit to the number of records returned. * @param {'ASC' | 'DESC'} [sortOrder] The sort order creation date. You can choose between ascending (`ASC`) or descending (`DESC`) sort order. * @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getShippingLabels(createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, options?: any): AxiosPromise; /** * Creates a shipping label for a purchase order and returns a `transactionId` for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShippingLabelRequest * @param {SubmitShippingLabelsRequest} body The request body that contains the shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShippingLabelRequest(body: SubmitShippingLabelsRequest, options?: any): AxiosPromise; }; /** * Request parameters for createShippingLabels operation in VendorShippingLabelsApi. * @export * @interface VendorShippingLabelsApiCreateShippingLabelsRequest */ export interface VendorShippingLabelsApiCreateShippingLabelsRequest { /** * The purchase order number for which you want to return the shipping labels. It should be the same number as the `purchaseOrderNumber` in the order. * @type {string} * @memberof VendorShippingLabelsApiCreateShippingLabels */ readonly purchaseOrderNumber: string; /** * The request payload that contains the parameters for creating shipping labels. * @type {CreateShippingLabelsRequest} * @memberof VendorShippingLabelsApiCreateShippingLabels */ readonly body: CreateShippingLabelsRequest; } /** * Request parameters for getShippingLabel operation in VendorShippingLabelsApi. * @export * @interface VendorShippingLabelsApiGetShippingLabelRequest */ export interface VendorShippingLabelsApiGetShippingLabelRequest { /** * The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` that you received in the order. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabel */ readonly purchaseOrderNumber: string; } /** * Request parameters for getShippingLabels operation in VendorShippingLabelsApi. * @export * @interface VendorShippingLabelsApiGetShippingLabelsRequest */ export interface VendorShippingLabelsApiGetShippingLabelsRequest { /** * Shipping labels that became available after this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabels */ readonly createdAfter: string; /** * Shipping labels that became available before this date and time will be included in the result. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabels */ readonly createdBefore: string; /** * The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabels */ readonly shipFromPartyId?: string; /** * The limit to the number of records returned. * @type {number} * @memberof VendorShippingLabelsApiGetShippingLabels */ readonly limit?: number; /** * The sort order creation date. You can choose between ascending (`ASC`) or descending (`DESC`) sort order. * @type {'ASC' | 'DESC'} * @memberof VendorShippingLabelsApiGetShippingLabels */ readonly sortOrder?: 'ASC' | 'DESC'; /** * Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabels */ readonly nextToken?: string; } /** * Request parameters for submitShippingLabelRequest operation in VendorShippingLabelsApi. * @export * @interface VendorShippingLabelsApiSubmitShippingLabelRequestRequest */ export interface VendorShippingLabelsApiSubmitShippingLabelRequestRequest { /** * The request body that contains the shipping labels data. * @type {SubmitShippingLabelsRequest} * @memberof VendorShippingLabelsApiSubmitShippingLabelRequest */ readonly body: SubmitShippingLabelsRequest; } /** * VendorShippingLabelsApi - object-oriented interface * @export * @class VendorShippingLabelsApi * @extends {BaseAPI} */ export declare class VendorShippingLabelsApi extends BaseAPI { /** * Creates shipping labels for a purchase order and returns the labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary createShippingLabels * @param {VendorShippingLabelsApiCreateShippingLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingLabelsApi */ createShippingLabels(requestParameters: VendorShippingLabelsApiCreateShippingLabelsRequest, options?: any): Promise>; /** * Returns a shipping label for the `purchaseOrderNumber` that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getShippingLabel * @param {VendorShippingLabelsApiGetShippingLabelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingLabelsApi */ getShippingLabel(requestParameters: VendorShippingLabelsApiGetShippingLabelRequest, options?: any): Promise>; /** * Returns a list of shipping labels created during the time frame that you specify. Use the `createdAfter` and `createdBefore` parameters to define the time frame. You must use both of these parameters. The date range to search must not be more than seven days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary getShippingLabels * @param {VendorShippingLabelsApiGetShippingLabelsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingLabelsApi */ getShippingLabels(requestParameters: VendorShippingLabelsApiGetShippingLabelsRequest, options?: any): Promise>; /** * Creates a shipping label for a purchase order and returns a `transactionId` for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @summary submitShippingLabelRequest * @param {VendorShippingLabelsApiSubmitShippingLabelRequestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingLabelsApi */ submitShippingLabelRequest(requestParameters: VendorShippingLabelsApiSubmitShippingLabelRequestRequest, options?: any): Promise>; }