@sp-api-sdk/vendor-orders-api-v1 1.6.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +58 -0
- package/dist/cjs/index.js +6 -0
- package/dist/cjs/src/api-model/api/vendor-orders-api.js +438 -0
- package/dist/cjs/src/api-model/api.js +17 -0
- package/dist/cjs/src/api-model/base.js +62 -0
- package/dist/cjs/src/api-model/common.js +137 -0
- package/dist/cjs/src/api-model/configuration.js +42 -0
- package/dist/cjs/src/api-model/index.js +19 -0
- package/dist/cjs/src/api-model/models/acknowledgement-status-details.js +15 -0
- package/dist/cjs/src/api-model/models/address.js +15 -0
- package/dist/cjs/src/api-model/models/get-purchase-order-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-purchase-orders-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-purchase-orders-status-response.js +15 -0
- package/dist/cjs/src/api-model/models/import-details.js +47 -0
- package/dist/cjs/src/api-model/models/index.js +31 -0
- package/dist/cjs/src/api-model/models/item-quantity.js +25 -0
- package/dist/cjs/src/api-model/models/model-error.js +15 -0
- package/dist/cjs/src/api-model/models/money.js +15 -0
- package/dist/cjs/src/api-model/models/order-acknowledgement-item.js +15 -0
- package/dist/cjs/src/api-model/models/order-acknowledgement.js +15 -0
- package/dist/cjs/src/api-model/models/order-details.js +38 -0
- package/dist/cjs/src/api-model/models/order-item-acknowledgement.js +36 -0
- package/dist/cjs/src/api-model/models/order-item-status-acknowledgement-status.js +27 -0
- package/dist/cjs/src/api-model/models/order-item-status-ordered-quantity.js +15 -0
- package/dist/cjs/src/api-model/models/order-item-status.js +15 -0
- package/dist/cjs/src/api-model/models/order-item.js +15 -0
- package/dist/cjs/src/api-model/models/order-list-status.js +15 -0
- package/dist/cjs/src/api-model/models/order-list.js +15 -0
- package/dist/cjs/src/api-model/models/order-status.js +25 -0
- package/dist/cjs/src/api-model/models/order.js +26 -0
- package/dist/cjs/src/api-model/models/ordered-quantity-details.js +15 -0
- package/dist/cjs/src/api-model/models/pagination.js +15 -0
- package/dist/cjs/src/api-model/models/party-identification.js +15 -0
- package/dist/cjs/src/api-model/models/submit-acknowledgement-request.js +15 -0
- package/dist/cjs/src/api-model/models/submit-acknowledgement-response.js +15 -0
- package/dist/cjs/src/api-model/models/tax-registration-details.js +25 -0
- package/dist/cjs/src/api-model/models/transaction-id.js +15 -0
- package/dist/cjs/src/client.js +53 -0
- package/dist/cjs/src/error.js +10 -0
- package/dist/es/index.js +3 -0
- package/dist/es/src/api-model/api/vendor-orders-api.js +430 -0
- package/dist/es/src/api-model/api.js +14 -0
- package/dist/es/src/api-model/base.js +56 -0
- package/dist/es/src/api-model/common.js +125 -0
- package/dist/es/src/api-model/configuration.js +38 -0
- package/dist/es/src/api-model/index.js +16 -0
- package/dist/es/src/api-model/models/acknowledgement-status-details.js +14 -0
- package/dist/es/src/api-model/models/address.js +14 -0
- package/dist/es/src/api-model/models/get-purchase-order-response.js +14 -0
- package/dist/es/src/api-model/models/get-purchase-orders-response.js +14 -0
- package/dist/es/src/api-model/models/get-purchase-orders-status-response.js +14 -0
- package/dist/es/src/api-model/models/import-details.js +44 -0
- package/dist/es/src/api-model/models/index.js +28 -0
- package/dist/es/src/api-model/models/item-quantity.js +22 -0
- package/dist/es/src/api-model/models/model-error.js +14 -0
- package/dist/es/src/api-model/models/money.js +14 -0
- package/dist/es/src/api-model/models/order-acknowledgement-item.js +14 -0
- package/dist/es/src/api-model/models/order-acknowledgement.js +14 -0
- package/dist/es/src/api-model/models/order-details.js +35 -0
- package/dist/es/src/api-model/models/order-item-acknowledgement.js +33 -0
- package/dist/es/src/api-model/models/order-item-status-acknowledgement-status.js +24 -0
- package/dist/es/src/api-model/models/order-item-status-ordered-quantity.js +14 -0
- package/dist/es/src/api-model/models/order-item-status.js +14 -0
- package/dist/es/src/api-model/models/order-item.js +14 -0
- package/dist/es/src/api-model/models/order-list-status.js +14 -0
- package/dist/es/src/api-model/models/order-list.js +14 -0
- package/dist/es/src/api-model/models/order-status.js +22 -0
- package/dist/es/src/api-model/models/order.js +23 -0
- package/dist/es/src/api-model/models/ordered-quantity-details.js +14 -0
- package/dist/es/src/api-model/models/pagination.js +14 -0
- package/dist/es/src/api-model/models/party-identification.js +14 -0
- package/dist/es/src/api-model/models/submit-acknowledgement-request.js +14 -0
- package/dist/es/src/api-model/models/submit-acknowledgement-response.js +14 -0
- package/dist/es/src/api-model/models/tax-registration-details.js +22 -0
- package/dist/es/src/api-model/models/transaction-id.js +14 -0
- package/dist/es/src/client.js +49 -0
- package/dist/es/src/error.js +6 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/src/api-model/api/vendor-orders-api.d.ts +411 -0
- package/dist/types/src/api-model/api.d.ts +12 -0
- package/dist/types/src/api-model/base.d.ts +55 -0
- package/dist/types/src/api-model/common.d.ts +65 -0
- package/dist/types/src/api-model/configuration.d.ts +83 -0
- package/dist/types/src/api-model/index.d.ts +14 -0
- package/dist/types/src/api-model/models/acknowledgement-status-details.d.ts +37 -0
- package/dist/types/src/api-model/models/address.d.ts +84 -0
- package/dist/types/src/api-model/models/get-purchase-order-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-purchase-orders-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-purchase-orders-status-response.d.ts +31 -0
- package/dist/types/src/api-model/models/import-details.d.ts +77 -0
- package/dist/types/src/api-model/models/index.d.ts +28 -0
- package/dist/types/src/api-model/models/item-quantity.d.ts +44 -0
- package/dist/types/src/api-model/models/model-error.d.ts +36 -0
- package/dist/types/src/api-model/models/money.d.ts +30 -0
- package/dist/types/src/api-model/models/order-acknowledgement-item.d.ts +69 -0
- package/dist/types/src/api-model/models/order-acknowledgement.d.ts +44 -0
- package/dist/types/src/api-model/models/order-details.d.ts +125 -0
- package/dist/types/src/api-model/models/order-item-acknowledgement.d.ts +67 -0
- package/dist/types/src/api-model/models/order-item-status-acknowledgement-status.d.ts +54 -0
- package/dist/types/src/api-model/models/order-item-status-ordered-quantity.d.ts +32 -0
- package/dist/types/src/api-model/models/order-item-status.d.ts +63 -0
- package/dist/types/src/api-model/models/order-item.d.ts +62 -0
- package/dist/types/src/api-model/models/order-list-status.d.ts +32 -0
- package/dist/types/src/api-model/models/order-list.d.ts +32 -0
- package/dist/types/src/api-model/models/order-status.d.ts +70 -0
- package/dist/types/src/api-model/models/order.d.ts +46 -0
- package/dist/types/src/api-model/models/ordered-quantity-details.d.ts +37 -0
- package/dist/types/src/api-model/models/pagination.d.ts +24 -0
- package/dist/types/src/api-model/models/party-identification.d.ts +38 -0
- package/dist/types/src/api-model/models/submit-acknowledgement-request.d.ts +25 -0
- package/dist/types/src/api-model/models/submit-acknowledgement-response.d.ts +31 -0
- package/dist/types/src/api-model/models/tax-registration-details.d.ts +38 -0
- package/dist/types/src/api-model/models/transaction-id.d.ts +24 -0
- package/dist/types/src/client.d.ts +13 -0
- package/dist/types/src/error.d.ts +3 -0
- package/package.json +53 -0
|
@@ -0,0 +1,411 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Retail Procurement Orders
|
|
3
|
+
* The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { GetPurchaseOrderResponse } from '../models';
|
|
16
|
+
import { GetPurchaseOrdersResponse } from '../models';
|
|
17
|
+
import { GetPurchaseOrdersStatusResponse } from '../models';
|
|
18
|
+
import { SubmitAcknowledgementRequest } from '../models';
|
|
19
|
+
import { SubmitAcknowledgementResponse } from '../models';
|
|
20
|
+
/**
|
|
21
|
+
* VendorOrdersApi - axios parameter creator
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
25
|
+
/**
|
|
26
|
+
* Returns a purchase order based on the purchaseOrderNumber value that you specify. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
27
|
+
* @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
getPurchaseOrder: (purchaseOrderNumber: string, options?: any) => Promise<RequestArgs>;
|
|
32
|
+
/**
|
|
33
|
+
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
34
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
35
|
+
* @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.
|
|
36
|
+
* @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.
|
|
37
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
38
|
+
* @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
|
|
39
|
+
* @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
|
|
40
|
+
* @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
41
|
+
* @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
42
|
+
* @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.
|
|
43
|
+
* @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.
|
|
44
|
+
* @param {'New' | 'Acknowledged' | 'Closed'} [purchaseOrderState] Filters purchase orders based on the purchase order state.
|
|
45
|
+
* @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.
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
getPurchaseOrders: (limit?: number | undefined, createdAfter?: string | undefined, createdBefore?: string | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, includeDetails?: boolean | undefined, changedAfter?: string | undefined, changedBefore?: string | undefined, poItemState?: "Cancelled" | undefined, isPOChanged?: boolean | undefined, purchaseOrderState?: "New" | "Acknowledged" | "Closed" | undefined, orderingVendorCode?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
50
|
+
/**
|
|
51
|
+
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
52
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
53
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
54
|
+
* @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit.
|
|
55
|
+
* @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.
|
|
56
|
+
* @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.
|
|
57
|
+
* @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.
|
|
58
|
+
* @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.
|
|
59
|
+
* @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number.
|
|
60
|
+
* @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.
|
|
61
|
+
* @param {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} [itemConfirmationStatus] Filters purchase orders based on the specified purchase order item status. If not included in filter, purchase orders for all statuses are included.
|
|
62
|
+
* @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.
|
|
63
|
+
* @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.
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
getPurchaseOrdersStatus: (limit?: number | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, createdAfter?: string | undefined, createdBefore?: string | undefined, updatedAfter?: string | undefined, updatedBefore?: string | undefined, purchaseOrderNumber?: string | undefined, purchaseOrderStatus?: "OPEN" | "CLOSED" | undefined, itemConfirmationStatus?: "ACCEPTED" | "PARTIALLY_ACCEPTED" | "REJECTED" | "UNCONFIRMED" | undefined, orderingVendorCode?: string | undefined, shipToPartyId?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
68
|
+
/**
|
|
69
|
+
* Submits acknowledgements for one or more purchase orders. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
70
|
+
* @param {SubmitAcknowledgementRequest} body
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
submitAcknowledgement: (body: SubmitAcknowledgementRequest, options?: any) => Promise<RequestArgs>;
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* VendorOrdersApi - functional programming interface
|
|
78
|
+
* @export
|
|
79
|
+
*/
|
|
80
|
+
export declare const VendorOrdersApiFp: (configuration?: Configuration | undefined) => {
|
|
81
|
+
/**
|
|
82
|
+
* Returns a purchase order based on the purchaseOrderNumber value that you specify. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
83
|
+
* @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
getPurchaseOrder(purchaseOrderNumber: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetPurchaseOrderResponse>>;
|
|
88
|
+
/**
|
|
89
|
+
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
90
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
91
|
+
* @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.
|
|
92
|
+
* @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.
|
|
93
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
94
|
+
* @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
|
|
95
|
+
* @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
|
|
96
|
+
* @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
97
|
+
* @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
98
|
+
* @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.
|
|
99
|
+
* @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.
|
|
100
|
+
* @param {'New' | 'Acknowledged' | 'Closed'} [purchaseOrderState] Filters purchase orders based on the purchase order state.
|
|
101
|
+
* @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.
|
|
102
|
+
* @param {*} [options] Override http request option.
|
|
103
|
+
* @throws {RequiredError}
|
|
104
|
+
*/
|
|
105
|
+
getPurchaseOrders(limit?: number | undefined, createdAfter?: string | undefined, createdBefore?: string | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, includeDetails?: boolean | undefined, changedAfter?: string | undefined, changedBefore?: string | undefined, poItemState?: "Cancelled" | undefined, isPOChanged?: boolean | undefined, purchaseOrderState?: "New" | "Acknowledged" | "Closed" | undefined, orderingVendorCode?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetPurchaseOrdersResponse>>;
|
|
106
|
+
/**
|
|
107
|
+
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
108
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
109
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
110
|
+
* @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit.
|
|
111
|
+
* @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.
|
|
112
|
+
* @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.
|
|
113
|
+
* @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.
|
|
114
|
+
* @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.
|
|
115
|
+
* @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number.
|
|
116
|
+
* @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.
|
|
117
|
+
* @param {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} [itemConfirmationStatus] Filters purchase orders based on the specified purchase order item status. If not included in filter, purchase orders for all statuses are included.
|
|
118
|
+
* @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.
|
|
119
|
+
* @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.
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
getPurchaseOrdersStatus(limit?: number | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, createdAfter?: string | undefined, createdBefore?: string | undefined, updatedAfter?: string | undefined, updatedBefore?: string | undefined, purchaseOrderNumber?: string | undefined, purchaseOrderStatus?: "OPEN" | "CLOSED" | undefined, itemConfirmationStatus?: "ACCEPTED" | "PARTIALLY_ACCEPTED" | "REJECTED" | "UNCONFIRMED" | undefined, orderingVendorCode?: string | undefined, shipToPartyId?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetPurchaseOrdersStatusResponse>>;
|
|
124
|
+
/**
|
|
125
|
+
* Submits acknowledgements for one or more purchase orders. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
126
|
+
* @param {SubmitAcknowledgementRequest} body
|
|
127
|
+
* @param {*} [options] Override http request option.
|
|
128
|
+
* @throws {RequiredError}
|
|
129
|
+
*/
|
|
130
|
+
submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SubmitAcknowledgementResponse>>;
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* VendorOrdersApi - factory interface
|
|
134
|
+
* @export
|
|
135
|
+
*/
|
|
136
|
+
export declare const VendorOrdersApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
137
|
+
/**
|
|
138
|
+
* Returns a purchase order based on the purchaseOrderNumber value that you specify. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
139
|
+
* @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
140
|
+
* @param {*} [options] Override http request option.
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
*/
|
|
143
|
+
getPurchaseOrder(purchaseOrderNumber: string, options?: any): AxiosPromise<GetPurchaseOrderResponse>;
|
|
144
|
+
/**
|
|
145
|
+
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
146
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
147
|
+
* @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.
|
|
148
|
+
* @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.
|
|
149
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
150
|
+
* @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
|
|
151
|
+
* @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
|
|
152
|
+
* @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
153
|
+
* @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
154
|
+
* @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.
|
|
155
|
+
* @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.
|
|
156
|
+
* @param {'New' | 'Acknowledged' | 'Closed'} [purchaseOrderState] Filters purchase orders based on the purchase order state.
|
|
157
|
+
* @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.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
getPurchaseOrders(limit?: number | undefined, createdAfter?: string | undefined, createdBefore?: string | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, includeDetails?: boolean | undefined, changedAfter?: string | undefined, changedBefore?: string | undefined, poItemState?: "Cancelled" | undefined, isPOChanged?: boolean | undefined, purchaseOrderState?: "New" | "Acknowledged" | "Closed" | undefined, orderingVendorCode?: string | undefined, options?: any): AxiosPromise<GetPurchaseOrdersResponse>;
|
|
162
|
+
/**
|
|
163
|
+
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
164
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
165
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
166
|
+
* @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit.
|
|
167
|
+
* @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.
|
|
168
|
+
* @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.
|
|
169
|
+
* @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.
|
|
170
|
+
* @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.
|
|
171
|
+
* @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number.
|
|
172
|
+
* @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.
|
|
173
|
+
* @param {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'} [itemConfirmationStatus] Filters purchase orders based on the specified purchase order item status. If not included in filter, purchase orders for all statuses are included.
|
|
174
|
+
* @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.
|
|
175
|
+
* @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.
|
|
176
|
+
* @param {*} [options] Override http request option.
|
|
177
|
+
* @throws {RequiredError}
|
|
178
|
+
*/
|
|
179
|
+
getPurchaseOrdersStatus(limit?: number | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, createdAfter?: string | undefined, createdBefore?: string | undefined, updatedAfter?: string | undefined, updatedBefore?: string | undefined, purchaseOrderNumber?: string | undefined, purchaseOrderStatus?: "OPEN" | "CLOSED" | undefined, itemConfirmationStatus?: "ACCEPTED" | "PARTIALLY_ACCEPTED" | "REJECTED" | "UNCONFIRMED" | undefined, orderingVendorCode?: string | undefined, shipToPartyId?: string | undefined, options?: any): AxiosPromise<GetPurchaseOrdersStatusResponse>;
|
|
180
|
+
/**
|
|
181
|
+
* Submits acknowledgements for one or more purchase orders. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
182
|
+
* @param {SubmitAcknowledgementRequest} body
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: any): AxiosPromise<SubmitAcknowledgementResponse>;
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Request parameters for getPurchaseOrder operation in VendorOrdersApi.
|
|
190
|
+
* @export
|
|
191
|
+
* @interface VendorOrdersApiGetPurchaseOrderRequest
|
|
192
|
+
*/
|
|
193
|
+
export interface VendorOrdersApiGetPurchaseOrderRequest {
|
|
194
|
+
/**
|
|
195
|
+
* The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
196
|
+
* @type {string}
|
|
197
|
+
* @memberof VendorOrdersApiGetPurchaseOrder
|
|
198
|
+
*/
|
|
199
|
+
readonly purchaseOrderNumber: string;
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* Request parameters for getPurchaseOrders operation in VendorOrdersApi.
|
|
203
|
+
* @export
|
|
204
|
+
* @interface VendorOrdersApiGetPurchaseOrdersRequest
|
|
205
|
+
*/
|
|
206
|
+
export interface VendorOrdersApiGetPurchaseOrdersRequest {
|
|
207
|
+
/**
|
|
208
|
+
* The limit to the number of records returned. Default value is 100 records.
|
|
209
|
+
* @type {number}
|
|
210
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
211
|
+
*/
|
|
212
|
+
readonly limit?: number;
|
|
213
|
+
/**
|
|
214
|
+
* Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
215
|
+
* @type {string}
|
|
216
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
217
|
+
*/
|
|
218
|
+
readonly createdAfter?: string;
|
|
219
|
+
/**
|
|
220
|
+
* Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
221
|
+
* @type {string}
|
|
222
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
223
|
+
*/
|
|
224
|
+
readonly createdBefore?: string;
|
|
225
|
+
/**
|
|
226
|
+
* Sort in ascending or descending order by purchase order creation date.
|
|
227
|
+
* @type {'ASC' | 'DESC'}
|
|
228
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
229
|
+
*/
|
|
230
|
+
readonly sortOrder?: 'ASC' | 'DESC';
|
|
231
|
+
/**
|
|
232
|
+
* 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
|
|
233
|
+
* @type {string}
|
|
234
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
235
|
+
*/
|
|
236
|
+
readonly nextToken?: string;
|
|
237
|
+
/**
|
|
238
|
+
* When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
|
|
239
|
+
* @type {boolean}
|
|
240
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
241
|
+
*/
|
|
242
|
+
readonly includeDetails?: boolean;
|
|
243
|
+
/**
|
|
244
|
+
* Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
245
|
+
* @type {string}
|
|
246
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
247
|
+
*/
|
|
248
|
+
readonly changedAfter?: string;
|
|
249
|
+
/**
|
|
250
|
+
* Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
251
|
+
* @type {string}
|
|
252
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
253
|
+
*/
|
|
254
|
+
readonly changedBefore?: string;
|
|
255
|
+
/**
|
|
256
|
+
* 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.
|
|
257
|
+
* @type {'Cancelled'}
|
|
258
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
259
|
+
*/
|
|
260
|
+
readonly poItemState?: 'Cancelled';
|
|
261
|
+
/**
|
|
262
|
+
* 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.
|
|
263
|
+
* @type {boolean}
|
|
264
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
265
|
+
*/
|
|
266
|
+
readonly isPOChanged?: boolean;
|
|
267
|
+
/**
|
|
268
|
+
* Filters purchase orders based on the purchase order state.
|
|
269
|
+
* @type {'New' | 'Acknowledged' | 'Closed'}
|
|
270
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
271
|
+
*/
|
|
272
|
+
readonly purchaseOrderState?: 'New' | 'Acknowledged' | 'Closed';
|
|
273
|
+
/**
|
|
274
|
+
* 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.
|
|
275
|
+
* @type {string}
|
|
276
|
+
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
277
|
+
*/
|
|
278
|
+
readonly orderingVendorCode?: string;
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* Request parameters for getPurchaseOrdersStatus operation in VendorOrdersApi.
|
|
282
|
+
* @export
|
|
283
|
+
* @interface VendorOrdersApiGetPurchaseOrdersStatusRequest
|
|
284
|
+
*/
|
|
285
|
+
export interface VendorOrdersApiGetPurchaseOrdersStatusRequest {
|
|
286
|
+
/**
|
|
287
|
+
* The limit to the number of records returned. Default value is 100 records.
|
|
288
|
+
* @type {number}
|
|
289
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
290
|
+
*/
|
|
291
|
+
readonly limit?: number;
|
|
292
|
+
/**
|
|
293
|
+
* Sort in ascending or descending order by purchase order creation date.
|
|
294
|
+
* @type {'ASC' | 'DESC'}
|
|
295
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
296
|
+
*/
|
|
297
|
+
readonly sortOrder?: 'ASC' | 'DESC';
|
|
298
|
+
/**
|
|
299
|
+
* Used for pagination when there are more purchase orders than the specified result size limit.
|
|
300
|
+
* @type {string}
|
|
301
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
302
|
+
*/
|
|
303
|
+
readonly nextToken?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
306
|
+
* @type {string}
|
|
307
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
308
|
+
*/
|
|
309
|
+
readonly createdAfter?: string;
|
|
310
|
+
/**
|
|
311
|
+
* Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
312
|
+
* @type {string}
|
|
313
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
314
|
+
*/
|
|
315
|
+
readonly createdBefore?: string;
|
|
316
|
+
/**
|
|
317
|
+
* 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.
|
|
318
|
+
* @type {string}
|
|
319
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
320
|
+
*/
|
|
321
|
+
readonly updatedAfter?: string;
|
|
322
|
+
/**
|
|
323
|
+
* 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.
|
|
324
|
+
* @type {string}
|
|
325
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
326
|
+
*/
|
|
327
|
+
readonly updatedBefore?: string;
|
|
328
|
+
/**
|
|
329
|
+
* Provides purchase order status for the specified purchase order number.
|
|
330
|
+
* @type {string}
|
|
331
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
332
|
+
*/
|
|
333
|
+
readonly purchaseOrderNumber?: string;
|
|
334
|
+
/**
|
|
335
|
+
* Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.
|
|
336
|
+
* @type {'OPEN' | 'CLOSED'}
|
|
337
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
338
|
+
*/
|
|
339
|
+
readonly purchaseOrderStatus?: 'OPEN' | 'CLOSED';
|
|
340
|
+
/**
|
|
341
|
+
* Filters purchase orders based on the specified purchase order item status. If not included in filter, purchase orders for all statuses are included.
|
|
342
|
+
* @type {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'}
|
|
343
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
344
|
+
*/
|
|
345
|
+
readonly itemConfirmationStatus?: 'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED';
|
|
346
|
+
/**
|
|
347
|
+
* 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.
|
|
348
|
+
* @type {string}
|
|
349
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
350
|
+
*/
|
|
351
|
+
readonly orderingVendorCode?: string;
|
|
352
|
+
/**
|
|
353
|
+
* 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.
|
|
354
|
+
* @type {string}
|
|
355
|
+
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
356
|
+
*/
|
|
357
|
+
readonly shipToPartyId?: string;
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* Request parameters for submitAcknowledgement operation in VendorOrdersApi.
|
|
361
|
+
* @export
|
|
362
|
+
* @interface VendorOrdersApiSubmitAcknowledgementRequest
|
|
363
|
+
*/
|
|
364
|
+
export interface VendorOrdersApiSubmitAcknowledgementRequest {
|
|
365
|
+
/**
|
|
366
|
+
*
|
|
367
|
+
* @type {SubmitAcknowledgementRequest}
|
|
368
|
+
* @memberof VendorOrdersApiSubmitAcknowledgement
|
|
369
|
+
*/
|
|
370
|
+
readonly body: SubmitAcknowledgementRequest;
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* VendorOrdersApi - object-oriented interface
|
|
374
|
+
* @export
|
|
375
|
+
* @class VendorOrdersApi
|
|
376
|
+
* @extends {BaseAPI}
|
|
377
|
+
*/
|
|
378
|
+
export declare class VendorOrdersApi extends BaseAPI {
|
|
379
|
+
/**
|
|
380
|
+
* Returns a purchase order based on the purchaseOrderNumber value that you specify. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
381
|
+
* @param {VendorOrdersApiGetPurchaseOrderRequest} requestParameters Request parameters.
|
|
382
|
+
* @param {*} [options] Override http request option.
|
|
383
|
+
* @throws {RequiredError}
|
|
384
|
+
* @memberof VendorOrdersApi
|
|
385
|
+
*/
|
|
386
|
+
getPurchaseOrder(requestParameters: VendorOrdersApiGetPurchaseOrderRequest, options?: any): Promise<import("axios").AxiosResponse<GetPurchaseOrderResponse>>;
|
|
387
|
+
/**
|
|
388
|
+
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
389
|
+
* @param {VendorOrdersApiGetPurchaseOrdersRequest} requestParameters Request parameters.
|
|
390
|
+
* @param {*} [options] Override http request option.
|
|
391
|
+
* @throws {RequiredError}
|
|
392
|
+
* @memberof VendorOrdersApi
|
|
393
|
+
*/
|
|
394
|
+
getPurchaseOrders(requestParameters?: VendorOrdersApiGetPurchaseOrdersRequest, options?: any): Promise<import("axios").AxiosResponse<GetPurchaseOrdersResponse>>;
|
|
395
|
+
/**
|
|
396
|
+
* 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
397
|
+
* @param {VendorOrdersApiGetPurchaseOrdersStatusRequest} requestParameters Request parameters.
|
|
398
|
+
* @param {*} [options] Override http request option.
|
|
399
|
+
* @throws {RequiredError}
|
|
400
|
+
* @memberof VendorOrdersApi
|
|
401
|
+
*/
|
|
402
|
+
getPurchaseOrdersStatus(requestParameters?: VendorOrdersApiGetPurchaseOrdersStatusRequest, options?: any): Promise<import("axios").AxiosResponse<GetPurchaseOrdersStatusResponse>>;
|
|
403
|
+
/**
|
|
404
|
+
* Submits acknowledgements for one or more purchase orders. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
405
|
+
* @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
|
|
406
|
+
* @param {*} [options] Override http request option.
|
|
407
|
+
* @throws {RequiredError}
|
|
408
|
+
* @memberof VendorOrdersApi
|
|
409
|
+
*/
|
|
410
|
+
submitAcknowledgement(requestParameters: VendorOrdersApiSubmitAcknowledgementRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitAcknowledgementResponse>>;
|
|
411
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Retail Procurement Orders
|
|
3
|
+
* The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export * from './api/vendor-orders-api';
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Retail Procurement Orders
|
|
3
|
+
* The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { Configuration } from "./configuration";
|
|
13
|
+
import { AxiosInstance } from 'axios';
|
|
14
|
+
export declare const BASE_PATH: string;
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const COLLECTION_FORMATS: {
|
|
20
|
+
csv: string;
|
|
21
|
+
ssv: string;
|
|
22
|
+
tsv: string;
|
|
23
|
+
pipes: string;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @export
|
|
28
|
+
* @interface RequestArgs
|
|
29
|
+
*/
|
|
30
|
+
export interface RequestArgs {
|
|
31
|
+
url: string;
|
|
32
|
+
options: any;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @export
|
|
37
|
+
* @class BaseAPI
|
|
38
|
+
*/
|
|
39
|
+
export declare class BaseAPI {
|
|
40
|
+
protected basePath: string;
|
|
41
|
+
protected axios: AxiosInstance;
|
|
42
|
+
protected configuration: Configuration | undefined;
|
|
43
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @export
|
|
48
|
+
* @class RequiredError
|
|
49
|
+
* @extends {Error}
|
|
50
|
+
*/
|
|
51
|
+
export declare class RequiredError extends Error {
|
|
52
|
+
field: string;
|
|
53
|
+
name: "RequiredError";
|
|
54
|
+
constructor(field: string, msg?: string);
|
|
55
|
+
}
|