/** * Selling Partner API for Direct Fulfillment Shipping * The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data. * * The version of the OpenAPI document: v1 * * * 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 digit country code in ISO 3166-1 alpha-2 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; } /** * 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. * @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" } /** * 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" } /** * The response schema for the getCustomerInvoice operation. * @export * @interface GetCustomerInvoiceResponse */ export interface GetCustomerInvoiceResponse { /** * * @type {CustomerInvoice} * @memberof GetCustomerInvoiceResponse */ payload?: CustomerInvoice; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetCustomerInvoiceResponse */ errors?: Array; } /** * The response schema for the getCustomerInvoices operation. * @export * @interface GetCustomerInvoicesResponse */ export interface GetCustomerInvoicesResponse { /** * * @type {CustomerInvoiceList} * @memberof GetCustomerInvoicesResponse */ payload?: CustomerInvoiceList; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetCustomerInvoicesResponse */ errors?: Array; } /** * Response payload with the list of Packing Slips. * @export * @interface GetPackingSlipListResponse */ export interface GetPackingSlipListResponse { /** * * @type {PackingSlipList} * @memberof GetPackingSlipListResponse */ payload?: PackingSlipList; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetPackingSlipListResponse */ errors?: Array; } /** * Response payload with packing slip. * @export * @interface GetPackingSlipResponse */ export interface GetPackingSlipResponse { /** * * @type {PackingSlip} * @memberof GetPackingSlipResponse */ payload?: PackingSlip; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetPackingSlipResponse */ errors?: Array; } /** * The response schema for the getShippingLabels operation. * @export * @interface GetShippingLabelListResponse */ export interface GetShippingLabelListResponse { /** * * @type {ShippingLabelList} * @memberof GetShippingLabelListResponse */ payload?: ShippingLabelList; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetShippingLabelListResponse */ errors?: Array; } /** * The response schema for the getShippingLabel operation. * @export * @interface GetShippingLabelResponse */ export interface GetShippingLabelResponse { /** * * @type {ShippingLabel} * @memberof GetShippingLabelResponse */ payload?: ShippingLabel; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetShippingLabelResponse */ errors?: Array; } /** * Details of the item being shipped. * @export * @interface Item */ export interface Item { /** * Item Sequence Number for the item. This must be the same value as sent in order for a given item. * @type {number} * @memberof Item */ itemSequenceNumber: number; /** * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required. * @type {string} * @memberof Item */ buyerProductIdentifier?: string; /** * The vendor selected product identification of the item. Should be the same as was sent in the purchase order, like SKU Number. * @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; } /** * Represents an item that has been packed into a container for shipping. * @export * @interface PackedItem */ export interface PackedItem { /** * Item Sequence Number for the item. This must be the same value as sent in the order for a given item. * @type {number} * @memberof PackedItem */ itemSequenceNumber: number; /** * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required. * @type {string} * @memberof PackedItem */ buyerProductIdentifier?: string; /** * The vendor selected product identification of the item. Should be the same as was sent in the Purchase Order, like SKU Number. * @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 corresponds to the packing slip. * @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 { /** * A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return. * @type {string} * @memberof Pagination */ nextToken?: string; } /** * Name, address and tax details of a party. * @export * @interface PartyIdentification */ export interface PartyIdentification { /** * Assigned Identification for the party. * @type {string} * @memberof PartyIdentification */ partyId: string; /** * * @type {Address} * @memberof PartyIdentification */ address?: Address; /** * Tax registration details of the entity. * @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 { /** * This field indicates the date of the departure of the shipment from vendor\'s location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Amazon destination warehouse, whichever is sooner. Shipped date mentioned in the Shipment Confirmation should not be in the future. * @type {string} * @memberof ShipmentDetails */ shippedDate: string; /** * Indicate 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; /** * Date on which the shipment is expected to reach the buyer\'s warehouse. It needs to be an estimate based on the average transit time between the ship-from location and the destination. The exact appointment time will be provided by buyer and is potentially not known when creating the shipment confirmation. * @type {string} * @memberof ShipmentDetails */ estimatedDeliveryDate?: string; } /** * @export * @enum {string} */ export declare enum ShipmentDetailsShipmentStatusEnum { Shipped = "SHIPPED", FloorDenial = "FLOOR_DENIAL" } /** * 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 { /** * 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 { /** * This is required to be provided for every package and should match with 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. This field is expected to be in 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 {StatusUpdateDetailsShipmentSchedule} * @memberof StatusUpdateDetails */ shipmentSchedule?: StatusUpdateDetailsShipmentSchedule; } /** * Details for the scheduled delivery timeline for a shipment, including the estimated delivery date and time, as well as the start and end times of the appointment window for delivery. * @export * @interface StatusUpdateDetailsShipmentSchedule */ export interface StatusUpdateDetailsShipmentSchedule { /** * Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in 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 StatusUpdateDetailsShipmentSchedule */ estimatedDeliveryDateTime?: string; /** * This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in 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 StatusUpdateDetailsShipmentSchedule */ apptWindowStartDateTime?: string; /** * This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in 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 StatusUpdateDetailsShipmentSchedule */ apptWindowEndDateTime?: string; } /** * The request schema for the submitShipmentConfirmations operation. * @export * @interface SubmitShipmentConfirmationsRequest */ export interface SubmitShipmentConfirmationsRequest { /** * Array of ShipmentConfirmation objects, each representing confirmation details for a specific shipment. * @type {Array} * @memberof SubmitShipmentConfirmationsRequest */ shipmentConfirmations?: Array; } /** * The response schema for the submitShipmentConfirmations operation. * @export * @interface SubmitShipmentConfirmationsResponse */ export interface SubmitShipmentConfirmationsResponse { /** * * @type {TransactionReference} * @memberof SubmitShipmentConfirmationsResponse */ payload?: TransactionReference; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof SubmitShipmentConfirmationsResponse */ errors?: Array; } /** * Represents the request payload for submitting updates to the status of shipments, containing an array of one or more ShipmentStatusUpdate objects. * @export * @interface SubmitShipmentStatusUpdatesRequest */ export interface SubmitShipmentStatusUpdatesRequest { /** * Contains a list of one or more ShipmentStatusUpdate objects, each representing an update to the status of a specific shipment. * @type {Array} * @memberof SubmitShipmentStatusUpdatesRequest */ shipmentStatusUpdates?: Array; } /** * The response schema for the submitShipmentStatusUpdates operation. * @export * @interface SubmitShipmentStatusUpdatesResponse */ export interface SubmitShipmentStatusUpdatesResponse { /** * * @type {TransactionReference} * @memberof SubmitShipmentStatusUpdatesResponse */ payload?: TransactionReference; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof SubmitShipmentStatusUpdatesResponse */ errors?: 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; } /** * The response schema for the submitShippingLabelRequest operation. * @export * @interface SubmitShippingLabelsResponse */ export interface SubmitShippingLabelsResponse { /** * * @type {TransactionReference} * @memberof SubmitShippingLabelsResponse */ payload?: TransactionReference; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof SubmitShippingLabelsResponse */ errors?: 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" } /** * 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in 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. Must be in 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. Must be in 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in 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 packing slip creation date. * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in 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 packing slip creation date. * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in 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 packing slip creation date. * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 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 became available after this date and time will be included in the result. Must be in 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. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorShippingApiGetPackingSlips */ readonly createdBefore: string; /** * The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses. * @type {string} * @memberof VendorShippingApiGetPackingSlips */ readonly shipFromPartyId?: string; /** * The limit to the number of records returned * @type {number} * @memberof VendorShippingApiGetPackingSlips */ readonly limit?: number; /** * Sort ASC or DESC by packing slip creation date. * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingApi */ submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: any): Promise>; /** * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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) => { /** * 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as 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. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in 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 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {SubmitShippingLabelsRequest} body Request body containing one or more 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) => { /** * 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as 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. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in 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 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {SubmitShippingLabelsRequest} body Request body containing one or more 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) => { /** * 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as 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. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format. * @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in 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 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitShippingLabelRequest(body: SubmitShippingLabelsRequest, options?: any): AxiosPromise; }; /** * 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 as 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. Must be in 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. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorShippingLabelsApiGetShippingLabels */ readonly createdBefore: string; /** * The vendor warehouseId for order fulfillment. If not specified, the result will contain 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; /** * Sort ASC or DESC by order creation date. * @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 { /** * Request body containing one or more 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 { /** * 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [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). * @param {VendorShippingLabelsApiSubmitShippingLabelRequestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorShippingLabelsApi */ submitShippingLabelRequest(requestParameters: VendorShippingLabelsApiSubmitShippingLabelRequestRequest, options?: any): Promise>; }