@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 3.0.3 → 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/dist/cjs/api-model/api/{vendor-shipping-api.js → vendor-direct-fulfillment-shipping-api.js} +61 -61
- package/dist/cjs/api-model/api.js +1 -1
- package/dist/cjs/client.js +1 -1
- package/dist/es/api-model/api/{vendor-shipping-api.js → vendor-direct-fulfillment-shipping-api.js} +56 -56
- package/dist/es/api-model/api.js +1 -1
- package/dist/es/client.js +2 -2
- package/dist/types/api-model/api/{vendor-shipping-api.d.ts → vendor-direct-fulfillment-shipping-api.d.ts} +105 -105
- package/dist/types/api-model/api.d.ts +1 -1
- package/dist/types/client.d.ts +2 -2
- package/package.json +4 -4
|
@@ -26,10 +26,10 @@ import type { SubmitShipmentStatusUpdatesResponse } from '../models';
|
|
|
26
26
|
import type { SubmitShippingLabelsRequest } from '../models';
|
|
27
27
|
import type { SubmitShippingLabelsResponse } from '../models';
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* VendorDirectFulfillmentShippingApi - axios parameter creator
|
|
30
30
|
* @export
|
|
31
31
|
*/
|
|
32
|
-
export declare const
|
|
32
|
+
export declare const VendorDirectFulfillmentShippingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
33
33
|
/**
|
|
34
34
|
* Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
35
35
|
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
@@ -110,10 +110,10 @@ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Config
|
|
|
110
110
|
submitShippingLabelRequest: (body: SubmitShippingLabelsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
111
|
};
|
|
112
112
|
/**
|
|
113
|
-
*
|
|
113
|
+
* VendorDirectFulfillmentShippingApi - functional programming interface
|
|
114
114
|
* @export
|
|
115
115
|
*/
|
|
116
|
-
export declare const
|
|
116
|
+
export declare const VendorDirectFulfillmentShippingApiFp: (configuration?: Configuration) => {
|
|
117
117
|
/**
|
|
118
118
|
* Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
119
119
|
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
@@ -194,360 +194,360 @@ export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
|
194
194
|
submitShippingLabelRequest(body: SubmitShippingLabelsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitShippingLabelsResponse>>;
|
|
195
195
|
};
|
|
196
196
|
/**
|
|
197
|
-
*
|
|
197
|
+
* VendorDirectFulfillmentShippingApi - factory interface
|
|
198
198
|
* @export
|
|
199
199
|
*/
|
|
200
|
-
export declare const
|
|
200
|
+
export declare const VendorDirectFulfillmentShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
201
201
|
/**
|
|
202
202
|
* Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
203
|
-
* @param {
|
|
203
|
+
* @param {VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
207
|
-
getCustomerInvoice(requestParameters:
|
|
207
|
+
getCustomerInvoice(requestParameters: VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomerInvoiceResponse>;
|
|
208
208
|
/**
|
|
209
209
|
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
210
|
-
* @param {
|
|
210
|
+
* @param {VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
211
211
|
* @param {*} [options] Override http request option.
|
|
212
212
|
* @throws {RequiredError}
|
|
213
213
|
*/
|
|
214
|
-
getCustomerInvoices(requestParameters:
|
|
214
|
+
getCustomerInvoices(requestParameters: VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomerInvoicesResponse>;
|
|
215
215
|
/**
|
|
216
216
|
* Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
217
|
-
* @param {
|
|
217
|
+
* @param {VendorDirectFulfillmentShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
218
218
|
* @param {*} [options] Override http request option.
|
|
219
219
|
* @throws {RequiredError}
|
|
220
220
|
*/
|
|
221
|
-
getPackingSlip(requestParameters:
|
|
221
|
+
getPackingSlip(requestParameters: VendorDirectFulfillmentShippingApiGetPackingSlipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPackingSlipResponse>;
|
|
222
222
|
/**
|
|
223
223
|
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
224
|
-
* @param {
|
|
224
|
+
* @param {VendorDirectFulfillmentShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
225
225
|
* @param {*} [options] Override http request option.
|
|
226
226
|
* @throws {RequiredError}
|
|
227
227
|
*/
|
|
228
|
-
getPackingSlips(requestParameters:
|
|
228
|
+
getPackingSlips(requestParameters: VendorDirectFulfillmentShippingApiGetPackingSlipsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPackingSlipListResponse>;
|
|
229
229
|
/**
|
|
230
230
|
* Returns a shipping label for the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
231
|
-
* @param {
|
|
231
|
+
* @param {VendorDirectFulfillmentShippingApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
232
232
|
* @param {*} [options] Override http request option.
|
|
233
233
|
* @throws {RequiredError}
|
|
234
234
|
*/
|
|
235
|
-
getShippingLabel(requestParameters:
|
|
235
|
+
getShippingLabel(requestParameters: VendorDirectFulfillmentShippingApiGetShippingLabelRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShippingLabelResponse>;
|
|
236
236
|
/**
|
|
237
237
|
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
238
|
-
* @param {
|
|
238
|
+
* @param {VendorDirectFulfillmentShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
240
240
|
* @throws {RequiredError}
|
|
241
241
|
*/
|
|
242
|
-
getShippingLabels(requestParameters:
|
|
242
|
+
getShippingLabels(requestParameters: VendorDirectFulfillmentShippingApiGetShippingLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShippingLabelListResponse>;
|
|
243
243
|
/**
|
|
244
244
|
* Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
245
|
-
* @param {
|
|
245
|
+
* @param {VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
246
246
|
* @param {*} [options] Override http request option.
|
|
247
247
|
* @throws {RequiredError}
|
|
248
248
|
*/
|
|
249
|
-
submitShipmentConfirmations(requestParameters:
|
|
249
|
+
submitShipmentConfirmations(requestParameters: VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentConfirmationsResponse>;
|
|
250
250
|
/**
|
|
251
251
|
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
252
|
-
* @param {
|
|
252
|
+
* @param {VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
253
253
|
* @param {*} [options] Override http request option.
|
|
254
254
|
* @throws {RequiredError}
|
|
255
255
|
*/
|
|
256
|
-
submitShipmentStatusUpdates(requestParameters:
|
|
256
|
+
submitShipmentStatusUpdates(requestParameters: VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentStatusUpdatesResponse>;
|
|
257
257
|
/**
|
|
258
258
|
* Creates a shipping label for a purchase order and returns a transactionId for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
259
|
-
* @param {
|
|
259
|
+
* @param {VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
260
260
|
* @param {*} [options] Override http request option.
|
|
261
261
|
* @throws {RequiredError}
|
|
262
262
|
*/
|
|
263
|
-
submitShippingLabelRequest(requestParameters:
|
|
263
|
+
submitShippingLabelRequest(requestParameters: VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShippingLabelsResponse>;
|
|
264
264
|
};
|
|
265
265
|
/**
|
|
266
|
-
* Request parameters for getCustomerInvoice operation in
|
|
266
|
+
* Request parameters for getCustomerInvoice operation in VendorDirectFulfillmentShippingApi.
|
|
267
267
|
* @export
|
|
268
|
-
* @interface
|
|
268
|
+
* @interface VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest
|
|
269
269
|
*/
|
|
270
|
-
export interface
|
|
270
|
+
export interface VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest {
|
|
271
271
|
/**
|
|
272
272
|
* Purchase order number of the shipment for which to return the invoice.
|
|
273
273
|
* @type {string}
|
|
274
|
-
* @memberof
|
|
274
|
+
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoice
|
|
275
275
|
*/
|
|
276
276
|
readonly purchaseOrderNumber: string;
|
|
277
277
|
}
|
|
278
278
|
/**
|
|
279
|
-
* Request parameters for getCustomerInvoices operation in
|
|
279
|
+
* Request parameters for getCustomerInvoices operation in VendorDirectFulfillmentShippingApi.
|
|
280
280
|
* @export
|
|
281
|
-
* @interface
|
|
281
|
+
* @interface VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest
|
|
282
282
|
*/
|
|
283
|
-
export interface
|
|
283
|
+
export interface VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest {
|
|
284
284
|
/**
|
|
285
285
|
* Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
286
286
|
* @type {string}
|
|
287
|
-
* @memberof
|
|
287
|
+
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
288
288
|
*/
|
|
289
289
|
readonly createdAfter: string;
|
|
290
290
|
/**
|
|
291
291
|
* Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
292
292
|
* @type {string}
|
|
293
|
-
* @memberof
|
|
293
|
+
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
294
294
|
*/
|
|
295
295
|
readonly createdBefore: string;
|
|
296
296
|
/**
|
|
297
297
|
* The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
298
298
|
* @type {string}
|
|
299
|
-
* @memberof
|
|
299
|
+
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
300
300
|
*/
|
|
301
301
|
readonly shipFromPartyId?: string;
|
|
302
302
|
/**
|
|
303
303
|
* The limit to the number of records returned
|
|
304
304
|
* @type {number}
|
|
305
|
-
* @memberof
|
|
305
|
+
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
306
306
|
*/
|
|
307
307
|
readonly limit?: number;
|
|
308
308
|
/**
|
|
309
309
|
* Sort ASC or DESC by order creation date.
|
|
310
310
|
* @type {'ASC' | 'DESC'}
|
|
311
|
-
* @memberof
|
|
311
|
+
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
312
312
|
*/
|
|
313
313
|
readonly sortOrder?: GetCustomerInvoicesSortOrderEnum;
|
|
314
314
|
/**
|
|
315
315
|
* Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
|
|
316
316
|
* @type {string}
|
|
317
|
-
* @memberof
|
|
317
|
+
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
318
318
|
*/
|
|
319
319
|
readonly nextToken?: string;
|
|
320
320
|
}
|
|
321
321
|
/**
|
|
322
|
-
* Request parameters for getPackingSlip operation in
|
|
322
|
+
* Request parameters for getPackingSlip operation in VendorDirectFulfillmentShippingApi.
|
|
323
323
|
* @export
|
|
324
|
-
* @interface
|
|
324
|
+
* @interface VendorDirectFulfillmentShippingApiGetPackingSlipRequest
|
|
325
325
|
*/
|
|
326
|
-
export interface
|
|
326
|
+
export interface VendorDirectFulfillmentShippingApiGetPackingSlipRequest {
|
|
327
327
|
/**
|
|
328
328
|
* The purchaseOrderNumber for the packing slip you want.
|
|
329
329
|
* @type {string}
|
|
330
|
-
* @memberof
|
|
330
|
+
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlip
|
|
331
331
|
*/
|
|
332
332
|
readonly purchaseOrderNumber: string;
|
|
333
333
|
}
|
|
334
334
|
/**
|
|
335
|
-
* Request parameters for getPackingSlips operation in
|
|
335
|
+
* Request parameters for getPackingSlips operation in VendorDirectFulfillmentShippingApi.
|
|
336
336
|
* @export
|
|
337
|
-
* @interface
|
|
337
|
+
* @interface VendorDirectFulfillmentShippingApiGetPackingSlipsRequest
|
|
338
338
|
*/
|
|
339
|
-
export interface
|
|
339
|
+
export interface VendorDirectFulfillmentShippingApiGetPackingSlipsRequest {
|
|
340
340
|
/**
|
|
341
341
|
* Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
342
342
|
* @type {string}
|
|
343
|
-
* @memberof
|
|
343
|
+
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
344
344
|
*/
|
|
345
345
|
readonly createdAfter: string;
|
|
346
346
|
/**
|
|
347
347
|
* Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
348
348
|
* @type {string}
|
|
349
|
-
* @memberof
|
|
349
|
+
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
350
350
|
*/
|
|
351
351
|
readonly createdBefore: string;
|
|
352
352
|
/**
|
|
353
353
|
* The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
354
354
|
* @type {string}
|
|
355
|
-
* @memberof
|
|
355
|
+
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
356
356
|
*/
|
|
357
357
|
readonly shipFromPartyId?: string;
|
|
358
358
|
/**
|
|
359
359
|
* The limit to the number of records returned
|
|
360
360
|
* @type {number}
|
|
361
|
-
* @memberof
|
|
361
|
+
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
362
362
|
*/
|
|
363
363
|
readonly limit?: number;
|
|
364
364
|
/**
|
|
365
365
|
* Sort ASC or DESC by packing slip creation date.
|
|
366
366
|
* @type {'ASC' | 'DESC'}
|
|
367
|
-
* @memberof
|
|
367
|
+
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
368
368
|
*/
|
|
369
369
|
readonly sortOrder?: GetPackingSlipsSortOrderEnum;
|
|
370
370
|
/**
|
|
371
371
|
* Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
|
|
372
372
|
* @type {string}
|
|
373
|
-
* @memberof
|
|
373
|
+
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
374
374
|
*/
|
|
375
375
|
readonly nextToken?: string;
|
|
376
376
|
}
|
|
377
377
|
/**
|
|
378
|
-
* Request parameters for getShippingLabel operation in
|
|
378
|
+
* Request parameters for getShippingLabel operation in VendorDirectFulfillmentShippingApi.
|
|
379
379
|
* @export
|
|
380
|
-
* @interface
|
|
380
|
+
* @interface VendorDirectFulfillmentShippingApiGetShippingLabelRequest
|
|
381
381
|
*/
|
|
382
|
-
export interface
|
|
382
|
+
export interface VendorDirectFulfillmentShippingApiGetShippingLabelRequest {
|
|
383
383
|
/**
|
|
384
384
|
* The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
385
385
|
* @type {string}
|
|
386
|
-
* @memberof
|
|
386
|
+
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabel
|
|
387
387
|
*/
|
|
388
388
|
readonly purchaseOrderNumber: string;
|
|
389
389
|
}
|
|
390
390
|
/**
|
|
391
|
-
* Request parameters for getShippingLabels operation in
|
|
391
|
+
* Request parameters for getShippingLabels operation in VendorDirectFulfillmentShippingApi.
|
|
392
392
|
* @export
|
|
393
|
-
* @interface
|
|
393
|
+
* @interface VendorDirectFulfillmentShippingApiGetShippingLabelsRequest
|
|
394
394
|
*/
|
|
395
|
-
export interface
|
|
395
|
+
export interface VendorDirectFulfillmentShippingApiGetShippingLabelsRequest {
|
|
396
396
|
/**
|
|
397
397
|
* Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
398
398
|
* @type {string}
|
|
399
|
-
* @memberof
|
|
399
|
+
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
400
400
|
*/
|
|
401
401
|
readonly createdAfter: string;
|
|
402
402
|
/**
|
|
403
403
|
* Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
404
404
|
* @type {string}
|
|
405
|
-
* @memberof
|
|
405
|
+
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
406
406
|
*/
|
|
407
407
|
readonly createdBefore: string;
|
|
408
408
|
/**
|
|
409
409
|
* The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
410
410
|
* @type {string}
|
|
411
|
-
* @memberof
|
|
411
|
+
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
412
412
|
*/
|
|
413
413
|
readonly shipFromPartyId?: string;
|
|
414
414
|
/**
|
|
415
415
|
* The limit to the number of records returned.
|
|
416
416
|
* @type {number}
|
|
417
|
-
* @memberof
|
|
417
|
+
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
418
418
|
*/
|
|
419
419
|
readonly limit?: number;
|
|
420
420
|
/**
|
|
421
421
|
* Sort ASC or DESC by order creation date.
|
|
422
422
|
* @type {'ASC' | 'DESC'}
|
|
423
|
-
* @memberof
|
|
423
|
+
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
424
424
|
*/
|
|
425
425
|
readonly sortOrder?: GetShippingLabelsSortOrderEnum;
|
|
426
426
|
/**
|
|
427
427
|
* Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
428
428
|
* @type {string}
|
|
429
|
-
* @memberof
|
|
429
|
+
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
430
430
|
*/
|
|
431
431
|
readonly nextToken?: string;
|
|
432
432
|
}
|
|
433
433
|
/**
|
|
434
|
-
* Request parameters for submitShipmentConfirmations operation in
|
|
434
|
+
* Request parameters for submitShipmentConfirmations operation in VendorDirectFulfillmentShippingApi.
|
|
435
435
|
* @export
|
|
436
|
-
* @interface
|
|
436
|
+
* @interface VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest
|
|
437
437
|
*/
|
|
438
|
-
export interface
|
|
438
|
+
export interface VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest {
|
|
439
439
|
/**
|
|
440
440
|
* Request body containing the shipment confirmations data.
|
|
441
441
|
* @type {SubmitShipmentConfirmationsRequest}
|
|
442
|
-
* @memberof
|
|
442
|
+
* @memberof VendorDirectFulfillmentShippingApiSubmitShipmentConfirmations
|
|
443
443
|
*/
|
|
444
444
|
readonly body: SubmitShipmentConfirmationsRequest;
|
|
445
445
|
}
|
|
446
446
|
/**
|
|
447
|
-
* Request parameters for submitShipmentStatusUpdates operation in
|
|
447
|
+
* Request parameters for submitShipmentStatusUpdates operation in VendorDirectFulfillmentShippingApi.
|
|
448
448
|
* @export
|
|
449
|
-
* @interface
|
|
449
|
+
* @interface VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest
|
|
450
450
|
*/
|
|
451
|
-
export interface
|
|
451
|
+
export interface VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest {
|
|
452
452
|
/**
|
|
453
453
|
* Request body containing the shipment status update data.
|
|
454
454
|
* @type {SubmitShipmentStatusUpdatesRequest}
|
|
455
|
-
* @memberof
|
|
455
|
+
* @memberof VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdates
|
|
456
456
|
*/
|
|
457
457
|
readonly body: SubmitShipmentStatusUpdatesRequest;
|
|
458
458
|
}
|
|
459
459
|
/**
|
|
460
|
-
* Request parameters for submitShippingLabelRequest operation in
|
|
460
|
+
* Request parameters for submitShippingLabelRequest operation in VendorDirectFulfillmentShippingApi.
|
|
461
461
|
* @export
|
|
462
|
-
* @interface
|
|
462
|
+
* @interface VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest
|
|
463
463
|
*/
|
|
464
|
-
export interface
|
|
464
|
+
export interface VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest {
|
|
465
465
|
/**
|
|
466
466
|
* Request body containing one or more shipping labels data.
|
|
467
467
|
* @type {SubmitShippingLabelsRequest}
|
|
468
|
-
* @memberof
|
|
468
|
+
* @memberof VendorDirectFulfillmentShippingApiSubmitShippingLabelRequest
|
|
469
469
|
*/
|
|
470
470
|
readonly body: SubmitShippingLabelsRequest;
|
|
471
471
|
}
|
|
472
472
|
/**
|
|
473
|
-
*
|
|
473
|
+
* VendorDirectFulfillmentShippingApi - object-oriented interface
|
|
474
474
|
* @export
|
|
475
|
-
* @class
|
|
475
|
+
* @class VendorDirectFulfillmentShippingApi
|
|
476
476
|
* @extends {BaseAPI}
|
|
477
477
|
*/
|
|
478
|
-
export declare class
|
|
478
|
+
export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
479
479
|
/**
|
|
480
480
|
* Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
481
|
-
* @param {
|
|
481
|
+
* @param {VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
482
482
|
* @param {*} [options] Override http request option.
|
|
483
483
|
* @throws {RequiredError}
|
|
484
|
-
* @memberof
|
|
484
|
+
* @memberof VendorDirectFulfillmentShippingApi
|
|
485
485
|
*/
|
|
486
|
-
getCustomerInvoice(requestParameters:
|
|
486
|
+
getCustomerInvoice(requestParameters: VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCustomerInvoiceResponse, any>>;
|
|
487
487
|
/**
|
|
488
488
|
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
489
|
-
* @param {
|
|
489
|
+
* @param {VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
490
490
|
* @param {*} [options] Override http request option.
|
|
491
491
|
* @throws {RequiredError}
|
|
492
|
-
* @memberof
|
|
492
|
+
* @memberof VendorDirectFulfillmentShippingApi
|
|
493
493
|
*/
|
|
494
|
-
getCustomerInvoices(requestParameters:
|
|
494
|
+
getCustomerInvoices(requestParameters: VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCustomerInvoicesResponse, any>>;
|
|
495
495
|
/**
|
|
496
496
|
* Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
497
|
-
* @param {
|
|
497
|
+
* @param {VendorDirectFulfillmentShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
498
498
|
* @param {*} [options] Override http request option.
|
|
499
499
|
* @throws {RequiredError}
|
|
500
|
-
* @memberof
|
|
500
|
+
* @memberof VendorDirectFulfillmentShippingApi
|
|
501
501
|
*/
|
|
502
|
-
getPackingSlip(requestParameters:
|
|
502
|
+
getPackingSlip(requestParameters: VendorDirectFulfillmentShippingApiGetPackingSlipRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackingSlipResponse, any>>;
|
|
503
503
|
/**
|
|
504
504
|
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
505
|
-
* @param {
|
|
505
|
+
* @param {VendorDirectFulfillmentShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
506
506
|
* @param {*} [options] Override http request option.
|
|
507
507
|
* @throws {RequiredError}
|
|
508
|
-
* @memberof
|
|
508
|
+
* @memberof VendorDirectFulfillmentShippingApi
|
|
509
509
|
*/
|
|
510
|
-
getPackingSlips(requestParameters:
|
|
510
|
+
getPackingSlips(requestParameters: VendorDirectFulfillmentShippingApiGetPackingSlipsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackingSlipListResponse, any>>;
|
|
511
511
|
/**
|
|
512
512
|
* Returns a shipping label for the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
513
|
-
* @param {
|
|
513
|
+
* @param {VendorDirectFulfillmentShippingApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
514
514
|
* @param {*} [options] Override http request option.
|
|
515
515
|
* @throws {RequiredError}
|
|
516
|
-
* @memberof
|
|
516
|
+
* @memberof VendorDirectFulfillmentShippingApi
|
|
517
517
|
*/
|
|
518
|
-
getShippingLabel(requestParameters:
|
|
518
|
+
getShippingLabel(requestParameters: VendorDirectFulfillmentShippingApiGetShippingLabelRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShippingLabelResponse, any>>;
|
|
519
519
|
/**
|
|
520
520
|
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
521
|
-
* @param {
|
|
521
|
+
* @param {VendorDirectFulfillmentShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
522
522
|
* @param {*} [options] Override http request option.
|
|
523
523
|
* @throws {RequiredError}
|
|
524
|
-
* @memberof
|
|
524
|
+
* @memberof VendorDirectFulfillmentShippingApi
|
|
525
525
|
*/
|
|
526
|
-
getShippingLabels(requestParameters:
|
|
526
|
+
getShippingLabels(requestParameters: VendorDirectFulfillmentShippingApiGetShippingLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShippingLabelListResponse, any>>;
|
|
527
527
|
/**
|
|
528
528
|
* Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
529
|
-
* @param {
|
|
529
|
+
* @param {VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
530
530
|
* @param {*} [options] Override http request option.
|
|
531
531
|
* @throws {RequiredError}
|
|
532
|
-
* @memberof
|
|
532
|
+
* @memberof VendorDirectFulfillmentShippingApi
|
|
533
533
|
*/
|
|
534
|
-
submitShipmentConfirmations(requestParameters:
|
|
534
|
+
submitShipmentConfirmations(requestParameters: VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
|
|
535
535
|
/**
|
|
536
536
|
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
537
|
-
* @param {
|
|
537
|
+
* @param {VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
538
538
|
* @param {*} [options] Override http request option.
|
|
539
539
|
* @throws {RequiredError}
|
|
540
|
-
* @memberof
|
|
540
|
+
* @memberof VendorDirectFulfillmentShippingApi
|
|
541
541
|
*/
|
|
542
|
-
submitShipmentStatusUpdates(requestParameters:
|
|
542
|
+
submitShipmentStatusUpdates(requestParameters: VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentStatusUpdatesResponse, any>>;
|
|
543
543
|
/**
|
|
544
544
|
* Creates a shipping label for a purchase order and returns a transactionId for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
545
|
-
* @param {
|
|
545
|
+
* @param {VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
546
546
|
* @param {*} [options] Override http request option.
|
|
547
547
|
* @throws {RequiredError}
|
|
548
|
-
* @memberof
|
|
548
|
+
* @memberof VendorDirectFulfillmentShippingApi
|
|
549
549
|
*/
|
|
550
|
-
submitShippingLabelRequest(requestParameters:
|
|
550
|
+
submitShippingLabelRequest(requestParameters: VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShippingLabelsResponse, any>>;
|
|
551
551
|
}
|
|
552
552
|
/**
|
|
553
553
|
* @export
|
package/dist/types/client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
|
|
2
|
-
import {
|
|
2
|
+
import { VendorDirectFulfillmentShippingApi } from './api-model';
|
|
3
3
|
export declare const clientRateLimits: RateLimit[];
|
|
4
|
-
export declare class VendorDirectFulfillmentShippingApiClient extends
|
|
4
|
+
export declare class VendorDirectFulfillmentShippingApiClient extends VendorDirectFulfillmentShippingApi {
|
|
5
5
|
constructor(configuration: ClientConfiguration);
|
|
6
6
|
}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1",
|
|
3
3
|
"author": "Bertrand Marron <bertrand@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.",
|
|
5
|
-
"version": "
|
|
5
|
+
"version": "4.0.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"dist/**/*.d.ts"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@sp-api-sdk/common": "2.1.
|
|
22
|
-
"axios": "^1.
|
|
21
|
+
"@sp-api-sdk/common": "2.1.14",
|
|
22
|
+
"axios": "^1.9.0"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
25
25
|
"type": "git",
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"vendor direct fulfillment shipping api"
|
|
42
42
|
],
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
|
|
44
44
|
}
|