/** * Selling Partner API for Retail Procurement Orders * The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders 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'; /** * Details of item quantity ordered * @export * @interface AcknowledgementStatusDetails */ export interface AcknowledgementStatusDetails { /** * The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format. * @type {string} * @memberof AcknowledgementStatusDetails */ acknowledgementDate?: string; /** * * @type {ItemQuantity} * @memberof AcknowledgementStatusDetails */ acceptedQuantity?: ItemQuantity; /** * * @type {ItemQuantity} * @memberof AcknowledgementStatusDetails */ rejectedQuantity?: ItemQuantity; } /** * 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 address information, if required. * @type {string} * @memberof Address */ addressLine2?: string; /** * Additional 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 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. * @type {string} * @memberof Address */ phone?: string; } /** * The response schema for the getPurchaseOrder operation. * @export * @interface GetPurchaseOrderResponse */ export interface GetPurchaseOrderResponse { /** * * @type {Order} * @memberof GetPurchaseOrderResponse */ payload?: Order; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetPurchaseOrderResponse */ errors?: Array; } /** * The response schema for the getPurchaseOrders operation. * @export * @interface GetPurchaseOrdersResponse */ export interface GetPurchaseOrdersResponse { /** * * @type {OrderList} * @memberof GetPurchaseOrdersResponse */ payload?: OrderList; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetPurchaseOrdersResponse */ errors?: Array; } /** * The response schema for the getPurchaseOrdersStatus operation. * @export * @interface GetPurchaseOrdersStatusResponse */ export interface GetPurchaseOrdersStatusResponse { /** * * @type {OrderListStatus} * @memberof GetPurchaseOrdersStatusResponse */ payload?: OrderListStatus; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetPurchaseOrdersStatusResponse */ errors?: Array; } /** * Import details for an import order. * @export * @interface ImportDetails */ export interface ImportDetails { /** * If the recipient requests, contains the shipment method of payment. This is for import PO\'s only. * @type {string} * @memberof ImportDetails */ methodOfPayment?: ImportDetailsMethodOfPaymentEnum | 'PaidByBuyer' | 'CollectOnDelivery' | 'DefinedByBuyerAndSeller' | 'FOBPortOfCall' | 'PrepaidBySeller' | 'PaidBySeller'; /** * Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. This is for import purchase orders only. * @type {string} * @memberof ImportDetails */ internationalCommercialTerms?: ImportDetailsInternationalCommercialTermsEnum | 'ExWorks' | 'FreeCarrier' | 'FreeOnBoard' | 'FreeAlongSideShip' | 'CarriagePaidTo' | 'CostAndFreight' | 'CarriageAndInsurancePaidTo' | 'CostInsuranceAndFreight' | 'DeliveredAtTerminal' | 'DeliveredAtPlace' | 'DeliverDutyPaid'; /** * The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB. * @type {string} * @memberof ImportDetails */ portOfDelivery?: string; /** * Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40\'(40-foot container), 40\'HC (40-foot high-capacity container), 45\', 45\'HC, 30\', 30\'HC, 20\', 20\'HC. * @type {string} * @memberof ImportDetails */ importContainers?: string; /** * Special instructions regarding the shipment. This field is for import purchase orders. * @type {string} * @memberof ImportDetails */ shippingInstructions?: string; } /** * @export * @enum {string} */ export declare enum ImportDetailsMethodOfPaymentEnum { PaidByBuyer = "PaidByBuyer", CollectOnDelivery = "CollectOnDelivery", DefinedByBuyerAndSeller = "DefinedByBuyerAndSeller", FobPortOfCall = "FOBPortOfCall", PrepaidBySeller = "PrepaidBySeller", PaidBySeller = "PaidBySeller" } /** * @export * @enum {string} */ export declare enum ImportDetailsInternationalCommercialTermsEnum { ExWorks = "ExWorks", FreeCarrier = "FreeCarrier", FreeOnBoard = "FreeOnBoard", FreeAlongSideShip = "FreeAlongSideShip", CarriagePaidTo = "CarriagePaidTo", CostAndFreight = "CostAndFreight", CarriageAndInsurancePaidTo = "CarriageAndInsurancePaidTo", CostInsuranceAndFreight = "CostInsuranceAndFreight", DeliveredAtTerminal = "DeliveredAtTerminal", DeliveredAtPlace = "DeliveredAtPlace", DeliverDutyPaid = "DeliverDutyPaid" } /** * 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 | 'Cases' | 'Eaches'; /** * The case size, in the event that we ordered using cases. * @type {number} * @memberof ItemQuantity */ unitSize?: number; } /** * @export * @enum {string} */ export declare enum ItemQuantityUnitOfMeasureEnum { Cases = "Cases", Eaches = "Eaches" } /** * 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. Includes the currency code and an optional unit of measure for items priced by weight. * @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.
**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`. * @type {string} * @memberof Money */ amount?: string; /** * The unit of measure for prices of items sold by weight. If this field is absent, the item is sold by eaches. * @type {string} * @memberof Money */ unitOfMeasure?: MoneyUnitOfMeasureEnum | 'POUNDS' | 'OUNCES' | 'GRAMS' | 'KILOGRAMS'; } /** * @export * @enum {string} */ export declare enum MoneyUnitOfMeasureEnum { Pounds = "POUNDS", Ounces = "OUNCES", Grams = "GRAMS", Kilograms = "KILOGRAMS" } /** * Represents an order placed by Amazon, including the purchase order number, current state, and order details. * @export * @interface Order */ export interface Order { /** * The purchase order number for this order. Formatting Notes: 8-character alpha-numeric code. * @type {string} * @memberof Order */ purchaseOrderNumber: string; /** * This field will contain the current state of the purchase order. * @type {string} * @memberof Order */ purchaseOrderState: OrderPurchaseOrderStateEnum | 'New' | 'Acknowledged' | 'Closed'; /** * * @type {OrderDetails} * @memberof Order */ orderDetails?: OrderDetails; } /** * @export * @enum {string} */ export declare enum OrderPurchaseOrderStateEnum { New = "New", Acknowledged = "Acknowledged", Closed = "Closed" } /** * Represents an acknowledgement for an order, including the purchase order number, selling party details, acknowledgement date, and a list of acknowledged items. * @export * @interface OrderAcknowledgement */ export interface OrderAcknowledgement { /** * The purchase order number. Formatting Notes: 8-character alpha-numeric code. * @type {string} * @memberof OrderAcknowledgement */ purchaseOrderNumber: string; /** * * @type {PartyIdentification} * @memberof OrderAcknowledgement */ sellingParty: PartyIdentification; /** * The date and time when the purchase order is acknowledged, in ISO-8601 date/time format. * @type {string} * @memberof OrderAcknowledgement */ acknowledgementDate: string; /** * A list of the items being acknowledged with associated details. * @type {Array} * @memberof OrderAcknowledgement */ items: Array; } /** * Details of the item being acknowledged. * @export * @interface OrderAcknowledgementItem */ export interface OrderAcknowledgementItem { /** * Line item sequence number for the item. * @type {string} * @memberof OrderAcknowledgementItem */ itemSequenceNumber?: string; /** * Amazon Standard Identification Number (ASIN) of an item. * @type {string} * @memberof OrderAcknowledgementItem */ amazonProductIdentifier?: string; /** * The vendor selected product identification of the item. Should be the same as was sent in the purchase order. * @type {string} * @memberof OrderAcknowledgementItem */ vendorProductIdentifier?: string; /** * * @type {ItemQuantity} * @memberof OrderAcknowledgementItem */ orderedQuantity: ItemQuantity; /** * * @type {Money} * @memberof OrderAcknowledgementItem */ netCost?: Money; /** * * @type {Money} * @memberof OrderAcknowledgementItem */ listPrice?: Money; /** * The discount multiplier that should be applied to the price if a vendor sells books with a list price. This is a multiplier factor to arrive at a final discounted price. A multiplier of .90 would be the factor if a 10% discount is given. * @type {string} * @memberof OrderAcknowledgementItem */ discountMultiplier?: string; /** * This is used to indicate acknowledged quantity. * @type {Array} * @memberof OrderAcknowledgementItem */ itemAcknowledgements: Array; } /** * Details of an order. * @export * @interface OrderDetails */ export interface OrderDetails { /** * The date the purchase order was placed. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderDetails */ purchaseOrderDate: string; /** * The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than \'purchaseOrderDate\'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderDetails */ purchaseOrderChangedDate?: string; /** * The date when current purchase order state was changed. Current purchase order state is available in the field \'purchaseOrderState\'. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderDetails */ purchaseOrderStateChangedDate: string; /** * Type of purchase order. * @type {string} * @memberof OrderDetails */ purchaseOrderType?: OrderDetailsPurchaseOrderTypeEnum | 'RegularOrder' | 'ConsignedOrder' | 'NewProductIntroduction' | 'RushOrder'; /** * * @type {ImportDetails} * @memberof OrderDetails */ importDetails?: ImportDetails; /** * If requested by the recipient, this field will contain a promotional/deal number. The discount code line is optional. It is used to obtain a price discount on items on the order. * @type {string} * @memberof OrderDetails */ dealCode?: string; /** * Payment method used. * @type {string} * @memberof OrderDetails */ paymentMethod?: OrderDetailsPaymentMethodEnum | 'Invoice' | 'Consignment' | 'CreditCard' | 'Prepaid'; /** * * @type {PartyIdentification} * @memberof OrderDetails */ buyingParty?: PartyIdentification; /** * * @type {PartyIdentification} * @memberof OrderDetails */ sellingParty?: PartyIdentification; /** * * @type {PartyIdentification} * @memberof OrderDetails */ shipToParty?: PartyIdentification; /** * * @type {PartyIdentification} * @memberof OrderDetails */ billToParty?: PartyIdentification; /** * Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--). * @type {string} * @memberof OrderDetails */ shipWindow?: string; /** * Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--). * @type {string} * @memberof OrderDetails */ deliveryWindow?: string; /** * A list of items in this purchase order. * @type {Array} * @memberof OrderDetails */ items: Array; } /** * @export * @enum {string} */ export declare enum OrderDetailsPurchaseOrderTypeEnum { RegularOrder = "RegularOrder", ConsignedOrder = "ConsignedOrder", NewProductIntroduction = "NewProductIntroduction", RushOrder = "RushOrder" } /** * @export * @enum {string} */ export declare enum OrderDetailsPaymentMethodEnum { Invoice = "Invoice", Consignment = "Consignment", CreditCard = "CreditCard", Prepaid = "Prepaid" } /** * Represents an individual item in an order, including item details, quantities, pricing, and backorder information. * @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; /** * Amazon Standard Identification Number (ASIN) of an item. * @type {string} * @memberof OrderItem */ amazonProductIdentifier?: string; /** * The vendor selected product identification of the item. * @type {string} * @memberof OrderItem */ vendorProductIdentifier?: string; /** * * @type {ItemQuantity} * @memberof OrderItem */ orderedQuantity: ItemQuantity; /** * When true, we will accept backorder confirmations for this item. * @type {boolean} * @memberof OrderItem */ isBackOrderAllowed: boolean; /** * * @type {Money} * @memberof OrderItem */ netCost?: Money; /** * * @type {Money} * @memberof OrderItem */ listPrice?: Money; } /** * Represents the acknowledgement details for an individual order item, including the acknowledgement code, acknowledged quantity, scheduled ship and delivery dates, and rejection reason (if applicable). * @export * @interface OrderItemAcknowledgement */ export interface OrderItemAcknowledgement { /** * This indicates the acknowledgement code. * @type {string} * @memberof OrderItemAcknowledgement */ acknowledgementCode: OrderItemAcknowledgementAcknowledgementCodeEnum | 'Accepted' | 'Backordered' | 'Rejected'; /** * * @type {ItemQuantity} * @memberof OrderItemAcknowledgement */ acknowledgedQuantity: ItemQuantity; /** * Estimated ship date per line item. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderItemAcknowledgement */ scheduledShipDate?: string; /** * Estimated delivery date per line item. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderItemAcknowledgement */ scheduledDeliveryDate?: string; /** * Indicates the reason for rejection. * @type {string} * @memberof OrderItemAcknowledgement */ rejectionReason?: OrderItemAcknowledgementRejectionReasonEnum | 'TemporarilyUnavailable' | 'InvalidProductIdentifier' | 'ObsoleteProduct'; } /** * @export * @enum {string} */ export declare enum OrderItemAcknowledgementAcknowledgementCodeEnum { Accepted = "Accepted", Backordered = "Backordered", Rejected = "Rejected" } /** * @export * @enum {string} */ export declare enum OrderItemAcknowledgementRejectionReasonEnum { TemporarilyUnavailable = "TemporarilyUnavailable", InvalidProductIdentifier = "InvalidProductIdentifier", ObsoleteProduct = "ObsoleteProduct" } /** * Represents the current status of an order item, including acknowledgement and receiving details. * @export * @interface OrderItemStatus */ export interface OrderItemStatus { /** * Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on. * @type {string} * @memberof OrderItemStatus */ itemSequenceNumber: string; /** * Buyer\'s Standard Identification Number (ASIN) of an item. * @type {string} * @memberof OrderItemStatus */ buyerProductIdentifier?: string; /** * The vendor selected product identification of the item. * @type {string} * @memberof OrderItemStatus */ vendorProductIdentifier?: string; /** * * @type {Money} * @memberof OrderItemStatus */ netCost?: Money; /** * * @type {Money} * @memberof OrderItemStatus */ listPrice?: Money; /** * * @type {OrderItemStatusOrderedQuantity} * @memberof OrderItemStatus */ orderedQuantity?: OrderItemStatusOrderedQuantity; /** * * @type {OrderItemStatusAcknowledgementStatus} * @memberof OrderItemStatus */ acknowledgementStatus?: OrderItemStatusAcknowledgementStatus; /** * * @type {OrderItemStatusReceivingStatus} * @memberof OrderItemStatus */ receivingStatus?: OrderItemStatusReceivingStatus; } /** * Acknowledgement status information. * @export * @interface OrderItemStatusAcknowledgementStatus */ export interface OrderItemStatusAcknowledgementStatus { /** * Confirmation status of line item. * @type {string} * @memberof OrderItemStatusAcknowledgementStatus */ confirmationStatus?: OrderItemStatusAcknowledgementStatusConfirmationStatusEnum | 'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'; /** * * @type {ItemQuantity} * @memberof OrderItemStatusAcknowledgementStatus */ acceptedQuantity?: ItemQuantity; /** * * @type {ItemQuantity} * @memberof OrderItemStatusAcknowledgementStatus */ rejectedQuantity?: ItemQuantity; /** * Details of item quantity confirmed. * @type {Array} * @memberof OrderItemStatusAcknowledgementStatus */ acknowledgementStatusDetails?: Array; } /** * @export * @enum {string} */ export declare enum OrderItemStatusAcknowledgementStatusConfirmationStatusEnum { Accepted = "ACCEPTED", PartiallyAccepted = "PARTIALLY_ACCEPTED", Rejected = "REJECTED", Unconfirmed = "UNCONFIRMED" } /** * Ordered quantity information. * @export * @interface OrderItemStatusOrderedQuantity */ export interface OrderItemStatusOrderedQuantity { /** * * @type {ItemQuantity} * @memberof OrderItemStatusOrderedQuantity */ orderedQuantity?: ItemQuantity; /** * Details of item quantity ordered. * @type {Array} * @memberof OrderItemStatusOrderedQuantity */ orderedQuantityDetails?: Array; } /** * Item receive status at the buyer\'s warehouse. * @export * @interface OrderItemStatusReceivingStatus */ export interface OrderItemStatusReceivingStatus { /** * Receive status of the line item. * @type {string} * @memberof OrderItemStatusReceivingStatus */ receiveStatus?: OrderItemStatusReceivingStatusReceiveStatusEnum | 'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED'; /** * * @type {ItemQuantity} * @memberof OrderItemStatusReceivingStatus */ receivedQuantity?: ItemQuantity; /** * The date when the most recent item was received at the buyer\'s warehouse. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderItemStatusReceivingStatus */ lastReceiveDate?: string; } /** * @export * @enum {string} */ export declare enum OrderItemStatusReceivingStatusReceiveStatusEnum { NotReceived = "NOT_RECEIVED", PartiallyReceived = "PARTIALLY_RECEIVED", Received = "RECEIVED" } /** * A list of orders returned as response. * @export * @interface OrderList */ export interface OrderList { /** * * @type {Pagination} * @memberof OrderList */ pagination?: Pagination; /** * Represents an individual order within the OrderList. * @type {Array} * @memberof OrderList */ orders?: Array; } /** * A list of order statuses. * @export * @interface OrderListStatus */ export interface OrderListStatus { /** * * @type {Pagination} * @memberof OrderListStatus */ pagination?: Pagination; /** * Represents an order status within the OrderListStatus. * @type {Array} * @memberof OrderListStatus */ ordersStatus?: Array; } /** * Current status of a purchase order. * @export * @interface OrderStatus */ export interface OrderStatus { /** * The buyer\'s purchase order number for this order. Formatting Notes: 8-character alpha-numeric code. * @type {string} * @memberof OrderStatus */ purchaseOrderNumber: string; /** * The status of the buyer\'s purchase order for this order. * @type {string} * @memberof OrderStatus */ purchaseOrderStatus: OrderStatusPurchaseOrderStatusEnum | 'OPEN' | 'CLOSED'; /** * The date the purchase order was placed. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderStatus */ purchaseOrderDate: string; /** * The date when the purchase order was last updated. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderStatus */ lastUpdatedDate?: string; /** * * @type {PartyIdentification} * @memberof OrderStatus */ sellingParty: PartyIdentification; /** * * @type {PartyIdentification} * @memberof OrderStatus */ shipToParty: PartyIdentification; /** * Detailed description of items order status. * @type {Array} * @memberof OrderStatus */ itemStatus: Array; } /** * @export * @enum {string} */ export declare enum OrderStatusPurchaseOrderStatusEnum { Open = "OPEN", Closed = "CLOSED" } /** * Details of item quantity ordered. * @export * @interface OrderedQuantityDetails */ export interface OrderedQuantityDetails { /** * The date when the line item quantity was updated by buyer. Must be in ISO-8601 date/time format. * @type {string} * @memberof OrderedQuantityDetails */ updatedDate?: string; /** * * @type {ItemQuantity} * @memberof OrderedQuantityDetails */ orderedQuantity?: ItemQuantity; /** * * @type {ItemQuantity} * @memberof OrderedQuantityDetails */ cancelledQuantity?: ItemQuantity; } /** * 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 purchase 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; } /** * The request schema for the submitAcknowledgment operation. * @export * @interface SubmitAcknowledgementRequest */ export interface SubmitAcknowledgementRequest { /** * An array of order acknowledgements to be submitted. * @type {Array} * @memberof SubmitAcknowledgementRequest */ acknowledgements?: 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; } /** * 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 entity. For example, VAT ID. * @type {string} * @memberof TaxRegistrationDetails */ taxRegistrationNumber: 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 a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPurchaseOrder: (purchaseOrderNumber: string, options?: any) => Promise; /** * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. * @param {string} [createdAfter] Purchase orders that became available after this 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 time will be included in the result. Must be in ISO-8601 date/time format. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call * @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. * @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {'Cancelled'} [poItemState] Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. * @param {boolean} [isPOChanged] When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @param {'New' | 'Acknowledged' | 'Closed'} [purchaseOrderState] Filters purchase orders based on the purchase order state. * @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPurchaseOrders: (limit?: number, createdAfter?: string, createdBefore?: string, sortOrder?: "ASC" | "DESC", nextToken?: string, includeDetails?: boolean, changedAfter?: string, changedBefore?: string, poItemState?: "Cancelled", isPOChanged?: boolean, purchaseOrderState?: "New" | "Acknowledged" | "Closed", orderingVendorCode?: string, options?: any) => Promise; /** * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit. * @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number. * @param {'OPEN' | 'CLOSED'} [purchaseOrderStatus] Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. * @param {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} [itemConfirmationStatus] Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. * @param {'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED'} [itemReceiveStatus] Filters purchase orders based on the purchase order\'s item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included. * @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned. * @param {string} [shipToPartyId] Filters purchase orders for a specific buyer\'s Fulfillment Center/warehouse by providing ship to location id here. This value should be same as \'shipToParty.partyId\' in the purchase order. If not included in filter, this will return purchase orders for all the buyer\'s warehouses used for vendor group purchase orders. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPurchaseOrdersStatus: (limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: "OPEN" | "CLOSED", itemConfirmationStatus?: "ACCEPTED" | "PARTIALLY_ACCEPTED" | "REJECTED" | "UNCONFIRMED", itemReceiveStatus?: "NOT_RECEIVED" | "PARTIALLY_RECEIVED" | "RECEIVED", orderingVendorCode?: string, shipToPartyId?: string, 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {SubmitAcknowledgementRequest} body Submits acknowledgements for one or more purchase orders from a vendor. * @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 a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPurchaseOrder(purchaseOrderNumber: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. * @param {string} [createdAfter] Purchase orders that became available after this 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 time will be included in the result. Must be in ISO-8601 date/time format. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call * @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. * @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {'Cancelled'} [poItemState] Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. * @param {boolean} [isPOChanged] When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @param {'New' | 'Acknowledged' | 'Closed'} [purchaseOrderState] Filters purchase orders based on the purchase order state. * @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPurchaseOrders(limit?: number, createdAfter?: string, createdBefore?: string, sortOrder?: "ASC" | "DESC", nextToken?: string, includeDetails?: boolean, changedAfter?: string, changedBefore?: string, poItemState?: "Cancelled", isPOChanged?: boolean, purchaseOrderState?: "New" | "Acknowledged" | "Closed", orderingVendorCode?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit. * @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number. * @param {'OPEN' | 'CLOSED'} [purchaseOrderStatus] Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. * @param {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} [itemConfirmationStatus] Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. * @param {'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED'} [itemReceiveStatus] Filters purchase orders based on the purchase order\'s item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included. * @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned. * @param {string} [shipToPartyId] Filters purchase orders for a specific buyer\'s Fulfillment Center/warehouse by providing ship to location id here. This value should be same as \'shipToParty.partyId\' in the purchase order. If not included in filter, this will return purchase orders for all the buyer\'s warehouses used for vendor group purchase orders. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPurchaseOrdersStatus(limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: "OPEN" | "CLOSED", itemConfirmationStatus?: "ACCEPTED" | "PARTIALLY_ACCEPTED" | "REJECTED" | "UNCONFIRMED", itemReceiveStatus?: "NOT_RECEIVED" | "PARTIALLY_RECEIVED" | "RECEIVED", orderingVendorCode?: string, shipToPartyId?: string, 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {SubmitAcknowledgementRequest} body Submits acknowledgements for one or more purchase orders from a vendor. * @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 a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPurchaseOrder(purchaseOrderNumber: string, options?: any): AxiosPromise; /** * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. * @param {string} [createdAfter] Purchase orders that became available after this 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 time will be included in the result. Must be in ISO-8601 date/time format. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call * @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. * @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {'Cancelled'} [poItemState] Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. * @param {boolean} [isPOChanged] When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @param {'New' | 'Acknowledged' | 'Closed'} [purchaseOrderState] Filters purchase orders based on the purchase order state. * @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPurchaseOrders(limit?: number, createdAfter?: string, createdBefore?: string, sortOrder?: "ASC" | "DESC", nextToken?: string, includeDetails?: boolean, changedAfter?: string, changedBefore?: string, poItemState?: "Cancelled", isPOChanged?: boolean, purchaseOrderState?: "New" | "Acknowledged" | "Closed", orderingVendorCode?: string, options?: any): AxiosPromise; /** * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {number} [limit] The limit to the number of records returned. Default value is 100 records. * @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date. * @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit. * @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number. * @param {'OPEN' | 'CLOSED'} [purchaseOrderStatus] Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. * @param {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} [itemConfirmationStatus] Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. * @param {'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED'} [itemReceiveStatus] Filters purchase orders based on the purchase order\'s item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included. * @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned. * @param {string} [shipToPartyId] Filters purchase orders for a specific buyer\'s Fulfillment Center/warehouse by providing ship to location id here. This value should be same as \'shipToParty.partyId\' in the purchase order. If not included in filter, this will return purchase orders for all the buyer\'s warehouses used for vendor group purchase orders. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPurchaseOrdersStatus(limit?: number, sortOrder?: "ASC" | "DESC", nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: "OPEN" | "CLOSED", itemConfirmationStatus?: "ACCEPTED" | "PARTIALLY_ACCEPTED" | "REJECTED" | "UNCONFIRMED", itemReceiveStatus?: "NOT_RECEIVED" | "PARTIALLY_RECEIVED" | "RECEIVED", orderingVendorCode?: string, shipToPartyId?: string, 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {SubmitAcknowledgementRequest} body Submits acknowledgements for one or more purchase orders from a vendor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: any): AxiosPromise; }; /** * Request parameters for getPurchaseOrder operation in VendorOrdersApi. * @export * @interface VendorOrdersApiGetPurchaseOrderRequest */ export interface VendorOrdersApiGetPurchaseOrderRequest { /** * The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrder */ readonly purchaseOrderNumber: string; } /** * Request parameters for getPurchaseOrders operation in VendorOrdersApi. * @export * @interface VendorOrdersApiGetPurchaseOrdersRequest */ export interface VendorOrdersApiGetPurchaseOrdersRequest { /** * The limit to the number of records returned. Default value is 100 records. * @type {number} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly limit?: number; /** * Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly createdAfter?: string; /** * Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly createdBefore?: string; /** * Sort in ascending or descending order by purchase order creation date. * @type {'ASC' | 'DESC'} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly sortOrder?: 'ASC' | 'DESC'; /** * Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly nextToken?: string; /** * When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. * @type {boolean} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly includeDetails?: boolean; /** * Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly changedAfter?: string; /** * Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly changedBefore?: string; /** * Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. * @type {'Cancelled'} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly poItemState?: 'Cancelled'; /** * When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. * @type {boolean} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly isPOChanged?: boolean; /** * Filters purchase orders based on the purchase order state. * @type {'New' | 'Acknowledged' | 'Closed'} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly purchaseOrderState?: 'New' | 'Acknowledged' | 'Closed'; /** * Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrders */ readonly orderingVendorCode?: string; } /** * Request parameters for getPurchaseOrdersStatus operation in VendorOrdersApi. * @export * @interface VendorOrdersApiGetPurchaseOrdersStatusRequest */ export interface VendorOrdersApiGetPurchaseOrdersStatusRequest { /** * The limit to the number of records returned. Default value is 100 records. * @type {number} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly limit?: number; /** * Sort in ascending or descending order by purchase order creation date. * @type {'ASC' | 'DESC'} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly sortOrder?: 'ASC' | 'DESC'; /** * Used for pagination when there are more purchase orders than the specified result size limit. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly nextToken?: string; /** * Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly createdAfter?: string; /** * Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly createdBefore?: string; /** * Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly updatedAfter?: string; /** * Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly updatedBefore?: string; /** * Provides purchase order status for the specified purchase order number. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly purchaseOrderNumber?: string; /** * Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. * @type {'OPEN' | 'CLOSED'} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly purchaseOrderStatus?: 'OPEN' | 'CLOSED'; /** * Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. * @type {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly itemConfirmationStatus?: 'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'; /** * Filters purchase orders based on the purchase order\'s item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included. * @type {'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED'} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly itemReceiveStatus?: 'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED'; /** * Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly orderingVendorCode?: string; /** * Filters purchase orders for a specific buyer\'s Fulfillment Center/warehouse by providing ship to location id here. This value should be same as \'shipToParty.partyId\' in the purchase order. If not included in filter, this will return purchase orders for all the buyer\'s warehouses used for vendor group purchase orders. * @type {string} * @memberof VendorOrdersApiGetPurchaseOrdersStatus */ readonly shipToPartyId?: string; } /** * Request parameters for submitAcknowledgement operation in VendorOrdersApi. * @export * @interface VendorOrdersApiSubmitAcknowledgementRequest */ export interface VendorOrdersApiSubmitAcknowledgementRequest { /** * Submits acknowledgements for one or more purchase orders from a vendor. * @type {SubmitAcknowledgementRequest} * @memberof VendorOrdersApiSubmitAcknowledgement */ readonly body: SubmitAcknowledgementRequest; } /** * VendorOrdersApi - object-oriented interface * @export * @class VendorOrdersApi * @extends {BaseAPI} */ export declare class VendorOrdersApi extends BaseAPI { /** * Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorOrdersApiGetPurchaseOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorOrdersApi */ getPurchaseOrder(requestParameters: VendorOrdersApiGetPurchaseOrderRequest, options?: any): Promise>; /** * Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorOrdersApiGetPurchaseOrdersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorOrdersApi */ getPurchaseOrders(requestParameters?: VendorOrdersApiGetPurchaseOrdersRequest, options?: any): Promise>; /** * Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorOrdersApiGetPurchaseOrdersStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorOrdersApi */ getPurchaseOrdersStatus(requestParameters?: VendorOrdersApiGetPurchaseOrdersStatusRequest, 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 preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VendorOrdersApi */ submitAcknowledgement(requestParameters: VendorOrdersApiSubmitAcknowledgementRequest, options?: any): Promise>; }