@sp-api-sdk/amazon-warehousing-and-distribution-api-2024-05-09 2.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/LICENSE +21 -0
- package/README.md +97 -0
- package/dist/cjs/api-model/api/awd-api.js +346 -0
- package/dist/cjs/api-model/api.js +30 -0
- package/dist/cjs/api-model/base.js +71 -0
- package/dist/cjs/api-model/common.js +145 -0
- package/dist/cjs/api-model/configuration.js +99 -0
- package/dist/cjs/api-model/index.js +32 -0
- package/dist/cjs/api-model/models/address.js +15 -0
- package/dist/cjs/api-model/models/carrier-code-type.js +24 -0
- package/dist/cjs/api-model/models/carrier-code.js +15 -0
- package/dist/cjs/api-model/models/dimension-unit-of-measurement.js +25 -0
- package/dist/cjs/api-model/models/distribution-package-contents.js +15 -0
- package/dist/cjs/api-model/models/distribution-package-quantity.js +15 -0
- package/dist/cjs/api-model/models/distribution-package-type.js +25 -0
- package/dist/cjs/api-model/models/distribution-package.js +15 -0
- package/dist/cjs/api-model/models/error-list.js +15 -0
- package/dist/cjs/api-model/models/expiration-details.js +15 -0
- package/dist/cjs/api-model/models/format-type.js +24 -0
- package/dist/cjs/api-model/models/inbound-eligibility-status.js +25 -0
- package/dist/cjs/api-model/models/inbound-eligibility.js +15 -0
- package/dist/cjs/api-model/models/inbound-order-creation-data.js +15 -0
- package/dist/cjs/api-model/models/inbound-order-reference.js +15 -0
- package/dist/cjs/api-model/models/inbound-order.js +15 -0
- package/dist/cjs/api-model/models/inbound-packages.js +15 -0
- package/dist/cjs/api-model/models/inbound-preferences.js +15 -0
- package/dist/cjs/api-model/models/inbound-shipment-status.js +30 -0
- package/dist/cjs/api-model/models/inbound-shipment-summary.js +15 -0
- package/dist/cjs/api-model/models/inbound-shipment.js +15 -0
- package/dist/cjs/api-model/models/inbound-status.js +29 -0
- package/dist/cjs/api-model/models/index.js +81 -0
- package/dist/cjs/api-model/models/inventory-details-visibility.js +25 -0
- package/dist/cjs/api-model/models/inventory-details.js +15 -0
- package/dist/cjs/api-model/models/inventory-listing.js +15 -0
- package/dist/cjs/api-model/models/inventory-quantity.js +15 -0
- package/dist/cjs/api-model/models/inventory-summary.js +15 -0
- package/dist/cjs/api-model/models/inventory-unit-of-measurement.js +26 -0
- package/dist/cjs/api-model/models/label-owner.js +25 -0
- package/dist/cjs/api-model/models/label-status.js +27 -0
- package/dist/cjs/api-model/models/measurement-data.js +15 -0
- package/dist/cjs/api-model/models/model-error.js +15 -0
- package/dist/cjs/api-model/models/order-attribute.js +15 -0
- package/dist/cjs/api-model/models/order-ineligibility-reason.js +15 -0
- package/dist/cjs/api-model/models/order-preference-value.js +25 -0
- package/dist/cjs/api-model/models/order-preference.js +24 -0
- package/dist/cjs/api-model/models/outbound-execution-error.js +15 -0
- package/dist/cjs/api-model/models/outbound-listing.js +15 -0
- package/dist/cjs/api-model/models/outbound-order-creation-data.js +15 -0
- package/dist/cjs/api-model/models/outbound-order-reference.js +15 -0
- package/dist/cjs/api-model/models/outbound-order.js +15 -0
- package/dist/cjs/api-model/models/outbound-shipment-status.js +31 -0
- package/dist/cjs/api-model/models/outbound-shipment.js +15 -0
- package/dist/cjs/api-model/models/outbound-status.js +32 -0
- package/dist/cjs/api-model/models/package-dimensions.js +15 -0
- package/dist/cjs/api-model/models/package-volume.js +15 -0
- package/dist/cjs/api-model/models/package-weight.js +15 -0
- package/dist/cjs/api-model/models/page-type.js +26 -0
- package/dist/cjs/api-model/models/prep-details.js +15 -0
- package/dist/cjs/api-model/models/prep-instruction.js +15 -0
- package/dist/cjs/api-model/models/prep-owner.js +25 -0
- package/dist/cjs/api-model/models/product-attribute.js +15 -0
- package/dist/cjs/api-model/models/product-quantity.js +15 -0
- package/dist/cjs/api-model/models/shipment-labels.js +15 -0
- package/dist/cjs/api-model/models/shipment-listing.js +15 -0
- package/dist/cjs/api-model/models/shipment-sortable-field.js +25 -0
- package/dist/cjs/api-model/models/sku-eligibility.js +15 -0
- package/dist/cjs/api-model/models/sku-ineligibility-reason.js +15 -0
- package/dist/cjs/api-model/models/sku-quantities-visibility.js +25 -0
- package/dist/cjs/api-model/models/sku-quantity.js +15 -0
- package/dist/cjs/api-model/models/sort-order.js +25 -0
- package/dist/cjs/api-model/models/tracking-details.js +15 -0
- package/dist/cjs/api-model/models/transportation-details.js +15 -0
- package/dist/cjs/api-model/models/volume-unit-of-measurement.js +26 -0
- package/dist/cjs/api-model/models/weight-unit-of-measurement.js +25 -0
- package/dist/cjs/client.js +35 -0
- package/dist/cjs/index.js +19 -0
- package/dist/es/api-model/api/awd-api.js +336 -0
- package/dist/es/api-model/api.js +14 -0
- package/dist/es/api-model/base.js +63 -0
- package/dist/es/api-model/common.js +133 -0
- package/dist/es/api-model/configuration.js +95 -0
- package/dist/es/api-model/index.js +16 -0
- package/dist/es/api-model/models/address.js +14 -0
- package/dist/es/api-model/models/carrier-code-type.js +21 -0
- package/dist/es/api-model/models/carrier-code.js +14 -0
- package/dist/es/api-model/models/dimension-unit-of-measurement.js +22 -0
- package/dist/es/api-model/models/distribution-package-contents.js +14 -0
- package/dist/es/api-model/models/distribution-package-quantity.js +14 -0
- package/dist/es/api-model/models/distribution-package-type.js +22 -0
- package/dist/es/api-model/models/distribution-package.js +14 -0
- package/dist/es/api-model/models/error-list.js +14 -0
- package/dist/es/api-model/models/expiration-details.js +14 -0
- package/dist/es/api-model/models/format-type.js +21 -0
- package/dist/es/api-model/models/inbound-eligibility-status.js +22 -0
- package/dist/es/api-model/models/inbound-eligibility.js +14 -0
- package/dist/es/api-model/models/inbound-order-creation-data.js +14 -0
- package/dist/es/api-model/models/inbound-order-reference.js +14 -0
- package/dist/es/api-model/models/inbound-order.js +14 -0
- package/dist/es/api-model/models/inbound-packages.js +14 -0
- package/dist/es/api-model/models/inbound-preferences.js +14 -0
- package/dist/es/api-model/models/inbound-shipment-status.js +27 -0
- package/dist/es/api-model/models/inbound-shipment-summary.js +14 -0
- package/dist/es/api-model/models/inbound-shipment.js +14 -0
- package/dist/es/api-model/models/inbound-status.js +26 -0
- package/dist/es/api-model/models/index.js +65 -0
- package/dist/es/api-model/models/inventory-details-visibility.js +22 -0
- package/dist/es/api-model/models/inventory-details.js +14 -0
- package/dist/es/api-model/models/inventory-listing.js +14 -0
- package/dist/es/api-model/models/inventory-quantity.js +14 -0
- package/dist/es/api-model/models/inventory-summary.js +14 -0
- package/dist/es/api-model/models/inventory-unit-of-measurement.js +23 -0
- package/dist/es/api-model/models/label-owner.js +22 -0
- package/dist/es/api-model/models/label-status.js +24 -0
- package/dist/es/api-model/models/measurement-data.js +14 -0
- package/dist/es/api-model/models/model-error.js +14 -0
- package/dist/es/api-model/models/order-attribute.js +14 -0
- package/dist/es/api-model/models/order-ineligibility-reason.js +14 -0
- package/dist/es/api-model/models/order-preference-value.js +22 -0
- package/dist/es/api-model/models/order-preference.js +21 -0
- package/dist/es/api-model/models/outbound-execution-error.js +14 -0
- package/dist/es/api-model/models/outbound-listing.js +14 -0
- package/dist/es/api-model/models/outbound-order-creation-data.js +14 -0
- package/dist/es/api-model/models/outbound-order-reference.js +14 -0
- package/dist/es/api-model/models/outbound-order.js +14 -0
- package/dist/es/api-model/models/outbound-shipment-status.js +28 -0
- package/dist/es/api-model/models/outbound-shipment.js +14 -0
- package/dist/es/api-model/models/outbound-status.js +29 -0
- package/dist/es/api-model/models/package-dimensions.js +14 -0
- package/dist/es/api-model/models/package-volume.js +14 -0
- package/dist/es/api-model/models/package-weight.js +14 -0
- package/dist/es/api-model/models/page-type.js +23 -0
- package/dist/es/api-model/models/prep-details.js +14 -0
- package/dist/es/api-model/models/prep-instruction.js +14 -0
- package/dist/es/api-model/models/prep-owner.js +22 -0
- package/dist/es/api-model/models/product-attribute.js +14 -0
- package/dist/es/api-model/models/product-quantity.js +14 -0
- package/dist/es/api-model/models/shipment-labels.js +14 -0
- package/dist/es/api-model/models/shipment-listing.js +14 -0
- package/dist/es/api-model/models/shipment-sortable-field.js +22 -0
- package/dist/es/api-model/models/sku-eligibility.js +14 -0
- package/dist/es/api-model/models/sku-ineligibility-reason.js +14 -0
- package/dist/es/api-model/models/sku-quantities-visibility.js +22 -0
- package/dist/es/api-model/models/sku-quantity.js +14 -0
- package/dist/es/api-model/models/sort-order.js +22 -0
- package/dist/es/api-model/models/tracking-details.js +14 -0
- package/dist/es/api-model/models/transportation-details.js +14 -0
- package/dist/es/api-model/models/volume-unit-of-measurement.js +23 -0
- package/dist/es/api-model/models/weight-unit-of-measurement.js +22 -0
- package/dist/es/client.js +31 -0
- package/dist/es/index.js +3 -0
- package/dist/types/api-model/api/awd-api.d.ts +311 -0
- package/dist/types/api-model/api.d.ts +12 -0
- package/dist/types/api-model/base.d.ts +66 -0
- package/dist/types/api-model/common.d.ts +65 -0
- package/dist/types/api-model/configuration.d.ts +91 -0
- package/dist/types/api-model/index.d.ts +14 -0
- package/dist/types/api-model/models/address.d.ts +84 -0
- package/dist/types/api-model/models/carrier-code-type.d.ts +20 -0
- package/dist/types/api-model/models/carrier-code.d.ts +31 -0
- package/dist/types/api-model/models/dimension-unit-of-measurement.d.ts +21 -0
- package/dist/types/api-model/models/distribution-package-contents.d.ts +32 -0
- package/dist/types/api-model/models/distribution-package-quantity.d.ts +31 -0
- package/dist/types/api-model/models/distribution-package-type.d.ts +21 -0
- package/dist/types/api-model/models/distribution-package.d.ts +39 -0
- package/dist/types/api-model/models/error-list.d.ts +24 -0
- package/dist/types/api-model/models/expiration-details.d.ts +30 -0
- package/dist/types/api-model/models/format-type.d.ts +20 -0
- package/dist/types/api-model/models/inbound-eligibility-status.d.ts +21 -0
- package/dist/types/api-model/models/inbound-eligibility.d.ts +45 -0
- package/dist/types/api-model/models/inbound-order-creation-data.d.ts +51 -0
- package/dist/types/api-model/models/inbound-order-reference.d.ts +30 -0
- package/dist/types/api-model/models/inbound-order.d.ts +89 -0
- package/dist/types/api-model/models/inbound-packages.d.ts +25 -0
- package/dist/types/api-model/models/inbound-preferences.d.ts +24 -0
- package/dist/types/api-model/models/inbound-shipment-status.d.ts +26 -0
- package/dist/types/api-model/models/inbound-shipment-summary.d.ts +55 -0
- package/dist/types/api-model/models/inbound-shipment.d.ts +120 -0
- package/dist/types/api-model/models/inbound-status.d.ts +25 -0
- package/dist/types/api-model/models/index.d.ts +65 -0
- package/dist/types/api-model/models/inventory-details-visibility.d.ts +21 -0
- package/dist/types/api-model/models/inventory-details.d.ts +30 -0
- package/dist/types/api-model/models/inventory-listing.d.ts +31 -0
- package/dist/types/api-model/models/inventory-quantity.d.ts +31 -0
- package/dist/types/api-model/models/inventory-summary.d.ts +50 -0
- package/dist/types/api-model/models/inventory-unit-of-measurement.d.ts +22 -0
- package/dist/types/api-model/models/label-owner.d.ts +21 -0
- package/dist/types/api-model/models/label-status.d.ts +23 -0
- package/dist/types/api-model/models/measurement-data.d.ts +39 -0
- package/dist/types/api-model/models/model-error.d.ts +36 -0
- package/dist/types/api-model/models/order-attribute.d.ts +32 -0
- package/dist/types/api-model/models/order-ineligibility-reason.d.ts +30 -0
- package/dist/types/api-model/models/order-preference-value.d.ts +21 -0
- package/dist/types/api-model/models/order-preference.d.ts +20 -0
- package/dist/types/api-model/models/outbound-execution-error.d.ts +36 -0
- package/dist/types/api-model/models/outbound-listing.d.ts +31 -0
- package/dist/types/api-model/models/outbound-order-creation-data.d.ts +39 -0
- package/dist/types/api-model/models/outbound-order-reference.d.ts +24 -0
- package/dist/types/api-model/models/outbound-order.d.ts +108 -0
- package/dist/types/api-model/models/outbound-shipment-status.d.ts +27 -0
- package/dist/types/api-model/models/outbound-shipment.d.ts +76 -0
- package/dist/types/api-model/models/outbound-status.d.ts +28 -0
- package/dist/types/api-model/models/package-dimensions.d.ts +43 -0
- package/dist/types/api-model/models/package-volume.d.ts +31 -0
- package/dist/types/api-model/models/package-weight.d.ts +31 -0
- package/dist/types/api-model/models/page-type.d.ts +22 -0
- package/dist/types/api-model/models/prep-details.d.ts +45 -0
- package/dist/types/api-model/models/prep-instruction.d.ts +31 -0
- package/dist/types/api-model/models/prep-owner.d.ts +21 -0
- package/dist/types/api-model/models/product-attribute.d.ts +30 -0
- package/dist/types/api-model/models/product-quantity.d.ts +50 -0
- package/dist/types/api-model/models/shipment-labels.d.ts +31 -0
- package/dist/types/api-model/models/shipment-listing.d.ts +31 -0
- package/dist/types/api-model/models/shipment-sortable-field.d.ts +21 -0
- package/dist/types/api-model/models/sku-eligibility.d.ts +39 -0
- package/dist/types/api-model/models/sku-ineligibility-reason.d.ts +30 -0
- package/dist/types/api-model/models/sku-quantities-visibility.d.ts +21 -0
- package/dist/types/api-model/models/sku-quantity.d.ts +37 -0
- package/dist/types/api-model/models/sort-order.d.ts +21 -0
- package/dist/types/api-model/models/tracking-details.d.ts +37 -0
- package/dist/types/api-model/models/transportation-details.d.ts +25 -0
- package/dist/types/api-model/models/volume-unit-of-measurement.d.ts +22 -0
- package/dist/types/api-model/models/weight-unit-of-measurement.d.ts +21 -0
- package/dist/types/client.d.ts +6 -0
- package/dist/types/index.d.ts +3 -0
- package/package.json +44 -0
|
@@ -0,0 +1,311 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
3
|
+
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-05-09
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import type { InboundShipment } from '../models';
|
|
17
|
+
import type { InventoryListing } from '../models';
|
|
18
|
+
import type { ShipmentListing } from '../models';
|
|
19
|
+
/**
|
|
20
|
+
* AwdApi - axios parameter creator
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
export declare const AwdApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
|
+
/**
|
|
25
|
+
* Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [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)
|
|
26
|
+
* @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded.
|
|
27
|
+
* @param {GetInboundShipmentSkuQuantitiesEnum} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
getInboundShipment: (shipmentId: string, skuQuantities?: GetInboundShipmentSkuQuantitiesEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
/**
|
|
33
|
+
* Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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, refer to [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).
|
|
34
|
+
* @param {ListInboundShipmentsSortByEnum} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT.
|
|
35
|
+
* @param {ListInboundShipmentsSortOrderEnum} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.
|
|
36
|
+
* @param {ListInboundShipmentsShipmentStatusEnum} [shipmentStatus] Filter by inbound shipment status.
|
|
37
|
+
* @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
38
|
+
* @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
39
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
40
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
listInboundShipments: (sortBy?: ListInboundShipmentsSortByEnum, sortOrder?: ListInboundShipmentsSortOrderEnum, shipmentStatus?: ListInboundShipmentsShipmentStatusEnum, updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
|
+
/**
|
|
46
|
+
* Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [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).
|
|
47
|
+
* @param {string} [sku] Filter by seller or merchant SKU for the item.
|
|
48
|
+
* @param {ListInventorySortOrderEnum} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order.
|
|
49
|
+
* @param {ListInventoryDetailsEnum} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.
|
|
50
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
51
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
listInventory: (sku?: string, sortOrder?: ListInventorySortOrderEnum, details?: ListInventoryDetailsEnum, nextToken?: string, maxResults?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* AwdApi - functional programming interface
|
|
59
|
+
* @export
|
|
60
|
+
*/
|
|
61
|
+
export declare const AwdApiFp: (configuration?: Configuration) => {
|
|
62
|
+
/**
|
|
63
|
+
* Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [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)
|
|
64
|
+
* @param {string} shipmentId ID for the shipment. A shipment contains the cases being inbounded.
|
|
65
|
+
* @param {GetInboundShipmentSkuQuantitiesEnum} [skuQuantities] If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
getInboundShipment(shipmentId: string, skuQuantities?: GetInboundShipmentSkuQuantitiesEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundShipment>>;
|
|
70
|
+
/**
|
|
71
|
+
* Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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, refer to [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).
|
|
72
|
+
* @param {ListInboundShipmentsSortByEnum} [sortBy] Field to sort results by. By default, the response will be sorted by UPDATED_AT.
|
|
73
|
+
* @param {ListInboundShipmentsSortOrderEnum} [sortOrder] Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.
|
|
74
|
+
* @param {ListInboundShipmentsShipmentStatusEnum} [shipmentStatus] Filter by inbound shipment status.
|
|
75
|
+
* @param {string} [updatedAfter] List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
76
|
+
* @param {string} [updatedBefore] List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
77
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
78
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
79
|
+
* @param {*} [options] Override http request option.
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
*/
|
|
82
|
+
listInboundShipments(sortBy?: ListInboundShipmentsSortByEnum, sortOrder?: ListInboundShipmentsSortOrderEnum, shipmentStatus?: ListInboundShipmentsShipmentStatusEnum, updatedAfter?: string, updatedBefore?: string, maxResults?: number, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentListing>>;
|
|
83
|
+
/**
|
|
84
|
+
* Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [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).
|
|
85
|
+
* @param {string} [sku] Filter by seller or merchant SKU for the item.
|
|
86
|
+
* @param {ListInventorySortOrderEnum} [sortOrder] Sort the response in `ASCENDING` or `DESCENDING` order.
|
|
87
|
+
* @param {ListInventoryDetailsEnum} [details] Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.
|
|
88
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
89
|
+
* @param {number} [maxResults] Maximum number of results to return.
|
|
90
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
listInventory(sku?: string, sortOrder?: ListInventorySortOrderEnum, details?: ListInventoryDetailsEnum, nextToken?: string, maxResults?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InventoryListing>>;
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* AwdApi - factory interface
|
|
97
|
+
* @export
|
|
98
|
+
*/
|
|
99
|
+
export declare const AwdApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
100
|
+
/**
|
|
101
|
+
* Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [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)
|
|
102
|
+
* @param {AwdApiGetInboundShipmentRequest} requestParameters Request parameters.
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
getInboundShipment(requestParameters: AwdApiGetInboundShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<InboundShipment>;
|
|
107
|
+
/**
|
|
108
|
+
* Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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, refer to [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).
|
|
109
|
+
* @param {AwdApiListInboundShipmentsRequest} requestParameters Request parameters.
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
*/
|
|
113
|
+
listInboundShipments(requestParameters?: AwdApiListInboundShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentListing>;
|
|
114
|
+
/**
|
|
115
|
+
* Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [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).
|
|
116
|
+
* @param {AwdApiListInventoryRequest} requestParameters Request parameters.
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
listInventory(requestParameters?: AwdApiListInventoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<InventoryListing>;
|
|
121
|
+
};
|
|
122
|
+
/**
|
|
123
|
+
* Request parameters for getInboundShipment operation in AwdApi.
|
|
124
|
+
* @export
|
|
125
|
+
* @interface AwdApiGetInboundShipmentRequest
|
|
126
|
+
*/
|
|
127
|
+
export interface AwdApiGetInboundShipmentRequest {
|
|
128
|
+
/**
|
|
129
|
+
* ID for the shipment. A shipment contains the cases being inbounded.
|
|
130
|
+
* @type {string}
|
|
131
|
+
* @memberof AwdApiGetInboundShipment
|
|
132
|
+
*/
|
|
133
|
+
readonly shipmentId: string;
|
|
134
|
+
/**
|
|
135
|
+
* If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities
|
|
136
|
+
* @type {'SHOW' | 'HIDE'}
|
|
137
|
+
* @memberof AwdApiGetInboundShipment
|
|
138
|
+
*/
|
|
139
|
+
readonly skuQuantities?: GetInboundShipmentSkuQuantitiesEnum;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Request parameters for listInboundShipments operation in AwdApi.
|
|
143
|
+
* @export
|
|
144
|
+
* @interface AwdApiListInboundShipmentsRequest
|
|
145
|
+
*/
|
|
146
|
+
export interface AwdApiListInboundShipmentsRequest {
|
|
147
|
+
/**
|
|
148
|
+
* Field to sort results by. By default, the response will be sorted by UPDATED_AT.
|
|
149
|
+
* @type {'UPDATED_AT' | 'CREATED_AT'}
|
|
150
|
+
* @memberof AwdApiListInboundShipments
|
|
151
|
+
*/
|
|
152
|
+
readonly sortBy?: ListInboundShipmentsSortByEnum;
|
|
153
|
+
/**
|
|
154
|
+
* Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.
|
|
155
|
+
* @type {'ASCENDING' | 'DESCENDING'}
|
|
156
|
+
* @memberof AwdApiListInboundShipments
|
|
157
|
+
*/
|
|
158
|
+
readonly sortOrder?: ListInboundShipmentsSortOrderEnum;
|
|
159
|
+
/**
|
|
160
|
+
* Filter by inbound shipment status.
|
|
161
|
+
* @type {'CREATED' | 'SHIPPED' | 'IN_TRANSIT' | 'RECEIVING' | 'DELIVERED' | 'CLOSED' | 'CANCELLED'}
|
|
162
|
+
* @memberof AwdApiListInboundShipments
|
|
163
|
+
*/
|
|
164
|
+
readonly shipmentStatus?: ListInboundShipmentsShipmentStatusEnum;
|
|
165
|
+
/**
|
|
166
|
+
* List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
167
|
+
* @type {string}
|
|
168
|
+
* @memberof AwdApiListInboundShipments
|
|
169
|
+
*/
|
|
170
|
+
readonly updatedAfter?: string;
|
|
171
|
+
/**
|
|
172
|
+
* List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
173
|
+
* @type {string}
|
|
174
|
+
* @memberof AwdApiListInboundShipments
|
|
175
|
+
*/
|
|
176
|
+
readonly updatedBefore?: string;
|
|
177
|
+
/**
|
|
178
|
+
* Maximum number of results to return.
|
|
179
|
+
* @type {number}
|
|
180
|
+
* @memberof AwdApiListInboundShipments
|
|
181
|
+
*/
|
|
182
|
+
readonly maxResults?: number;
|
|
183
|
+
/**
|
|
184
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
185
|
+
* @type {string}
|
|
186
|
+
* @memberof AwdApiListInboundShipments
|
|
187
|
+
*/
|
|
188
|
+
readonly nextToken?: string;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Request parameters for listInventory operation in AwdApi.
|
|
192
|
+
* @export
|
|
193
|
+
* @interface AwdApiListInventoryRequest
|
|
194
|
+
*/
|
|
195
|
+
export interface AwdApiListInventoryRequest {
|
|
196
|
+
/**
|
|
197
|
+
* Filter by seller or merchant SKU for the item.
|
|
198
|
+
* @type {string}
|
|
199
|
+
* @memberof AwdApiListInventory
|
|
200
|
+
*/
|
|
201
|
+
readonly sku?: string;
|
|
202
|
+
/**
|
|
203
|
+
* Sort the response in `ASCENDING` or `DESCENDING` order.
|
|
204
|
+
* @type {'ASCENDING' | 'DESCENDING'}
|
|
205
|
+
* @memberof AwdApiListInventory
|
|
206
|
+
*/
|
|
207
|
+
readonly sortOrder?: ListInventorySortOrderEnum;
|
|
208
|
+
/**
|
|
209
|
+
* Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.
|
|
210
|
+
* @type {'SHOW' | 'HIDE'}
|
|
211
|
+
* @memberof AwdApiListInventory
|
|
212
|
+
*/
|
|
213
|
+
readonly details?: ListInventoryDetailsEnum;
|
|
214
|
+
/**
|
|
215
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
216
|
+
* @type {string}
|
|
217
|
+
* @memberof AwdApiListInventory
|
|
218
|
+
*/
|
|
219
|
+
readonly nextToken?: string;
|
|
220
|
+
/**
|
|
221
|
+
* Maximum number of results to return.
|
|
222
|
+
* @type {number}
|
|
223
|
+
* @memberof AwdApiListInventory
|
|
224
|
+
*/
|
|
225
|
+
readonly maxResults?: number;
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* AwdApi - object-oriented interface
|
|
229
|
+
* @export
|
|
230
|
+
* @class AwdApi
|
|
231
|
+
* @extends {BaseAPI}
|
|
232
|
+
*/
|
|
233
|
+
export declare class AwdApi extends BaseAPI {
|
|
234
|
+
/**
|
|
235
|
+
* Retrieves an AWD inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [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)
|
|
236
|
+
* @param {AwdApiGetInboundShipmentRequest} requestParameters Request parameters.
|
|
237
|
+
* @param {*} [options] Override http request option.
|
|
238
|
+
* @throws {RequiredError}
|
|
239
|
+
* @memberof AwdApi
|
|
240
|
+
*/
|
|
241
|
+
getInboundShipment(requestParameters: AwdApiGetInboundShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InboundShipment, any>>;
|
|
242
|
+
/**
|
|
243
|
+
* Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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, refer to [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).
|
|
244
|
+
* @param {AwdApiListInboundShipmentsRequest} requestParameters Request parameters.
|
|
245
|
+
* @param {*} [options] Override http request option.
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
* @memberof AwdApi
|
|
248
|
+
*/
|
|
249
|
+
listInboundShipments(requestParameters?: AwdApiListInboundShipmentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShipmentListing, any>>;
|
|
250
|
+
/**
|
|
251
|
+
* Lists AWD inventory associated with a merchant with the ability to apply optional filters. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to [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 {AwdApiListInventoryRequest} requestParameters Request parameters.
|
|
253
|
+
* @param {*} [options] Override http request option.
|
|
254
|
+
* @throws {RequiredError}
|
|
255
|
+
* @memberof AwdApi
|
|
256
|
+
*/
|
|
257
|
+
listInventory(requestParameters?: AwdApiListInventoryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InventoryListing, any>>;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* @export
|
|
261
|
+
*/
|
|
262
|
+
export declare const GetInboundShipmentSkuQuantitiesEnum: {
|
|
263
|
+
readonly Show: "SHOW";
|
|
264
|
+
readonly Hide: "HIDE";
|
|
265
|
+
};
|
|
266
|
+
export type GetInboundShipmentSkuQuantitiesEnum = typeof GetInboundShipmentSkuQuantitiesEnum[keyof typeof GetInboundShipmentSkuQuantitiesEnum];
|
|
267
|
+
/**
|
|
268
|
+
* @export
|
|
269
|
+
*/
|
|
270
|
+
export declare const ListInboundShipmentsSortByEnum: {
|
|
271
|
+
readonly UpdatedAt: "UPDATED_AT";
|
|
272
|
+
readonly CreatedAt: "CREATED_AT";
|
|
273
|
+
};
|
|
274
|
+
export type ListInboundShipmentsSortByEnum = typeof ListInboundShipmentsSortByEnum[keyof typeof ListInboundShipmentsSortByEnum];
|
|
275
|
+
/**
|
|
276
|
+
* @export
|
|
277
|
+
*/
|
|
278
|
+
export declare const ListInboundShipmentsSortOrderEnum: {
|
|
279
|
+
readonly Ascending: "ASCENDING";
|
|
280
|
+
readonly Descending: "DESCENDING";
|
|
281
|
+
};
|
|
282
|
+
export type ListInboundShipmentsSortOrderEnum = typeof ListInboundShipmentsSortOrderEnum[keyof typeof ListInboundShipmentsSortOrderEnum];
|
|
283
|
+
/**
|
|
284
|
+
* @export
|
|
285
|
+
*/
|
|
286
|
+
export declare const ListInboundShipmentsShipmentStatusEnum: {
|
|
287
|
+
readonly Created: "CREATED";
|
|
288
|
+
readonly Shipped: "SHIPPED";
|
|
289
|
+
readonly InTransit: "IN_TRANSIT";
|
|
290
|
+
readonly Receiving: "RECEIVING";
|
|
291
|
+
readonly Delivered: "DELIVERED";
|
|
292
|
+
readonly Closed: "CLOSED";
|
|
293
|
+
readonly Cancelled: "CANCELLED";
|
|
294
|
+
};
|
|
295
|
+
export type ListInboundShipmentsShipmentStatusEnum = typeof ListInboundShipmentsShipmentStatusEnum[keyof typeof ListInboundShipmentsShipmentStatusEnum];
|
|
296
|
+
/**
|
|
297
|
+
* @export
|
|
298
|
+
*/
|
|
299
|
+
export declare const ListInventorySortOrderEnum: {
|
|
300
|
+
readonly Ascending: "ASCENDING";
|
|
301
|
+
readonly Descending: "DESCENDING";
|
|
302
|
+
};
|
|
303
|
+
export type ListInventorySortOrderEnum = typeof ListInventorySortOrderEnum[keyof typeof ListInventorySortOrderEnum];
|
|
304
|
+
/**
|
|
305
|
+
* @export
|
|
306
|
+
*/
|
|
307
|
+
export declare const ListInventoryDetailsEnum: {
|
|
308
|
+
readonly Show: "SHOW";
|
|
309
|
+
readonly Hide: "HIDE";
|
|
310
|
+
};
|
|
311
|
+
export type ListInventoryDetailsEnum = typeof ListInventoryDetailsEnum[keyof typeof ListInventoryDetailsEnum];
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
3
|
+
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-05-09
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export * from './api/awd-api';
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
3
|
+
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-05-09
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
export declare const BASE_PATH: string;
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const COLLECTION_FORMATS: {
|
|
20
|
+
csv: string;
|
|
21
|
+
ssv: string;
|
|
22
|
+
tsv: string;
|
|
23
|
+
pipes: string;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @export
|
|
28
|
+
* @interface RequestArgs
|
|
29
|
+
*/
|
|
30
|
+
export interface RequestArgs {
|
|
31
|
+
url: string;
|
|
32
|
+
options: RawAxiosRequestConfig;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @export
|
|
37
|
+
* @class BaseAPI
|
|
38
|
+
*/
|
|
39
|
+
export declare class BaseAPI {
|
|
40
|
+
protected basePath: string;
|
|
41
|
+
protected axios: AxiosInstance;
|
|
42
|
+
protected configuration: Configuration | undefined;
|
|
43
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @export
|
|
48
|
+
* @class RequiredError
|
|
49
|
+
* @extends {Error}
|
|
50
|
+
*/
|
|
51
|
+
export declare class RequiredError extends Error {
|
|
52
|
+
field: string;
|
|
53
|
+
constructor(field: string, msg?: string);
|
|
54
|
+
}
|
|
55
|
+
interface ServerMap {
|
|
56
|
+
[key: string]: {
|
|
57
|
+
url: string;
|
|
58
|
+
description: string;
|
|
59
|
+
}[];
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const operationServerMap: ServerMap;
|
|
66
|
+
export {};
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
3
|
+
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-05-09
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from "./configuration";
|
|
13
|
+
import type { RequestArgs } from "./base";
|
|
14
|
+
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @export
|
|
49
|
+
*/
|
|
50
|
+
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export declare const toPathString: (url: URL) => string;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
3
|
+
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-05-09
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface ConfigurationParameters {
|
|
13
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
14
|
+
username?: string;
|
|
15
|
+
password?: string;
|
|
16
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
17
|
+
basePath?: string;
|
|
18
|
+
serverIndex?: number;
|
|
19
|
+
baseOptions?: any;
|
|
20
|
+
formDataCtor?: new () => any;
|
|
21
|
+
}
|
|
22
|
+
export declare class Configuration {
|
|
23
|
+
/**
|
|
24
|
+
* parameter for apiKey security
|
|
25
|
+
* @param name security name
|
|
26
|
+
* @memberof Configuration
|
|
27
|
+
*/
|
|
28
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
|
+
/**
|
|
30
|
+
* parameter for basic security
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof Configuration
|
|
34
|
+
*/
|
|
35
|
+
username?: string;
|
|
36
|
+
/**
|
|
37
|
+
* parameter for basic security
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof Configuration
|
|
41
|
+
*/
|
|
42
|
+
password?: string;
|
|
43
|
+
/**
|
|
44
|
+
* parameter for oauth2 security
|
|
45
|
+
* @param name security name
|
|
46
|
+
* @param scopes oauth2 scope
|
|
47
|
+
* @memberof Configuration
|
|
48
|
+
*/
|
|
49
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
|
+
/**
|
|
51
|
+
* override base path
|
|
52
|
+
*
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof Configuration
|
|
55
|
+
*/
|
|
56
|
+
basePath?: string;
|
|
57
|
+
/**
|
|
58
|
+
* override server index
|
|
59
|
+
*
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof Configuration
|
|
62
|
+
*/
|
|
63
|
+
serverIndex?: number;
|
|
64
|
+
/**
|
|
65
|
+
* base options for axios calls
|
|
66
|
+
*
|
|
67
|
+
* @type {any}
|
|
68
|
+
* @memberof Configuration
|
|
69
|
+
*/
|
|
70
|
+
baseOptions?: any;
|
|
71
|
+
/**
|
|
72
|
+
* The FormData constructor that will be used to create multipart form data
|
|
73
|
+
* requests. You can inject this here so that execution environments that
|
|
74
|
+
* do not support the FormData class can still run the generated client.
|
|
75
|
+
*
|
|
76
|
+
* @type {new () => FormData}
|
|
77
|
+
*/
|
|
78
|
+
formDataCtor?: new () => any;
|
|
79
|
+
constructor(param?: ConfigurationParameters);
|
|
80
|
+
/**
|
|
81
|
+
* Check if the given MIME is a JSON MIME.
|
|
82
|
+
* JSON MIME examples:
|
|
83
|
+
* application/json
|
|
84
|
+
* application/json; charset=UTF8
|
|
85
|
+
* APPLICATION/JSON
|
|
86
|
+
* application/vnd.company+json
|
|
87
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
88
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
89
|
+
*/
|
|
90
|
+
isJsonMime(mime: string): boolean;
|
|
91
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
3
|
+
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-05-09
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export * from "./api";
|
|
13
|
+
export * from "./configuration";
|
|
14
|
+
export * from "./models";
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Amazon Warehousing and Distribution
|
|
3
|
+
* The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-05-09
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Shipping address that represents the origin or destination location.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface Address
|
|
16
|
+
*/
|
|
17
|
+
export interface Address {
|
|
18
|
+
/**
|
|
19
|
+
* First line of the address text.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof Address
|
|
22
|
+
*/
|
|
23
|
+
'addressLine1': string;
|
|
24
|
+
/**
|
|
25
|
+
* Optional second line of the address text.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof Address
|
|
28
|
+
*/
|
|
29
|
+
'addressLine2'?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Optional third line of the address text.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof Address
|
|
34
|
+
*/
|
|
35
|
+
'addressLine3'?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Optional city where this address is located.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof Address
|
|
40
|
+
*/
|
|
41
|
+
'city'?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof Address
|
|
46
|
+
*/
|
|
47
|
+
'countryCode': string;
|
|
48
|
+
/**
|
|
49
|
+
* Optional county where this address is located.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof Address
|
|
52
|
+
*/
|
|
53
|
+
'county'?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Optional district where this address is located.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof Address
|
|
58
|
+
*/
|
|
59
|
+
'district'?: string;
|
|
60
|
+
/**
|
|
61
|
+
* Name of the person, business, or institution at this address.
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof Address
|
|
64
|
+
*/
|
|
65
|
+
'name': string;
|
|
66
|
+
/**
|
|
67
|
+
* Optional E.164-formatted phone number for an available contact at this address.
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof Address
|
|
70
|
+
*/
|
|
71
|
+
'phoneNumber'?: string;
|
|
72
|
+
/**
|
|
73
|
+
* Optional postal code where this address is located.
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof Address
|
|
76
|
+
*/
|
|
77
|
+
'postalCode'?: string;
|
|
78
|
+
/**
|
|
79
|
+
* State or region where this address is located. Note that this is contextual to the specified country code.
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof Address
|
|
82
|
+
*/
|
|
83
|
+
'stateOrRegion': string;
|
|
84
|
+
}
|