@sp-api-sdk/orders-api-v0 1.8.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/LICENSE +21 -0
- package/README.md +58 -0
- package/dist/cjs/index.js +6 -0
- package/dist/cjs/src/api-model/api/orders-v0-api.js +513 -0
- package/dist/cjs/src/api-model/api.js +17 -0
- package/dist/cjs/src/api-model/base.js +62 -0
- package/dist/cjs/src/api-model/common.js +137 -0
- package/dist/cjs/src/api-model/configuration.js +42 -0
- package/dist/cjs/src/api-model/index.js +19 -0
- package/dist/cjs/src/api-model/models/address.js +25 -0
- package/dist/cjs/src/api-model/models/buyer-customized-info-detail.js +15 -0
- package/dist/cjs/src/api-model/models/buyer-info.js +15 -0
- package/dist/cjs/src/api-model/models/buyer-tax-info.js +15 -0
- package/dist/cjs/src/api-model/models/fulfillment-instruction.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-address-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-buyer-info-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-items-buyer-info-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-items-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-orders-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +31 -0
- package/dist/cjs/src/api-model/models/item-buyer-info.js +15 -0
- package/dist/cjs/src/api-model/models/marketplace-tax-info.js +15 -0
- package/dist/cjs/src/api-model/models/model-error.js +15 -0
- package/dist/cjs/src/api-model/models/money.js +15 -0
- package/dist/cjs/src/api-model/models/order-address.js +15 -0
- package/dist/cjs/src/api-model/models/order-buyer-info.js +15 -0
- package/dist/cjs/src/api-model/models/order-item-buyer-info.js +15 -0
- package/dist/cjs/src/api-model/models/order-item.js +25 -0
- package/dist/cjs/src/api-model/models/order-items-buyer-info-list.js +15 -0
- package/dist/cjs/src/api-model/models/order-items-list.js +15 -0
- package/dist/cjs/src/api-model/models/order.js +62 -0
- package/dist/cjs/src/api-model/models/orders-list.js +15 -0
- package/dist/cjs/src/api-model/models/payment-execution-detail-item.js +15 -0
- package/dist/cjs/src/api-model/models/points-granted-detail.js +15 -0
- package/dist/cjs/src/api-model/models/product-info-detail.js +15 -0
- package/dist/cjs/src/api-model/models/tax-classification.js +15 -0
- package/dist/cjs/src/api-model/models/tax-collection.js +32 -0
- package/dist/cjs/src/client.js +65 -0
- package/dist/cjs/src/error.js +10 -0
- package/dist/es/index.js +3 -0
- package/dist/es/src/api-model/api/orders-v0-api.js +505 -0
- package/dist/es/src/api-model/api.js +14 -0
- package/dist/es/src/api-model/base.js +56 -0
- package/dist/es/src/api-model/common.js +125 -0
- package/dist/es/src/api-model/configuration.js +38 -0
- package/dist/es/src/api-model/index.js +16 -0
- package/dist/es/src/api-model/models/address.js +22 -0
- package/dist/es/src/api-model/models/buyer-customized-info-detail.js +14 -0
- package/dist/es/src/api-model/models/buyer-info.js +14 -0
- package/dist/es/src/api-model/models/buyer-tax-info.js +14 -0
- package/dist/es/src/api-model/models/fulfillment-instruction.js +14 -0
- package/dist/es/src/api-model/models/get-order-address-response.js +14 -0
- package/dist/es/src/api-model/models/get-order-buyer-info-response.js +14 -0
- package/dist/es/src/api-model/models/get-order-items-buyer-info-response.js +14 -0
- package/dist/es/src/api-model/models/get-order-items-response.js +14 -0
- package/dist/es/src/api-model/models/get-order-response.js +14 -0
- package/dist/es/src/api-model/models/get-orders-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +28 -0
- package/dist/es/src/api-model/models/item-buyer-info.js +14 -0
- package/dist/es/src/api-model/models/marketplace-tax-info.js +14 -0
- package/dist/es/src/api-model/models/model-error.js +14 -0
- package/dist/es/src/api-model/models/money.js +14 -0
- package/dist/es/src/api-model/models/order-address.js +14 -0
- package/dist/es/src/api-model/models/order-buyer-info.js +14 -0
- package/dist/es/src/api-model/models/order-item-buyer-info.js +14 -0
- package/dist/es/src/api-model/models/order-item.js +22 -0
- package/dist/es/src/api-model/models/order-items-buyer-info-list.js +14 -0
- package/dist/es/src/api-model/models/order-items-list.js +14 -0
- package/dist/es/src/api-model/models/order.js +59 -0
- package/dist/es/src/api-model/models/orders-list.js +14 -0
- package/dist/es/src/api-model/models/payment-execution-detail-item.js +14 -0
- package/dist/es/src/api-model/models/points-granted-detail.js +14 -0
- package/dist/es/src/api-model/models/product-info-detail.js +14 -0
- package/dist/es/src/api-model/models/tax-classification.js +14 -0
- package/dist/es/src/api-model/models/tax-collection.js +29 -0
- package/dist/es/src/client.js +61 -0
- package/dist/es/src/error.js +6 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +460 -0
- package/dist/types/src/api-model/api.d.ts +12 -0
- package/dist/types/src/api-model/base.d.ts +55 -0
- package/dist/types/src/api-model/common.d.ts +65 -0
- package/dist/types/src/api-model/configuration.d.ts +83 -0
- package/dist/types/src/api-model/index.d.ts +14 -0
- package/dist/types/src/api-model/models/address.d.ts +104 -0
- package/dist/types/src/api-model/models/buyer-customized-info-detail.d.ts +24 -0
- package/dist/types/src/api-model/models/buyer-info.d.ts +49 -0
- package/dist/types/src/api-model/models/buyer-tax-info.d.ts +37 -0
- package/dist/types/src/api-model/models/fulfillment-instruction.d.ts +24 -0
- package/dist/types/src/api-model/models/get-order-address-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-order-buyer-info-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-order-items-buyer-info-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-order-items-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-order-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-orders-response.d.ts +31 -0
- package/dist/types/src/api-model/models/index.d.ts +28 -0
- package/dist/types/src/api-model/models/item-buyer-info.d.ts +50 -0
- package/dist/types/src/api-model/models/marketplace-tax-info.d.ts +25 -0
- package/dist/types/src/api-model/models/model-error.d.ts +36 -0
- package/dist/types/src/api-model/models/money.d.ts +30 -0
- package/dist/types/src/api-model/models/order-address.d.ts +31 -0
- package/dist/types/src/api-model/models/order-buyer-info.d.ts +55 -0
- package/dist/types/src/api-model/models/order-item-buyer-info.d.ts +56 -0
- package/dist/types/src/api-model/models/order-item.d.ts +229 -0
- package/dist/types/src/api-model/models/order-items-buyer-info-list.d.ts +37 -0
- package/dist/types/src/api-model/models/order-items-list.d.ts +37 -0
- package/dist/types/src/api-model/models/order.d.ts +306 -0
- package/dist/types/src/api-model/models/orders-list.d.ts +43 -0
- package/dist/types/src/api-model/models/payment-execution-detail-item.d.ts +31 -0
- package/dist/types/src/api-model/models/points-granted-detail.d.ts +31 -0
- package/dist/types/src/api-model/models/product-info-detail.d.ts +24 -0
- package/dist/types/src/api-model/models/tax-classification.d.ts +30 -0
- package/dist/types/src/api-model/models/tax-collection.d.ts +44 -0
- package/dist/types/src/client.d.ts +13 -0
- package/dist/types/src/error.d.ts +3 -0
- package/package.json +53 -0
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Orders
|
|
3
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v0
|
|
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 { Order } from './order';
|
|
13
|
+
/**
|
|
14
|
+
* A list of orders along with additional information to make subsequent API calls.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface OrdersList
|
|
17
|
+
*/
|
|
18
|
+
export interface OrdersList {
|
|
19
|
+
/**
|
|
20
|
+
* A list of orders.
|
|
21
|
+
* @type {Array<Order>}
|
|
22
|
+
* @memberof OrdersList
|
|
23
|
+
*/
|
|
24
|
+
Orders: Array<Order>;
|
|
25
|
+
/**
|
|
26
|
+
* When present and not empty, pass this string token in the next request to return the next response page.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof OrdersList
|
|
29
|
+
*/
|
|
30
|
+
NextToken?: string;
|
|
31
|
+
/**
|
|
32
|
+
* A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. All dates must be in ISO 8601 format.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof OrdersList
|
|
35
|
+
*/
|
|
36
|
+
LastUpdatedBefore?: string;
|
|
37
|
+
/**
|
|
38
|
+
* A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof OrdersList
|
|
41
|
+
*/
|
|
42
|
+
CreatedBefore?: string;
|
|
43
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Orders
|
|
3
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v0
|
|
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 { Money } from './money';
|
|
13
|
+
/**
|
|
14
|
+
* Information about a sub-payment method used to pay for a COD order.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface PaymentExecutionDetailItem
|
|
17
|
+
*/
|
|
18
|
+
export interface PaymentExecutionDetailItem {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {Money}
|
|
22
|
+
* @memberof PaymentExecutionDetailItem
|
|
23
|
+
*/
|
|
24
|
+
Payment: Money;
|
|
25
|
+
/**
|
|
26
|
+
* A sub-payment method for a COD order. Possible values: * COD - Cash On Delivery. * GC - Gift Card. * PointsAccount - Amazon Points.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof PaymentExecutionDetailItem
|
|
29
|
+
*/
|
|
30
|
+
PaymentMethod: string;
|
|
31
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Orders
|
|
3
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v0
|
|
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 { Money } from './money';
|
|
13
|
+
/**
|
|
14
|
+
* The number of Amazon Points offered with the purchase of an item, and their monetary value.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface PointsGrantedDetail
|
|
17
|
+
*/
|
|
18
|
+
export interface PointsGrantedDetail {
|
|
19
|
+
/**
|
|
20
|
+
* The number of Amazon Points granted with the purchase of an item.
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof PointsGrantedDetail
|
|
23
|
+
*/
|
|
24
|
+
PointsNumber?: number;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {Money}
|
|
28
|
+
* @memberof PointsGrantedDetail
|
|
29
|
+
*/
|
|
30
|
+
PointsMonetaryValue?: Money;
|
|
31
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Orders
|
|
3
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v0
|
|
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
|
+
* Product information on the number of items.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ProductInfoDetail
|
|
16
|
+
*/
|
|
17
|
+
export interface ProductInfoDetail {
|
|
18
|
+
/**
|
|
19
|
+
* The total number of items that are included in the ASIN.
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof ProductInfoDetail
|
|
22
|
+
*/
|
|
23
|
+
NumberOfItems?: number;
|
|
24
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Orders
|
|
3
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v0
|
|
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
|
+
* The tax classification for the order.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface TaxClassification
|
|
16
|
+
*/
|
|
17
|
+
export interface TaxClassification {
|
|
18
|
+
/**
|
|
19
|
+
* The type of tax.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof TaxClassification
|
|
22
|
+
*/
|
|
23
|
+
Name?: string;
|
|
24
|
+
/**
|
|
25
|
+
* The buyer\'s tax identifier.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof TaxClassification
|
|
28
|
+
*/
|
|
29
|
+
Value?: string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Orders
|
|
3
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v0
|
|
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
|
+
* Information about withheld taxes.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface TaxCollection
|
|
16
|
+
*/
|
|
17
|
+
export interface TaxCollection {
|
|
18
|
+
/**
|
|
19
|
+
* The tax collection model applied to the item.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof TaxCollection
|
|
22
|
+
*/
|
|
23
|
+
Model?: TaxCollectionModelEnum;
|
|
24
|
+
/**
|
|
25
|
+
* The party responsible for withholding the taxes and remitting them to the taxing authority.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof TaxCollection
|
|
28
|
+
*/
|
|
29
|
+
ResponsibleParty?: TaxCollectionResponsiblePartyEnum;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* @export
|
|
33
|
+
* @enum {string}
|
|
34
|
+
*/
|
|
35
|
+
export declare enum TaxCollectionModelEnum {
|
|
36
|
+
MarketplaceFacilitator = "MarketplaceFacilitator"
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* @export
|
|
40
|
+
* @enum {string}
|
|
41
|
+
*/
|
|
42
|
+
export declare enum TaxCollectionResponsiblePartyEnum {
|
|
43
|
+
AmazonServicesInc = "Amazon Services, Inc."
|
|
44
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { onRetry } from '@sp-api-sdk/common';
|
|
2
|
+
import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
|
|
3
|
+
import { OrdersV0Api } from './api-model';
|
|
4
|
+
export declare const RATE_LIMITS: RateLimit[];
|
|
5
|
+
export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
|
|
6
|
+
rateLimiting?: {
|
|
7
|
+
retry: boolean;
|
|
8
|
+
onRetry?: onRetry;
|
|
9
|
+
};
|
|
10
|
+
}
|
|
11
|
+
export declare class OrdersApiClient extends OrdersV0Api {
|
|
12
|
+
constructor(parameters: ClientParameters);
|
|
13
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@sp-api-sdk/orders-api-v0",
|
|
3
|
+
"author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
|
|
4
|
+
"description": "The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.",
|
|
5
|
+
"version": "1.8.5",
|
|
6
|
+
"main": "dist/cjs/index.js",
|
|
7
|
+
"module": "dist/es/index.js",
|
|
8
|
+
"types": "dist/types/index.d.ts",
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"publishConfig": {
|
|
11
|
+
"access": "public"
|
|
12
|
+
},
|
|
13
|
+
"directories": {
|
|
14
|
+
"lib": "dist"
|
|
15
|
+
},
|
|
16
|
+
"files": [
|
|
17
|
+
"dist/**/*.js",
|
|
18
|
+
"dist/**/*.d.ts"
|
|
19
|
+
],
|
|
20
|
+
"scripts": {
|
|
21
|
+
"build:cjs": "tsc -p tsconfig.json",
|
|
22
|
+
"build:es": "tsc -p tsconfig.es.json",
|
|
23
|
+
"build": "yarn build:cjs && yarn build:es",
|
|
24
|
+
"clean": "rimraf dist",
|
|
25
|
+
"lint": "xo --cwd=../../ $PWD",
|
|
26
|
+
"test": "NODE_ENV='test' yarn jest"
|
|
27
|
+
},
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@sp-api-sdk/auth": "^1.9.1",
|
|
30
|
+
"@sp-api-sdk/common": "^1.7.2",
|
|
31
|
+
"axios": "^0.21.1"
|
|
32
|
+
},
|
|
33
|
+
"repository": {
|
|
34
|
+
"type": "git",
|
|
35
|
+
"url": "https://github.com/bizon/selling-partner-api-sdk.git",
|
|
36
|
+
"directory": "clients/orders-api-v0"
|
|
37
|
+
},
|
|
38
|
+
"bugs": {
|
|
39
|
+
"url": "https://github.com/bizon/selling-partner-api-sdk/issues"
|
|
40
|
+
},
|
|
41
|
+
"homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/orders-api-v0",
|
|
42
|
+
"keywords": [
|
|
43
|
+
"amazon",
|
|
44
|
+
"bizon",
|
|
45
|
+
"marketplace web services",
|
|
46
|
+
"mws",
|
|
47
|
+
"selling partner api",
|
|
48
|
+
"sp api",
|
|
49
|
+
"sp sdk",
|
|
50
|
+
"orders api"
|
|
51
|
+
],
|
|
52
|
+
"gitHead": "dc4286920dc77e99d6ad71f71bcb78ae22b9ab06"
|
|
53
|
+
}
|