/** * Selling Partner API for Direct Fulfillment Orders * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order 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'; /** * Status of acknowledgement. * @export * @interface AcknowledgementStatus */ export interface AcknowledgementStatus { /** * Acknowledgement code is a unique two digit value which indicates the status of the acknowledgement. For a list of acknowledgement codes that Amazon supports, see the Vendor Direct Fulfillment APIs Use Case Guide. * @type {string} * @memberof AcknowledgementStatus */ code?: string; /** * Reason for the acknowledgement code. * @type {string} * @memberof AcknowledgementStatus */ description?: string; } /** * Address of the party. * @export * @interface Address */ export interface Address { /** * The name of the person, business or institution at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ name: string; /** * The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ attention?: string; /** * First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ addressLine1: string; /** * Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ addressLine2?: string; /** * Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ addressLine3?: string; /** * The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ city?: string; /** * The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ county?: string; /** * The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @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 conatins 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. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`. * @type {string} * @memberof Address */ phone?: string; } /** * The response schema for the getOrder operation. * @export * @interface GetOrderResponse */ export interface GetOrderResponse { /** * * @type {Order} * @memberof GetOrderResponse */ payload?: Order; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetOrderResponse */ errors?: Array; } /** * The response schema for the getOrders operation. * @export * @interface GetOrdersResponse */ export interface GetOrdersResponse { /** * * @type {OrderList} * @memberof GetOrdersResponse */ payload?: OrderList; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetOrdersResponse */ errors?: Array; } /** * Gift details for the item. * @export * @interface GiftDetails */ export interface GiftDetails { /** * Gift message to be printed in shipment. * @type {string} * @memberof GiftDetails */ giftMessage?: string; /** * Gift wrap identifier for the gift wrapping, if any. * @type {string} * @memberof GiftDetails */ giftWrapId?: string; } /** * Details of quantity ordered. * @export * @interface ItemQuantity */ export interface ItemQuantity { /** * Acknowledged quantity. This value should not be zero. * @type {number} * @memberof ItemQuantity */ amount?: number; /** * Unit of measure for the acknowledged quantity. * @type {string} * @memberof ItemQuantity */ unitOfMeasure?: ItemQuantityUnitOfMeasureEnum | 'Each'; } /** * @export * @enum {string} */ export declare enum ItemQuantityUnitOfMeasureEnum { Each = "Each" } /** * 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; } /** * An amount of money, including units in the form of currency. * @export * @interface Money */ export interface Money { /** * Three digit currency code in ISO 4217 format. String of length 3. * @type {string} * @memberof Money */ currencyCode?: string; /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. * @type {string} * @memberof Money */ amount?: string; } /** * Represents a purchase order. * @export * @interface Order */ export interface Order { /** * The purchase order number for this order. Formatting Notes: alpha-numeric code. * @type {string} * @memberof Order */ purchaseOrderNumber: string; /** * * @type {OrderDetails} * @memberof Order */ orderDetails?: OrderDetails; } /** * Details of an individual order being acknowledged. * @export * @interface OrderAcknowledgementItem */ export interface OrderAcknowledgementItem { /** * The purchase order number for this order. Formatting Notes: alpha-numeric code. * @type {string} * @memberof OrderAcknowledgementItem */ purchaseOrderNumber: string; /** * The vendor\'s order number for this order. * @type {string} * @memberof OrderAcknowledgementItem */ vendorOrderNumber: string; /** * The date and time when the order is acknowledged, in ISO-8601 date/time format. For example: 2018-07-16T23:00:00Z / 2018-07-16T23:00:00-05:00 / 2018-07-16T23:00:00-08:00. * @type {string} * @memberof OrderAcknowledgementItem */ acknowledgementDate: string; /** * * @type {AcknowledgementStatus} * @memberof OrderAcknowledgementItem */ acknowledgementStatus: AcknowledgementStatus; /** * * @type {PartyIdentification} * @memberof OrderAcknowledgementItem */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof OrderAcknowledgementItem */ shipFromParty: PartyIdentification; /** * Item details including acknowledged quantity. * @type {Array} * @memberof OrderAcknowledgementItem */ itemAcknowledgements: Array; } /** * Details of an order. * @export * @interface OrderDetails */ export interface OrderDetails { /** * The customer order number. * @type {string} * @memberof OrderDetails */ customerOrderNumber: string; /** * The date the order was placed. This field is expected to be in ISO-8601 date/time format, for example:2018-07-16T23:00:00Z/ 2018-07-16T23:00:00-05:00 /2018-07-16T23:00:00-08:00. If no time zone is specified, UTC should be assumed. * @type {string} * @memberof OrderDetails */ orderDate: string; /** * Current status of the order. * @type {string} * @memberof OrderDetails */ orderStatus?: OrderDetailsOrderStatusEnum | 'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'; /** * * @type {ShipmentDetails} * @memberof OrderDetails */ shipmentDetails: ShipmentDetails; /** * * @type {OrderDetailsTaxTotal} * @memberof OrderDetails */ taxTotal?: OrderDetailsTaxTotal; /** * * @type {PartyIdentification} * @memberof OrderDetails */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof OrderDetails */ shipFromParty: PartyIdentification; /** * * @type {Address} * @memberof OrderDetails */ shipToParty: Address; /** * * @type {PartyIdentification} * @memberof OrderDetails */ billToParty: PartyIdentification; /** * A list of items in this purchase order. * @type {Array} * @memberof OrderDetails */ items: Array; } /** * @export * @enum {string} */ export declare enum OrderDetailsOrderStatusEnum { New = "NEW", Shipped = "SHIPPED", Accepted = "ACCEPTED", Cancelled = "CANCELLED" } /** * The total Tax object within shipment that relates to the order. * @export * @interface OrderDetailsTaxTotal */ export interface OrderDetailsTaxTotal { /** * A list of tax line items. * @type {Array} * @memberof OrderDetailsTaxTotal */ taxLineItem?: Array; } /** * An item within an order * @export * @interface OrderItem */ export interface OrderItem { /** * Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on. * @type {string} * @memberof OrderItem */ itemSequenceNumber: string; /** * Buyer\'s standard identification number (ASIN) of an item. * @type {string} * @memberof OrderItem */ buyerProductIdentifier?: string; /** * The vendor selected product identification of the item. * @type {string} * @memberof OrderItem */ vendorProductIdentifier?: string; /** * Title for the item. * @type {string} * @memberof OrderItem */ title?: string; /** * * @type {ItemQuantity} * @memberof OrderItem */ orderedQuantity: ItemQuantity; /** * * @type {ScheduledDeliveryShipment} * @memberof OrderItem */ scheduledDeliveryShipment?: ScheduledDeliveryShipment; /** * * @type {GiftDetails} * @memberof OrderItem */ giftDetails?: GiftDetails; /** * * @type {Money} * @memberof OrderItem */ netPrice: Money; /** * * @type {OrderItemTaxDetails} * @memberof OrderItem */ taxDetails?: OrderItemTaxDetails; /** * * @type {Money} * @memberof OrderItem */ totalPrice?: Money; } /** * Details of an individual item within the order being acknowledged. * @export * @interface OrderItemAcknowledgement */ export interface OrderItemAcknowledgement { /** * Line item sequence number for the item. * @type {string} * @memberof OrderItemAcknowledgement */ itemSequenceNumber: string; /** * Buyer\'s standard identification number (ASIN) of an item. * @type {string} * @memberof OrderItemAcknowledgement */ buyerProductIdentifier?: string; /** * The vendor selected product identification of the item. Should be the same as was provided in the purchase order. * @type {string} * @memberof OrderItemAcknowledgement */ vendorProductIdentifier?: string; /** * * @type {ItemQuantity} * @memberof OrderItemAcknowledgement */ acknowledgedQuantity: ItemQuantity; } /** * Total tax details for the line item. * @export * @interface OrderItemTaxDetails */ export interface OrderItemTaxDetails { /** * A list of tax line items. * @type {Array} * @memberof OrderItemTaxDetails */ taxLineItem?: Array; } /** * A list of purchase orders returned as response. * @export * @interface OrderList */ export interface OrderList { /** * * @type {Pagination} * @memberof OrderList */ pagination?: Pagination; /** * Represents a purchase order within the OrderList. * @type {Array} * @memberof OrderList */ orders?: 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. For example, warehouse code or vendor code. Please refer to specific party for more details. * @type {string} * @memberof PartyIdentification */ partyId: string; /** * * @type {Address} * @memberof PartyIdentification */ address?: Address; /** * * @type {TaxRegistrationDetails} * @memberof PartyIdentification */ taxInfo?: TaxRegistrationDetails; } /** * Dates for the scheduled delivery shipments. * @export * @interface ScheduledDeliveryShipment */ export interface ScheduledDeliveryShipment { /** * Scheduled delivery service type. * @type {string} * @memberof ScheduledDeliveryShipment */ scheduledDeliveryServiceType?: string; /** * Earliest nominated delivery date for the scheduled delivery. * @type {string} * @memberof ScheduledDeliveryShipment */ earliestNominatedDeliveryDate?: string; /** * Latest nominated delivery date for the scheduled delivery. * @type {string} * @memberof ScheduledDeliveryShipment */ latestNominatedDeliveryDate?: string; } /** * Shipment dates. * @export * @interface ShipmentDates */ export interface ShipmentDates { /** * Time by which the vendor is required to ship the order. * @type {string} * @memberof ShipmentDates */ requiredShipDate: string; /** * Delivery date promised to the Amazon customer. * @type {string} * @memberof ShipmentDates */ promisedDeliveryDate?: string; } /** * Shipment details required for the shipment. * @export * @interface ShipmentDetails */ export interface ShipmentDetails { /** * When true, this is a priority shipment. * @type {boolean} * @memberof ShipmentDetails */ isPriorityShipment: boolean; /** * When true, this order is part of a scheduled delivery program. * @type {boolean} * @memberof ShipmentDetails */ isScheduledDeliveryShipment?: boolean; /** * When true, a packing slip is required to be sent to the customer. * @type {boolean} * @memberof ShipmentDetails */ isPslipRequired: boolean; /** * When true, the order contain a gift. Include the gift message and gift wrap information. * @type {boolean} * @memberof ShipmentDetails */ isGift?: boolean; /** * Ship method to be used for shipping the order. Amazon defines ship method codes indicating the shipping carrier and shipment service level. To see the full list of ship methods in use, including both the code and the friendly name, search the \'Help\' section on Vendor Central for \'ship methods\'. * @type {string} * @memberof ShipmentDetails */ shipMethod: string; /** * * @type {ShipmentDates} * @memberof ShipmentDetails */ shipmentDates: ShipmentDates; /** * Message to customer for order status. * @type {string} * @memberof ShipmentDetails */ messageToCustomer: string; } /** * The request schema for the submitAcknowledgement operation. * @export * @interface SubmitAcknowledgementRequest */ export interface SubmitAcknowledgementRequest { /** * A list of one or more purchase orders. * @type {Array} * @memberof SubmitAcknowledgementRequest */ orderAcknowledgements?: Array; } /** * The response schema for the submitAcknowledgement operation. * @export * @interface SubmitAcknowledgementResponse */ export interface SubmitAcknowledgementResponse { /** * * @type {TransactionId} * @memberof SubmitAcknowledgementResponse */ payload?: TransactionId; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof SubmitAcknowledgementResponse */ errors?: Array; } /** * The tax details related to the order. * @export * @interface TaxDetails */ export interface TaxDetails { /** * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. * @type {string} * @memberof TaxDetails */ taxRate?: string; /** * * @type {Money} * @memberof TaxDetails */ taxAmount: Money; /** * * @type {Money} * @memberof TaxDetails */ taxableAmount?: Money; /** * Tax type. * @type {string} * @memberof TaxDetails */ type?: TaxDetailsTypeEnum | 'CONSUMPTION' | 'GST' | 'MwSt.' | 'PST' | 'TOTAL' | 'TVA' | 'VAT'; } /** * @export * @enum {string} */ export declare enum TaxDetailsTypeEnum { Consumption = "CONSUMPTION", Gst = "GST", MwSt = "MwSt.", Pst = "PST", Total = "TOTAL", Tva = "TVA", Vat = "VAT" } /** * 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 TransactionId */ export interface TransactionId { /** * GUID assigned by Amazon to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction. * @type {string} * @memberof TransactionId */ transactionId?: string; } /** * VendorOrdersApi - axios parameter creator * @export */ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns purchase order information 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 order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrder: (purchaseOrderNumber: string, options?: any) => Promise; /** * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order. **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 Purchase 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 Purchase 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 warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses. * @param {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'} [status] Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status. * @param {number} [limit] The limit to the number of purchase orders returned. * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order 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 {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrders: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: "NEW" | "SHIPPED" | "ACCEPTED" | "CANCELLED", limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, includeDetails?: boolean, options?: any) => Promise; /** * Submits acknowledgements for one or more purchase 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 {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitAcknowledgement: (body: SubmitAcknowledgementRequest, options?: any) => Promise; }; /** * VendorOrdersApi - functional programming interface * @export */ export declare const VendorOrdersApiFp: (configuration?: Configuration) => { /** * Returns purchase order information 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 order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrder(purchaseOrderNumber: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order. **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 Purchase 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 Purchase 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 warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses. * @param {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'} [status] Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status. * @param {number} [limit] The limit to the number of purchase orders returned. * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order 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 {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrders(createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: "NEW" | "SHIPPED" | "ACCEPTED" | "CANCELLED", limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, includeDetails?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submits acknowledgements for one or more purchase 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 {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VendorOrdersApi - factory interface * @export */ export declare const VendorOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns purchase order information 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 order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrder(purchaseOrderNumber: string, options?: any): AxiosPromise; /** * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order. **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 Purchase 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 Purchase 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 warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses. * @param {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'} [status] Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status. * @param {number} [limit] The limit to the number of purchase orders returned. * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order 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 {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrders(createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: "NEW" | "SHIPPED" | "ACCEPTED" | "CANCELLED", limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, includeDetails?: boolean, options?: any): AxiosPromise; /** * Submits acknowledgements for one or more purchase 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 {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: any): AxiosPromise; }; /** * Request parameters for getOrder operation in VendorOrdersApi. * @export * @interface VendorOrdersApiGetOrderRequest */ export interface VendorOrdersApiGetOrderRequest { /** * The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code. * @type {string} * @memberof VendorOrdersApiGetOrder */ readonly purchaseOrderNumber: string; } /** * Request parameters for getOrders operation in VendorOrdersApi. * @export * @interface VendorOrdersApiGetOrdersRequest */ export interface VendorOrdersApiGetOrdersRequest { /** * Purchase 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 VendorOrdersApiGetOrders */ readonly createdAfter: string; /** * Purchase 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 VendorOrdersApiGetOrders */ readonly createdBefore: string; /** * The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses. * @type {string} * @memberof VendorOrdersApiGetOrders */ readonly shipFromPartyId?: string; /** * Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status. * @type {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'} * @memberof VendorOrdersApiGetOrders */ readonly status?: 'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'; /** * The limit to the number of purchase orders returned. * @type {number} * @memberof VendorOrdersApiGetOrders */ readonly limit?: number; /** * Sort the list in ascending or descending order by order creation date. * @type {'ASC' | 'DESC'} * @memberof VendorOrdersApiGetOrders */ 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 VendorOrdersApiGetOrders */ readonly nextToken?: string; /** * When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned. * @type {boolean} * @memberof VendorOrdersApiGetOrders */ readonly includeDetails?: boolean; } /** * Request parameters for submitAcknowledgement operation in VendorOrdersApi. * @export * @interface VendorOrdersApiSubmitAcknowledgementRequest */ export interface VendorOrdersApiSubmitAcknowledgementRequest { /** * The request body containing the acknowledgement to an order. * @type {SubmitAcknowledgementRequest} * @memberof VendorOrdersApiSubmitAcknowledgement */ readonly body: SubmitAcknowledgementRequest; } /** * VendorOrdersApi - object-oriented interface * @export * @class VendorOrdersApi * @extends {BaseAPI} */ export declare class VendorOrdersApi extends BaseAPI { /** * Returns purchase order information 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 {VendorOrdersApiGetOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorOrdersApi */ getOrder(requestParameters: VendorOrdersApiGetOrderRequest, options?: any): Promise>; /** * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order. **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 {VendorOrdersApiGetOrdersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorOrdersApi */ getOrders(requestParameters: VendorOrdersApiGetOrdersRequest, options?: any): Promise>; /** * Submits acknowledgements for one or more purchase 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 {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorOrdersApi */ submitAcknowledgement(requestParameters: VendorOrdersApiSubmitAcknowledgementRequest, options?: any): Promise>; }