@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,259 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Direct Fulfillment Shipping
|
|
3
|
+
* The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping 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 { GetPackingSlipListResponse } from '../models';
|
|
16
|
+
import { GetPackingSlipResponse } from '../models';
|
|
17
|
+
import { SubmitShipmentConfirmationsRequest } from '../models';
|
|
18
|
+
import { SubmitShipmentConfirmationsResponse } from '../models';
|
|
19
|
+
import { SubmitShipmentStatusUpdatesRequest } from '../models';
|
|
20
|
+
import { SubmitShipmentStatusUpdatesResponse } from '../models';
|
|
21
|
+
/**
|
|
22
|
+
* VendorShippingApi - axios parameter creator
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const VendorShippingApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
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: (purchaseOrderNumber: string, options?: any) => Promise<RequestArgs>;
|
|
33
|
+
/**
|
|
34
|
+
* 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.
|
|
35
|
+
* @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.
|
|
36
|
+
* @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.
|
|
37
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
38
|
+
* @param {number} [limit] The limit to the number of records returned
|
|
39
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
40
|
+
* @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.
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
getPackingSlips: (createdAfter: string, createdBefore: string, shipFromPartyId?: string | undefined, limit?: number | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
45
|
+
/**
|
|
46
|
+
* 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.
|
|
47
|
+
* @param {SubmitShipmentConfirmationsRequest} body
|
|
48
|
+
* @param {*} [options] Override http request option.
|
|
49
|
+
* @throws {RequiredError}
|
|
50
|
+
*/
|
|
51
|
+
submitShipmentConfirmations: (body: SubmitShipmentConfirmationsRequest, options?: any) => Promise<RequestArgs>;
|
|
52
|
+
/**
|
|
53
|
+
* 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.
|
|
54
|
+
* @param {SubmitShipmentStatusUpdatesRequest} body
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
submitShipmentStatusUpdates: (body: SubmitShipmentStatusUpdatesRequest, options?: any) => Promise<RequestArgs>;
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* VendorShippingApi - functional programming interface
|
|
62
|
+
* @export
|
|
63
|
+
*/
|
|
64
|
+
export declare const VendorShippingApiFp: (configuration?: Configuration | undefined) => {
|
|
65
|
+
/**
|
|
66
|
+
* 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.
|
|
67
|
+
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
68
|
+
* @param {*} [options] Override http request option.
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
*/
|
|
71
|
+
getPackingSlip(purchaseOrderNumber: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetPackingSlipResponse>>;
|
|
72
|
+
/**
|
|
73
|
+
* 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.
|
|
74
|
+
* @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.
|
|
75
|
+
* @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.
|
|
76
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
77
|
+
* @param {number} [limit] The limit to the number of records returned
|
|
78
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
79
|
+
* @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.
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
*/
|
|
83
|
+
getPackingSlips(createdAfter: string, createdBefore: string, shipFromPartyId?: string | undefined, limit?: number | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetPackingSlipListResponse>>;
|
|
84
|
+
/**
|
|
85
|
+
* 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.
|
|
86
|
+
* @param {SubmitShipmentConfirmationsRequest} body
|
|
87
|
+
* @param {*} [options] Override http request option.
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SubmitShipmentConfirmationsResponse>>;
|
|
91
|
+
/**
|
|
92
|
+
* 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.
|
|
93
|
+
* @param {SubmitShipmentStatusUpdatesRequest} body
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
submitShipmentStatusUpdates(body: SubmitShipmentStatusUpdatesRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SubmitShipmentStatusUpdatesResponse>>;
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* VendorShippingApi - factory interface
|
|
101
|
+
* @export
|
|
102
|
+
*/
|
|
103
|
+
export declare const VendorShippingApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
104
|
+
/**
|
|
105
|
+
* 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.
|
|
106
|
+
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
*/
|
|
110
|
+
getPackingSlip(purchaseOrderNumber: string, options?: any): AxiosPromise<GetPackingSlipResponse>;
|
|
111
|
+
/**
|
|
112
|
+
* 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.
|
|
113
|
+
* @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.
|
|
114
|
+
* @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.
|
|
115
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
116
|
+
* @param {number} [limit] The limit to the number of records returned
|
|
117
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
118
|
+
* @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.
|
|
119
|
+
* @param {*} [options] Override http request option.
|
|
120
|
+
* @throws {RequiredError}
|
|
121
|
+
*/
|
|
122
|
+
getPackingSlips(createdAfter: string, createdBefore: string, shipFromPartyId?: string | undefined, limit?: number | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, options?: any): AxiosPromise<GetPackingSlipListResponse>;
|
|
123
|
+
/**
|
|
124
|
+
* 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.
|
|
125
|
+
* @param {SubmitShipmentConfirmationsRequest} body
|
|
126
|
+
* @param {*} [options] Override http request option.
|
|
127
|
+
* @throws {RequiredError}
|
|
128
|
+
*/
|
|
129
|
+
submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: any): AxiosPromise<SubmitShipmentConfirmationsResponse>;
|
|
130
|
+
/**
|
|
131
|
+
* 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.
|
|
132
|
+
* @param {SubmitShipmentStatusUpdatesRequest} body
|
|
133
|
+
* @param {*} [options] Override http request option.
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
submitShipmentStatusUpdates(body: SubmitShipmentStatusUpdatesRequest, options?: any): AxiosPromise<SubmitShipmentStatusUpdatesResponse>;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* Request parameters for getPackingSlip operation in VendorShippingApi.
|
|
140
|
+
* @export
|
|
141
|
+
* @interface VendorShippingApiGetPackingSlipRequest
|
|
142
|
+
*/
|
|
143
|
+
export interface VendorShippingApiGetPackingSlipRequest {
|
|
144
|
+
/**
|
|
145
|
+
* The purchaseOrderNumber for the packing slip you want.
|
|
146
|
+
* @type {string}
|
|
147
|
+
* @memberof VendorShippingApiGetPackingSlip
|
|
148
|
+
*/
|
|
149
|
+
readonly purchaseOrderNumber: string;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* Request parameters for getPackingSlips operation in VendorShippingApi.
|
|
153
|
+
* @export
|
|
154
|
+
* @interface VendorShippingApiGetPackingSlipsRequest
|
|
155
|
+
*/
|
|
156
|
+
export interface VendorShippingApiGetPackingSlipsRequest {
|
|
157
|
+
/**
|
|
158
|
+
* Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
159
|
+
* @type {string}
|
|
160
|
+
* @memberof VendorShippingApiGetPackingSlips
|
|
161
|
+
*/
|
|
162
|
+
readonly createdAfter: string;
|
|
163
|
+
/**
|
|
164
|
+
* Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
165
|
+
* @type {string}
|
|
166
|
+
* @memberof VendorShippingApiGetPackingSlips
|
|
167
|
+
*/
|
|
168
|
+
readonly createdBefore: string;
|
|
169
|
+
/**
|
|
170
|
+
* The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
171
|
+
* @type {string}
|
|
172
|
+
* @memberof VendorShippingApiGetPackingSlips
|
|
173
|
+
*/
|
|
174
|
+
readonly shipFromPartyId?: string;
|
|
175
|
+
/**
|
|
176
|
+
* The limit to the number of records returned
|
|
177
|
+
* @type {number}
|
|
178
|
+
* @memberof VendorShippingApiGetPackingSlips
|
|
179
|
+
*/
|
|
180
|
+
readonly limit?: number;
|
|
181
|
+
/**
|
|
182
|
+
* Sort ASC or DESC by packing slip creation date.
|
|
183
|
+
* @type {'ASC' | 'DESC'}
|
|
184
|
+
* @memberof VendorShippingApiGetPackingSlips
|
|
185
|
+
*/
|
|
186
|
+
readonly sortOrder?: 'ASC' | 'DESC';
|
|
187
|
+
/**
|
|
188
|
+
* 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.
|
|
189
|
+
* @type {string}
|
|
190
|
+
* @memberof VendorShippingApiGetPackingSlips
|
|
191
|
+
*/
|
|
192
|
+
readonly nextToken?: string;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* Request parameters for submitShipmentConfirmations operation in VendorShippingApi.
|
|
196
|
+
* @export
|
|
197
|
+
* @interface VendorShippingApiSubmitShipmentConfirmationsRequest
|
|
198
|
+
*/
|
|
199
|
+
export interface VendorShippingApiSubmitShipmentConfirmationsRequest {
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @type {SubmitShipmentConfirmationsRequest}
|
|
203
|
+
* @memberof VendorShippingApiSubmitShipmentConfirmations
|
|
204
|
+
*/
|
|
205
|
+
readonly body: SubmitShipmentConfirmationsRequest;
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* Request parameters for submitShipmentStatusUpdates operation in VendorShippingApi.
|
|
209
|
+
* @export
|
|
210
|
+
* @interface VendorShippingApiSubmitShipmentStatusUpdatesRequest
|
|
211
|
+
*/
|
|
212
|
+
export interface VendorShippingApiSubmitShipmentStatusUpdatesRequest {
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @type {SubmitShipmentStatusUpdatesRequest}
|
|
216
|
+
* @memberof VendorShippingApiSubmitShipmentStatusUpdates
|
|
217
|
+
*/
|
|
218
|
+
readonly body: SubmitShipmentStatusUpdatesRequest;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* VendorShippingApi - object-oriented interface
|
|
222
|
+
* @export
|
|
223
|
+
* @class VendorShippingApi
|
|
224
|
+
* @extends {BaseAPI}
|
|
225
|
+
*/
|
|
226
|
+
export declare class VendorShippingApi extends BaseAPI {
|
|
227
|
+
/**
|
|
228
|
+
* 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.
|
|
229
|
+
* @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
230
|
+
* @param {*} [options] Override http request option.
|
|
231
|
+
* @throws {RequiredError}
|
|
232
|
+
* @memberof VendorShippingApi
|
|
233
|
+
*/
|
|
234
|
+
getPackingSlip(requestParameters: VendorShippingApiGetPackingSlipRequest, options?: any): Promise<import("axios").AxiosResponse<GetPackingSlipResponse>>;
|
|
235
|
+
/**
|
|
236
|
+
* 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.
|
|
237
|
+
* @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
238
|
+
* @param {*} [options] Override http request option.
|
|
239
|
+
* @throws {RequiredError}
|
|
240
|
+
* @memberof VendorShippingApi
|
|
241
|
+
*/
|
|
242
|
+
getPackingSlips(requestParameters: VendorShippingApiGetPackingSlipsRequest, options?: any): Promise<import("axios").AxiosResponse<GetPackingSlipListResponse>>;
|
|
243
|
+
/**
|
|
244
|
+
* 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.
|
|
245
|
+
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
246
|
+
* @param {*} [options] Override http request option.
|
|
247
|
+
* @throws {RequiredError}
|
|
248
|
+
* @memberof VendorShippingApi
|
|
249
|
+
*/
|
|
250
|
+
submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShipmentConfirmationsResponse>>;
|
|
251
|
+
/**
|
|
252
|
+
* 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.
|
|
253
|
+
* @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
254
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
* @memberof VendorShippingApi
|
|
257
|
+
*/
|
|
258
|
+
submitShipmentStatusUpdates(requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShipmentStatusUpdatesResponse>>;
|
|
259
|
+
}
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Direct Fulfillment Shipping
|
|
3
|
+
* The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor\'s shipping 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 { GetShippingLabelListResponse } from '../models';
|
|
16
|
+
import { GetShippingLabelResponse } from '../models';
|
|
17
|
+
import { SubmitShippingLabelsRequest } from '../models';
|
|
18
|
+
import { SubmitShippingLabelsResponse } from '../models';
|
|
19
|
+
/**
|
|
20
|
+
* VendorShippingLabelsApi - axios parameter creator
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
export declare const VendorShippingLabelsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
24
|
+
/**
|
|
25
|
+
* Returns a shipping label for 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.
|
|
26
|
+
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
27
|
+
* @param {*} [options] Override http request option.
|
|
28
|
+
* @throws {RequiredError}
|
|
29
|
+
*/
|
|
30
|
+
getShippingLabel: (purchaseOrderNumber: string, options?: any) => Promise<RequestArgs>;
|
|
31
|
+
/**
|
|
32
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage 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.
|
|
33
|
+
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
34
|
+
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
35
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
36
|
+
* @param {number} [limit] The limit to the number of records returned.
|
|
37
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date.
|
|
38
|
+
* @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
getShippingLabels: (createdAfter: string, createdBefore: string, shipFromPartyId?: string | undefined, limit?: number | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
43
|
+
/**
|
|
44
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **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.
|
|
45
|
+
* @param {SubmitShippingLabelsRequest} body
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
submitShippingLabelRequest: (body: SubmitShippingLabelsRequest, options?: any) => Promise<RequestArgs>;
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* VendorShippingLabelsApi - functional programming interface
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const VendorShippingLabelsApiFp: (configuration?: Configuration | undefined) => {
|
|
56
|
+
/**
|
|
57
|
+
* Returns a shipping label for 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.
|
|
58
|
+
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
59
|
+
* @param {*} [options] Override http request option.
|
|
60
|
+
* @throws {RequiredError}
|
|
61
|
+
*/
|
|
62
|
+
getShippingLabel(purchaseOrderNumber: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetShippingLabelResponse>>;
|
|
63
|
+
/**
|
|
64
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage 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.
|
|
65
|
+
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
66
|
+
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
67
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
68
|
+
* @param {number} [limit] The limit to the number of records returned.
|
|
69
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date.
|
|
70
|
+
* @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
getShippingLabels(createdAfter: string, createdBefore: string, shipFromPartyId?: string | undefined, limit?: number | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetShippingLabelListResponse>>;
|
|
75
|
+
/**
|
|
76
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **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.
|
|
77
|
+
* @param {SubmitShippingLabelsRequest} body
|
|
78
|
+
* @param {*} [options] Override http request option.
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
*/
|
|
81
|
+
submitShippingLabelRequest(body: SubmitShippingLabelsRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SubmitShippingLabelsResponse>>;
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* VendorShippingLabelsApi - factory interface
|
|
85
|
+
* @export
|
|
86
|
+
*/
|
|
87
|
+
export declare const VendorShippingLabelsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
88
|
+
/**
|
|
89
|
+
* Returns a shipping label for 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.
|
|
90
|
+
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
getShippingLabel(purchaseOrderNumber: string, options?: any): AxiosPromise<GetShippingLabelResponse>;
|
|
95
|
+
/**
|
|
96
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage 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.
|
|
97
|
+
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
98
|
+
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
99
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
100
|
+
* @param {number} [limit] The limit to the number of records returned.
|
|
101
|
+
* @param {'ASC' | 'DESC'} [sortOrder] Sort ASC or DESC by order creation date.
|
|
102
|
+
* @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
getShippingLabels(createdAfter: string, createdBefore: string, shipFromPartyId?: string | undefined, limit?: number | undefined, sortOrder?: "ASC" | "DESC" | undefined, nextToken?: string | undefined, options?: any): AxiosPromise<GetShippingLabelListResponse>;
|
|
107
|
+
/**
|
|
108
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **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.
|
|
109
|
+
* @param {SubmitShippingLabelsRequest} body
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
*/
|
|
113
|
+
submitShippingLabelRequest(body: SubmitShippingLabelsRequest, options?: any): AxiosPromise<SubmitShippingLabelsResponse>;
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* Request parameters for getShippingLabel operation in VendorShippingLabelsApi.
|
|
117
|
+
* @export
|
|
118
|
+
* @interface VendorShippingLabelsApiGetShippingLabelRequest
|
|
119
|
+
*/
|
|
120
|
+
export interface VendorShippingLabelsApiGetShippingLabelRequest {
|
|
121
|
+
/**
|
|
122
|
+
* The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
123
|
+
* @type {string}
|
|
124
|
+
* @memberof VendorShippingLabelsApiGetShippingLabel
|
|
125
|
+
*/
|
|
126
|
+
readonly purchaseOrderNumber: string;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* Request parameters for getShippingLabels operation in VendorShippingLabelsApi.
|
|
130
|
+
* @export
|
|
131
|
+
* @interface VendorShippingLabelsApiGetShippingLabelsRequest
|
|
132
|
+
*/
|
|
133
|
+
export interface VendorShippingLabelsApiGetShippingLabelsRequest {
|
|
134
|
+
/**
|
|
135
|
+
* Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
136
|
+
* @type {string}
|
|
137
|
+
* @memberof VendorShippingLabelsApiGetShippingLabels
|
|
138
|
+
*/
|
|
139
|
+
readonly createdAfter: string;
|
|
140
|
+
/**
|
|
141
|
+
* Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
142
|
+
* @type {string}
|
|
143
|
+
* @memberof VendorShippingLabelsApiGetShippingLabels
|
|
144
|
+
*/
|
|
145
|
+
readonly createdBefore: string;
|
|
146
|
+
/**
|
|
147
|
+
* The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
148
|
+
* @type {string}
|
|
149
|
+
* @memberof VendorShippingLabelsApiGetShippingLabels
|
|
150
|
+
*/
|
|
151
|
+
readonly shipFromPartyId?: string;
|
|
152
|
+
/**
|
|
153
|
+
* The limit to the number of records returned.
|
|
154
|
+
* @type {number}
|
|
155
|
+
* @memberof VendorShippingLabelsApiGetShippingLabels
|
|
156
|
+
*/
|
|
157
|
+
readonly limit?: number;
|
|
158
|
+
/**
|
|
159
|
+
* Sort ASC or DESC by order creation date.
|
|
160
|
+
* @type {'ASC' | 'DESC'}
|
|
161
|
+
* @memberof VendorShippingLabelsApiGetShippingLabels
|
|
162
|
+
*/
|
|
163
|
+
readonly sortOrder?: 'ASC' | 'DESC';
|
|
164
|
+
/**
|
|
165
|
+
* Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
166
|
+
* @type {string}
|
|
167
|
+
* @memberof VendorShippingLabelsApiGetShippingLabels
|
|
168
|
+
*/
|
|
169
|
+
readonly nextToken?: string;
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* Request parameters for submitShippingLabelRequest operation in VendorShippingLabelsApi.
|
|
173
|
+
* @export
|
|
174
|
+
* @interface VendorShippingLabelsApiSubmitShippingLabelRequestRequest
|
|
175
|
+
*/
|
|
176
|
+
export interface VendorShippingLabelsApiSubmitShippingLabelRequestRequest {
|
|
177
|
+
/**
|
|
178
|
+
*
|
|
179
|
+
* @type {SubmitShippingLabelsRequest}
|
|
180
|
+
* @memberof VendorShippingLabelsApiSubmitShippingLabelRequest
|
|
181
|
+
*/
|
|
182
|
+
readonly body: SubmitShippingLabelsRequest;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* VendorShippingLabelsApi - object-oriented interface
|
|
186
|
+
* @export
|
|
187
|
+
* @class VendorShippingLabelsApi
|
|
188
|
+
* @extends {BaseAPI}
|
|
189
|
+
*/
|
|
190
|
+
export declare class VendorShippingLabelsApi extends BaseAPI {
|
|
191
|
+
/**
|
|
192
|
+
* Returns a shipping label for 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.
|
|
193
|
+
* @param {VendorShippingLabelsApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
194
|
+
* @param {*} [options] Override http request option.
|
|
195
|
+
* @throws {RequiredError}
|
|
196
|
+
* @memberof VendorShippingLabelsApi
|
|
197
|
+
*/
|
|
198
|
+
getShippingLabel(requestParameters: VendorShippingLabelsApiGetShippingLabelRequest, options?: any): Promise<import("axios").AxiosResponse<GetShippingLabelResponse>>;
|
|
199
|
+
/**
|
|
200
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage 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.
|
|
201
|
+
* @param {VendorShippingLabelsApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
* @memberof VendorShippingLabelsApi
|
|
205
|
+
*/
|
|
206
|
+
getShippingLabels(requestParameters: VendorShippingLabelsApiGetShippingLabelsRequest, options?: any): Promise<import("axios").AxiosResponse<GetShippingLabelListResponse>>;
|
|
207
|
+
/**
|
|
208
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **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.
|
|
209
|
+
* @param {VendorShippingLabelsApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
210
|
+
* @param {*} [options] Override http request option.
|
|
211
|
+
* @throws {RequiredError}
|
|
212
|
+
* @memberof VendorShippingLabelsApi
|
|
213
|
+
*/
|
|
214
|
+
submitShippingLabelRequest(requestParameters: VendorShippingLabelsApiSubmitShippingLabelRequestRequest, options?: any): Promise<import("axios").AxiosResponse<SubmitShippingLabelsResponse>>;
|
|
215
|
+
}
|