@sp-api-sdk/merchant-fulfillment-api-v0 3.1.11 → 4.0.0
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/README.md +4 -4
- package/dist/index.cjs +775 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +2022 -0
- package/dist/index.d.ts +2022 -0
- package/dist/index.js +716 -0
- package/dist/index.js.map +1 -0
- package/package.json +23 -12
- package/dist/cjs/api-model/api/merchant-fulfillment-api.js +0 -355
- package/dist/cjs/api-model/api.js +0 -30
- package/dist/cjs/api-model/base.js +0 -52
- package/dist/cjs/api-model/common.js +0 -123
- package/dist/cjs/api-model/configuration.js +0 -98
- package/dist/cjs/api-model/index.js +0 -32
- package/dist/cjs/api-model/models/additional-inputs.js +0 -15
- package/dist/cjs/api-model/models/additional-seller-input.js +0 -15
- package/dist/cjs/api-model/models/additional-seller-inputs.js +0 -15
- package/dist/cjs/api-model/models/address.js +0 -15
- package/dist/cjs/api-model/models/available-carrier-will-pick-up-option.js +0 -15
- package/dist/cjs/api-model/models/available-delivery-experience-option.js +0 -15
- package/dist/cjs/api-model/models/available-shipping-service-options.js +0 -15
- package/dist/cjs/api-model/models/benefits.js +0 -15
- package/dist/cjs/api-model/models/cancel-shipment-response.js +0 -15
- package/dist/cjs/api-model/models/carrier-will-pick-up-option.js +0 -24
- package/dist/cjs/api-model/models/constraint.js +0 -15
- package/dist/cjs/api-model/models/create-shipment-request.js +0 -15
- package/dist/cjs/api-model/models/create-shipment-response.js +0 -15
- package/dist/cjs/api-model/models/currency-amount.js +0 -15
- package/dist/cjs/api-model/models/dangerous-goods-details.js +0 -36
- package/dist/cjs/api-model/models/delivery-experience-option.js +0 -26
- package/dist/cjs/api-model/models/delivery-experience-type.js +0 -25
- package/dist/cjs/api-model/models/excluded-benefit.js +0 -15
- package/dist/cjs/api-model/models/file-contents.js +0 -15
- package/dist/cjs/api-model/models/file-type.js +0 -24
- package/dist/cjs/api-model/models/get-additional-seller-inputs-request.js +0 -15
- package/dist/cjs/api-model/models/get-additional-seller-inputs-response.js +0 -15
- package/dist/cjs/api-model/models/get-additional-seller-inputs-result.js +0 -15
- package/dist/cjs/api-model/models/get-eligible-shipment-services-request.js +0 -15
- package/dist/cjs/api-model/models/get-eligible-shipment-services-response.js +0 -15
- package/dist/cjs/api-model/models/get-eligible-shipment-services-result.js +0 -15
- package/dist/cjs/api-model/models/get-shipment-response.js +0 -15
- package/dist/cjs/api-model/models/hazmat-type.js +0 -23
- package/dist/cjs/api-model/models/index.js +0 -75
- package/dist/cjs/api-model/models/input-target-type.js +0 -23
- package/dist/cjs/api-model/models/item-level-fields.js +0 -15
- package/dist/cjs/api-model/models/item.js +0 -15
- package/dist/cjs/api-model/models/label-customization.js +0 -15
- package/dist/cjs/api-model/models/label-dimensions.js +0 -15
- package/dist/cjs/api-model/models/label-format-option-request.js +0 -15
- package/dist/cjs/api-model/models/label-format-option.js +0 -15
- package/dist/cjs/api-model/models/label-format.js +0 -26
- package/dist/cjs/api-model/models/label.js +0 -15
- package/dist/cjs/api-model/models/length.js +0 -15
- package/dist/cjs/api-model/models/liquid-volume.js +0 -25
- package/dist/cjs/api-model/models/model-error.js +0 -15
- package/dist/cjs/api-model/models/package-dimensions.js +0 -15
- package/dist/cjs/api-model/models/predefined-package-dimensions.js +0 -71
- package/dist/cjs/api-model/models/rate-item-id.js +0 -22
- package/dist/cjs/api-model/models/rate-item-type.js +0 -22
- package/dist/cjs/api-model/models/rate-item.js +0 -15
- package/dist/cjs/api-model/models/rejected-shipping-service.js +0 -15
- package/dist/cjs/api-model/models/seller-input-definition.js +0 -15
- package/dist/cjs/api-model/models/shipment-request-details.js +0 -15
- package/dist/cjs/api-model/models/shipment-status.js +0 -25
- package/dist/cjs/api-model/models/shipment.js +0 -15
- package/dist/cjs/api-model/models/shipping-offering-filter.js +0 -15
- package/dist/cjs/api-model/models/shipping-service-options.js +0 -15
- package/dist/cjs/api-model/models/shipping-service.js +0 -15
- package/dist/cjs/api-model/models/standard-id-for-label.js +0 -22
- package/dist/cjs/api-model/models/temporarily-unavailable-carrier.js +0 -15
- package/dist/cjs/api-model/models/terms-and-conditions-not-accepted-carrier.js +0 -15
- package/dist/cjs/api-model/models/unit-of-length.js +0 -23
- package/dist/cjs/api-model/models/unit-of-weight.js +0 -23
- package/dist/cjs/api-model/models/weight.js +0 -15
- package/dist/cjs/client.js +0 -49
- package/dist/cjs/index.js +0 -19
- package/dist/es/api-model/api/merchant-fulfillment-api.js +0 -345
- package/dist/es/api-model/api.js +0 -14
- package/dist/es/api-model/base.js +0 -44
- package/dist/es/api-model/common.js +0 -110
- package/dist/es/api-model/configuration.js +0 -94
- package/dist/es/api-model/index.js +0 -16
- package/dist/es/api-model/models/additional-inputs.js +0 -14
- package/dist/es/api-model/models/additional-seller-input.js +0 -14
- package/dist/es/api-model/models/additional-seller-inputs.js +0 -14
- package/dist/es/api-model/models/address.js +0 -14
- package/dist/es/api-model/models/available-carrier-will-pick-up-option.js +0 -14
- package/dist/es/api-model/models/available-delivery-experience-option.js +0 -14
- package/dist/es/api-model/models/available-shipping-service-options.js +0 -14
- package/dist/es/api-model/models/benefits.js +0 -14
- package/dist/es/api-model/models/cancel-shipment-response.js +0 -14
- package/dist/es/api-model/models/carrier-will-pick-up-option.js +0 -21
- package/dist/es/api-model/models/constraint.js +0 -14
- package/dist/es/api-model/models/create-shipment-request.js +0 -14
- package/dist/es/api-model/models/create-shipment-response.js +0 -14
- package/dist/es/api-model/models/currency-amount.js +0 -14
- package/dist/es/api-model/models/dangerous-goods-details.js +0 -33
- package/dist/es/api-model/models/delivery-experience-option.js +0 -23
- package/dist/es/api-model/models/delivery-experience-type.js +0 -22
- package/dist/es/api-model/models/excluded-benefit.js +0 -14
- package/dist/es/api-model/models/file-contents.js +0 -14
- package/dist/es/api-model/models/file-type.js +0 -21
- package/dist/es/api-model/models/get-additional-seller-inputs-request.js +0 -14
- package/dist/es/api-model/models/get-additional-seller-inputs-response.js +0 -14
- package/dist/es/api-model/models/get-additional-seller-inputs-result.js +0 -14
- package/dist/es/api-model/models/get-eligible-shipment-services-request.js +0 -14
- package/dist/es/api-model/models/get-eligible-shipment-services-response.js +0 -14
- package/dist/es/api-model/models/get-eligible-shipment-services-result.js +0 -14
- package/dist/es/api-model/models/get-shipment-response.js +0 -14
- package/dist/es/api-model/models/hazmat-type.js +0 -20
- package/dist/es/api-model/models/index.js +0 -59
- package/dist/es/api-model/models/input-target-type.js +0 -20
- package/dist/es/api-model/models/item-level-fields.js +0 -14
- package/dist/es/api-model/models/item.js +0 -14
- package/dist/es/api-model/models/label-customization.js +0 -14
- package/dist/es/api-model/models/label-dimensions.js +0 -14
- package/dist/es/api-model/models/label-format-option-request.js +0 -14
- package/dist/es/api-model/models/label-format-option.js +0 -14
- package/dist/es/api-model/models/label-format.js +0 -23
- package/dist/es/api-model/models/label.js +0 -14
- package/dist/es/api-model/models/length.js +0 -14
- package/dist/es/api-model/models/liquid-volume.js +0 -22
- package/dist/es/api-model/models/model-error.js +0 -14
- package/dist/es/api-model/models/package-dimensions.js +0 -14
- package/dist/es/api-model/models/predefined-package-dimensions.js +0 -68
- package/dist/es/api-model/models/rate-item-id.js +0 -19
- package/dist/es/api-model/models/rate-item-type.js +0 -19
- package/dist/es/api-model/models/rate-item.js +0 -14
- package/dist/es/api-model/models/rejected-shipping-service.js +0 -14
- package/dist/es/api-model/models/seller-input-definition.js +0 -14
- package/dist/es/api-model/models/shipment-request-details.js +0 -14
- package/dist/es/api-model/models/shipment-status.js +0 -22
- package/dist/es/api-model/models/shipment.js +0 -14
- package/dist/es/api-model/models/shipping-offering-filter.js +0 -14
- package/dist/es/api-model/models/shipping-service-options.js +0 -14
- package/dist/es/api-model/models/shipping-service.js +0 -14
- package/dist/es/api-model/models/standard-id-for-label.js +0 -19
- package/dist/es/api-model/models/temporarily-unavailable-carrier.js +0 -14
- package/dist/es/api-model/models/terms-and-conditions-not-accepted-carrier.js +0 -14
- package/dist/es/api-model/models/unit-of-length.js +0 -20
- package/dist/es/api-model/models/unit-of-weight.js +0 -20
- package/dist/es/api-model/models/weight.js +0 -14
- package/dist/es/client.js +0 -45
- package/dist/es/index.js +0 -3
- package/dist/types/api-model/api/merchant-fulfillment-api.d.ts +0 -228
- package/dist/types/api-model/api.d.ts +0 -12
- package/dist/types/api-model/base.d.ts +0 -42
- package/dist/types/api-model/common.d.ts +0 -34
- package/dist/types/api-model/configuration.d.ts +0 -98
- package/dist/types/api-model/index.d.ts +0 -14
- package/dist/types/api-model/models/additional-inputs.d.ts +0 -22
- package/dist/types/api-model/models/additional-seller-input.d.ts +0 -44
- package/dist/types/api-model/models/additional-seller-inputs.d.ts +0 -22
- package/dist/types/api-model/models/address.d.ts +0 -60
- package/dist/types/api-model/models/available-carrier-will-pick-up-option.d.ts +0 -20
- package/dist/types/api-model/models/available-delivery-experience-option.d.ts +0 -20
- package/dist/types/api-model/models/available-shipping-service-options.d.ts +0 -26
- package/dist/types/api-model/models/benefits.d.ts +0 -25
- package/dist/types/api-model/models/cancel-shipment-response.d.ts +0 -22
- package/dist/types/api-model/models/carrier-will-pick-up-option.d.ts +0 -20
- package/dist/types/api-model/models/constraint.d.ts +0 -24
- package/dist/types/api-model/models/create-shipment-request.d.ts +0 -35
- package/dist/types/api-model/models/create-shipment-response.d.ts +0 -22
- package/dist/types/api-model/models/currency-amount.d.ts +0 -24
- package/dist/types/api-model/models/dangerous-goods-details.d.ts +0 -54
- package/dist/types/api-model/models/delivery-experience-option.d.ts +0 -22
- package/dist/types/api-model/models/delivery-experience-type.d.ts +0 -21
- package/dist/types/api-model/models/excluded-benefit.d.ts +0 -24
- package/dist/types/api-model/models/file-contents.d.ts +0 -26
- package/dist/types/api-model/models/file-type.d.ts +0 -20
- package/dist/types/api-model/models/get-additional-seller-inputs-request.d.ts +0 -26
- package/dist/types/api-model/models/get-additional-seller-inputs-response.d.ts +0 -22
- package/dist/types/api-model/models/get-additional-seller-inputs-result.d.ts +0 -26
- package/dist/types/api-model/models/get-eligible-shipment-services-request.d.ts +0 -20
- package/dist/types/api-model/models/get-eligible-shipment-services-response.d.ts +0 -22
- package/dist/types/api-model/models/get-eligible-shipment-services-result.d.ts +0 -36
- package/dist/types/api-model/models/get-shipment-response.d.ts +0 -22
- package/dist/types/api-model/models/hazmat-type.d.ts +0 -19
- package/dist/types/api-model/models/index.d.ts +0 -59
- package/dist/types/api-model/models/input-target-type.d.ts +0 -19
- package/dist/types/api-model/models/item-level-fields.d.ts +0 -25
- package/dist/types/api-model/models/item.d.ts +0 -47
- package/dist/types/api-model/models/label-customization.d.ts +0 -22
- package/dist/types/api-model/models/label-dimensions.d.ts +0 -26
- package/dist/types/api-model/models/label-format-option-request.d.ts +0 -20
- package/dist/types/api-model/models/label-format-option.d.ts +0 -22
- package/dist/types/api-model/models/label-format.d.ts +0 -22
- package/dist/types/api-model/models/label.d.ts +0 -28
- package/dist/types/api-model/models/length.d.ts +0 -22
- package/dist/types/api-model/models/liquid-volume.d.ts +0 -34
- package/dist/types/api-model/models/model-error.d.ts +0 -28
- package/dist/types/api-model/models/package-dimensions.d.ts +0 -32
- package/dist/types/api-model/models/predefined-package-dimensions.d.ts +0 -67
- package/dist/types/api-model/models/rate-item-id.d.ts +0 -18
- package/dist/types/api-model/models/rate-item-type.d.ts +0 -18
- package/dist/types/api-model/models/rate-item.d.ts +0 -26
- package/dist/types/api-model/models/rejected-shipping-service.d.ts +0 -36
- package/dist/types/api-model/models/seller-input-definition.d.ts +0 -41
- package/dist/types/api-model/models/shipment-request-details.d.ts +0 -47
- package/dist/types/api-model/models/shipment-status.d.ts +0 -21
- package/dist/types/api-model/models/shipment.d.ts +0 -60
- package/dist/types/api-model/models/shipping-offering-filter.d.ts +0 -28
- package/dist/types/api-model/models/shipping-service-options.d.ts +0 -28
- package/dist/types/api-model/models/shipping-service.d.ts +0 -72
- package/dist/types/api-model/models/standard-id-for-label.d.ts +0 -18
- package/dist/types/api-model/models/temporarily-unavailable-carrier.d.ts +0 -20
- package/dist/types/api-model/models/terms-and-conditions-not-accepted-carrier.d.ts +0 -20
- package/dist/types/api-model/models/unit-of-length.d.ts +0 -19
- package/dist/types/api-model/models/unit-of-weight.d.ts +0 -19
- package/dist/types/api-model/models/weight.d.ts +0 -22
- package/dist/types/client.d.ts +0 -6
- package/dist/types/index.d.ts +0 -3
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,2022 @@
|
|
|
1
|
+
import { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
|
|
2
|
+
import * as axios from 'axios';
|
|
3
|
+
import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Selling Partner API for Merchant Fulfillment
|
|
7
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
8
|
+
*
|
|
9
|
+
* The version of the OpenAPI document: v0
|
|
10
|
+
*
|
|
11
|
+
*
|
|
12
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
13
|
+
* https://openapi-generator.tech
|
|
14
|
+
* Do not edit the class manually.
|
|
15
|
+
*/
|
|
16
|
+
interface AWSv4Configuration {
|
|
17
|
+
options?: {
|
|
18
|
+
region?: string;
|
|
19
|
+
service?: string;
|
|
20
|
+
};
|
|
21
|
+
credentials?: {
|
|
22
|
+
accessKeyId?: string;
|
|
23
|
+
secretAccessKey?: string;
|
|
24
|
+
sessionToken?: string;
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
interface ConfigurationParameters {
|
|
28
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
|
+
username?: string;
|
|
30
|
+
password?: string;
|
|
31
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
32
|
+
awsv4?: AWSv4Configuration;
|
|
33
|
+
basePath?: string;
|
|
34
|
+
serverIndex?: number;
|
|
35
|
+
baseOptions?: any;
|
|
36
|
+
formDataCtor?: new () => any;
|
|
37
|
+
}
|
|
38
|
+
declare class Configuration {
|
|
39
|
+
/**
|
|
40
|
+
* parameter for apiKey security
|
|
41
|
+
* @param name security name
|
|
42
|
+
*/
|
|
43
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
44
|
+
/**
|
|
45
|
+
* parameter for basic security
|
|
46
|
+
*/
|
|
47
|
+
username?: string;
|
|
48
|
+
/**
|
|
49
|
+
* parameter for basic security
|
|
50
|
+
*/
|
|
51
|
+
password?: string;
|
|
52
|
+
/**
|
|
53
|
+
* parameter for oauth2 security
|
|
54
|
+
* @param name security name
|
|
55
|
+
* @param scopes oauth2 scope
|
|
56
|
+
*/
|
|
57
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
58
|
+
/**
|
|
59
|
+
* parameter for aws4 signature security
|
|
60
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
61
|
+
* @param {string} options.region - aws region
|
|
62
|
+
* @param {string} options.service - name of the service.
|
|
63
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
64
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
65
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
66
|
+
* @memberof Configuration
|
|
67
|
+
*/
|
|
68
|
+
awsv4?: AWSv4Configuration;
|
|
69
|
+
/**
|
|
70
|
+
* override base path
|
|
71
|
+
*/
|
|
72
|
+
basePath?: string;
|
|
73
|
+
/**
|
|
74
|
+
* override server index
|
|
75
|
+
*/
|
|
76
|
+
serverIndex?: number;
|
|
77
|
+
/**
|
|
78
|
+
* base options for axios calls
|
|
79
|
+
*/
|
|
80
|
+
baseOptions?: any;
|
|
81
|
+
/**
|
|
82
|
+
* The FormData constructor that will be used to create multipart form data
|
|
83
|
+
* requests. You can inject this here so that execution environments that
|
|
84
|
+
* do not support the FormData class can still run the generated client.
|
|
85
|
+
*
|
|
86
|
+
* @type {new () => FormData}
|
|
87
|
+
*/
|
|
88
|
+
formDataCtor?: new () => any;
|
|
89
|
+
constructor(param?: ConfigurationParameters);
|
|
90
|
+
/**
|
|
91
|
+
* Check if the given MIME is a JSON MIME.
|
|
92
|
+
* JSON MIME examples:
|
|
93
|
+
* application/json
|
|
94
|
+
* application/json; charset=UTF8
|
|
95
|
+
* APPLICATION/JSON
|
|
96
|
+
* application/vnd.company+json
|
|
97
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
98
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
99
|
+
*/
|
|
100
|
+
isJsonMime(mime: string): boolean;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Selling Partner API for Merchant Fulfillment
|
|
105
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
106
|
+
*
|
|
107
|
+
* The version of the OpenAPI document: v0
|
|
108
|
+
*
|
|
109
|
+
*
|
|
110
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
111
|
+
* https://openapi-generator.tech
|
|
112
|
+
* Do not edit the class manually.
|
|
113
|
+
*/
|
|
114
|
+
|
|
115
|
+
interface RequestArgs {
|
|
116
|
+
url: string;
|
|
117
|
+
options: RawAxiosRequestConfig;
|
|
118
|
+
}
|
|
119
|
+
declare class BaseAPI {
|
|
120
|
+
protected basePath: string;
|
|
121
|
+
protected axios: AxiosInstance;
|
|
122
|
+
protected configuration: Configuration | undefined;
|
|
123
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Selling Partner API for Merchant Fulfillment
|
|
128
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
129
|
+
*
|
|
130
|
+
* The version of the OpenAPI document: v0
|
|
131
|
+
*
|
|
132
|
+
*
|
|
133
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
134
|
+
* https://openapi-generator.tech
|
|
135
|
+
* Do not edit the class manually.
|
|
136
|
+
*/
|
|
137
|
+
/**
|
|
138
|
+
* The postal address information.
|
|
139
|
+
*/
|
|
140
|
+
interface Address {
|
|
141
|
+
/**
|
|
142
|
+
* The name of the addressee, or business name.
|
|
143
|
+
*/
|
|
144
|
+
'Name': string;
|
|
145
|
+
/**
|
|
146
|
+
* The street address information.
|
|
147
|
+
*/
|
|
148
|
+
'AddressLine1': string;
|
|
149
|
+
/**
|
|
150
|
+
* Additional street address information.
|
|
151
|
+
*/
|
|
152
|
+
'AddressLine2'?: string;
|
|
153
|
+
/**
|
|
154
|
+
* Additional street address information.
|
|
155
|
+
*/
|
|
156
|
+
'AddressLine3'?: string;
|
|
157
|
+
/**
|
|
158
|
+
* The district or county.
|
|
159
|
+
*/
|
|
160
|
+
'DistrictOrCounty'?: string;
|
|
161
|
+
/**
|
|
162
|
+
* The email address.
|
|
163
|
+
*/
|
|
164
|
+
'Email': string;
|
|
165
|
+
/**
|
|
166
|
+
* The city.
|
|
167
|
+
*/
|
|
168
|
+
'City': string;
|
|
169
|
+
/**
|
|
170
|
+
* The state or province code. This is a required field in Canada, US, and UK marketplaces, and for shipments that originate in China.
|
|
171
|
+
*/
|
|
172
|
+
'StateOrProvinceCode'?: string;
|
|
173
|
+
/**
|
|
174
|
+
* The zip code or postal code.
|
|
175
|
+
*/
|
|
176
|
+
'PostalCode': string;
|
|
177
|
+
/**
|
|
178
|
+
* The two-letter country code in [ISO 3166-1 alpha-2](https://www.iban.com/country-codes) format.
|
|
179
|
+
*/
|
|
180
|
+
'CountryCode': string;
|
|
181
|
+
/**
|
|
182
|
+
* The phone number.
|
|
183
|
+
*/
|
|
184
|
+
'Phone': string;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Selling Partner API for Merchant Fulfillment
|
|
189
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
190
|
+
*
|
|
191
|
+
* The version of the OpenAPI document: v0
|
|
192
|
+
*
|
|
193
|
+
*
|
|
194
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
195
|
+
* https://openapi-generator.tech
|
|
196
|
+
* Do not edit the class manually.
|
|
197
|
+
*/
|
|
198
|
+
/**
|
|
199
|
+
* Currency type and amount.
|
|
200
|
+
*/
|
|
201
|
+
interface CurrencyAmount {
|
|
202
|
+
/**
|
|
203
|
+
* Three-digit currency code in ISO 4217 format.
|
|
204
|
+
*/
|
|
205
|
+
'CurrencyCode': string;
|
|
206
|
+
/**
|
|
207
|
+
* The currency amount.
|
|
208
|
+
*/
|
|
209
|
+
'Amount': number;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* Selling Partner API for Merchant Fulfillment
|
|
214
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
215
|
+
*
|
|
216
|
+
* The version of the OpenAPI document: v0
|
|
217
|
+
*
|
|
218
|
+
*
|
|
219
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
220
|
+
* https://openapi-generator.tech
|
|
221
|
+
* Do not edit the class manually.
|
|
222
|
+
*/
|
|
223
|
+
/**
|
|
224
|
+
* The unit of length.
|
|
225
|
+
*/
|
|
226
|
+
declare const UnitOfLength: {
|
|
227
|
+
readonly Inches: "inches";
|
|
228
|
+
readonly Centimeters: "centimeters";
|
|
229
|
+
};
|
|
230
|
+
type UnitOfLength = typeof UnitOfLength[keyof typeof UnitOfLength];
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* Selling Partner API for Merchant Fulfillment
|
|
234
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
235
|
+
*
|
|
236
|
+
* The version of the OpenAPI document: v0
|
|
237
|
+
*
|
|
238
|
+
*
|
|
239
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
240
|
+
* https://openapi-generator.tech
|
|
241
|
+
* Do not edit the class manually.
|
|
242
|
+
*/
|
|
243
|
+
|
|
244
|
+
/**
|
|
245
|
+
* The length.
|
|
246
|
+
*/
|
|
247
|
+
interface Length {
|
|
248
|
+
/**
|
|
249
|
+
* The value in units.
|
|
250
|
+
*/
|
|
251
|
+
'value'?: number;
|
|
252
|
+
'unit'?: UnitOfLength;
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* Selling Partner API for Merchant Fulfillment
|
|
257
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
258
|
+
*
|
|
259
|
+
* The version of the OpenAPI document: v0
|
|
260
|
+
*
|
|
261
|
+
*
|
|
262
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
263
|
+
* https://openapi-generator.tech
|
|
264
|
+
* Do not edit the class manually.
|
|
265
|
+
*/
|
|
266
|
+
/**
|
|
267
|
+
* The unit of weight.
|
|
268
|
+
*/
|
|
269
|
+
declare const UnitOfWeight: {
|
|
270
|
+
readonly Oz: "oz";
|
|
271
|
+
readonly G: "g";
|
|
272
|
+
};
|
|
273
|
+
type UnitOfWeight = typeof UnitOfWeight[keyof typeof UnitOfWeight];
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Selling Partner API for Merchant Fulfillment
|
|
277
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
278
|
+
*
|
|
279
|
+
* The version of the OpenAPI document: v0
|
|
280
|
+
*
|
|
281
|
+
*
|
|
282
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
283
|
+
* https://openapi-generator.tech
|
|
284
|
+
* Do not edit the class manually.
|
|
285
|
+
*/
|
|
286
|
+
|
|
287
|
+
/**
|
|
288
|
+
* The weight.
|
|
289
|
+
*/
|
|
290
|
+
interface Weight {
|
|
291
|
+
/**
|
|
292
|
+
* The weight value.
|
|
293
|
+
*/
|
|
294
|
+
'Value': number;
|
|
295
|
+
'Unit': UnitOfWeight;
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
/**
|
|
299
|
+
* Selling Partner API for Merchant Fulfillment
|
|
300
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
301
|
+
*
|
|
302
|
+
* The version of the OpenAPI document: v0
|
|
303
|
+
*
|
|
304
|
+
*
|
|
305
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
306
|
+
* https://openapi-generator.tech
|
|
307
|
+
* Do not edit the class manually.
|
|
308
|
+
*/
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Additional information required to purchase shipping.
|
|
312
|
+
*/
|
|
313
|
+
interface AdditionalSellerInput {
|
|
314
|
+
/**
|
|
315
|
+
* The data type of the additional information.
|
|
316
|
+
*/
|
|
317
|
+
'DataType'?: string;
|
|
318
|
+
/**
|
|
319
|
+
* The value when the data type is string.
|
|
320
|
+
*/
|
|
321
|
+
'ValueAsString'?: string;
|
|
322
|
+
/**
|
|
323
|
+
* The value when the data type is boolean.
|
|
324
|
+
*/
|
|
325
|
+
'ValueAsBoolean'?: boolean;
|
|
326
|
+
/**
|
|
327
|
+
* The value when the data type is integer.
|
|
328
|
+
*/
|
|
329
|
+
'ValueAsInteger'?: number;
|
|
330
|
+
/**
|
|
331
|
+
* Date-time formatted timestamp.
|
|
332
|
+
*/
|
|
333
|
+
'ValueAsTimestamp'?: string;
|
|
334
|
+
'ValueAsAddress'?: Address;
|
|
335
|
+
'ValueAsWeight'?: Weight;
|
|
336
|
+
'ValueAsDimension'?: Length;
|
|
337
|
+
'ValueAsCurrency'?: CurrencyAmount;
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Selling Partner API for Merchant Fulfillment
|
|
342
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
343
|
+
*
|
|
344
|
+
* The version of the OpenAPI document: v0
|
|
345
|
+
*
|
|
346
|
+
*
|
|
347
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
348
|
+
* https://openapi-generator.tech
|
|
349
|
+
* Do not edit the class manually.
|
|
350
|
+
*/
|
|
351
|
+
/**
|
|
352
|
+
* A validation constraint.
|
|
353
|
+
*/
|
|
354
|
+
interface Constraint {
|
|
355
|
+
/**
|
|
356
|
+
* A regular expression.
|
|
357
|
+
*/
|
|
358
|
+
'ValidationRegEx'?: string;
|
|
359
|
+
/**
|
|
360
|
+
* A validation string.
|
|
361
|
+
*/
|
|
362
|
+
'ValidationString': string;
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* Selling Partner API for Merchant Fulfillment
|
|
367
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
368
|
+
*
|
|
369
|
+
* The version of the OpenAPI document: v0
|
|
370
|
+
*
|
|
371
|
+
*
|
|
372
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
373
|
+
* https://openapi-generator.tech
|
|
374
|
+
* Do not edit the class manually.
|
|
375
|
+
*/
|
|
376
|
+
/**
|
|
377
|
+
* Indicates whether the additional seller input is at the item or shipment level.
|
|
378
|
+
*/
|
|
379
|
+
declare const InputTargetType: {
|
|
380
|
+
readonly ShipmentLevel: "SHIPMENT_LEVEL";
|
|
381
|
+
readonly ItemLevel: "ITEM_LEVEL";
|
|
382
|
+
};
|
|
383
|
+
type InputTargetType = typeof InputTargetType[keyof typeof InputTargetType];
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* Selling Partner API for Merchant Fulfillment
|
|
387
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
388
|
+
*
|
|
389
|
+
* The version of the OpenAPI document: v0
|
|
390
|
+
*
|
|
391
|
+
*
|
|
392
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
393
|
+
* https://openapi-generator.tech
|
|
394
|
+
* Do not edit the class manually.
|
|
395
|
+
*/
|
|
396
|
+
|
|
397
|
+
/**
|
|
398
|
+
* Specifies characteristics that apply to a seller input.
|
|
399
|
+
*/
|
|
400
|
+
interface SellerInputDefinition {
|
|
401
|
+
/**
|
|
402
|
+
* When true, the additional input field is required.
|
|
403
|
+
*/
|
|
404
|
+
'IsRequired': boolean;
|
|
405
|
+
/**
|
|
406
|
+
* The data type of the additional input field.
|
|
407
|
+
*/
|
|
408
|
+
'DataType': string;
|
|
409
|
+
/**
|
|
410
|
+
* List of constraints.
|
|
411
|
+
*/
|
|
412
|
+
'Constraints': Array<Constraint>;
|
|
413
|
+
/**
|
|
414
|
+
* The display text for the additional input field.
|
|
415
|
+
*/
|
|
416
|
+
'InputDisplayText': string;
|
|
417
|
+
'InputTarget'?: InputTargetType;
|
|
418
|
+
'StoredValue': AdditionalSellerInput;
|
|
419
|
+
/**
|
|
420
|
+
* The set of fixed values in an additional seller input.
|
|
421
|
+
*/
|
|
422
|
+
'RestrictedSetValues'?: Array<string>;
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
/**
|
|
426
|
+
* Selling Partner API for Merchant Fulfillment
|
|
427
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
428
|
+
*
|
|
429
|
+
* The version of the OpenAPI document: v0
|
|
430
|
+
*
|
|
431
|
+
*
|
|
432
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
433
|
+
* https://openapi-generator.tech
|
|
434
|
+
* Do not edit the class manually.
|
|
435
|
+
*/
|
|
436
|
+
|
|
437
|
+
/**
|
|
438
|
+
* Maps the additional seller input to the definition. The key to the map is the field name.
|
|
439
|
+
*/
|
|
440
|
+
interface AdditionalInputs {
|
|
441
|
+
/**
|
|
442
|
+
* The field name.
|
|
443
|
+
*/
|
|
444
|
+
'AdditionalInputFieldName'?: string;
|
|
445
|
+
'SellerInputDefinition'?: SellerInputDefinition;
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
/**
|
|
449
|
+
* Selling Partner API for Merchant Fulfillment
|
|
450
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
451
|
+
*
|
|
452
|
+
* The version of the OpenAPI document: v0
|
|
453
|
+
*
|
|
454
|
+
*
|
|
455
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
456
|
+
* https://openapi-generator.tech
|
|
457
|
+
* Do not edit the class manually.
|
|
458
|
+
*/
|
|
459
|
+
|
|
460
|
+
/**
|
|
461
|
+
* An additional set of seller inputs required to purchase shipping.
|
|
462
|
+
*/
|
|
463
|
+
interface AdditionalSellerInputs {
|
|
464
|
+
/**
|
|
465
|
+
* The name of the additional input field.
|
|
466
|
+
*/
|
|
467
|
+
'AdditionalInputFieldName': string;
|
|
468
|
+
'AdditionalSellerInput': AdditionalSellerInput;
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Selling Partner API for Merchant Fulfillment
|
|
473
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
474
|
+
*
|
|
475
|
+
* The version of the OpenAPI document: v0
|
|
476
|
+
*
|
|
477
|
+
*
|
|
478
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
479
|
+
* https://openapi-generator.tech
|
|
480
|
+
* Do not edit the class manually.
|
|
481
|
+
*/
|
|
482
|
+
/**
|
|
483
|
+
* Carrier will pick up option.
|
|
484
|
+
*/
|
|
485
|
+
declare const CarrierWillPickUpOption: {
|
|
486
|
+
readonly CarrierWillPickUp: "CarrierWillPickUp";
|
|
487
|
+
readonly ShipperWillDropOff: "ShipperWillDropOff";
|
|
488
|
+
readonly NoPreference: "NoPreference";
|
|
489
|
+
};
|
|
490
|
+
type CarrierWillPickUpOption = typeof CarrierWillPickUpOption[keyof typeof CarrierWillPickUpOption];
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* Selling Partner API for Merchant Fulfillment
|
|
494
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
495
|
+
*
|
|
496
|
+
* The version of the OpenAPI document: v0
|
|
497
|
+
*
|
|
498
|
+
*
|
|
499
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
500
|
+
* https://openapi-generator.tech
|
|
501
|
+
* Do not edit the class manually.
|
|
502
|
+
*/
|
|
503
|
+
|
|
504
|
+
/**
|
|
505
|
+
* Indicates whether the carrier will pick up the package, and what fee is charged, if any.
|
|
506
|
+
*/
|
|
507
|
+
interface AvailableCarrierWillPickUpOption {
|
|
508
|
+
'CarrierWillPickUpOption': CarrierWillPickUpOption;
|
|
509
|
+
'Charge': CurrencyAmount;
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
* Selling Partner API for Merchant Fulfillment
|
|
514
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
515
|
+
*
|
|
516
|
+
* The version of the OpenAPI document: v0
|
|
517
|
+
*
|
|
518
|
+
*
|
|
519
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
520
|
+
* https://openapi-generator.tech
|
|
521
|
+
* Do not edit the class manually.
|
|
522
|
+
*/
|
|
523
|
+
/**
|
|
524
|
+
* The delivery confirmation level.
|
|
525
|
+
*/
|
|
526
|
+
declare const DeliveryExperienceOption: {
|
|
527
|
+
readonly DeliveryConfirmationWithAdultSignature: "DeliveryConfirmationWithAdultSignature";
|
|
528
|
+
readonly DeliveryConfirmationWithSignature: "DeliveryConfirmationWithSignature";
|
|
529
|
+
readonly DeliveryConfirmationWithoutSignature: "DeliveryConfirmationWithoutSignature";
|
|
530
|
+
readonly NoTracking: "NoTracking";
|
|
531
|
+
readonly NoPreference: "NoPreference";
|
|
532
|
+
};
|
|
533
|
+
type DeliveryExperienceOption = typeof DeliveryExperienceOption[keyof typeof DeliveryExperienceOption];
|
|
534
|
+
|
|
535
|
+
/**
|
|
536
|
+
* Selling Partner API for Merchant Fulfillment
|
|
537
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
538
|
+
*
|
|
539
|
+
* The version of the OpenAPI document: v0
|
|
540
|
+
*
|
|
541
|
+
*
|
|
542
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
543
|
+
* https://openapi-generator.tech
|
|
544
|
+
* Do not edit the class manually.
|
|
545
|
+
*/
|
|
546
|
+
|
|
547
|
+
/**
|
|
548
|
+
* The available delivery confirmation options, and the fee charged, if any.
|
|
549
|
+
*/
|
|
550
|
+
interface AvailableDeliveryExperienceOption {
|
|
551
|
+
'DeliveryExperienceOption': DeliveryExperienceOption;
|
|
552
|
+
'Charge': CurrencyAmount;
|
|
553
|
+
}
|
|
554
|
+
|
|
555
|
+
/**
|
|
556
|
+
* Selling Partner API for Merchant Fulfillment
|
|
557
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
558
|
+
*
|
|
559
|
+
* The version of the OpenAPI document: v0
|
|
560
|
+
*
|
|
561
|
+
*
|
|
562
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
563
|
+
* https://openapi-generator.tech
|
|
564
|
+
* Do not edit the class manually.
|
|
565
|
+
*/
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
* The available shipping service options.
|
|
569
|
+
*/
|
|
570
|
+
interface AvailableShippingServiceOptions {
|
|
571
|
+
/**
|
|
572
|
+
* List of available carrier pickup options.
|
|
573
|
+
*/
|
|
574
|
+
'AvailableCarrierWillPickUpOptions': Array<AvailableCarrierWillPickUpOption>;
|
|
575
|
+
/**
|
|
576
|
+
* List of available delivery experience options.
|
|
577
|
+
*/
|
|
578
|
+
'AvailableDeliveryExperienceOptions': Array<AvailableDeliveryExperienceOption>;
|
|
579
|
+
}
|
|
580
|
+
|
|
581
|
+
/**
|
|
582
|
+
* Selling Partner API for Merchant Fulfillment
|
|
583
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
584
|
+
*
|
|
585
|
+
* The version of the OpenAPI document: v0
|
|
586
|
+
*
|
|
587
|
+
*
|
|
588
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
589
|
+
* https://openapi-generator.tech
|
|
590
|
+
* Do not edit the class manually.
|
|
591
|
+
*/
|
|
592
|
+
/**
|
|
593
|
+
* An object representing an excluded benefit that is excluded for a shipping offer or rate.
|
|
594
|
+
*/
|
|
595
|
+
interface ExcludedBenefit {
|
|
596
|
+
/**
|
|
597
|
+
* A benefit that is being excluded from a shipment.
|
|
598
|
+
*/
|
|
599
|
+
'Benefit'?: string;
|
|
600
|
+
/**
|
|
601
|
+
* List of reasons why a benefit is excluded for a shipping offer (for example, `LATE_DELIVERY_RISK`).
|
|
602
|
+
*/
|
|
603
|
+
'ReasonCodes'?: Array<string>;
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
/**
|
|
607
|
+
* Selling Partner API for Merchant Fulfillment
|
|
608
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
609
|
+
*
|
|
610
|
+
* The version of the OpenAPI document: v0
|
|
611
|
+
*
|
|
612
|
+
*
|
|
613
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
614
|
+
* https://openapi-generator.tech
|
|
615
|
+
* Do not edit the class manually.
|
|
616
|
+
*/
|
|
617
|
+
|
|
618
|
+
/**
|
|
619
|
+
* Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (for example, `CLAIMS_PROTECTED`) when sellers purchase shipping through Amazon. Benefit details are made available for any shipment placed on or after January 1st 2024 00:00 UTC.
|
|
620
|
+
*/
|
|
621
|
+
interface Benefits {
|
|
622
|
+
/**
|
|
623
|
+
* A list of included benefits.
|
|
624
|
+
*/
|
|
625
|
+
'IncludedBenefits'?: Array<string>;
|
|
626
|
+
/**
|
|
627
|
+
* A list of excluded benefits. Refer to the `ExcludeBenefit` object for further documentation.
|
|
628
|
+
*/
|
|
629
|
+
'ExcludedBenefits'?: Array<ExcludedBenefit>;
|
|
630
|
+
}
|
|
631
|
+
|
|
632
|
+
/**
|
|
633
|
+
* Selling Partner API for Merchant Fulfillment
|
|
634
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
635
|
+
*
|
|
636
|
+
* The version of the OpenAPI document: v0
|
|
637
|
+
*
|
|
638
|
+
*
|
|
639
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
640
|
+
* https://openapi-generator.tech
|
|
641
|
+
* Do not edit the class manually.
|
|
642
|
+
*/
|
|
643
|
+
/**
|
|
644
|
+
* Details related to any dangerous goods or items that are shipped.
|
|
645
|
+
*/
|
|
646
|
+
interface DangerousGoodsDetails {
|
|
647
|
+
/**
|
|
648
|
+
* The specific UNID of the item being shipped.
|
|
649
|
+
*/
|
|
650
|
+
'UnitedNationsRegulatoryId'?: string;
|
|
651
|
+
/**
|
|
652
|
+
* The specific regulatory class of the shipped item.
|
|
653
|
+
*/
|
|
654
|
+
'TransportationRegulatoryClass'?: string;
|
|
655
|
+
/**
|
|
656
|
+
* The specific packaging group of the item being shipped.
|
|
657
|
+
*/
|
|
658
|
+
'PackingGroup'?: DangerousGoodsDetailsPackingGroupEnum;
|
|
659
|
+
/**
|
|
660
|
+
* The specific packing instruction of the item being shipped.
|
|
661
|
+
*/
|
|
662
|
+
'PackingInstruction'?: DangerousGoodsDetailsPackingInstructionEnum;
|
|
663
|
+
}
|
|
664
|
+
declare const DangerousGoodsDetailsPackingGroupEnum: {
|
|
665
|
+
readonly I: "I";
|
|
666
|
+
readonly Ii: "II";
|
|
667
|
+
readonly Iii: "III";
|
|
668
|
+
};
|
|
669
|
+
type DangerousGoodsDetailsPackingGroupEnum = typeof DangerousGoodsDetailsPackingGroupEnum[keyof typeof DangerousGoodsDetailsPackingGroupEnum];
|
|
670
|
+
declare const DangerousGoodsDetailsPackingInstructionEnum: {
|
|
671
|
+
readonly Pi965SectionIa: "PI965_SECTION_IA";
|
|
672
|
+
readonly Pi965SectionIb: "PI965_SECTION_IB";
|
|
673
|
+
readonly Pi965SectionIi: "PI965_SECTION_II";
|
|
674
|
+
readonly Pi966SectionI: "PI966_SECTION_I";
|
|
675
|
+
readonly Pi966SectionIi: "PI966_SECTION_II";
|
|
676
|
+
readonly Pi967SectionI: "PI967_SECTION_I";
|
|
677
|
+
readonly Pi967SectionIi: "PI967_SECTION_II";
|
|
678
|
+
readonly Pi968SectionIa: "PI968_SECTION_IA";
|
|
679
|
+
readonly Pi968SectionIb: "PI968_SECTION_IB";
|
|
680
|
+
readonly Pi969SectionI: "PI969_SECTION_I";
|
|
681
|
+
readonly Pi969SectionIi: "PI969_SECTION_II";
|
|
682
|
+
readonly Pi970SectionI: "PI970_SECTION_I";
|
|
683
|
+
readonly Pi970SectionIi: "PI970_SECTION_II";
|
|
684
|
+
};
|
|
685
|
+
type DangerousGoodsDetailsPackingInstructionEnum = typeof DangerousGoodsDetailsPackingInstructionEnum[keyof typeof DangerousGoodsDetailsPackingInstructionEnum];
|
|
686
|
+
|
|
687
|
+
/**
|
|
688
|
+
* Selling Partner API for Merchant Fulfillment
|
|
689
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
690
|
+
*
|
|
691
|
+
* The version of the OpenAPI document: v0
|
|
692
|
+
*
|
|
693
|
+
*
|
|
694
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
695
|
+
* https://openapi-generator.tech
|
|
696
|
+
* Do not edit the class manually.
|
|
697
|
+
*/
|
|
698
|
+
/**
|
|
699
|
+
* Liquid volume.
|
|
700
|
+
*/
|
|
701
|
+
interface LiquidVolume {
|
|
702
|
+
/**
|
|
703
|
+
* The unit of measurement.
|
|
704
|
+
*/
|
|
705
|
+
'Unit': LiquidVolumeUnitEnum;
|
|
706
|
+
/**
|
|
707
|
+
* The measurement value.
|
|
708
|
+
*/
|
|
709
|
+
'Value': number;
|
|
710
|
+
}
|
|
711
|
+
declare const LiquidVolumeUnitEnum: {
|
|
712
|
+
readonly Ml: "ML";
|
|
713
|
+
readonly L: "L";
|
|
714
|
+
readonly FlOz: "FL_OZ";
|
|
715
|
+
readonly Gal: "GAL";
|
|
716
|
+
readonly Pt: "PT";
|
|
717
|
+
readonly Qt: "QT";
|
|
718
|
+
readonly C: "C";
|
|
719
|
+
};
|
|
720
|
+
type LiquidVolumeUnitEnum = typeof LiquidVolumeUnitEnum[keyof typeof LiquidVolumeUnitEnum];
|
|
721
|
+
|
|
722
|
+
/**
|
|
723
|
+
* Selling Partner API for Merchant Fulfillment
|
|
724
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
725
|
+
*
|
|
726
|
+
* The version of the OpenAPI document: v0
|
|
727
|
+
*
|
|
728
|
+
*
|
|
729
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
730
|
+
* https://openapi-generator.tech
|
|
731
|
+
* Do not edit the class manually.
|
|
732
|
+
*/
|
|
733
|
+
|
|
734
|
+
/**
|
|
735
|
+
* An Amazon order item identifier and a quantity.
|
|
736
|
+
*/
|
|
737
|
+
interface Item {
|
|
738
|
+
/**
|
|
739
|
+
* An Amazon-defined identifier for an individual item in an order.
|
|
740
|
+
*/
|
|
741
|
+
'OrderItemId': string;
|
|
742
|
+
/**
|
|
743
|
+
* The number of items.
|
|
744
|
+
*/
|
|
745
|
+
'Quantity': number;
|
|
746
|
+
'ItemWeight'?: Weight;
|
|
747
|
+
/**
|
|
748
|
+
* The description of the item.
|
|
749
|
+
*/
|
|
750
|
+
'ItemDescription'?: string;
|
|
751
|
+
/**
|
|
752
|
+
* A list of transparency codes.
|
|
753
|
+
*/
|
|
754
|
+
'TransparencyCodeList'?: Array<string>;
|
|
755
|
+
/**
|
|
756
|
+
* A list of additional seller input pairs required to purchase shipping.
|
|
757
|
+
*/
|
|
758
|
+
'ItemLevelSellerInputsList'?: Array<AdditionalSellerInputs>;
|
|
759
|
+
'LiquidVolume'?: LiquidVolume;
|
|
760
|
+
/**
|
|
761
|
+
* When true, the item qualifies as hazardous materials (hazmat). Defaults to false.
|
|
762
|
+
*/
|
|
763
|
+
'IsHazmat'?: boolean;
|
|
764
|
+
'DangerousGoodsDetails'?: DangerousGoodsDetails;
|
|
765
|
+
}
|
|
766
|
+
|
|
767
|
+
/**
|
|
768
|
+
* Selling Partner API for Merchant Fulfillment
|
|
769
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
770
|
+
*
|
|
771
|
+
* The version of the OpenAPI document: v0
|
|
772
|
+
*
|
|
773
|
+
*
|
|
774
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
775
|
+
* https://openapi-generator.tech
|
|
776
|
+
* Do not edit the class manually.
|
|
777
|
+
*/
|
|
778
|
+
/**
|
|
779
|
+
* The file type for a label.
|
|
780
|
+
*/
|
|
781
|
+
declare const FileType: {
|
|
782
|
+
readonly ApplicationPdf: "application/pdf";
|
|
783
|
+
readonly ApplicationZpl: "application/zpl";
|
|
784
|
+
readonly ImagePng: "image/png";
|
|
785
|
+
};
|
|
786
|
+
type FileType = typeof FileType[keyof typeof FileType];
|
|
787
|
+
|
|
788
|
+
/**
|
|
789
|
+
* Selling Partner API for Merchant Fulfillment
|
|
790
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
791
|
+
*
|
|
792
|
+
* The version of the OpenAPI document: v0
|
|
793
|
+
*
|
|
794
|
+
*
|
|
795
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
796
|
+
* https://openapi-generator.tech
|
|
797
|
+
* Do not edit the class manually.
|
|
798
|
+
*/
|
|
799
|
+
|
|
800
|
+
/**
|
|
801
|
+
* The document data and checksum.
|
|
802
|
+
*/
|
|
803
|
+
interface FileContents {
|
|
804
|
+
/**
|
|
805
|
+
* Data for printing labels encoded into a Base64, GZip-compressed string.
|
|
806
|
+
*/
|
|
807
|
+
'Contents': string;
|
|
808
|
+
'FileType': FileType;
|
|
809
|
+
/**
|
|
810
|
+
* An MD5 hash to validate the PDF document data, in the form of a Base64 string.
|
|
811
|
+
*/
|
|
812
|
+
'Checksum': string;
|
|
813
|
+
}
|
|
814
|
+
|
|
815
|
+
/**
|
|
816
|
+
* Selling Partner API for Merchant Fulfillment
|
|
817
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
818
|
+
*
|
|
819
|
+
* The version of the OpenAPI document: v0
|
|
820
|
+
*
|
|
821
|
+
*
|
|
822
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
823
|
+
* https://openapi-generator.tech
|
|
824
|
+
* Do not edit the class manually.
|
|
825
|
+
*/
|
|
826
|
+
|
|
827
|
+
/**
|
|
828
|
+
* Dimensions for printing a shipping label.
|
|
829
|
+
*/
|
|
830
|
+
interface LabelDimensions {
|
|
831
|
+
/**
|
|
832
|
+
* A label dimension.
|
|
833
|
+
*/
|
|
834
|
+
'Length': number;
|
|
835
|
+
/**
|
|
836
|
+
* A label dimension.
|
|
837
|
+
*/
|
|
838
|
+
'Width': number;
|
|
839
|
+
'Unit': UnitOfLength;
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
/**
|
|
843
|
+
* Selling Partner API for Merchant Fulfillment
|
|
844
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
845
|
+
*
|
|
846
|
+
* The version of the OpenAPI document: v0
|
|
847
|
+
*
|
|
848
|
+
*
|
|
849
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
850
|
+
* https://openapi-generator.tech
|
|
851
|
+
* Do not edit the class manually.
|
|
852
|
+
*/
|
|
853
|
+
/**
|
|
854
|
+
* The label format.
|
|
855
|
+
*/
|
|
856
|
+
declare const LabelFormat: {
|
|
857
|
+
readonly Pdf: "PDF";
|
|
858
|
+
readonly Png: "PNG";
|
|
859
|
+
readonly Zpl203: "ZPL203";
|
|
860
|
+
readonly Zpl300: "ZPL300";
|
|
861
|
+
readonly ShippingServiceDefault: "ShippingServiceDefault";
|
|
862
|
+
};
|
|
863
|
+
type LabelFormat = typeof LabelFormat[keyof typeof LabelFormat];
|
|
864
|
+
|
|
865
|
+
/**
|
|
866
|
+
* Selling Partner API for Merchant Fulfillment
|
|
867
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
868
|
+
*
|
|
869
|
+
* The version of the OpenAPI document: v0
|
|
870
|
+
*
|
|
871
|
+
*
|
|
872
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
873
|
+
* https://openapi-generator.tech
|
|
874
|
+
* Do not edit the class manually.
|
|
875
|
+
*/
|
|
876
|
+
/**
|
|
877
|
+
* The type of standard identifier to print on the label.
|
|
878
|
+
*/
|
|
879
|
+
declare const StandardIdForLabel: {
|
|
880
|
+
readonly AmazonOrderId: "AmazonOrderId";
|
|
881
|
+
};
|
|
882
|
+
type StandardIdForLabel = typeof StandardIdForLabel[keyof typeof StandardIdForLabel];
|
|
883
|
+
|
|
884
|
+
/**
|
|
885
|
+
* Selling Partner API for Merchant Fulfillment
|
|
886
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
887
|
+
*
|
|
888
|
+
* The version of the OpenAPI document: v0
|
|
889
|
+
*
|
|
890
|
+
*
|
|
891
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
892
|
+
* https://openapi-generator.tech
|
|
893
|
+
* Do not edit the class manually.
|
|
894
|
+
*/
|
|
895
|
+
|
|
896
|
+
/**
|
|
897
|
+
* Data for creating a shipping label and dimensions for printing the label.
|
|
898
|
+
*/
|
|
899
|
+
interface Label {
|
|
900
|
+
/**
|
|
901
|
+
* Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`.
|
|
902
|
+
*/
|
|
903
|
+
'CustomTextForLabel'?: string;
|
|
904
|
+
'Dimensions': LabelDimensions;
|
|
905
|
+
'FileContents': FileContents;
|
|
906
|
+
'LabelFormat'?: LabelFormat;
|
|
907
|
+
'StandardIdForLabel'?: StandardIdForLabel;
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
/**
|
|
911
|
+
* Selling Partner API for Merchant Fulfillment
|
|
912
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
913
|
+
*
|
|
914
|
+
* The version of the OpenAPI document: v0
|
|
915
|
+
*
|
|
916
|
+
*
|
|
917
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
918
|
+
* https://openapi-generator.tech
|
|
919
|
+
* Do not edit the class manually.
|
|
920
|
+
*/
|
|
921
|
+
/**
|
|
922
|
+
* An enumeration of predefined parcel tokens. If you specify a `PredefinedPackageDimensions` token, you are not obligated to use a branded package from a carrier. For example, if you specify the `FedEx_Box_10kg` token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token. Note: Carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate envelope or box.
|
|
923
|
+
*/
|
|
924
|
+
declare const PredefinedPackageDimensions: {
|
|
925
|
+
readonly FedExBox10kg: "FedEx_Box_10kg";
|
|
926
|
+
readonly FedExBox25kg: "FedEx_Box_25kg";
|
|
927
|
+
readonly FedExBoxExtraLarge1: "FedEx_Box_Extra_Large_1";
|
|
928
|
+
readonly FedExBoxExtraLarge2: "FedEx_Box_Extra_Large_2";
|
|
929
|
+
readonly FedExBoxLarge1: "FedEx_Box_Large_1";
|
|
930
|
+
readonly FedExBoxLarge2: "FedEx_Box_Large_2";
|
|
931
|
+
readonly FedExBoxMedium1: "FedEx_Box_Medium_1";
|
|
932
|
+
readonly FedExBoxMedium2: "FedEx_Box_Medium_2";
|
|
933
|
+
readonly FedExBoxSmall1: "FedEx_Box_Small_1";
|
|
934
|
+
readonly FedExBoxSmall2: "FedEx_Box_Small_2";
|
|
935
|
+
readonly FedExEnvelope: "FedEx_Envelope";
|
|
936
|
+
readonly FedExPaddedPak: "FedEx_Padded_Pak";
|
|
937
|
+
readonly FedExPak1: "FedEx_Pak_1";
|
|
938
|
+
readonly FedExPak2: "FedEx_Pak_2";
|
|
939
|
+
readonly FedExTube: "FedEx_Tube";
|
|
940
|
+
readonly FedExXlPak: "FedEx_XL_Pak";
|
|
941
|
+
readonly UpsBox10kg: "UPS_Box_10kg";
|
|
942
|
+
readonly UpsBox25kg: "UPS_Box_25kg";
|
|
943
|
+
readonly UpsExpressBox: "UPS_Express_Box";
|
|
944
|
+
readonly UpsExpressBoxLarge: "UPS_Express_Box_Large";
|
|
945
|
+
readonly UpsExpressBoxMedium: "UPS_Express_Box_Medium";
|
|
946
|
+
readonly UpsExpressBoxSmall: "UPS_Express_Box_Small";
|
|
947
|
+
readonly UpsExpressEnvelope: "UPS_Express_Envelope";
|
|
948
|
+
readonly UpsExpressHardPak: "UPS_Express_Hard_Pak";
|
|
949
|
+
readonly UpsExpressLegalEnvelope: "UPS_Express_Legal_Envelope";
|
|
950
|
+
readonly UpsExpressPak: "UPS_Express_Pak";
|
|
951
|
+
readonly UpsExpressTube: "UPS_Express_Tube";
|
|
952
|
+
readonly UpsLaboratoryPak: "UPS_Laboratory_Pak";
|
|
953
|
+
readonly UpsPadPak: "UPS_Pad_Pak";
|
|
954
|
+
readonly UpsPallet: "UPS_Pallet";
|
|
955
|
+
readonly UspsCard: "USPS_Card";
|
|
956
|
+
readonly UspsFlat: "USPS_Flat";
|
|
957
|
+
readonly UspsFlatRateCardboardEnvelope: "USPS_FlatRateCardboardEnvelope";
|
|
958
|
+
readonly UspsFlatRateEnvelope: "USPS_FlatRateEnvelope";
|
|
959
|
+
readonly UspsFlatRateGiftCardEnvelope: "USPS_FlatRateGiftCardEnvelope";
|
|
960
|
+
readonly UspsFlatRateLegalEnvelope: "USPS_FlatRateLegalEnvelope";
|
|
961
|
+
readonly UspsFlatRatePaddedEnvelope: "USPS_FlatRatePaddedEnvelope";
|
|
962
|
+
readonly UspsFlatRateWindowEnvelope: "USPS_FlatRateWindowEnvelope";
|
|
963
|
+
readonly UspsLargeFlatRateBoardGameBox: "USPS_LargeFlatRateBoardGameBox";
|
|
964
|
+
readonly UspsLargeFlatRateBox: "USPS_LargeFlatRateBox";
|
|
965
|
+
readonly UspsLetter: "USPS_Letter";
|
|
966
|
+
readonly UspsMediumFlatRateBox1: "USPS_MediumFlatRateBox1";
|
|
967
|
+
readonly UspsMediumFlatRateBox2: "USPS_MediumFlatRateBox2";
|
|
968
|
+
readonly UspsRegionalRateBoxA1: "USPS_RegionalRateBoxA1";
|
|
969
|
+
readonly UspsRegionalRateBoxA2: "USPS_RegionalRateBoxA2";
|
|
970
|
+
readonly UspsRegionalRateBoxB1: "USPS_RegionalRateBoxB1";
|
|
971
|
+
readonly UspsRegionalRateBoxB2: "USPS_RegionalRateBoxB2";
|
|
972
|
+
readonly UspsRegionalRateBoxC: "USPS_RegionalRateBoxC";
|
|
973
|
+
readonly UspsSmallFlatRateBox: "USPS_SmallFlatRateBox";
|
|
974
|
+
readonly UspsSmallFlatRateEnvelope: "USPS_SmallFlatRateEnvelope";
|
|
975
|
+
};
|
|
976
|
+
type PredefinedPackageDimensions = typeof PredefinedPackageDimensions[keyof typeof PredefinedPackageDimensions];
|
|
977
|
+
|
|
978
|
+
/**
|
|
979
|
+
* Selling Partner API for Merchant Fulfillment
|
|
980
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
981
|
+
*
|
|
982
|
+
* The version of the OpenAPI document: v0
|
|
983
|
+
*
|
|
984
|
+
*
|
|
985
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
986
|
+
* https://openapi-generator.tech
|
|
987
|
+
* Do not edit the class manually.
|
|
988
|
+
*/
|
|
989
|
+
|
|
990
|
+
/**
|
|
991
|
+
* The dimensions of a package contained in a shipment.
|
|
992
|
+
*/
|
|
993
|
+
interface PackageDimensions {
|
|
994
|
+
/**
|
|
995
|
+
* A number that represents the given package dimension.
|
|
996
|
+
*/
|
|
997
|
+
'Length'?: number;
|
|
998
|
+
/**
|
|
999
|
+
* A number that represents the given package dimension.
|
|
1000
|
+
*/
|
|
1001
|
+
'Width'?: number;
|
|
1002
|
+
/**
|
|
1003
|
+
* A number that represents the given package dimension.
|
|
1004
|
+
*/
|
|
1005
|
+
'Height'?: number;
|
|
1006
|
+
'Unit'?: UnitOfLength;
|
|
1007
|
+
'PredefinedPackageDimensions'?: PredefinedPackageDimensions;
|
|
1008
|
+
}
|
|
1009
|
+
|
|
1010
|
+
/**
|
|
1011
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1012
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1013
|
+
*
|
|
1014
|
+
* The version of the OpenAPI document: v0
|
|
1015
|
+
*
|
|
1016
|
+
*
|
|
1017
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1018
|
+
* https://openapi-generator.tech
|
|
1019
|
+
* Do not edit the class manually.
|
|
1020
|
+
*/
|
|
1021
|
+
/**
|
|
1022
|
+
* The shipment status.
|
|
1023
|
+
*/
|
|
1024
|
+
declare const ShipmentStatus: {
|
|
1025
|
+
readonly Purchased: "Purchased";
|
|
1026
|
+
readonly RefundPending: "RefundPending";
|
|
1027
|
+
readonly RefundRejected: "RefundRejected";
|
|
1028
|
+
readonly RefundApplied: "RefundApplied";
|
|
1029
|
+
};
|
|
1030
|
+
type ShipmentStatus = typeof ShipmentStatus[keyof typeof ShipmentStatus];
|
|
1031
|
+
|
|
1032
|
+
/**
|
|
1033
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1034
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1035
|
+
*
|
|
1036
|
+
* The version of the OpenAPI document: v0
|
|
1037
|
+
*
|
|
1038
|
+
*
|
|
1039
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1040
|
+
* https://openapi-generator.tech
|
|
1041
|
+
* Do not edit the class manually.
|
|
1042
|
+
*/
|
|
1043
|
+
|
|
1044
|
+
/**
|
|
1045
|
+
* The label format details and whether to include a packing slip.
|
|
1046
|
+
*/
|
|
1047
|
+
interface LabelFormatOption {
|
|
1048
|
+
/**
|
|
1049
|
+
* When true, include a packing slip with the label.
|
|
1050
|
+
*/
|
|
1051
|
+
'IncludePackingSlipWithLabel'?: boolean;
|
|
1052
|
+
'LabelFormat'?: LabelFormat;
|
|
1053
|
+
}
|
|
1054
|
+
|
|
1055
|
+
/**
|
|
1056
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1057
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1058
|
+
*
|
|
1059
|
+
* The version of the OpenAPI document: v0
|
|
1060
|
+
*
|
|
1061
|
+
*
|
|
1062
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1063
|
+
* https://openapi-generator.tech
|
|
1064
|
+
* Do not edit the class manually.
|
|
1065
|
+
*/
|
|
1066
|
+
/**
|
|
1067
|
+
* Unique identifier for the RateItem.
|
|
1068
|
+
*/
|
|
1069
|
+
declare const RateItemID: {
|
|
1070
|
+
readonly FbmShipPlusCredit: "FBM_SHIP_PLUS_CREDIT";
|
|
1071
|
+
};
|
|
1072
|
+
type RateItemID = typeof RateItemID[keyof typeof RateItemID];
|
|
1073
|
+
|
|
1074
|
+
/**
|
|
1075
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1076
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1077
|
+
*
|
|
1078
|
+
* The version of the OpenAPI document: v0
|
|
1079
|
+
*
|
|
1080
|
+
*
|
|
1081
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1082
|
+
* https://openapi-generator.tech
|
|
1083
|
+
* Do not edit the class manually.
|
|
1084
|
+
*/
|
|
1085
|
+
/**
|
|
1086
|
+
* Type for the RateItem.
|
|
1087
|
+
*/
|
|
1088
|
+
declare const RateItemType: {
|
|
1089
|
+
readonly Included: "INCLUDED";
|
|
1090
|
+
};
|
|
1091
|
+
type RateItemType = typeof RateItemType[keyof typeof RateItemType];
|
|
1092
|
+
|
|
1093
|
+
/**
|
|
1094
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1095
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1096
|
+
*
|
|
1097
|
+
* The version of the OpenAPI document: v0
|
|
1098
|
+
*
|
|
1099
|
+
*
|
|
1100
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1101
|
+
* https://openapi-generator.tech
|
|
1102
|
+
* Do not edit the class manually.
|
|
1103
|
+
*/
|
|
1104
|
+
|
|
1105
|
+
/**
|
|
1106
|
+
* Rate item for shipping costs and adjustments.
|
|
1107
|
+
*/
|
|
1108
|
+
interface RateItem {
|
|
1109
|
+
'RateItemID': RateItemID;
|
|
1110
|
+
'RateItemType'?: RateItemType;
|
|
1111
|
+
'RateItemCharge'?: CurrencyAmount;
|
|
1112
|
+
/**
|
|
1113
|
+
* Localized name for the RateItem.
|
|
1114
|
+
*/
|
|
1115
|
+
'RateItemNameLocalization'?: string;
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
/**
|
|
1119
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1120
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1121
|
+
*
|
|
1122
|
+
* The version of the OpenAPI document: v0
|
|
1123
|
+
*
|
|
1124
|
+
*
|
|
1125
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1126
|
+
* https://openapi-generator.tech
|
|
1127
|
+
* Do not edit the class manually.
|
|
1128
|
+
*/
|
|
1129
|
+
/**
|
|
1130
|
+
* The delivery confirmation level.
|
|
1131
|
+
*/
|
|
1132
|
+
declare const DeliveryExperienceType: {
|
|
1133
|
+
readonly DeliveryConfirmationWithAdultSignature: "DeliveryConfirmationWithAdultSignature";
|
|
1134
|
+
readonly DeliveryConfirmationWithSignature: "DeliveryConfirmationWithSignature";
|
|
1135
|
+
readonly DeliveryConfirmationWithoutSignature: "DeliveryConfirmationWithoutSignature";
|
|
1136
|
+
readonly NoTracking: "NoTracking";
|
|
1137
|
+
};
|
|
1138
|
+
type DeliveryExperienceType = typeof DeliveryExperienceType[keyof typeof DeliveryExperienceType];
|
|
1139
|
+
|
|
1140
|
+
/**
|
|
1141
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1142
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1143
|
+
*
|
|
1144
|
+
* The version of the OpenAPI document: v0
|
|
1145
|
+
*
|
|
1146
|
+
*
|
|
1147
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1148
|
+
* https://openapi-generator.tech
|
|
1149
|
+
* Do not edit the class manually.
|
|
1150
|
+
*/
|
|
1151
|
+
|
|
1152
|
+
/**
|
|
1153
|
+
* Extra services provided by a carrier.
|
|
1154
|
+
*/
|
|
1155
|
+
interface ShippingServiceOptions {
|
|
1156
|
+
'DeliveryExperience': DeliveryExperienceType;
|
|
1157
|
+
'DeclaredValue'?: CurrencyAmount;
|
|
1158
|
+
/**
|
|
1159
|
+
* When true, the carrier will pick up the package. Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK).
|
|
1160
|
+
*/
|
|
1161
|
+
'CarrierWillPickUp': boolean;
|
|
1162
|
+
'CarrierWillPickUpOption'?: CarrierWillPickUpOption;
|
|
1163
|
+
'LabelFormat'?: LabelFormat;
|
|
1164
|
+
}
|
|
1165
|
+
|
|
1166
|
+
/**
|
|
1167
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1168
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1169
|
+
*
|
|
1170
|
+
* The version of the OpenAPI document: v0
|
|
1171
|
+
*
|
|
1172
|
+
*
|
|
1173
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1174
|
+
* https://openapi-generator.tech
|
|
1175
|
+
* Do not edit the class manually.
|
|
1176
|
+
*/
|
|
1177
|
+
|
|
1178
|
+
/**
|
|
1179
|
+
* A shipping service offer made by a carrier.
|
|
1180
|
+
*/
|
|
1181
|
+
interface ShippingService {
|
|
1182
|
+
/**
|
|
1183
|
+
* A plain text representation of a carrier\'s shipping service. For example, \"UPS Ground\" or \"FedEx Standard Overnight\".
|
|
1184
|
+
*/
|
|
1185
|
+
'ShippingServiceName': string;
|
|
1186
|
+
/**
|
|
1187
|
+
* The name of the carrier.
|
|
1188
|
+
*/
|
|
1189
|
+
'CarrierName': string;
|
|
1190
|
+
/**
|
|
1191
|
+
* An Amazon-defined shipping service identifier.
|
|
1192
|
+
*/
|
|
1193
|
+
'ShippingServiceId': string;
|
|
1194
|
+
/**
|
|
1195
|
+
* An Amazon-defined shipping service offer identifier.
|
|
1196
|
+
*/
|
|
1197
|
+
'ShippingServiceOfferId': string;
|
|
1198
|
+
/**
|
|
1199
|
+
* Date-time formatted timestamp.
|
|
1200
|
+
*/
|
|
1201
|
+
'ShipDate': string;
|
|
1202
|
+
/**
|
|
1203
|
+
* Date-time formatted timestamp.
|
|
1204
|
+
*/
|
|
1205
|
+
'EarliestEstimatedDeliveryDate'?: string;
|
|
1206
|
+
/**
|
|
1207
|
+
* Date-time formatted timestamp.
|
|
1208
|
+
*/
|
|
1209
|
+
'LatestEstimatedDeliveryDate'?: string;
|
|
1210
|
+
'Rate': CurrencyAmount;
|
|
1211
|
+
'RateWithAdjustments': CurrencyAmount;
|
|
1212
|
+
/**
|
|
1213
|
+
* List of adjustments.
|
|
1214
|
+
*/
|
|
1215
|
+
'AdjustmentItemList'?: Array<RateItem>;
|
|
1216
|
+
'ShippingServiceOptions': ShippingServiceOptions;
|
|
1217
|
+
'AvailableShippingServiceOptions'?: AvailableShippingServiceOptions;
|
|
1218
|
+
/**
|
|
1219
|
+
* List of label formats.
|
|
1220
|
+
*/
|
|
1221
|
+
'AvailableLabelFormats'?: Array<LabelFormat>;
|
|
1222
|
+
/**
|
|
1223
|
+
* The available label formats.
|
|
1224
|
+
*/
|
|
1225
|
+
'AvailableFormatOptionsForLabel'?: Array<LabelFormatOption>;
|
|
1226
|
+
/**
|
|
1227
|
+
* When true, additional seller inputs are required.
|
|
1228
|
+
*/
|
|
1229
|
+
'RequiresAdditionalSellerInputs': boolean;
|
|
1230
|
+
'Benefits'?: Benefits;
|
|
1231
|
+
}
|
|
1232
|
+
|
|
1233
|
+
/**
|
|
1234
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1235
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1236
|
+
*
|
|
1237
|
+
* The version of the OpenAPI document: v0
|
|
1238
|
+
*
|
|
1239
|
+
*
|
|
1240
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1241
|
+
* https://openapi-generator.tech
|
|
1242
|
+
* Do not edit the class manually.
|
|
1243
|
+
*/
|
|
1244
|
+
|
|
1245
|
+
/**
|
|
1246
|
+
* The details of a shipment. Includes the shipment status.
|
|
1247
|
+
*/
|
|
1248
|
+
interface Shipment {
|
|
1249
|
+
/**
|
|
1250
|
+
* An Amazon-defined shipment identifier.
|
|
1251
|
+
*/
|
|
1252
|
+
'ShipmentId': string;
|
|
1253
|
+
/**
|
|
1254
|
+
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
1255
|
+
*/
|
|
1256
|
+
'AmazonOrderId': string;
|
|
1257
|
+
/**
|
|
1258
|
+
* A seller-defined order identifier.
|
|
1259
|
+
*/
|
|
1260
|
+
'SellerOrderId'?: string;
|
|
1261
|
+
/**
|
|
1262
|
+
* The list of items you want to include in a shipment.
|
|
1263
|
+
*/
|
|
1264
|
+
'ItemList': Array<Item>;
|
|
1265
|
+
'ShipFromAddress': Address;
|
|
1266
|
+
'ShipToAddress': Address;
|
|
1267
|
+
'PackageDimensions': PackageDimensions;
|
|
1268
|
+
'Weight': Weight;
|
|
1269
|
+
'Insurance': CurrencyAmount;
|
|
1270
|
+
'ShippingService': ShippingService;
|
|
1271
|
+
'Label': Label;
|
|
1272
|
+
'Status': ShipmentStatus;
|
|
1273
|
+
/**
|
|
1274
|
+
* The shipment tracking identifier provided by the carrier.
|
|
1275
|
+
*/
|
|
1276
|
+
'TrackingId'?: string;
|
|
1277
|
+
/**
|
|
1278
|
+
* Date-time formatted timestamp.
|
|
1279
|
+
*/
|
|
1280
|
+
'CreatedDate': string;
|
|
1281
|
+
/**
|
|
1282
|
+
* Date-time formatted timestamp.
|
|
1283
|
+
*/
|
|
1284
|
+
'LastUpdatedDate'?: string;
|
|
1285
|
+
}
|
|
1286
|
+
|
|
1287
|
+
/**
|
|
1288
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1289
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1290
|
+
*
|
|
1291
|
+
* The version of the OpenAPI document: v0
|
|
1292
|
+
*
|
|
1293
|
+
*
|
|
1294
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1295
|
+
* https://openapi-generator.tech
|
|
1296
|
+
* Do not edit the class manually.
|
|
1297
|
+
*/
|
|
1298
|
+
|
|
1299
|
+
/**
|
|
1300
|
+
* Response schema.
|
|
1301
|
+
*/
|
|
1302
|
+
interface CancelShipmentResponse {
|
|
1303
|
+
'payload'?: Shipment;
|
|
1304
|
+
/**
|
|
1305
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
1306
|
+
*/
|
|
1307
|
+
'errors'?: Array<Error>;
|
|
1308
|
+
}
|
|
1309
|
+
|
|
1310
|
+
/**
|
|
1311
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1312
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1313
|
+
*
|
|
1314
|
+
* The version of the OpenAPI document: v0
|
|
1315
|
+
*
|
|
1316
|
+
*
|
|
1317
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1318
|
+
* https://openapi-generator.tech
|
|
1319
|
+
* Do not edit the class manually.
|
|
1320
|
+
*/
|
|
1321
|
+
/**
|
|
1322
|
+
* Hazardous materials options for a package. Consult the terms and conditions for each carrier for more information on hazardous materials.
|
|
1323
|
+
*/
|
|
1324
|
+
declare const HazmatType: {
|
|
1325
|
+
readonly None: "None";
|
|
1326
|
+
readonly LqHazmat: "LQHazmat";
|
|
1327
|
+
};
|
|
1328
|
+
type HazmatType = typeof HazmatType[keyof typeof HazmatType];
|
|
1329
|
+
|
|
1330
|
+
/**
|
|
1331
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1332
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1333
|
+
*
|
|
1334
|
+
* The version of the OpenAPI document: v0
|
|
1335
|
+
*
|
|
1336
|
+
*
|
|
1337
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1338
|
+
* https://openapi-generator.tech
|
|
1339
|
+
* Do not edit the class manually.
|
|
1340
|
+
*/
|
|
1341
|
+
/**
|
|
1342
|
+
* Whether to include a packing slip.
|
|
1343
|
+
*/
|
|
1344
|
+
interface LabelFormatOptionRequest {
|
|
1345
|
+
/**
|
|
1346
|
+
* When true, include a packing slip with the label.
|
|
1347
|
+
*/
|
|
1348
|
+
'IncludePackingSlipWithLabel'?: boolean;
|
|
1349
|
+
}
|
|
1350
|
+
|
|
1351
|
+
/**
|
|
1352
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1353
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1354
|
+
*
|
|
1355
|
+
* The version of the OpenAPI document: v0
|
|
1356
|
+
*
|
|
1357
|
+
*
|
|
1358
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1359
|
+
* https://openapi-generator.tech
|
|
1360
|
+
* Do not edit the class manually.
|
|
1361
|
+
*/
|
|
1362
|
+
|
|
1363
|
+
/**
|
|
1364
|
+
* Custom text for shipping labels.
|
|
1365
|
+
*/
|
|
1366
|
+
interface LabelCustomization {
|
|
1367
|
+
/**
|
|
1368
|
+
* Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`.
|
|
1369
|
+
*/
|
|
1370
|
+
'CustomTextForLabel'?: string;
|
|
1371
|
+
'StandardIdForLabel'?: StandardIdForLabel;
|
|
1372
|
+
}
|
|
1373
|
+
|
|
1374
|
+
/**
|
|
1375
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1376
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1377
|
+
*
|
|
1378
|
+
* The version of the OpenAPI document: v0
|
|
1379
|
+
*
|
|
1380
|
+
*
|
|
1381
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1382
|
+
* https://openapi-generator.tech
|
|
1383
|
+
* Do not edit the class manually.
|
|
1384
|
+
*/
|
|
1385
|
+
|
|
1386
|
+
/**
|
|
1387
|
+
* Shipment information required for requesting shipping service offers or for creating a shipment.
|
|
1388
|
+
*/
|
|
1389
|
+
interface ShipmentRequestDetails {
|
|
1390
|
+
/**
|
|
1391
|
+
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
1392
|
+
*/
|
|
1393
|
+
'AmazonOrderId': string;
|
|
1394
|
+
/**
|
|
1395
|
+
* A seller-defined order identifier.
|
|
1396
|
+
*/
|
|
1397
|
+
'SellerOrderId'?: string;
|
|
1398
|
+
/**
|
|
1399
|
+
* The list of items you want to include in a shipment.
|
|
1400
|
+
*/
|
|
1401
|
+
'ItemList': Array<Item>;
|
|
1402
|
+
'ShipFromAddress': Address;
|
|
1403
|
+
'PackageDimensions': PackageDimensions;
|
|
1404
|
+
'Weight': Weight;
|
|
1405
|
+
/**
|
|
1406
|
+
* Date-time formatted timestamp.
|
|
1407
|
+
*/
|
|
1408
|
+
'MustArriveByDate'?: string;
|
|
1409
|
+
/**
|
|
1410
|
+
* Date-time formatted timestamp.
|
|
1411
|
+
*/
|
|
1412
|
+
'ShipDate'?: string;
|
|
1413
|
+
'ShippingServiceOptions': ShippingServiceOptions;
|
|
1414
|
+
'LabelCustomization'?: LabelCustomization;
|
|
1415
|
+
}
|
|
1416
|
+
|
|
1417
|
+
/**
|
|
1418
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1419
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1420
|
+
*
|
|
1421
|
+
* The version of the OpenAPI document: v0
|
|
1422
|
+
*
|
|
1423
|
+
*
|
|
1424
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1425
|
+
* https://openapi-generator.tech
|
|
1426
|
+
* Do not edit the class manually.
|
|
1427
|
+
*/
|
|
1428
|
+
|
|
1429
|
+
/**
|
|
1430
|
+
* Request schema.
|
|
1431
|
+
*/
|
|
1432
|
+
interface CreateShipmentRequest {
|
|
1433
|
+
'ShipmentRequestDetails': ShipmentRequestDetails;
|
|
1434
|
+
/**
|
|
1435
|
+
* An Amazon-defined shipping service identifier.
|
|
1436
|
+
*/
|
|
1437
|
+
'ShippingServiceId': string;
|
|
1438
|
+
/**
|
|
1439
|
+
* Identifies a shipping service order made by a carrier.
|
|
1440
|
+
*/
|
|
1441
|
+
'ShippingServiceOfferId'?: string;
|
|
1442
|
+
'HazmatType'?: HazmatType;
|
|
1443
|
+
'LabelFormatOption'?: LabelFormatOptionRequest;
|
|
1444
|
+
/**
|
|
1445
|
+
* A list of additional seller input pairs required to purchase shipping.
|
|
1446
|
+
*/
|
|
1447
|
+
'ShipmentLevelSellerInputsList'?: Array<AdditionalSellerInputs>;
|
|
1448
|
+
}
|
|
1449
|
+
|
|
1450
|
+
/**
|
|
1451
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1452
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1453
|
+
*
|
|
1454
|
+
* The version of the OpenAPI document: v0
|
|
1455
|
+
*
|
|
1456
|
+
*
|
|
1457
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1458
|
+
* https://openapi-generator.tech
|
|
1459
|
+
* Do not edit the class manually.
|
|
1460
|
+
*/
|
|
1461
|
+
|
|
1462
|
+
/**
|
|
1463
|
+
* Response schema.
|
|
1464
|
+
*/
|
|
1465
|
+
interface CreateShipmentResponse {
|
|
1466
|
+
'payload'?: Shipment;
|
|
1467
|
+
/**
|
|
1468
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
1469
|
+
*/
|
|
1470
|
+
'errors'?: Array<Error>;
|
|
1471
|
+
}
|
|
1472
|
+
|
|
1473
|
+
/**
|
|
1474
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1475
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1476
|
+
*
|
|
1477
|
+
* The version of the OpenAPI document: v0
|
|
1478
|
+
*
|
|
1479
|
+
*
|
|
1480
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1481
|
+
* https://openapi-generator.tech
|
|
1482
|
+
* Do not edit the class manually.
|
|
1483
|
+
*/
|
|
1484
|
+
|
|
1485
|
+
/**
|
|
1486
|
+
* Request schema.
|
|
1487
|
+
*/
|
|
1488
|
+
interface GetAdditionalSellerInputsRequest {
|
|
1489
|
+
/**
|
|
1490
|
+
* An Amazon-defined shipping service identifier.
|
|
1491
|
+
*/
|
|
1492
|
+
'ShippingServiceId': string;
|
|
1493
|
+
'ShipFromAddress': Address;
|
|
1494
|
+
/**
|
|
1495
|
+
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
1496
|
+
*/
|
|
1497
|
+
'OrderId': string;
|
|
1498
|
+
}
|
|
1499
|
+
|
|
1500
|
+
/**
|
|
1501
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1502
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1503
|
+
*
|
|
1504
|
+
* The version of the OpenAPI document: v0
|
|
1505
|
+
*
|
|
1506
|
+
*
|
|
1507
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1508
|
+
* https://openapi-generator.tech
|
|
1509
|
+
* Do not edit the class manually.
|
|
1510
|
+
*/
|
|
1511
|
+
|
|
1512
|
+
/**
|
|
1513
|
+
* A list of item level fields.
|
|
1514
|
+
*/
|
|
1515
|
+
interface ItemLevelFields {
|
|
1516
|
+
/**
|
|
1517
|
+
* The Amazon Standard Identification Number (ASIN) of the item.
|
|
1518
|
+
*/
|
|
1519
|
+
'Asin': string;
|
|
1520
|
+
/**
|
|
1521
|
+
* A list of additional inputs.
|
|
1522
|
+
*/
|
|
1523
|
+
'AdditionalInputs': Array<AdditionalInputs>;
|
|
1524
|
+
}
|
|
1525
|
+
|
|
1526
|
+
/**
|
|
1527
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1528
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1529
|
+
*
|
|
1530
|
+
* The version of the OpenAPI document: v0
|
|
1531
|
+
*
|
|
1532
|
+
*
|
|
1533
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1534
|
+
* https://openapi-generator.tech
|
|
1535
|
+
* Do not edit the class manually.
|
|
1536
|
+
*/
|
|
1537
|
+
|
|
1538
|
+
/**
|
|
1539
|
+
* The payload for the `getAdditionalSellerInputs` operation.
|
|
1540
|
+
*/
|
|
1541
|
+
interface GetAdditionalSellerInputsResult {
|
|
1542
|
+
/**
|
|
1543
|
+
* A list of additional inputs.
|
|
1544
|
+
*/
|
|
1545
|
+
'ShipmentLevelFields'?: Array<AdditionalInputs>;
|
|
1546
|
+
/**
|
|
1547
|
+
* A list of item level fields.
|
|
1548
|
+
*/
|
|
1549
|
+
'ItemLevelFieldsList'?: Array<ItemLevelFields>;
|
|
1550
|
+
}
|
|
1551
|
+
|
|
1552
|
+
/**
|
|
1553
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1554
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1555
|
+
*
|
|
1556
|
+
* The version of the OpenAPI document: v0
|
|
1557
|
+
*
|
|
1558
|
+
*
|
|
1559
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1560
|
+
* https://openapi-generator.tech
|
|
1561
|
+
* Do not edit the class manually.
|
|
1562
|
+
*/
|
|
1563
|
+
|
|
1564
|
+
/**
|
|
1565
|
+
* Response schema.
|
|
1566
|
+
*/
|
|
1567
|
+
interface GetAdditionalSellerInputsResponse {
|
|
1568
|
+
'payload'?: GetAdditionalSellerInputsResult;
|
|
1569
|
+
/**
|
|
1570
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
1571
|
+
*/
|
|
1572
|
+
'errors'?: Array<Error>;
|
|
1573
|
+
}
|
|
1574
|
+
|
|
1575
|
+
/**
|
|
1576
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1577
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1578
|
+
*
|
|
1579
|
+
* The version of the OpenAPI document: v0
|
|
1580
|
+
*
|
|
1581
|
+
*
|
|
1582
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1583
|
+
* https://openapi-generator.tech
|
|
1584
|
+
* Do not edit the class manually.
|
|
1585
|
+
*/
|
|
1586
|
+
|
|
1587
|
+
/**
|
|
1588
|
+
* Filter for use when requesting eligible shipping services.
|
|
1589
|
+
*/
|
|
1590
|
+
interface ShippingOfferingFilter {
|
|
1591
|
+
/**
|
|
1592
|
+
* When true, include a packing slip with the label.
|
|
1593
|
+
*/
|
|
1594
|
+
'IncludePackingSlipWithLabel'?: boolean;
|
|
1595
|
+
/**
|
|
1596
|
+
* When true, include complex shipping options.
|
|
1597
|
+
*/
|
|
1598
|
+
'IncludeComplexShippingOptions'?: boolean;
|
|
1599
|
+
'CarrierWillPickUp'?: CarrierWillPickUpOption;
|
|
1600
|
+
'DeliveryExperience'?: DeliveryExperienceOption;
|
|
1601
|
+
}
|
|
1602
|
+
|
|
1603
|
+
/**
|
|
1604
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1605
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1606
|
+
*
|
|
1607
|
+
* The version of the OpenAPI document: v0
|
|
1608
|
+
*
|
|
1609
|
+
*
|
|
1610
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1611
|
+
* https://openapi-generator.tech
|
|
1612
|
+
* Do not edit the class manually.
|
|
1613
|
+
*/
|
|
1614
|
+
|
|
1615
|
+
/**
|
|
1616
|
+
* Request schema.
|
|
1617
|
+
*/
|
|
1618
|
+
interface GetEligibleShipmentServicesRequest {
|
|
1619
|
+
'ShipmentRequestDetails': ShipmentRequestDetails;
|
|
1620
|
+
'ShippingOfferingFilter'?: ShippingOfferingFilter;
|
|
1621
|
+
}
|
|
1622
|
+
|
|
1623
|
+
/**
|
|
1624
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1625
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1626
|
+
*
|
|
1627
|
+
* The version of the OpenAPI document: v0
|
|
1628
|
+
*
|
|
1629
|
+
*
|
|
1630
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1631
|
+
* https://openapi-generator.tech
|
|
1632
|
+
* Do not edit the class manually.
|
|
1633
|
+
*/
|
|
1634
|
+
/**
|
|
1635
|
+
* Information about a rejected shipping service
|
|
1636
|
+
*/
|
|
1637
|
+
interface RejectedShippingService {
|
|
1638
|
+
/**
|
|
1639
|
+
* The rejected shipping carrier name. For example, USPS.
|
|
1640
|
+
*/
|
|
1641
|
+
'CarrierName': string;
|
|
1642
|
+
/**
|
|
1643
|
+
* The rejected shipping service localized name. For example, FedEx Standard Overnight.
|
|
1644
|
+
*/
|
|
1645
|
+
'ShippingServiceName': string;
|
|
1646
|
+
/**
|
|
1647
|
+
* An Amazon-defined shipping service identifier.
|
|
1648
|
+
*/
|
|
1649
|
+
'ShippingServiceId': string;
|
|
1650
|
+
/**
|
|
1651
|
+
* A reason code meant to be consumed programatically. For example, `CARRIER_CANNOT_SHIP_TO_POBOX`.
|
|
1652
|
+
*/
|
|
1653
|
+
'RejectionReasonCode': string;
|
|
1654
|
+
/**
|
|
1655
|
+
* A localized human readable description of the rejected reason.
|
|
1656
|
+
*/
|
|
1657
|
+
'RejectionReasonMessage'?: string;
|
|
1658
|
+
}
|
|
1659
|
+
|
|
1660
|
+
/**
|
|
1661
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1662
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1663
|
+
*
|
|
1664
|
+
* The version of the OpenAPI document: v0
|
|
1665
|
+
*
|
|
1666
|
+
*
|
|
1667
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1668
|
+
* https://openapi-generator.tech
|
|
1669
|
+
* Do not edit the class manually.
|
|
1670
|
+
*/
|
|
1671
|
+
/**
|
|
1672
|
+
* A carrier who is temporarily unavailable, most likely due to a service outage experienced by the carrier.
|
|
1673
|
+
*/
|
|
1674
|
+
interface TemporarilyUnavailableCarrier {
|
|
1675
|
+
/**
|
|
1676
|
+
* The name of the carrier.
|
|
1677
|
+
*/
|
|
1678
|
+
'CarrierName': string;
|
|
1679
|
+
}
|
|
1680
|
+
|
|
1681
|
+
/**
|
|
1682
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1683
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1684
|
+
*
|
|
1685
|
+
* The version of the OpenAPI document: v0
|
|
1686
|
+
*
|
|
1687
|
+
*
|
|
1688
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1689
|
+
* https://openapi-generator.tech
|
|
1690
|
+
* Do not edit the class manually.
|
|
1691
|
+
*/
|
|
1692
|
+
/**
|
|
1693
|
+
* A carrier whose terms and conditions have not been accepted by the seller.
|
|
1694
|
+
*/
|
|
1695
|
+
interface TermsAndConditionsNotAcceptedCarrier {
|
|
1696
|
+
/**
|
|
1697
|
+
* The name of the carrier.
|
|
1698
|
+
*/
|
|
1699
|
+
'CarrierName': string;
|
|
1700
|
+
}
|
|
1701
|
+
|
|
1702
|
+
/**
|
|
1703
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1704
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1705
|
+
*
|
|
1706
|
+
* The version of the OpenAPI document: v0
|
|
1707
|
+
*
|
|
1708
|
+
*
|
|
1709
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1710
|
+
* https://openapi-generator.tech
|
|
1711
|
+
* Do not edit the class manually.
|
|
1712
|
+
*/
|
|
1713
|
+
|
|
1714
|
+
/**
|
|
1715
|
+
* The payload for the `getEligibleShipmentServices` operation.
|
|
1716
|
+
*/
|
|
1717
|
+
interface GetEligibleShipmentServicesResult {
|
|
1718
|
+
/**
|
|
1719
|
+
* A list of shipping services offers.
|
|
1720
|
+
*/
|
|
1721
|
+
'ShippingServiceList': Array<ShippingService>;
|
|
1722
|
+
/**
|
|
1723
|
+
* List of services that are for some reason unavailable for this request
|
|
1724
|
+
*/
|
|
1725
|
+
'RejectedShippingServiceList'?: Array<RejectedShippingService>;
|
|
1726
|
+
/**
|
|
1727
|
+
* A list of temporarily unavailable carriers.
|
|
1728
|
+
*/
|
|
1729
|
+
'TemporarilyUnavailableCarrierList'?: Array<TemporarilyUnavailableCarrier>;
|
|
1730
|
+
/**
|
|
1731
|
+
* List of carriers whose terms and conditions were not accepted by the seller.
|
|
1732
|
+
*/
|
|
1733
|
+
'TermsAndConditionsNotAcceptedCarrierList'?: Array<TermsAndConditionsNotAcceptedCarrier>;
|
|
1734
|
+
}
|
|
1735
|
+
|
|
1736
|
+
/**
|
|
1737
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1738
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1739
|
+
*
|
|
1740
|
+
* The version of the OpenAPI document: v0
|
|
1741
|
+
*
|
|
1742
|
+
*
|
|
1743
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1744
|
+
* https://openapi-generator.tech
|
|
1745
|
+
* Do not edit the class manually.
|
|
1746
|
+
*/
|
|
1747
|
+
|
|
1748
|
+
/**
|
|
1749
|
+
* Response schema.
|
|
1750
|
+
*/
|
|
1751
|
+
interface GetEligibleShipmentServicesResponse {
|
|
1752
|
+
'payload'?: GetEligibleShipmentServicesResult;
|
|
1753
|
+
/**
|
|
1754
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
1755
|
+
*/
|
|
1756
|
+
'errors'?: Array<Error>;
|
|
1757
|
+
}
|
|
1758
|
+
|
|
1759
|
+
/**
|
|
1760
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1761
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1762
|
+
*
|
|
1763
|
+
* The version of the OpenAPI document: v0
|
|
1764
|
+
*
|
|
1765
|
+
*
|
|
1766
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1767
|
+
* https://openapi-generator.tech
|
|
1768
|
+
* Do not edit the class manually.
|
|
1769
|
+
*/
|
|
1770
|
+
|
|
1771
|
+
/**
|
|
1772
|
+
* Response schema.
|
|
1773
|
+
*/
|
|
1774
|
+
interface GetShipmentResponse {
|
|
1775
|
+
'payload'?: Shipment;
|
|
1776
|
+
/**
|
|
1777
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
1778
|
+
*/
|
|
1779
|
+
'errors'?: Array<Error>;
|
|
1780
|
+
}
|
|
1781
|
+
|
|
1782
|
+
/**
|
|
1783
|
+
* Selling Partner API for Merchant Fulfillment
|
|
1784
|
+
* With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon\'s Buy Shipping Services.
|
|
1785
|
+
*
|
|
1786
|
+
* The version of the OpenAPI document: v0
|
|
1787
|
+
*
|
|
1788
|
+
*
|
|
1789
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1790
|
+
* https://openapi-generator.tech
|
|
1791
|
+
* Do not edit the class manually.
|
|
1792
|
+
*/
|
|
1793
|
+
/**
|
|
1794
|
+
* Error response returned when the request is unsuccessful.
|
|
1795
|
+
*/
|
|
1796
|
+
interface ModelError {
|
|
1797
|
+
/**
|
|
1798
|
+
* An error code that identifies the type of error that occurred.
|
|
1799
|
+
*/
|
|
1800
|
+
'code': string;
|
|
1801
|
+
/**
|
|
1802
|
+
* A message that describes the error condition in a human-readable form.
|
|
1803
|
+
*/
|
|
1804
|
+
'message': string;
|
|
1805
|
+
/**
|
|
1806
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
1807
|
+
*/
|
|
1808
|
+
'details'?: string;
|
|
1809
|
+
}
|
|
1810
|
+
|
|
1811
|
+
/**
|
|
1812
|
+
* MerchantFulfillmentApi - axios parameter creator
|
|
1813
|
+
*/
|
|
1814
|
+
declare const MerchantFulfillmentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1815
|
+
/**
|
|
1816
|
+
* Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1817
|
+
* @param {string} shipmentId The Amazon-defined shipment identifier for the shipment to cancel.
|
|
1818
|
+
* @param {*} [options] Override http request option.
|
|
1819
|
+
* @throws {RequiredError}
|
|
1820
|
+
*/
|
|
1821
|
+
cancelShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1822
|
+
/**
|
|
1823
|
+
* Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1824
|
+
* @param {CreateShipmentRequest} body The request schema for the `CreateShipment` operation.
|
|
1825
|
+
* @param {*} [options] Override http request option.
|
|
1826
|
+
* @throws {RequiredError}
|
|
1827
|
+
*/
|
|
1828
|
+
createShipment: (body: CreateShipmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1829
|
+
/**
|
|
1830
|
+
* Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1831
|
+
* @param {GetAdditionalSellerInputsRequest} body The request schema for the `GetAdditionalSellerInputs` operation.
|
|
1832
|
+
* @param {*} [options] Override http request option.
|
|
1833
|
+
* @throws {RequiredError}
|
|
1834
|
+
*/
|
|
1835
|
+
getAdditionalSellerInputs: (body: GetAdditionalSellerInputsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1836
|
+
/**
|
|
1837
|
+
* Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1838
|
+
* @param {GetEligibleShipmentServicesRequest} body The request schema for the `GetEligibleShipmentServices` operation.
|
|
1839
|
+
* @param {*} [options] Override http request option.
|
|
1840
|
+
* @throws {RequiredError}
|
|
1841
|
+
*/
|
|
1842
|
+
getEligibleShipmentServices: (body: GetEligibleShipmentServicesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1843
|
+
/**
|
|
1844
|
+
* Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1845
|
+
* @param {string} shipmentId The Amazon-defined shipment identifier for the shipment.
|
|
1846
|
+
* @param {*} [options] Override http request option.
|
|
1847
|
+
* @throws {RequiredError}
|
|
1848
|
+
*/
|
|
1849
|
+
getShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1850
|
+
};
|
|
1851
|
+
/**
|
|
1852
|
+
* MerchantFulfillmentApi - functional programming interface
|
|
1853
|
+
*/
|
|
1854
|
+
declare const MerchantFulfillmentApiFp: (configuration?: Configuration) => {
|
|
1855
|
+
/**
|
|
1856
|
+
* Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1857
|
+
* @param {string} shipmentId The Amazon-defined shipment identifier for the shipment to cancel.
|
|
1858
|
+
* @param {*} [options] Override http request option.
|
|
1859
|
+
* @throws {RequiredError}
|
|
1860
|
+
*/
|
|
1861
|
+
cancelShipment(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelShipmentResponse>>;
|
|
1862
|
+
/**
|
|
1863
|
+
* Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1864
|
+
* @param {CreateShipmentRequest} body The request schema for the `CreateShipment` operation.
|
|
1865
|
+
* @param {*} [options] Override http request option.
|
|
1866
|
+
* @throws {RequiredError}
|
|
1867
|
+
*/
|
|
1868
|
+
createShipment(body: CreateShipmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateShipmentResponse>>;
|
|
1869
|
+
/**
|
|
1870
|
+
* Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1871
|
+
* @param {GetAdditionalSellerInputsRequest} body The request schema for the `GetAdditionalSellerInputs` operation.
|
|
1872
|
+
* @param {*} [options] Override http request option.
|
|
1873
|
+
* @throws {RequiredError}
|
|
1874
|
+
*/
|
|
1875
|
+
getAdditionalSellerInputs(body: GetAdditionalSellerInputsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAdditionalSellerInputsResponse>>;
|
|
1876
|
+
/**
|
|
1877
|
+
* Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1878
|
+
* @param {GetEligibleShipmentServicesRequest} body The request schema for the `GetEligibleShipmentServices` operation.
|
|
1879
|
+
* @param {*} [options] Override http request option.
|
|
1880
|
+
* @throws {RequiredError}
|
|
1881
|
+
*/
|
|
1882
|
+
getEligibleShipmentServices(body: GetEligibleShipmentServicesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEligibleShipmentServicesResponse>>;
|
|
1883
|
+
/**
|
|
1884
|
+
* Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1885
|
+
* @param {string} shipmentId The Amazon-defined shipment identifier for the shipment.
|
|
1886
|
+
* @param {*} [options] Override http request option.
|
|
1887
|
+
* @throws {RequiredError}
|
|
1888
|
+
*/
|
|
1889
|
+
getShipment(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentResponse>>;
|
|
1890
|
+
};
|
|
1891
|
+
/**
|
|
1892
|
+
* MerchantFulfillmentApi - factory interface
|
|
1893
|
+
*/
|
|
1894
|
+
declare const MerchantFulfillmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1895
|
+
/**
|
|
1896
|
+
* Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1897
|
+
* @param {MerchantFulfillmentApiCancelShipmentRequest} requestParameters Request parameters.
|
|
1898
|
+
* @param {*} [options] Override http request option.
|
|
1899
|
+
* @throws {RequiredError}
|
|
1900
|
+
*/
|
|
1901
|
+
cancelShipment(requestParameters: MerchantFulfillmentApiCancelShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CancelShipmentResponse>;
|
|
1902
|
+
/**
|
|
1903
|
+
* Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1904
|
+
* @param {MerchantFulfillmentApiCreateShipmentRequest} requestParameters Request parameters.
|
|
1905
|
+
* @param {*} [options] Override http request option.
|
|
1906
|
+
* @throws {RequiredError}
|
|
1907
|
+
*/
|
|
1908
|
+
createShipment(requestParameters: MerchantFulfillmentApiCreateShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateShipmentResponse>;
|
|
1909
|
+
/**
|
|
1910
|
+
* Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1911
|
+
* @param {MerchantFulfillmentApiGetAdditionalSellerInputsRequest} requestParameters Request parameters.
|
|
1912
|
+
* @param {*} [options] Override http request option.
|
|
1913
|
+
* @throws {RequiredError}
|
|
1914
|
+
*/
|
|
1915
|
+
getAdditionalSellerInputs(requestParameters: MerchantFulfillmentApiGetAdditionalSellerInputsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAdditionalSellerInputsResponse>;
|
|
1916
|
+
/**
|
|
1917
|
+
* Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1918
|
+
* @param {MerchantFulfillmentApiGetEligibleShipmentServicesRequest} requestParameters Request parameters.
|
|
1919
|
+
* @param {*} [options] Override http request option.
|
|
1920
|
+
* @throws {RequiredError}
|
|
1921
|
+
*/
|
|
1922
|
+
getEligibleShipmentServices(requestParameters: MerchantFulfillmentApiGetEligibleShipmentServicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEligibleShipmentServicesResponse>;
|
|
1923
|
+
/**
|
|
1924
|
+
* Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1925
|
+
* @param {MerchantFulfillmentApiGetShipmentRequest} requestParameters Request parameters.
|
|
1926
|
+
* @param {*} [options] Override http request option.
|
|
1927
|
+
* @throws {RequiredError}
|
|
1928
|
+
*/
|
|
1929
|
+
getShipment(requestParameters: MerchantFulfillmentApiGetShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentResponse>;
|
|
1930
|
+
};
|
|
1931
|
+
/**
|
|
1932
|
+
* Request parameters for cancelShipment operation in MerchantFulfillmentApi.
|
|
1933
|
+
*/
|
|
1934
|
+
interface MerchantFulfillmentApiCancelShipmentRequest {
|
|
1935
|
+
/**
|
|
1936
|
+
* The Amazon-defined shipment identifier for the shipment to cancel.
|
|
1937
|
+
*/
|
|
1938
|
+
readonly shipmentId: string;
|
|
1939
|
+
}
|
|
1940
|
+
/**
|
|
1941
|
+
* Request parameters for createShipment operation in MerchantFulfillmentApi.
|
|
1942
|
+
*/
|
|
1943
|
+
interface MerchantFulfillmentApiCreateShipmentRequest {
|
|
1944
|
+
/**
|
|
1945
|
+
* The request schema for the `CreateShipment` operation.
|
|
1946
|
+
*/
|
|
1947
|
+
readonly body: CreateShipmentRequest;
|
|
1948
|
+
}
|
|
1949
|
+
/**
|
|
1950
|
+
* Request parameters for getAdditionalSellerInputs operation in MerchantFulfillmentApi.
|
|
1951
|
+
*/
|
|
1952
|
+
interface MerchantFulfillmentApiGetAdditionalSellerInputsRequest {
|
|
1953
|
+
/**
|
|
1954
|
+
* The request schema for the `GetAdditionalSellerInputs` operation.
|
|
1955
|
+
*/
|
|
1956
|
+
readonly body: GetAdditionalSellerInputsRequest;
|
|
1957
|
+
}
|
|
1958
|
+
/**
|
|
1959
|
+
* Request parameters for getEligibleShipmentServices operation in MerchantFulfillmentApi.
|
|
1960
|
+
*/
|
|
1961
|
+
interface MerchantFulfillmentApiGetEligibleShipmentServicesRequest {
|
|
1962
|
+
/**
|
|
1963
|
+
* The request schema for the `GetEligibleShipmentServices` operation.
|
|
1964
|
+
*/
|
|
1965
|
+
readonly body: GetEligibleShipmentServicesRequest;
|
|
1966
|
+
}
|
|
1967
|
+
/**
|
|
1968
|
+
* Request parameters for getShipment operation in MerchantFulfillmentApi.
|
|
1969
|
+
*/
|
|
1970
|
+
interface MerchantFulfillmentApiGetShipmentRequest {
|
|
1971
|
+
/**
|
|
1972
|
+
* The Amazon-defined shipment identifier for the shipment.
|
|
1973
|
+
*/
|
|
1974
|
+
readonly shipmentId: string;
|
|
1975
|
+
}
|
|
1976
|
+
/**
|
|
1977
|
+
* MerchantFulfillmentApi - object-oriented interface
|
|
1978
|
+
*/
|
|
1979
|
+
declare class MerchantFulfillmentApi extends BaseAPI {
|
|
1980
|
+
/**
|
|
1981
|
+
* Cancel the shipment indicated by the specified shipment identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1982
|
+
* @param {MerchantFulfillmentApiCancelShipmentRequest} requestParameters Request parameters.
|
|
1983
|
+
* @param {*} [options] Override http request option.
|
|
1984
|
+
* @throws {RequiredError}
|
|
1985
|
+
*/
|
|
1986
|
+
cancelShipment(requestParameters: MerchantFulfillmentApiCancelShipmentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CancelShipmentResponse, any, {}>>;
|
|
1987
|
+
/**
|
|
1988
|
+
* Create a shipment with the information provided. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1989
|
+
* @param {MerchantFulfillmentApiCreateShipmentRequest} requestParameters Request parameters.
|
|
1990
|
+
* @param {*} [options] Override http request option.
|
|
1991
|
+
* @throws {RequiredError}
|
|
1992
|
+
*/
|
|
1993
|
+
createShipment(requestParameters: MerchantFulfillmentApiCreateShipmentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateShipmentResponse, any, {}>>;
|
|
1994
|
+
/**
|
|
1995
|
+
* Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1996
|
+
* @param {MerchantFulfillmentApiGetAdditionalSellerInputsRequest} requestParameters Request parameters.
|
|
1997
|
+
* @param {*} [options] Override http request option.
|
|
1998
|
+
* @throws {RequiredError}
|
|
1999
|
+
*/
|
|
2000
|
+
getAdditionalSellerInputs(requestParameters: MerchantFulfillmentApiGetAdditionalSellerInputsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetAdditionalSellerInputsResponse, any, {}>>;
|
|
2001
|
+
/**
|
|
2002
|
+
* Returns a list of shipping service offers that satisfy the specified shipment request details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2003
|
+
* @param {MerchantFulfillmentApiGetEligibleShipmentServicesRequest} requestParameters Request parameters.
|
|
2004
|
+
* @param {*} [options] Override http request option.
|
|
2005
|
+
* @throws {RequiredError}
|
|
2006
|
+
*/
|
|
2007
|
+
getEligibleShipmentServices(requestParameters: MerchantFulfillmentApiGetEligibleShipmentServicesRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetEligibleShipmentServicesResponse, any, {}>>;
|
|
2008
|
+
/**
|
|
2009
|
+
* Returns the shipment information for an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2010
|
+
* @param {MerchantFulfillmentApiGetShipmentRequest} requestParameters Request parameters.
|
|
2011
|
+
* @param {*} [options] Override http request option.
|
|
2012
|
+
* @throws {RequiredError}
|
|
2013
|
+
*/
|
|
2014
|
+
getShipment(requestParameters: MerchantFulfillmentApiGetShipmentRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetShipmentResponse, any, {}>>;
|
|
2015
|
+
}
|
|
2016
|
+
|
|
2017
|
+
declare const clientRateLimits: RateLimit[];
|
|
2018
|
+
declare class MerchantFulfillmentApiClient extends MerchantFulfillmentApi {
|
|
2019
|
+
constructor(configuration: ClientConfiguration);
|
|
2020
|
+
}
|
|
2021
|
+
|
|
2022
|
+
export { type AdditionalInputs, type AdditionalSellerInput, type AdditionalSellerInputs, type Address, type AvailableCarrierWillPickUpOption, type AvailableDeliveryExperienceOption, type AvailableShippingServiceOptions, type Benefits, type CancelShipmentResponse, CarrierWillPickUpOption, type Constraint, type CreateShipmentRequest, type CreateShipmentResponse, type CurrencyAmount, type DangerousGoodsDetails, DangerousGoodsDetailsPackingGroupEnum, DangerousGoodsDetailsPackingInstructionEnum, DeliveryExperienceOption, DeliveryExperienceType, type ExcludedBenefit, type FileContents, FileType, type GetAdditionalSellerInputsRequest, type GetAdditionalSellerInputsResponse, type GetAdditionalSellerInputsResult, type GetEligibleShipmentServicesRequest, type GetEligibleShipmentServicesResponse, type GetEligibleShipmentServicesResult, type GetShipmentResponse, HazmatType, InputTargetType, type Item, type ItemLevelFields, type Label, type LabelCustomization, type LabelDimensions, LabelFormat, type LabelFormatOption, type LabelFormatOptionRequest, type Length, type LiquidVolume, LiquidVolumeUnitEnum, MerchantFulfillmentApi, MerchantFulfillmentApiAxiosParamCreator, type MerchantFulfillmentApiCancelShipmentRequest, MerchantFulfillmentApiClient, type MerchantFulfillmentApiCreateShipmentRequest, MerchantFulfillmentApiFactory, MerchantFulfillmentApiFp, type MerchantFulfillmentApiGetAdditionalSellerInputsRequest, type MerchantFulfillmentApiGetEligibleShipmentServicesRequest, type MerchantFulfillmentApiGetShipmentRequest, type ModelError, type PackageDimensions, PredefinedPackageDimensions, type RateItem, RateItemID, RateItemType, type RejectedShippingService, type SellerInputDefinition, type Shipment, type ShipmentRequestDetails, ShipmentStatus, type ShippingOfferingFilter, type ShippingService, type ShippingServiceOptions, StandardIdForLabel, type TemporarilyUnavailableCarrier, type TermsAndConditionsNotAcceptedCarrier, UnitOfLength, UnitOfWeight, type Weight, clientRateLimits };
|