@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 4.0.0 → 4.0.2
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-direct-fulfillment-shipping-api.js +0 -24
- package/dist/cjs/api-model/base.js +0 -19
- package/dist/cjs/api-model/common.js +0 -37
- package/dist/cjs/api-model/configuration.js +0 -17
- package/dist/es/api-model/api/vendor-direct-fulfillment-shipping-api.js +0 -24
- package/dist/es/api-model/base.js +0 -19
- package/dist/es/api-model/common.js +0 -37
- package/dist/es/api-model/configuration.js +0 -17
- package/dist/types/api-model/api/vendor-direct-fulfillment-shipping-api.d.ts +0 -90
- package/dist/types/api-model/base.d.ts +0 -24
- package/dist/types/api-model/common.d.ts +0 -37
- package/dist/types/api-model/configuration.d.ts +0 -17
- package/dist/types/api-model/models/address.d.ts +0 -24
- package/dist/types/api-model/models/container.d.ts +0 -32
- package/dist/types/api-model/models/customer-invoice-list.d.ts +0 -9
- package/dist/types/api-model/models/customer-invoice.d.ts +0 -6
- package/dist/types/api-model/models/dimensions.d.ts +0 -10
- package/dist/types/api-model/models/get-customer-invoice-response.d.ts +0 -9
- package/dist/types/api-model/models/get-customer-invoices-response.d.ts +0 -9
- package/dist/types/api-model/models/get-packing-slip-list-response.d.ts +0 -9
- package/dist/types/api-model/models/get-packing-slip-response.d.ts +0 -9
- package/dist/types/api-model/models/get-shipping-label-list-response.d.ts +0 -9
- package/dist/types/api-model/models/get-shipping-label-response.d.ts +0 -9
- package/dist/types/api-model/models/item-quantity.d.ts +0 -6
- package/dist/types/api-model/models/item.d.ts +0 -13
- package/dist/types/api-model/models/label-data.d.ts +0 -12
- package/dist/types/api-model/models/model-error.d.ts +0 -8
- package/dist/types/api-model/models/packed-item.d.ts +0 -13
- package/dist/types/api-model/models/packing-slip-list.d.ts +0 -9
- package/dist/types/api-model/models/packing-slip.d.ts +0 -8
- package/dist/types/api-model/models/pagination.d.ts +0 -4
- package/dist/types/api-model/models/party-identification.d.ts +0 -11
- package/dist/types/api-model/models/shipment-confirmation.d.ts +0 -23
- package/dist/types/api-model/models/shipment-details.d.ts +0 -12
- package/dist/types/api-model/models/shipment-status-update.d.ts +0 -19
- package/dist/types/api-model/models/shipping-label-list.d.ts +0 -9
- package/dist/types/api-model/models/shipping-label-request.d.ts +0 -16
- package/dist/types/api-model/models/shipping-label.d.ts +0 -18
- package/dist/types/api-model/models/status-update-details-shipment-schedule.d.ts +0 -8
- package/dist/types/api-model/models/status-update-details.d.ts +0 -20
- package/dist/types/api-model/models/submit-shipment-confirmations-request.d.ts +0 -4
- package/dist/types/api-model/models/submit-shipment-confirmations-response.d.ts +0 -9
- package/dist/types/api-model/models/submit-shipment-status-updates-request.d.ts +0 -4
- package/dist/types/api-model/models/submit-shipment-status-updates-response.d.ts +0 -9
- package/dist/types/api-model/models/submit-shipping-labels-request.d.ts +0 -4
- package/dist/types/api-model/models/submit-shipping-labels-response.d.ts +0 -9
- package/dist/types/api-model/models/tax-registration-details.d.ts +0 -13
- package/dist/types/api-model/models/transaction-reference.d.ts +0 -4
- package/dist/types/api-model/models/weight.d.ts +0 -6
- package/package.json +25 -4
|
@@ -13,44 +13,24 @@ import type { Address } from './address';
|
|
|
13
13
|
import type { StatusUpdateDetailsShipmentSchedule } from './status-update-details-shipment-schedule';
|
|
14
14
|
/**
|
|
15
15
|
* Details for the shipment status update given by the vendor for the specific package.
|
|
16
|
-
* @export
|
|
17
|
-
* @interface StatusUpdateDetails
|
|
18
16
|
*/
|
|
19
17
|
export interface StatusUpdateDetails {
|
|
20
18
|
/**
|
|
21
19
|
* This is required to be provided for every package and should match with the trackingNumber sent for the shipment confirmation.
|
|
22
|
-
* @type {string}
|
|
23
|
-
* @memberof StatusUpdateDetails
|
|
24
20
|
*/
|
|
25
21
|
'trackingNumber': string;
|
|
26
22
|
/**
|
|
27
23
|
* Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof StatusUpdateDetails
|
|
30
24
|
*/
|
|
31
25
|
'statusCode': string;
|
|
32
26
|
/**
|
|
33
27
|
* Provides a reason code for the status of the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof StatusUpdateDetails
|
|
36
28
|
*/
|
|
37
29
|
'reasonCode': string;
|
|
38
30
|
/**
|
|
39
31
|
* The date and time when the shipment status was updated. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
|
|
40
|
-
* @type {string}
|
|
41
|
-
* @memberof StatusUpdateDetails
|
|
42
32
|
*/
|
|
43
33
|
'statusDateTime': string;
|
|
44
|
-
/**
|
|
45
|
-
*
|
|
46
|
-
* @type {Address}
|
|
47
|
-
* @memberof StatusUpdateDetails
|
|
48
|
-
*/
|
|
49
34
|
'statusLocationAddress': Address;
|
|
50
|
-
/**
|
|
51
|
-
*
|
|
52
|
-
* @type {StatusUpdateDetailsShipmentSchedule}
|
|
53
|
-
* @memberof StatusUpdateDetails
|
|
54
|
-
*/
|
|
55
35
|
'shipmentSchedule'?: StatusUpdateDetailsShipmentSchedule;
|
|
56
36
|
}
|
|
@@ -12,14 +12,10 @@
|
|
|
12
12
|
import type { ShipmentConfirmation } from './shipment-confirmation';
|
|
13
13
|
/**
|
|
14
14
|
* The request schema for the submitShipmentConfirmations operation.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface SubmitShipmentConfirmationsRequest
|
|
17
15
|
*/
|
|
18
16
|
export interface SubmitShipmentConfirmationsRequest {
|
|
19
17
|
/**
|
|
20
18
|
* Array of ShipmentConfirmation objects, each representing confirmation details for a specific shipment.
|
|
21
|
-
* @type {Array<ShipmentConfirmation>}
|
|
22
|
-
* @memberof SubmitShipmentConfirmationsRequest
|
|
23
19
|
*/
|
|
24
20
|
'shipmentConfirmations'?: Array<ShipmentConfirmation>;
|
|
25
21
|
}
|
|
@@ -12,20 +12,11 @@
|
|
|
12
12
|
import type { TransactionReference } from './transaction-reference';
|
|
13
13
|
/**
|
|
14
14
|
* The response schema for the submitShipmentConfirmations operation.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface SubmitShipmentConfirmationsResponse
|
|
17
15
|
*/
|
|
18
16
|
export interface SubmitShipmentConfirmationsResponse {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {TransactionReference}
|
|
22
|
-
* @memberof SubmitShipmentConfirmationsResponse
|
|
23
|
-
*/
|
|
24
17
|
'payload'?: TransactionReference;
|
|
25
18
|
/**
|
|
26
19
|
* A list of error responses returned when a request is unsuccessful.
|
|
27
|
-
* @type {Array<Error>}
|
|
28
|
-
* @memberof SubmitShipmentConfirmationsResponse
|
|
29
20
|
*/
|
|
30
21
|
'errors'?: Array<Error>;
|
|
31
22
|
}
|
|
@@ -12,14 +12,10 @@
|
|
|
12
12
|
import type { ShipmentStatusUpdate } from './shipment-status-update';
|
|
13
13
|
/**
|
|
14
14
|
* Represents the request payload for submitting updates to the status of shipments, containing an array of one or more ShipmentStatusUpdate objects.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface SubmitShipmentStatusUpdatesRequest
|
|
17
15
|
*/
|
|
18
16
|
export interface SubmitShipmentStatusUpdatesRequest {
|
|
19
17
|
/**
|
|
20
18
|
* Contains a list of one or more ShipmentStatusUpdate objects, each representing an update to the status of a specific shipment.
|
|
21
|
-
* @type {Array<ShipmentStatusUpdate>}
|
|
22
|
-
* @memberof SubmitShipmentStatusUpdatesRequest
|
|
23
19
|
*/
|
|
24
20
|
'shipmentStatusUpdates'?: Array<ShipmentStatusUpdate>;
|
|
25
21
|
}
|
|
@@ -12,20 +12,11 @@
|
|
|
12
12
|
import type { TransactionReference } from './transaction-reference';
|
|
13
13
|
/**
|
|
14
14
|
* The response schema for the submitShipmentStatusUpdates operation.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface SubmitShipmentStatusUpdatesResponse
|
|
17
15
|
*/
|
|
18
16
|
export interface SubmitShipmentStatusUpdatesResponse {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {TransactionReference}
|
|
22
|
-
* @memberof SubmitShipmentStatusUpdatesResponse
|
|
23
|
-
*/
|
|
24
17
|
'payload'?: TransactionReference;
|
|
25
18
|
/**
|
|
26
19
|
* A list of error responses returned when a request is unsuccessful.
|
|
27
|
-
* @type {Array<Error>}
|
|
28
|
-
* @memberof SubmitShipmentStatusUpdatesResponse
|
|
29
20
|
*/
|
|
30
21
|
'errors'?: Array<Error>;
|
|
31
22
|
}
|
|
@@ -12,14 +12,10 @@
|
|
|
12
12
|
import type { ShippingLabelRequest } from './shipping-label-request';
|
|
13
13
|
/**
|
|
14
14
|
* The request schema for the submitShippingLabelRequest operation.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface SubmitShippingLabelsRequest
|
|
17
15
|
*/
|
|
18
16
|
export interface SubmitShippingLabelsRequest {
|
|
19
17
|
/**
|
|
20
18
|
* An array of shipping label requests to be processed.
|
|
21
|
-
* @type {Array<ShippingLabelRequest>}
|
|
22
|
-
* @memberof SubmitShippingLabelsRequest
|
|
23
19
|
*/
|
|
24
20
|
'shippingLabelRequests'?: Array<ShippingLabelRequest>;
|
|
25
21
|
}
|
|
@@ -12,20 +12,11 @@
|
|
|
12
12
|
import type { TransactionReference } from './transaction-reference';
|
|
13
13
|
/**
|
|
14
14
|
* The response schema for the submitShippingLabelRequest operation.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface SubmitShippingLabelsResponse
|
|
17
15
|
*/
|
|
18
16
|
export interface SubmitShippingLabelsResponse {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {TransactionReference}
|
|
22
|
-
* @memberof SubmitShippingLabelsResponse
|
|
23
|
-
*/
|
|
24
17
|
'payload'?: TransactionReference;
|
|
25
18
|
/**
|
|
26
19
|
* A list of error responses returned when a request is unsuccessful.
|
|
27
|
-
* @type {Array<Error>}
|
|
28
|
-
* @memberof SubmitShippingLabelsResponse
|
|
29
20
|
*/
|
|
30
21
|
'errors'?: Array<Error>;
|
|
31
22
|
}
|
|
@@ -12,32 +12,19 @@
|
|
|
12
12
|
import type { Address } from './address';
|
|
13
13
|
/**
|
|
14
14
|
* Tax registration details of the entity.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface TaxRegistrationDetails
|
|
17
15
|
*/
|
|
18
16
|
export interface TaxRegistrationDetails {
|
|
19
17
|
/**
|
|
20
18
|
* Tax registration type for the entity.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof TaxRegistrationDetails
|
|
23
19
|
*/
|
|
24
20
|
'taxRegistrationType'?: TaxRegistrationDetailsTaxRegistrationTypeEnum;
|
|
25
21
|
/**
|
|
26
22
|
* Tax registration number for the party. For example, VAT ID.
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof TaxRegistrationDetails
|
|
29
23
|
*/
|
|
30
24
|
'taxRegistrationNumber': string;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {Address}
|
|
34
|
-
* @memberof TaxRegistrationDetails
|
|
35
|
-
*/
|
|
36
25
|
'taxRegistrationAddress'?: Address;
|
|
37
26
|
/**
|
|
38
27
|
* Tax registration message that can be used for additional tax related details.
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof TaxRegistrationDetails
|
|
41
28
|
*/
|
|
42
29
|
'taxRegistrationMessages'?: string;
|
|
43
30
|
}
|
|
@@ -11,14 +11,10 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* Response containing the transaction ID.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface TransactionReference
|
|
16
14
|
*/
|
|
17
15
|
export interface TransactionReference {
|
|
18
16
|
/**
|
|
19
17
|
* GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof TransactionReference
|
|
22
18
|
*/
|
|
23
19
|
'transactionId'?: string;
|
|
24
20
|
}
|
|
@@ -11,20 +11,14 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* The weight.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface Weight
|
|
16
14
|
*/
|
|
17
15
|
export interface Weight {
|
|
18
16
|
/**
|
|
19
17
|
* The unit of measurement.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof Weight
|
|
22
18
|
*/
|
|
23
19
|
'unitOfMeasure': WeightUnitOfMeasureEnum;
|
|
24
20
|
/**
|
|
25
21
|
* A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\\\\d*))(\\\\.\\\\d+)?([eE][+-]?\\\\d+)?$`.
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof Weight
|
|
28
22
|
*/
|
|
29
23
|
'value': string;
|
|
30
24
|
}
|
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": "4.0.
|
|
5
|
+
"version": "4.0.2",
|
|
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.16",
|
|
22
|
+
"axios": "^1.11.0"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
25
25
|
"type": "git",
|
|
@@ -40,5 +40,26 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"vendor direct fulfillment shipping api"
|
|
42
42
|
],
|
|
43
|
-
"
|
|
43
|
+
"xo": {
|
|
44
|
+
"extends": [
|
|
45
|
+
"xo-bizon"
|
|
46
|
+
],
|
|
47
|
+
"settings": {
|
|
48
|
+
"import/internal-regex": "^@sp-api-sdk/"
|
|
49
|
+
},
|
|
50
|
+
"semicolon": false,
|
|
51
|
+
"space": 2,
|
|
52
|
+
"prettier": true,
|
|
53
|
+
"ignores": [
|
|
54
|
+
"src/api-model/**"
|
|
55
|
+
],
|
|
56
|
+
"rules": {
|
|
57
|
+
"unicorn/prevent-abbreviations": "off"
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
"prettier": {
|
|
61
|
+
"printWidth": 100,
|
|
62
|
+
"jsxSingleQuote": true
|
|
63
|
+
},
|
|
64
|
+
"gitHead": "fc1b46f3bc172469e2fbbc2e0155f6fa7ce3edde"
|
|
44
65
|
}
|