@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 1.7.1
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/customer-invoices-api.js +213 -0
- package/dist/cjs/src/api-model/api/vendor-shipping-api.js +329 -0
- package/dist/cjs/src/api-model/api/vendor-shipping-labels-api.js +271 -0
- package/dist/cjs/src/api-model/api.js +19 -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/address.js +15 -0
- package/dist/cjs/src/api-model/models/container.js +25 -0
- package/dist/cjs/src/api-model/models/customer-invoice-list.js +15 -0
- package/dist/cjs/src/api-model/models/customer-invoice.js +15 -0
- package/dist/cjs/src/api-model/models/dimensions.js +25 -0
- package/dist/cjs/src/api-model/models/get-customer-invoice-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-customer-invoices-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-packing-slip-list-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-packing-slip-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-shipping-label-list-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-shipping-label-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +40 -0
- package/dist/cjs/src/api-model/models/item-quantity.js +15 -0
- package/dist/cjs/src/api-model/models/item.js +15 -0
- package/dist/cjs/src/api-model/models/label-data.js +15 -0
- package/dist/cjs/src/api-model/models/model-error.js +15 -0
- package/dist/cjs/src/api-model/models/package.js +15 -0
- package/dist/cjs/src/api-model/models/packed-item.js +15 -0
- package/dist/cjs/src/api-model/models/packing-slip-list.js +15 -0
- package/dist/cjs/src/api-model/models/packing-slip.js +24 -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/shipment-confirmation.js +15 -0
- package/dist/cjs/src/api-model/models/shipment-details.js +25 -0
- package/dist/cjs/src/api-model/models/shipment-status-update.js +15 -0
- package/dist/cjs/src/api-model/models/shipping-label-list.js +15 -0
- package/dist/cjs/src/api-model/models/shipping-label-request.js +15 -0
- package/dist/cjs/src/api-model/models/shipping-label.js +25 -0
- package/dist/cjs/src/api-model/models/status-update-details-shipment-schedule.js +15 -0
- package/dist/cjs/src/api-model/models/status-update-details.js +15 -0
- package/dist/cjs/src/api-model/models/submit-shipment-confirmations-request.js +15 -0
- package/dist/cjs/src/api-model/models/submit-shipment-confirmations-response.js +15 -0
- package/dist/cjs/src/api-model/models/submit-shipment-status-updates-request.js +15 -0
- package/dist/cjs/src/api-model/models/submit-shipment-status-updates-response.js +15 -0
- package/dist/cjs/src/api-model/models/submit-shipping-labels-request.js +15 -0
- package/dist/cjs/src/api-model/models/submit-shipping-labels-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-reference.js +15 -0
- package/dist/cjs/src/api-model/models/weight.js +25 -0
- package/dist/cjs/src/client.js +83 -0
- package/dist/cjs/src/error.js +10 -0
- package/dist/es/index.js +3 -0
- package/dist/es/src/api-model/api/customer-invoices-api.js +205 -0
- package/dist/es/src/api-model/api/vendor-shipping-api.js +321 -0
- package/dist/es/src/api-model/api/vendor-shipping-labels-api.js +263 -0
- package/dist/es/src/api-model/api.js +16 -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/address.js +14 -0
- package/dist/es/src/api-model/models/container.js +22 -0
- package/dist/es/src/api-model/models/customer-invoice-list.js +14 -0
- package/dist/es/src/api-model/models/customer-invoice.js +14 -0
- package/dist/es/src/api-model/models/dimensions.js +22 -0
- package/dist/es/src/api-model/models/get-customer-invoice-response.js +14 -0
- package/dist/es/src/api-model/models/get-customer-invoices-response.js +14 -0
- package/dist/es/src/api-model/models/get-packing-slip-list-response.js +14 -0
- package/dist/es/src/api-model/models/get-packing-slip-response.js +14 -0
- package/dist/es/src/api-model/models/get-shipping-label-list-response.js +14 -0
- package/dist/es/src/api-model/models/get-shipping-label-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +37 -0
- package/dist/es/src/api-model/models/item-quantity.js +14 -0
- package/dist/es/src/api-model/models/item.js +14 -0
- package/dist/es/src/api-model/models/label-data.js +14 -0
- package/dist/es/src/api-model/models/model-error.js +14 -0
- package/dist/es/src/api-model/models/package.js +14 -0
- package/dist/es/src/api-model/models/packed-item.js +14 -0
- package/dist/es/src/api-model/models/packing-slip-list.js +14 -0
- package/dist/es/src/api-model/models/packing-slip.js +21 -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/shipment-confirmation.js +14 -0
- package/dist/es/src/api-model/models/shipment-details.js +22 -0
- package/dist/es/src/api-model/models/shipment-status-update.js +14 -0
- package/dist/es/src/api-model/models/shipping-label-list.js +14 -0
- package/dist/es/src/api-model/models/shipping-label-request.js +14 -0
- package/dist/es/src/api-model/models/shipping-label.js +22 -0
- package/dist/es/src/api-model/models/status-update-details-shipment-schedule.js +14 -0
- package/dist/es/src/api-model/models/status-update-details.js +14 -0
- package/dist/es/src/api-model/models/submit-shipment-confirmations-request.js +14 -0
- package/dist/es/src/api-model/models/submit-shipment-confirmations-response.js +14 -0
- package/dist/es/src/api-model/models/submit-shipment-status-updates-request.js +14 -0
- package/dist/es/src/api-model/models/submit-shipment-status-updates-response.js +14 -0
- package/dist/es/src/api-model/models/submit-shipping-labels-request.js +14 -0
- package/dist/es/src/api-model/models/submit-shipping-labels-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-reference.js +14 -0
- package/dist/es/src/api-model/models/weight.js +22 -0
- package/dist/es/src/client.js +79 -0
- package/dist/es/src/error.js +6 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/src/api-model/api/customer-invoices-api.d.ts +171 -0
- package/dist/types/src/api-model/api/vendor-shipping-api.d.ts +259 -0
- package/dist/types/src/api-model/api/vendor-shipping-labels-api.d.ts +215 -0
- package/dist/types/src/api-model/api.d.ts +14 -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/address.d.ts +84 -0
- package/dist/types/src/api-model/models/container.d.ts +101 -0
- package/dist/types/src/api-model/models/customer-invoice-list.d.ts +32 -0
- package/dist/types/src/api-model/models/customer-invoice.d.ts +30 -0
- package/dist/types/src/api-model/models/dimensions.d.ts +50 -0
- package/dist/types/src/api-model/models/get-customer-invoice-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-customer-invoices-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-packing-slip-list-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-packing-slip-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-shipping-label-list-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-shipping-label-response.d.ts +31 -0
- package/dist/types/src/api-model/models/index.d.ts +37 -0
- package/dist/types/src/api-model/models/item-quantity.d.ts +30 -0
- package/dist/types/src/api-model/models/item.d.ts +43 -0
- package/dist/types/src/api-model/models/label-data.d.ts +48 -0
- package/dist/types/src/api-model/models/model-error.d.ts +36 -0
- package/dist/types/src/api-model/models/package.d.ts +62 -0
- package/dist/types/src/api-model/models/packed-item.d.ts +43 -0
- package/dist/types/src/api-model/models/packing-slip-list.d.ts +32 -0
- package/dist/types/src/api-model/models/packing-slip.d.ts +43 -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/shipment-confirmation.d.ts +58 -0
- package/dist/types/src/api-model/models/shipment-details.d.ts +56 -0
- package/dist/types/src/api-model/models/shipment-status-update.d.ts +44 -0
- package/dist/types/src/api-model/models/shipping-label-list.d.ts +32 -0
- package/dist/types/src/api-model/models/shipping-label-request.d.ts +44 -0
- package/dist/types/src/api-model/models/shipping-label.d.ts +58 -0
- package/dist/types/src/api-model/models/status-update-details-shipment-schedule.d.ts +36 -0
- package/dist/types/src/api-model/models/status-update-details.d.ts +56 -0
- package/dist/types/src/api-model/models/submit-shipment-confirmations-request.d.ts +25 -0
- package/dist/types/src/api-model/models/submit-shipment-confirmations-response.d.ts +31 -0
- package/dist/types/src/api-model/models/submit-shipment-status-updates-request.d.ts +25 -0
- package/dist/types/src/api-model/models/submit-shipment-status-updates-response.d.ts +31 -0
- package/dist/types/src/api-model/models/submit-shipping-labels-request.d.ts +25 -0
- package/dist/types/src/api-model/models/submit-shipping-labels-response.d.ts +31 -0
- package/dist/types/src/api-model/models/tax-registration-details.d.ts +51 -0
- package/dist/types/src/api-model/models/transaction-reference.d.ts +24 -0
- package/dist/types/src/api-model/models/weight.d.ts +38 -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,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.VendorDirectFulfillmentShippingApiError = void 0;
|
|
4
|
+
class VendorDirectFulfillmentShippingApiError extends Error {
|
|
5
|
+
constructor(message) {
|
|
6
|
+
super(message);
|
|
7
|
+
this.name = 'VendorDirectFulfillmentShippingApiError';
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
exports.VendorDirectFulfillmentShippingApiError = VendorDirectFulfillmentShippingApiError;
|
package/dist/es/index.js
ADDED
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Direct Fulfillment Shipping
|
|
5
|
+
* The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
// Some imports not used depending on template conditions
|
|
16
|
+
// @ts-ignore
|
|
17
|
+
import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, createRequestFunction } from '../common';
|
|
18
|
+
// @ts-ignore
|
|
19
|
+
import { BASE_PATH, BaseAPI } from '../base';
|
|
20
|
+
/**
|
|
21
|
+
* CustomerInvoicesApi - axios parameter creator
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export const CustomerInvoicesApiAxiosParamCreator = function (configuration) {
|
|
25
|
+
return {
|
|
26
|
+
/**
|
|
27
|
+
* Returns a customer invoice based on the purchaseOrderNumber 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.
|
|
28
|
+
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
29
|
+
* @param {*} [options] Override http request option.
|
|
30
|
+
* @throws {RequiredError}
|
|
31
|
+
*/
|
|
32
|
+
getCustomerInvoice: async (purchaseOrderNumber, options = {}) => {
|
|
33
|
+
// verify required parameter 'purchaseOrderNumber' is not null or undefined
|
|
34
|
+
assertParamExists('getCustomerInvoice', 'purchaseOrderNumber', purchaseOrderNumber);
|
|
35
|
+
const localVarPath = `/vendor/directFulfillment/shipping/v1/customerInvoices/{purchaseOrderNumber}`
|
|
36
|
+
.replace(`{${"purchaseOrderNumber"}}`, encodeURIComponent(String(purchaseOrderNumber)));
|
|
37
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
38
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
39
|
+
let baseOptions;
|
|
40
|
+
if (configuration) {
|
|
41
|
+
baseOptions = configuration.baseOptions;
|
|
42
|
+
}
|
|
43
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
44
|
+
const localVarHeaderParameter = {};
|
|
45
|
+
const localVarQueryParameter = {};
|
|
46
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
47
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
48
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
49
|
+
return {
|
|
50
|
+
url: toPathString(localVarUrlObj),
|
|
51
|
+
options: localVarRequestOptions,
|
|
52
|
+
};
|
|
53
|
+
},
|
|
54
|
+
/**
|
|
55
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage 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.
|
|
56
|
+
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
57
|
+
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
58
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
59
|
+
* @param {number} [limit] The limit to the number of records returned
|
|
60
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date.
|
|
61
|
+
* @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
getCustomerInvoices: async (createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options = {}) => {
|
|
66
|
+
// verify required parameter 'createdAfter' is not null or undefined
|
|
67
|
+
assertParamExists('getCustomerInvoices', 'createdAfter', createdAfter);
|
|
68
|
+
// verify required parameter 'createdBefore' is not null or undefined
|
|
69
|
+
assertParamExists('getCustomerInvoices', 'createdBefore', createdBefore);
|
|
70
|
+
const localVarPath = `/vendor/directFulfillment/shipping/v1/customerInvoices`;
|
|
71
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
72
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
73
|
+
let baseOptions;
|
|
74
|
+
if (configuration) {
|
|
75
|
+
baseOptions = configuration.baseOptions;
|
|
76
|
+
}
|
|
77
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
78
|
+
const localVarHeaderParameter = {};
|
|
79
|
+
const localVarQueryParameter = {};
|
|
80
|
+
if (shipFromPartyId !== undefined) {
|
|
81
|
+
localVarQueryParameter['shipFromPartyId'] = shipFromPartyId;
|
|
82
|
+
}
|
|
83
|
+
if (limit !== undefined) {
|
|
84
|
+
localVarQueryParameter['limit'] = limit;
|
|
85
|
+
}
|
|
86
|
+
if (createdAfter !== undefined) {
|
|
87
|
+
localVarQueryParameter['createdAfter'] = (createdAfter instanceof Date) ?
|
|
88
|
+
createdAfter.toISOString() :
|
|
89
|
+
createdAfter;
|
|
90
|
+
}
|
|
91
|
+
if (createdBefore !== undefined) {
|
|
92
|
+
localVarQueryParameter['createdBefore'] = (createdBefore instanceof Date) ?
|
|
93
|
+
createdBefore.toISOString() :
|
|
94
|
+
createdBefore;
|
|
95
|
+
}
|
|
96
|
+
if (sortOrder !== undefined) {
|
|
97
|
+
localVarQueryParameter['sortOrder'] = sortOrder;
|
|
98
|
+
}
|
|
99
|
+
if (nextToken !== undefined) {
|
|
100
|
+
localVarQueryParameter['nextToken'] = nextToken;
|
|
101
|
+
}
|
|
102
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
103
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
104
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
105
|
+
return {
|
|
106
|
+
url: toPathString(localVarUrlObj),
|
|
107
|
+
options: localVarRequestOptions,
|
|
108
|
+
};
|
|
109
|
+
},
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
/**
|
|
113
|
+
* CustomerInvoicesApi - functional programming interface
|
|
114
|
+
* @export
|
|
115
|
+
*/
|
|
116
|
+
export const CustomerInvoicesApiFp = function (configuration) {
|
|
117
|
+
const localVarAxiosParamCreator = CustomerInvoicesApiAxiosParamCreator(configuration);
|
|
118
|
+
return {
|
|
119
|
+
/**
|
|
120
|
+
* Returns a customer invoice based on the purchaseOrderNumber 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.
|
|
121
|
+
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
122
|
+
* @param {*} [options] Override http request option.
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
*/
|
|
125
|
+
async getCustomerInvoice(purchaseOrderNumber, options) {
|
|
126
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomerInvoice(purchaseOrderNumber, options);
|
|
127
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
128
|
+
},
|
|
129
|
+
/**
|
|
130
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage 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.
|
|
131
|
+
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
132
|
+
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
133
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
134
|
+
* @param {number} [limit] The limit to the number of records returned
|
|
135
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date.
|
|
136
|
+
* @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
|
|
137
|
+
* @param {*} [options] Override http request option.
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
*/
|
|
140
|
+
async getCustomerInvoices(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options) {
|
|
141
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomerInvoices(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options);
|
|
142
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
143
|
+
},
|
|
144
|
+
};
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* CustomerInvoicesApi - factory interface
|
|
148
|
+
* @export
|
|
149
|
+
*/
|
|
150
|
+
export const CustomerInvoicesApiFactory = function (configuration, basePath, axios) {
|
|
151
|
+
const localVarFp = CustomerInvoicesApiFp(configuration);
|
|
152
|
+
return {
|
|
153
|
+
/**
|
|
154
|
+
* Returns a customer invoice based on the purchaseOrderNumber 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.
|
|
155
|
+
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
getCustomerInvoice(purchaseOrderNumber, options) {
|
|
160
|
+
return localVarFp.getCustomerInvoice(purchaseOrderNumber, options).then((request) => request(axios, basePath));
|
|
161
|
+
},
|
|
162
|
+
/**
|
|
163
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage 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 {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
165
|
+
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
166
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
167
|
+
* @param {number} [limit] The limit to the number of records returned
|
|
168
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date.
|
|
169
|
+
* @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
|
|
170
|
+
* @param {*} [options] Override http request option.
|
|
171
|
+
* @throws {RequiredError}
|
|
172
|
+
*/
|
|
173
|
+
getCustomerInvoices(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options) {
|
|
174
|
+
return localVarFp.getCustomerInvoices(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options).then((request) => request(axios, basePath));
|
|
175
|
+
},
|
|
176
|
+
};
|
|
177
|
+
};
|
|
178
|
+
/**
|
|
179
|
+
* CustomerInvoicesApi - object-oriented interface
|
|
180
|
+
* @export
|
|
181
|
+
* @class CustomerInvoicesApi
|
|
182
|
+
* @extends {BaseAPI}
|
|
183
|
+
*/
|
|
184
|
+
export class CustomerInvoicesApi extends BaseAPI {
|
|
185
|
+
/**
|
|
186
|
+
* Returns a customer invoice based on the purchaseOrderNumber 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.
|
|
187
|
+
* @param {CustomerInvoicesApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
188
|
+
* @param {*} [options] Override http request option.
|
|
189
|
+
* @throws {RequiredError}
|
|
190
|
+
* @memberof CustomerInvoicesApi
|
|
191
|
+
*/
|
|
192
|
+
getCustomerInvoice(requestParameters, options) {
|
|
193
|
+
return CustomerInvoicesApiFp(this.configuration).getCustomerInvoice(requestParameters.purchaseOrderNumber, options).then((request) => request(this.axios, this.basePath));
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage 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.
|
|
197
|
+
* @param {CustomerInvoicesApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
198
|
+
* @param {*} [options] Override http request option.
|
|
199
|
+
* @throws {RequiredError}
|
|
200
|
+
* @memberof CustomerInvoicesApi
|
|
201
|
+
*/
|
|
202
|
+
getCustomerInvoices(requestParameters, options) {
|
|
203
|
+
return CustomerInvoicesApiFp(this.configuration).getCustomerInvoices(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
204
|
+
}
|
|
205
|
+
}
|
|
@@ -0,0 +1,321 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Direct Fulfillment Shipping
|
|
5
|
+
* The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping data.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v1
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
// Some imports not used depending on template conditions
|
|
16
|
+
// @ts-ignore
|
|
17
|
+
import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
18
|
+
// @ts-ignore
|
|
19
|
+
import { BASE_PATH, BaseAPI } from '../base';
|
|
20
|
+
/**
|
|
21
|
+
* VendorShippingApi - axios parameter creator
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
25
|
+
return {
|
|
26
|
+
/**
|
|
27
|
+
* Returns a packing slip based on the purchaseOrderNumber 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.
|
|
28
|
+
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
29
|
+
* @param {*} [options] Override http request option.
|
|
30
|
+
* @throws {RequiredError}
|
|
31
|
+
*/
|
|
32
|
+
getPackingSlip: async (purchaseOrderNumber, options = {}) => {
|
|
33
|
+
// verify required parameter 'purchaseOrderNumber' is not null or undefined
|
|
34
|
+
assertParamExists('getPackingSlip', 'purchaseOrderNumber', purchaseOrderNumber);
|
|
35
|
+
const localVarPath = `/vendor/directFulfillment/shipping/v1/packingSlips/{purchaseOrderNumber}`
|
|
36
|
+
.replace(`{${"purchaseOrderNumber"}}`, encodeURIComponent(String(purchaseOrderNumber)));
|
|
37
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
38
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
39
|
+
let baseOptions;
|
|
40
|
+
if (configuration) {
|
|
41
|
+
baseOptions = configuration.baseOptions;
|
|
42
|
+
}
|
|
43
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
44
|
+
const localVarHeaderParameter = {};
|
|
45
|
+
const localVarQueryParameter = {};
|
|
46
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
47
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
48
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
49
|
+
return {
|
|
50
|
+
url: toPathString(localVarUrlObj),
|
|
51
|
+
options: localVarRequestOptions,
|
|
52
|
+
};
|
|
53
|
+
},
|
|
54
|
+
/**
|
|
55
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage 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.
|
|
56
|
+
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
57
|
+
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
58
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
59
|
+
* @param {number} [limit] The limit to the number of records returned
|
|
60
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
61
|
+
* @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
getPackingSlips: async (createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options = {}) => {
|
|
66
|
+
// verify required parameter 'createdAfter' is not null or undefined
|
|
67
|
+
assertParamExists('getPackingSlips', 'createdAfter', createdAfter);
|
|
68
|
+
// verify required parameter 'createdBefore' is not null or undefined
|
|
69
|
+
assertParamExists('getPackingSlips', 'createdBefore', createdBefore);
|
|
70
|
+
const localVarPath = `/vendor/directFulfillment/shipping/v1/packingSlips`;
|
|
71
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
72
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
73
|
+
let baseOptions;
|
|
74
|
+
if (configuration) {
|
|
75
|
+
baseOptions = configuration.baseOptions;
|
|
76
|
+
}
|
|
77
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
78
|
+
const localVarHeaderParameter = {};
|
|
79
|
+
const localVarQueryParameter = {};
|
|
80
|
+
if (shipFromPartyId !== undefined) {
|
|
81
|
+
localVarQueryParameter['shipFromPartyId'] = shipFromPartyId;
|
|
82
|
+
}
|
|
83
|
+
if (limit !== undefined) {
|
|
84
|
+
localVarQueryParameter['limit'] = limit;
|
|
85
|
+
}
|
|
86
|
+
if (createdAfter !== undefined) {
|
|
87
|
+
localVarQueryParameter['createdAfter'] = (createdAfter instanceof Date) ?
|
|
88
|
+
createdAfter.toISOString() :
|
|
89
|
+
createdAfter;
|
|
90
|
+
}
|
|
91
|
+
if (createdBefore !== undefined) {
|
|
92
|
+
localVarQueryParameter['createdBefore'] = (createdBefore instanceof Date) ?
|
|
93
|
+
createdBefore.toISOString() :
|
|
94
|
+
createdBefore;
|
|
95
|
+
}
|
|
96
|
+
if (sortOrder !== undefined) {
|
|
97
|
+
localVarQueryParameter['sortOrder'] = sortOrder;
|
|
98
|
+
}
|
|
99
|
+
if (nextToken !== undefined) {
|
|
100
|
+
localVarQueryParameter['nextToken'] = nextToken;
|
|
101
|
+
}
|
|
102
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
103
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
104
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
105
|
+
return {
|
|
106
|
+
url: toPathString(localVarUrlObj),
|
|
107
|
+
options: localVarRequestOptions,
|
|
108
|
+
};
|
|
109
|
+
},
|
|
110
|
+
/**
|
|
111
|
+
* Submits one or more shipment confirmations for vendor 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.
|
|
112
|
+
* @param {SubmitShipmentConfirmationsRequest} body
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
*/
|
|
116
|
+
submitShipmentConfirmations: async (body, options = {}) => {
|
|
117
|
+
// verify required parameter 'body' is not null or undefined
|
|
118
|
+
assertParamExists('submitShipmentConfirmations', 'body', body);
|
|
119
|
+
const localVarPath = `/vendor/directFulfillment/shipping/v1/shipmentConfirmations`;
|
|
120
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
121
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
122
|
+
let baseOptions;
|
|
123
|
+
if (configuration) {
|
|
124
|
+
baseOptions = configuration.baseOptions;
|
|
125
|
+
}
|
|
126
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
127
|
+
const localVarHeaderParameter = {};
|
|
128
|
+
const localVarQueryParameter = {};
|
|
129
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
130
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
131
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
132
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
133
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
134
|
+
return {
|
|
135
|
+
url: toPathString(localVarUrlObj),
|
|
136
|
+
options: localVarRequestOptions,
|
|
137
|
+
};
|
|
138
|
+
},
|
|
139
|
+
/**
|
|
140
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage 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.
|
|
141
|
+
* @param {SubmitShipmentStatusUpdatesRequest} body
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
submitShipmentStatusUpdates: async (body, options = {}) => {
|
|
146
|
+
// verify required parameter 'body' is not null or undefined
|
|
147
|
+
assertParamExists('submitShipmentStatusUpdates', 'body', body);
|
|
148
|
+
const localVarPath = `/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates`;
|
|
149
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
150
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
151
|
+
let baseOptions;
|
|
152
|
+
if (configuration) {
|
|
153
|
+
baseOptions = configuration.baseOptions;
|
|
154
|
+
}
|
|
155
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
156
|
+
const localVarHeaderParameter = {};
|
|
157
|
+
const localVarQueryParameter = {};
|
|
158
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
159
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
160
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
161
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
162
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
163
|
+
return {
|
|
164
|
+
url: toPathString(localVarUrlObj),
|
|
165
|
+
options: localVarRequestOptions,
|
|
166
|
+
};
|
|
167
|
+
},
|
|
168
|
+
};
|
|
169
|
+
};
|
|
170
|
+
/**
|
|
171
|
+
* VendorShippingApi - functional programming interface
|
|
172
|
+
* @export
|
|
173
|
+
*/
|
|
174
|
+
export const VendorShippingApiFp = function (configuration) {
|
|
175
|
+
const localVarAxiosParamCreator = VendorShippingApiAxiosParamCreator(configuration);
|
|
176
|
+
return {
|
|
177
|
+
/**
|
|
178
|
+
* Returns a packing slip based on the purchaseOrderNumber 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.
|
|
179
|
+
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
180
|
+
* @param {*} [options] Override http request option.
|
|
181
|
+
* @throws {RequiredError}
|
|
182
|
+
*/
|
|
183
|
+
async getPackingSlip(purchaseOrderNumber, options) {
|
|
184
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPackingSlip(purchaseOrderNumber, options);
|
|
185
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
186
|
+
},
|
|
187
|
+
/**
|
|
188
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage 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.
|
|
189
|
+
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
190
|
+
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
191
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
192
|
+
* @param {number} [limit] The limit to the number of records returned
|
|
193
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
194
|
+
* @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
|
|
195
|
+
* @param {*} [options] Override http request option.
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
*/
|
|
198
|
+
async getPackingSlips(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options) {
|
|
199
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPackingSlips(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options);
|
|
200
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
201
|
+
},
|
|
202
|
+
/**
|
|
203
|
+
* Submits one or more shipment confirmations for vendor 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.
|
|
204
|
+
* @param {SubmitShipmentConfirmationsRequest} body
|
|
205
|
+
* @param {*} [options] Override http request option.
|
|
206
|
+
* @throws {RequiredError}
|
|
207
|
+
*/
|
|
208
|
+
async submitShipmentConfirmations(body, options) {
|
|
209
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.submitShipmentConfirmations(body, options);
|
|
210
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
211
|
+
},
|
|
212
|
+
/**
|
|
213
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage 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.
|
|
214
|
+
* @param {SubmitShipmentStatusUpdatesRequest} body
|
|
215
|
+
* @param {*} [options] Override http request option.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
*/
|
|
218
|
+
async submitShipmentStatusUpdates(body, options) {
|
|
219
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.submitShipmentStatusUpdates(body, options);
|
|
220
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
221
|
+
},
|
|
222
|
+
};
|
|
223
|
+
};
|
|
224
|
+
/**
|
|
225
|
+
* VendorShippingApi - factory interface
|
|
226
|
+
* @export
|
|
227
|
+
*/
|
|
228
|
+
export const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
229
|
+
const localVarFp = VendorShippingApiFp(configuration);
|
|
230
|
+
return {
|
|
231
|
+
/**
|
|
232
|
+
* Returns a packing slip based on the purchaseOrderNumber 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.
|
|
233
|
+
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
234
|
+
* @param {*} [options] Override http request option.
|
|
235
|
+
* @throws {RequiredError}
|
|
236
|
+
*/
|
|
237
|
+
getPackingSlip(purchaseOrderNumber, options) {
|
|
238
|
+
return localVarFp.getPackingSlip(purchaseOrderNumber, options).then((request) => request(axios, basePath));
|
|
239
|
+
},
|
|
240
|
+
/**
|
|
241
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage 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.
|
|
242
|
+
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
243
|
+
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
244
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
245
|
+
* @param {number} [limit] The limit to the number of records returned
|
|
246
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
247
|
+
* @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
|
|
248
|
+
* @param {*} [options] Override http request option.
|
|
249
|
+
* @throws {RequiredError}
|
|
250
|
+
*/
|
|
251
|
+
getPackingSlips(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options) {
|
|
252
|
+
return localVarFp.getPackingSlips(createdAfter, createdBefore, shipFromPartyId, limit, sortOrder, nextToken, options).then((request) => request(axios, basePath));
|
|
253
|
+
},
|
|
254
|
+
/**
|
|
255
|
+
* Submits one or more shipment confirmations for vendor 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.
|
|
256
|
+
* @param {SubmitShipmentConfirmationsRequest} body
|
|
257
|
+
* @param {*} [options] Override http request option.
|
|
258
|
+
* @throws {RequiredError}
|
|
259
|
+
*/
|
|
260
|
+
submitShipmentConfirmations(body, options) {
|
|
261
|
+
return localVarFp.submitShipmentConfirmations(body, options).then((request) => request(axios, basePath));
|
|
262
|
+
},
|
|
263
|
+
/**
|
|
264
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage 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.
|
|
265
|
+
* @param {SubmitShipmentStatusUpdatesRequest} body
|
|
266
|
+
* @param {*} [options] Override http request option.
|
|
267
|
+
* @throws {RequiredError}
|
|
268
|
+
*/
|
|
269
|
+
submitShipmentStatusUpdates(body, options) {
|
|
270
|
+
return localVarFp.submitShipmentStatusUpdates(body, options).then((request) => request(axios, basePath));
|
|
271
|
+
},
|
|
272
|
+
};
|
|
273
|
+
};
|
|
274
|
+
/**
|
|
275
|
+
* VendorShippingApi - object-oriented interface
|
|
276
|
+
* @export
|
|
277
|
+
* @class VendorShippingApi
|
|
278
|
+
* @extends {BaseAPI}
|
|
279
|
+
*/
|
|
280
|
+
export class VendorShippingApi extends BaseAPI {
|
|
281
|
+
/**
|
|
282
|
+
* Returns a packing slip based on the purchaseOrderNumber 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.
|
|
283
|
+
* @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
* @memberof VendorShippingApi
|
|
287
|
+
*/
|
|
288
|
+
getPackingSlip(requestParameters, options) {
|
|
289
|
+
return VendorShippingApiFp(this.configuration).getPackingSlip(requestParameters.purchaseOrderNumber, options).then((request) => request(this.axios, this.basePath));
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage 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.
|
|
293
|
+
* @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
294
|
+
* @param {*} [options] Override http request option.
|
|
295
|
+
* @throws {RequiredError}
|
|
296
|
+
* @memberof VendorShippingApi
|
|
297
|
+
*/
|
|
298
|
+
getPackingSlips(requestParameters, options) {
|
|
299
|
+
return VendorShippingApiFp(this.configuration).getPackingSlips(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
300
|
+
}
|
|
301
|
+
/**
|
|
302
|
+
* Submits one or more shipment confirmations for vendor 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.
|
|
303
|
+
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
304
|
+
* @param {*} [options] Override http request option.
|
|
305
|
+
* @throws {RequiredError}
|
|
306
|
+
* @memberof VendorShippingApi
|
|
307
|
+
*/
|
|
308
|
+
submitShipmentConfirmations(requestParameters, options) {
|
|
309
|
+
return VendorShippingApiFp(this.configuration).submitShipmentConfirmations(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
310
|
+
}
|
|
311
|
+
/**
|
|
312
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage 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.
|
|
313
|
+
* @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
314
|
+
* @param {*} [options] Override http request option.
|
|
315
|
+
* @throws {RequiredError}
|
|
316
|
+
* @memberof VendorShippingApi
|
|
317
|
+
*/
|
|
318
|
+
submitShipmentStatusUpdates(requestParameters, options) {
|
|
319
|
+
return VendorShippingApiFp(this.configuration).submitShipmentStatusUpdates(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
320
|
+
}
|
|
321
|
+
}
|