@sp-api-sdk/sales-api-v1 1.7.4 → 1.7.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
The Selling Partner API for Sales provides APIs related to sales performance.
|
|
4
4
|
|
|
5
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/sales-api/sales.md).
|
|
8
|
+
|
|
9
|
+
Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_sales_api_v1.html) for this API client.
|
|
10
|
+
|
|
5
11
|
## Installing
|
|
6
12
|
|
|
7
13
|
```sh
|
|
@@ -19,26 +25,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
|
|
|
19
25
|
import {SalesApiClient} from '@sp-api-sdk/sales-api-v1'
|
|
20
26
|
|
|
21
27
|
const auth = new SellingPartnerApiAuth({
|
|
22
|
-
clientId:
|
|
23
|
-
clientSecret:
|
|
24
|
-
refreshToken: '',
|
|
25
|
-
secretAccessKey: '',
|
|
28
|
+
clientId: process.env.LWA_CLIENT_ID,
|
|
29
|
+
clientSecret: process.env.LWA_CLIENT_SECRET,
|
|
30
|
+
refreshToken: 'Atzr|…',
|
|
26
31
|
accessKeyId: '',
|
|
27
|
-
|
|
32
|
+
secretAccessKey: '',
|
|
28
33
|
role: {
|
|
29
|
-
arn: '',
|
|
30
|
-
}
|
|
34
|
+
arn: 'arn:aws:iam::…',
|
|
35
|
+
},
|
|
31
36
|
})
|
|
32
37
|
|
|
33
38
|
const client = new SalesApiClient({
|
|
34
39
|
auth,
|
|
35
|
-
region: 'eu'
|
|
40
|
+
region: 'eu',
|
|
36
41
|
})
|
|
37
42
|
```
|
|
38
43
|
|
|
39
|
-
##
|
|
44
|
+
## Rate Limiting
|
|
40
45
|
|
|
41
|
-
|
|
46
|
+
In order to retry rate limited requests (HTTP 429), you can configure the API client as such:
|
|
42
47
|
|
|
43
48
|
```javascript
|
|
44
49
|
const client = new SalesApiClient({
|
|
@@ -46,13 +51,28 @@ const client = new SalesApiClient({
|
|
|
46
51
|
region: 'eu',
|
|
47
52
|
rateLimiting: {
|
|
48
53
|
retry: true,
|
|
49
|
-
|
|
50
|
-
|
|
54
|
+
// Optionally specify a callback that will be called on every retry.
|
|
55
|
+
onRetry: (retryInfo) => {
|
|
56
|
+
console.log(retryInfo)
|
|
57
|
+
},
|
|
58
|
+
},
|
|
51
59
|
})
|
|
52
60
|
```
|
|
53
61
|
|
|
54
|
-
The
|
|
62
|
+
The rate limits used for each route are specified in the [API documentation]((https://github.com/amzn/selling-partner-api-docs/tree/main/references/sales-api/sales.md)).
|
|
63
|
+
|
|
64
|
+
## License
|
|
65
|
+
|
|
66
|
+
MIT
|
|
55
67
|
|
|
56
|
-
##
|
|
68
|
+
## Miscellaneous
|
|
57
69
|
|
|
58
|
-
|
|
70
|
+
```
|
|
71
|
+
╚⊙ ⊙╝
|
|
72
|
+
╚═(███)═╝
|
|
73
|
+
╚═(███)═╝
|
|
74
|
+
╚═(███)═╝
|
|
75
|
+
╚═(███)═╝
|
|
76
|
+
╚═(███)═╝
|
|
77
|
+
╚═(███)═╝
|
|
78
|
+
```
|
|
@@ -151,5 +151,5 @@ export declare class SalesApi extends BaseAPI {
|
|
|
151
151
|
* @throws {RequiredError}
|
|
152
152
|
* @memberof SalesApi
|
|
153
153
|
*/
|
|
154
|
-
getOrderMetrics(requestParameters: SalesApiGetOrderMetricsRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderMetricsResponse>>;
|
|
154
|
+
getOrderMetrics(requestParameters: SalesApiGetOrderMetricsRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderMetricsResponse, any>>;
|
|
155
155
|
}
|
|
@@ -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 | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any, any>>;
|
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
|
|
1
|
+
import type { ClientConfiguration, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
|
|
3
2
|
import { SalesApi } from './api-model';
|
|
4
3
|
export declare const RATE_LIMITS: RateLimit[];
|
|
5
4
|
export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
|
|
6
5
|
rateLimiting?: {
|
|
7
6
|
retry: boolean;
|
|
8
|
-
onRetry?:
|
|
7
|
+
onRetry?: OnRetryHandler;
|
|
9
8
|
};
|
|
10
9
|
}
|
|
11
10
|
export declare class SalesApiClient extends SalesApi {
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/sales-api-v1",
|
|
3
3
|
"author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Sales provides APIs related to sales performance.",
|
|
5
|
-
"version": "1.7.
|
|
5
|
+
"version": "1.7.5",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
"test": "NODE_ENV='test' yarn jest"
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@sp-api-sdk/auth": "^1.9.
|
|
29
|
-
"@sp-api-sdk/common": "^1.7.
|
|
30
|
-
"axios": "^0.
|
|
28
|
+
"@sp-api-sdk/auth": "^1.9.5",
|
|
29
|
+
"@sp-api-sdk/common": "^1.7.7",
|
|
30
|
+
"axios": "^0.24.0"
|
|
31
31
|
},
|
|
32
32
|
"repository": {
|
|
33
33
|
"type": "git",
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"sp sdk",
|
|
49
49
|
"sales api"
|
|
50
50
|
],
|
|
51
|
-
"gitHead": "
|
|
51
|
+
"gitHead": "e8c21d7d481263e8a6663ee11f6708d4dc6968b6"
|
|
52
52
|
}
|