@sp-api-sdk/shipping-api-v2 2.0.1 → 2.1.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/shipping-api.js +274 -29
- package/dist/cjs/api-model/configuration.js +1 -2
- package/dist/cjs/api-model/models/carrier-account.js +15 -0
- package/dist/cjs/api-model/models/claim-reason.js +28 -0
- package/dist/cjs/api-model/models/create-claim-request.js +15 -0
- package/dist/cjs/api-model/models/create-claim-response.js +15 -0
- package/dist/cjs/api-model/models/detail-codes.js +53 -0
- package/dist/cjs/api-model/models/event-code.js +4 -1
- package/dist/cjs/api-model/models/goods-owner.js +15 -0
- package/dist/cjs/api-model/models/index.js +13 -0
- package/dist/cjs/api-model/models/label-attribute.js +26 -0
- package/dist/cjs/api-model/models/ndr-action.js +26 -0
- package/dist/cjs/api-model/models/ndr-request-data.js +15 -0
- package/dist/cjs/api-model/models/rate-item-id.js +6 -1
- package/dist/cjs/api-model/models/requested-label-customization.js +15 -0
- package/dist/cjs/api-model/models/settlement-type.js +25 -0
- package/dist/cjs/api-model/models/status.js +2 -1
- package/dist/cjs/api-model/models/submit-ndr-feedback-request.js +15 -0
- package/dist/cjs/api-model/models/tracking-detail-codes.js +15 -0
- package/dist/cjs/client.js +21 -0
- package/dist/es/api-model/api/shipping-api.js +273 -28
- package/dist/es/api-model/configuration.js +1 -2
- package/dist/es/api-model/models/carrier-account.js +14 -0
- package/dist/es/api-model/models/claim-reason.js +25 -0
- package/dist/es/api-model/models/create-claim-request.js +14 -0
- package/dist/es/api-model/models/create-claim-response.js +14 -0
- package/dist/es/api-model/models/detail-codes.js +50 -0
- package/dist/es/api-model/models/event-code.js +4 -1
- package/dist/es/api-model/models/goods-owner.js +14 -0
- package/dist/es/api-model/models/index.js +13 -0
- package/dist/es/api-model/models/label-attribute.js +23 -0
- package/dist/es/api-model/models/ndr-action.js +23 -0
- package/dist/es/api-model/models/ndr-request-data.js +14 -0
- package/dist/es/api-model/models/rate-item-id.js +6 -1
- package/dist/es/api-model/models/requested-label-customization.js +14 -0
- package/dist/es/api-model/models/settlement-type.js +22 -0
- package/dist/es/api-model/models/status.js +2 -1
- package/dist/es/api-model/models/submit-ndr-feedback-request.js +14 -0
- package/dist/es/api-model/models/tracking-detail-codes.js +14 -0
- package/dist/es/client.js +21 -0
- package/dist/types/api-model/api/shipping-api.d.ts +251 -42
- package/dist/types/api-model/common.d.ts +1 -1
- package/dist/types/api-model/models/access-point-details.d.ts +1 -1
- package/dist/types/api-model/models/access-point.d.ts +2 -2
- package/dist/types/api-model/models/active-account.d.ts +1 -1
- package/dist/types/api-model/models/benefits.d.ts +1 -1
- package/dist/types/api-model/models/carrier-account.d.ts +30 -0
- package/dist/types/api-model/models/claim-reason.d.ts +24 -0
- package/dist/types/api-model/models/create-claim-request.d.ts +57 -0
- package/dist/types/api-model/models/create-claim-response.d.ts +24 -0
- package/dist/types/api-model/models/detail-codes.d.ts +49 -0
- package/dist/types/api-model/models/error-list.d.ts +1 -1
- package/dist/types/api-model/models/event-code.d.ts +3 -0
- package/dist/types/api-model/models/event.d.ts +7 -0
- package/dist/types/api-model/models/excluded-benefit.d.ts +5 -5
- package/dist/types/api-model/models/get-rates-request.d.ts +7 -0
- package/dist/types/api-model/models/get-shipment-documents-result.d.ts +7 -0
- package/dist/types/api-model/models/goods-owner.d.ts +24 -0
- package/dist/types/api-model/models/index.d.ts +13 -0
- package/dist/types/api-model/models/label-attribute.d.ts +22 -0
- package/dist/types/api-model/models/link-carrier-account-response.d.ts +6 -0
- package/dist/types/api-model/models/ndr-action.d.ts +22 -0
- package/dist/types/api-model/models/ndr-request-data.d.ts +30 -0
- package/dist/types/api-model/models/one-click-shipment-request.d.ts +7 -0
- package/dist/types/api-model/models/operating-hours.d.ts +1 -1
- package/dist/types/api-model/models/purchase-shipment-result.d.ts +7 -0
- package/dist/types/api-model/models/rate-item-id.d.ts +5 -0
- package/dist/types/api-model/models/requested-document-specification.d.ts +7 -0
- package/dist/types/api-model/models/requested-label-customization.d.ts +25 -0
- package/dist/types/api-model/models/settlement-type.d.ts +21 -0
- package/dist/types/api-model/models/status.d.ts +1 -0
- package/dist/types/api-model/models/submit-ndr-feedback-request.d.ts +38 -0
- package/dist/types/api-model/models/time-of-day.d.ts +3 -3
- package/dist/types/api-model/models/tracking-detail-codes.d.ts +31 -0
- package/dist/types/api-model/models/tracking-summary.d.ts +7 -0
- package/dist/types/api-model/models/unlink-carrier-account-request.d.ts +6 -0
- package/package.json +4 -4
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
@@ -57,13 +57,13 @@ export interface AccessPoint {
|
|
|
57
57
|
*/
|
|
58
58
|
'address'?: Address;
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
60
|
+
* Exception operating hours for Access Point
|
|
61
61
|
* @type {Array<ExceptionOperatingHours>}
|
|
62
62
|
* @memberof AccessPoint
|
|
63
63
|
*/
|
|
64
64
|
'exceptionOperatingHours'?: Array<ExceptionOperatingHours>;
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
66
|
+
* Assistance type enum for Access point i.e. STAFF_ASSISTED or SELF_ASSISTED
|
|
67
67
|
* @type {string}
|
|
68
68
|
* @memberof AccessPoint
|
|
69
69
|
*/
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { ExcludedBenefit } from './excluded-benefit';
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface Benefits
|
|
17
17
|
*/
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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
|
+
* Carrier Account details used to fetch rates.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface CarrierAccount
|
|
16
|
+
*/
|
|
17
|
+
export interface CarrierAccount {
|
|
18
|
+
/**
|
|
19
|
+
* Identifier for the seller\'s carrier account.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof CarrierAccount
|
|
22
|
+
*/
|
|
23
|
+
'carrierAccountId': string;
|
|
24
|
+
/**
|
|
25
|
+
* The carrier identifier for the offering, provided by the carrier.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof CarrierAccount
|
|
28
|
+
*/
|
|
29
|
+
'carrierId': string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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
|
+
* The reason for which shipper is filing the claim for a particular shipment.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const ClaimReason: {
|
|
18
|
+
readonly LostInTransit: "LOST_IN_TRANSIT";
|
|
19
|
+
readonly DamagedInTransit: "DAMAGED_IN_TRANSIT";
|
|
20
|
+
readonly DeliveredNotReceived: "DELIVERED_NOT_RECEIVED";
|
|
21
|
+
readonly ItemMissingSwitcheroo: "ITEM_MISSING_SWITCHEROO";
|
|
22
|
+
readonly CodAbuse: "COD_ABUSE";
|
|
23
|
+
};
|
|
24
|
+
export type ClaimReason = typeof ClaimReason[keyof typeof ClaimReason];
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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 { ClaimReason } from './claim-reason';
|
|
13
|
+
import type { Currency } from './currency';
|
|
14
|
+
import type { SettlementType } from './settlement-type';
|
|
15
|
+
/**
|
|
16
|
+
* The request schema for the CreateClaim operation
|
|
17
|
+
* @export
|
|
18
|
+
* @interface CreateClaimRequest
|
|
19
|
+
*/
|
|
20
|
+
export interface CreateClaimRequest {
|
|
21
|
+
/**
|
|
22
|
+
* The carrier generated identifier for a package in a purchased shipment.
|
|
23
|
+
* @type {string}
|
|
24
|
+
* @memberof CreateClaimRequest
|
|
25
|
+
*/
|
|
26
|
+
'trackingId': string;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {Currency}
|
|
30
|
+
* @memberof CreateClaimRequest
|
|
31
|
+
*/
|
|
32
|
+
'declaredValue'?: Currency;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {ClaimReason}
|
|
36
|
+
* @memberof CreateClaimRequest
|
|
37
|
+
*/
|
|
38
|
+
'claimReason': ClaimReason;
|
|
39
|
+
/**
|
|
40
|
+
* Applicable for only On Amazon shipments to identify if replacement was sent
|
|
41
|
+
* @type {boolean}
|
|
42
|
+
* @memberof CreateClaimRequest
|
|
43
|
+
*/
|
|
44
|
+
'isReplacementPackageSent'?: boolean;
|
|
45
|
+
/**
|
|
46
|
+
* A list of proof URLs for a claim. Basic URL validation will happen for each URLs present in the list
|
|
47
|
+
* @type {Array<string>}
|
|
48
|
+
* @memberof CreateClaimRequest
|
|
49
|
+
*/
|
|
50
|
+
'proofs'?: Array<string>;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @type {SettlementType}
|
|
54
|
+
* @memberof CreateClaimRequest
|
|
55
|
+
*/
|
|
56
|
+
'settlementType': SettlementType;
|
|
57
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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
|
+
* The response schema for the createClaim operation.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface CreateClaimResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface CreateClaimResponse {
|
|
18
|
+
/**
|
|
19
|
+
* The claim identifier originally returned by the createClaim operation.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof CreateClaimResponse
|
|
22
|
+
*/
|
|
23
|
+
'claimId'?: string;
|
|
24
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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
|
+
* A list of codes used to provide additional shipment information.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const DetailCodes: {
|
|
18
|
+
readonly BusinessClosed: "BusinessClosed";
|
|
19
|
+
readonly CustomerUnavailable: "CustomerUnavailable";
|
|
20
|
+
readonly PaymentNotReady: "PaymentNotReady";
|
|
21
|
+
readonly OtpNotAvailable: "OtpNotAvailable";
|
|
22
|
+
readonly DeliveryAttempted: "DeliveryAttempted";
|
|
23
|
+
readonly UnableToAccess: "UnableToAccess";
|
|
24
|
+
readonly UnableToContactRecipient: "UnableToContactRecipient";
|
|
25
|
+
readonly DeliveredToBehindWheelieBin: "DeliveredToBehindWheelieBin";
|
|
26
|
+
readonly DeliveredToPorch: "DeliveredToPorch";
|
|
27
|
+
readonly DeliveredToGarage: "DeliveredToGarage";
|
|
28
|
+
readonly DeliveredToGarden: "DeliveredToGarden";
|
|
29
|
+
readonly DeliveredToGreenhouse: "DeliveredToGreenhouse";
|
|
30
|
+
readonly DeliveredToMailSlot: "DeliveredToMailSlot";
|
|
31
|
+
readonly DeliveredToMailRoom: "DeliveredToMailRoom";
|
|
32
|
+
readonly DeliveredToNeighbor: "DeliveredToNeighbor";
|
|
33
|
+
readonly DeliveredToRearDoor: "DeliveredToRearDoor";
|
|
34
|
+
readonly DeliveredToReceptionist: "DeliveredToReceptionist";
|
|
35
|
+
readonly DeliveredToShed: "DeliveredToShed";
|
|
36
|
+
readonly DeliveredWithOtp: "DeliveredWithOTP";
|
|
37
|
+
readonly Signed: "Signed";
|
|
38
|
+
readonly Damaged: "Damaged";
|
|
39
|
+
readonly IncorrectItems: "IncorrectItems";
|
|
40
|
+
readonly NotRequired: "NotRequired";
|
|
41
|
+
readonly Rejected: "Rejected";
|
|
42
|
+
readonly RejectedByRecipientWithVerification: "RejectedByRecipientWithVerification";
|
|
43
|
+
readonly CancelledByRecipient: "CancelledByRecipient";
|
|
44
|
+
readonly AddressNotFound: "AddressNotFound";
|
|
45
|
+
readonly HazmatShipment: "HazmatShipment";
|
|
46
|
+
readonly Undeliverable: "Undeliverable";
|
|
47
|
+
readonly ArrivedAtLocalFacility: "ArrivedAtLocalFacility";
|
|
48
|
+
};
|
|
49
|
+
export type DetailCodes = typeof DetailCodes[keyof typeof DetailCodes];
|
|
@@ -26,5 +26,8 @@ export declare const EventCode: {
|
|
|
26
26
|
readonly Rejected: "Rejected";
|
|
27
27
|
readonly Undeliverable: "Undeliverable";
|
|
28
28
|
readonly PickupCancelled: "PickupCancelled";
|
|
29
|
+
readonly ReturnInitiated: "ReturnInitiated";
|
|
30
|
+
readonly AvailableForPickup: "AvailableForPickup";
|
|
31
|
+
readonly RecipientRequestedAlternateDeliveryTiming: "RecipientRequestedAlternateDeliveryTiming";
|
|
29
32
|
};
|
|
30
33
|
export type EventCode = typeof EventCode[keyof typeof EventCode];
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { EventCode } from './event-code';
|
|
13
13
|
import type { Location } from './location';
|
|
14
|
+
import type { ShipmentType } from './shipment-type';
|
|
14
15
|
/**
|
|
15
16
|
* A tracking event.
|
|
16
17
|
* @export
|
|
@@ -35,4 +36,10 @@ export interface Event {
|
|
|
35
36
|
* @memberof Event
|
|
36
37
|
*/
|
|
37
38
|
'eventTime': string;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @type {ShipmentType}
|
|
42
|
+
* @memberof Event
|
|
43
|
+
*/
|
|
44
|
+
'shipmentType'?: ShipmentType;
|
|
38
45
|
}
|
|
@@ -10,21 +10,21 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* Object representing
|
|
13
|
+
* Object representing a benefit that is excluded for a shipping offer or rate.
|
|
14
14
|
* @export
|
|
15
15
|
* @interface ExcludedBenefit
|
|
16
16
|
*/
|
|
17
17
|
export interface ExcludedBenefit {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* benefit
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof ExcludedBenefit
|
|
22
22
|
*/
|
|
23
23
|
'benefit': string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
26
|
-
* @type {string}
|
|
25
|
+
* List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.
|
|
26
|
+
* @type {Array<string>}
|
|
27
27
|
* @memberof ExcludedBenefit
|
|
28
28
|
*/
|
|
29
|
-
'
|
|
29
|
+
'reasonCodes'?: Array<string>;
|
|
30
30
|
}
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { AccessPointDetails } from './access-point-details';
|
|
13
13
|
import type { Address } from './address';
|
|
14
|
+
import type { CarrierAccount } from './carrier-account';
|
|
14
15
|
import type { ChannelDetails } from './channel-details';
|
|
15
16
|
import type { ClientReferenceDetail } from './client-reference-detail';
|
|
16
17
|
import type { Package } from './package';
|
|
@@ -96,4 +97,10 @@ export interface GetRatesRequest {
|
|
|
96
97
|
* @memberof GetRatesRequest
|
|
97
98
|
*/
|
|
98
99
|
'destinationAccessPointDetails'?: AccessPointDetails;
|
|
100
|
+
/**
|
|
101
|
+
* A list of CarrierAccounts
|
|
102
|
+
* @type {Array<CarrierAccount>}
|
|
103
|
+
* @memberof GetRatesRequest
|
|
104
|
+
*/
|
|
105
|
+
'carrierAccounts'?: Array<CarrierAccount>;
|
|
99
106
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { Benefits } from './benefits';
|
|
12
13
|
import type { PackageDocumentDetail } from './package-document-detail';
|
|
13
14
|
/**
|
|
14
15
|
* The payload for the getShipmentDocuments operation.
|
|
@@ -28,4 +29,10 @@ export interface GetShipmentDocumentsResult {
|
|
|
28
29
|
* @memberof GetShipmentDocumentsResult
|
|
29
30
|
*/
|
|
30
31
|
'packageDocumentDetail': PackageDocumentDetail;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {Benefits}
|
|
35
|
+
* @memberof GetShipmentDocumentsResult
|
|
36
|
+
*/
|
|
37
|
+
'benefits'?: Benefits;
|
|
31
38
|
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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
|
+
* The seller owning the goods before handing them over to the carrier
|
|
14
|
+
* @export
|
|
15
|
+
* @interface GoodsOwner
|
|
16
|
+
*/
|
|
17
|
+
export interface GoodsOwner {
|
|
18
|
+
/**
|
|
19
|
+
* merchant Id of provided merchant
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof GoodsOwner
|
|
22
|
+
*/
|
|
23
|
+
'merchantId': string;
|
|
24
|
+
}
|
|
@@ -12,18 +12,23 @@ export * from './available-value-added-service-group';
|
|
|
12
12
|
export * from './benefits';
|
|
13
13
|
export * from './cancel-shipment-response';
|
|
14
14
|
export * from './carrier';
|
|
15
|
+
export * from './carrier-account';
|
|
15
16
|
export * from './carrier-account-attribute';
|
|
16
17
|
export * from './carrier-account-input';
|
|
17
18
|
export * from './channel-details';
|
|
18
19
|
export * from './channel-type';
|
|
19
20
|
export * from './charge-component';
|
|
21
|
+
export * from './claim-reason';
|
|
20
22
|
export * from './client-reference-detail';
|
|
21
23
|
export * from './collect-on-delivery';
|
|
22
24
|
export * from './collection-forms-history-record';
|
|
23
25
|
export * from './collections-form-document';
|
|
26
|
+
export * from './create-claim-request';
|
|
27
|
+
export * from './create-claim-response';
|
|
24
28
|
export * from './currency';
|
|
25
29
|
export * from './dangerous-goods-details';
|
|
26
30
|
export * from './date-range';
|
|
31
|
+
export * from './detail-codes';
|
|
27
32
|
export * from './dimensions';
|
|
28
33
|
export * from './direct-fulfillment-item-identifiers';
|
|
29
34
|
export * from './direct-purchase-request';
|
|
@@ -59,12 +64,14 @@ export * from './get-tracking-response';
|
|
|
59
64
|
export * from './get-tracking-result';
|
|
60
65
|
export * from './get-unmanifested-shipments-request';
|
|
61
66
|
export * from './get-unmanifested-shipments-response';
|
|
67
|
+
export * from './goods-owner';
|
|
62
68
|
export * from './ineligibility-reason';
|
|
63
69
|
export * from './ineligibility-reason-code';
|
|
64
70
|
export * from './ineligible-rate';
|
|
65
71
|
export * from './input-type';
|
|
66
72
|
export * from './invoice-details';
|
|
67
73
|
export * from './item';
|
|
74
|
+
export * from './label-attribute';
|
|
68
75
|
export * from './link-carrier-account-request';
|
|
69
76
|
export * from './link-carrier-account-response';
|
|
70
77
|
export * from './linkable-account-type';
|
|
@@ -72,6 +79,8 @@ export * from './linkable-carrier';
|
|
|
72
79
|
export * from './liquid-volume';
|
|
73
80
|
export * from './location';
|
|
74
81
|
export * from './model-error';
|
|
82
|
+
export * from './ndr-action';
|
|
83
|
+
export * from './ndr-request-data';
|
|
75
84
|
export * from './one-click-shipment-request';
|
|
76
85
|
export * from './one-click-shipment-response';
|
|
77
86
|
export * from './one-click-shipment-result';
|
|
@@ -91,18 +100,22 @@ export * from './rate-item';
|
|
|
91
100
|
export * from './rate-item-id';
|
|
92
101
|
export * from './rate-item-type';
|
|
93
102
|
export * from './requested-document-specification';
|
|
103
|
+
export * from './requested-label-customization';
|
|
94
104
|
export * from './requested-value-added-service';
|
|
95
105
|
export * from './service';
|
|
96
106
|
export * from './service-selection';
|
|
107
|
+
export * from './settlement-type';
|
|
97
108
|
export * from './shipment-type';
|
|
98
109
|
export * from './shipper-instruction';
|
|
99
110
|
export * from './status';
|
|
111
|
+
export * from './submit-ndr-feedback-request';
|
|
100
112
|
export * from './supported-document-detail';
|
|
101
113
|
export * from './supported-document-specification';
|
|
102
114
|
export * from './tax-detail';
|
|
103
115
|
export * from './tax-type';
|
|
104
116
|
export * from './time-of-day';
|
|
105
117
|
export * from './time-window';
|
|
118
|
+
export * from './tracking-detail-codes';
|
|
106
119
|
export * from './tracking-summary';
|
|
107
120
|
export * from './unlink-carrier-account-request';
|
|
108
121
|
export * from './unlink-carrier-account-response';
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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
|
+
* Enumerates the attributes supported to be printed on a shipping label. The values for these attributes are retrieved from GetRates/OneClickShipment request
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const LabelAttribute: {
|
|
18
|
+
readonly PackageClientReferenceId: "PACKAGE_CLIENT_REFERENCE_ID";
|
|
19
|
+
readonly SellerDisplayName: "SELLER_DISPLAY_NAME";
|
|
20
|
+
readonly CollectOnDeliveryAmount: "COLLECT_ON_DELIVERY_AMOUNT";
|
|
21
|
+
};
|
|
22
|
+
export type LabelAttribute = typeof LabelAttribute[keyof typeof LabelAttribute];
|
|
@@ -22,4 +22,10 @@ export interface LinkCarrierAccountResponse {
|
|
|
22
22
|
* @memberof LinkCarrierAccountResponse
|
|
23
23
|
*/
|
|
24
24
|
'registrationStatus'?: AccountStatus;
|
|
25
|
+
/**
|
|
26
|
+
* Identifier for the seller\'s carrier account.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof LinkCarrierAccountResponse
|
|
29
|
+
*/
|
|
30
|
+
'accountId'?: string;
|
|
25
31
|
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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
|
+
* The type of NDR action shipper wants to take for a particular shipment.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const NdrAction: {
|
|
18
|
+
readonly Reschedule: "RESCHEDULE";
|
|
19
|
+
readonly Reattempt: "REATTEMPT";
|
|
20
|
+
readonly Rto: "RTO";
|
|
21
|
+
};
|
|
22
|
+
export type NdrAction = typeof NdrAction[keyof typeof NdrAction];
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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
|
+
* Additional information required for the NDR action that has been filed. If the NDR Action is RESCHEDULE, rescheduleDate is a required field. Otherwise, if the NDR Action is REATTEMPT, additionalAddressNotes is a required field.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface NdrRequestData
|
|
16
|
+
*/
|
|
17
|
+
export interface NdrRequestData {
|
|
18
|
+
/**
|
|
19
|
+
* The date on which the Seller wants to reschedule shipment delivery, in ISO-8601 date/time format
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof NdrRequestData
|
|
22
|
+
*/
|
|
23
|
+
'rescheduleDate'?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Address notes to re-attempt delivery with.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof NdrRequestData
|
|
28
|
+
*/
|
|
29
|
+
'additionalAddressNotes'?: string;
|
|
30
|
+
}
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { AccessPointDetails } from './access-point-details';
|
|
13
13
|
import type { Address } from './address';
|
|
14
14
|
import type { ChannelDetails } from './channel-details';
|
|
15
|
+
import type { GoodsOwner } from './goods-owner';
|
|
15
16
|
import type { OneClickShipmentValueAddedService } from './one-click-shipment-value-added-service';
|
|
16
17
|
import type { Package } from './package';
|
|
17
18
|
import type { RequestedDocumentSpecification } from './requested-document-specification';
|
|
@@ -48,6 +49,12 @@ export interface OneClickShipmentRequest {
|
|
|
48
49
|
* @memberof OneClickShipmentRequest
|
|
49
50
|
*/
|
|
50
51
|
'shipDate'?: string;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {GoodsOwner}
|
|
55
|
+
* @memberof OneClickShipmentRequest
|
|
56
|
+
*/
|
|
57
|
+
'goodsOwner'?: GoodsOwner;
|
|
51
58
|
/**
|
|
52
59
|
* A list of packages to be shipped through a shipping service offering.
|
|
53
60
|
* @type {Array<Package>}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { Benefits } from './benefits';
|
|
12
13
|
import type { PackageDocumentDetail } from './package-document-detail';
|
|
13
14
|
import type { Promise } from './promise';
|
|
14
15
|
/**
|
|
@@ -35,4 +36,10 @@ export interface PurchaseShipmentResult {
|
|
|
35
36
|
* @memberof PurchaseShipmentResult
|
|
36
37
|
*/
|
|
37
38
|
'promise': Promise;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @type {Benefits}
|
|
42
|
+
* @memberof PurchaseShipmentResult
|
|
43
|
+
*/
|
|
44
|
+
'benefits'?: Benefits;
|
|
38
45
|
}
|
|
@@ -43,5 +43,10 @@ export declare const RateItemID: {
|
|
|
43
43
|
readonly AdditionalSurcharge: "ADDITIONAL_SURCHARGE";
|
|
44
44
|
readonly Surcharge: "SURCHARGE";
|
|
45
45
|
readonly Rebate: "REBATE";
|
|
46
|
+
readonly HighCubeSurcharge: "HIGH_CUBE_SURCHARGE";
|
|
47
|
+
readonly HighLengthSurcharge: "HIGH_LENGTH_SURCHARGE";
|
|
48
|
+
readonly HighWidthSurcharge: "HIGH_WIDTH_SURCHARGE";
|
|
49
|
+
readonly DemandSurcharge: "DEMAND_SURCHARGE";
|
|
50
|
+
readonly NonstandardFee: "NONSTANDARD_FEE";
|
|
46
51
|
};
|
|
47
52
|
export type RateItemID = typeof RateItemID[keyof typeof RateItemID];
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { DocumentFormat } from './document-format';
|
|
13
13
|
import type { DocumentSize } from './document-size';
|
|
14
14
|
import type { DocumentType } from './document-type';
|
|
15
|
+
import type { RequestedLabelCustomization } from './requested-label-customization';
|
|
15
16
|
/**
|
|
16
17
|
* The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation.
|
|
17
18
|
* @export
|
|
@@ -54,4 +55,10 @@ export interface RequestedDocumentSpecification {
|
|
|
54
55
|
* @memberof RequestedDocumentSpecification
|
|
55
56
|
*/
|
|
56
57
|
'requestedDocumentTypes': Array<DocumentType>;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @type {RequestedLabelCustomization}
|
|
61
|
+
* @memberof RequestedDocumentSpecification
|
|
62
|
+
*/
|
|
63
|
+
'requestedLabelCustomization'?: RequestedLabelCustomization;
|
|
57
64
|
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
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 { LabelAttribute } from './label-attribute';
|
|
13
|
+
/**
|
|
14
|
+
* Object contains customised data requested by a shipper to be printed on a shipping label.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface RequestedLabelCustomization
|
|
17
|
+
*/
|
|
18
|
+
export interface RequestedLabelCustomization {
|
|
19
|
+
/**
|
|
20
|
+
* Specify the type of attributes to be added on a label.
|
|
21
|
+
* @type {Array<LabelAttribute>}
|
|
22
|
+
* @memberof RequestedLabelCustomization
|
|
23
|
+
*/
|
|
24
|
+
'requestAttributes'?: Array<LabelAttribute>;
|
|
25
|
+
}
|