@congminh1254/shopee-sdk 1.6.2 → 1.8.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/README.md +9 -3
- package/lib/__tests__/errors.test.d.ts +1 -0
- package/lib/__tests__/errors.test.js +49 -0
- package/lib/__tests__/errors.test.js.map +1 -0
- package/lib/__tests__/fetch.test.d.ts +1 -0
- package/lib/__tests__/fetch.test.js +494 -0
- package/lib/__tests__/fetch.test.js.map +1 -0
- package/lib/__tests__/integration.test.d.ts +1 -0
- package/lib/__tests__/integration.test.js +201 -0
- package/lib/__tests__/integration.test.js.map +1 -0
- package/lib/__tests__/managers/account-health.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/account-health.manager.test.js +446 -0
- package/lib/__tests__/managers/account-health.manager.test.js.map +1 -0
- package/lib/__tests__/managers/add-on-deal.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/add-on-deal.manager.test.js +636 -0
- package/lib/__tests__/managers/add-on-deal.manager.test.js.map +1 -0
- package/lib/__tests__/managers/ads.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/ads.manager.test.js +1016 -0
- package/lib/__tests__/managers/ads.manager.test.js.map +1 -0
- package/lib/__tests__/managers/ams.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/ams.manager.test.js +1170 -0
- package/lib/__tests__/managers/ams.manager.test.js.map +1 -0
- package/lib/__tests__/managers/auth.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/auth.manager.test.js +193 -0
- package/lib/__tests__/managers/auth.manager.test.js.map +1 -0
- package/lib/__tests__/managers/bundle-deal.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/bundle-deal.manager.test.js +465 -0
- package/lib/__tests__/managers/bundle-deal.manager.test.js.map +1 -0
- package/lib/__tests__/managers/discount.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/discount.manager.test.js +615 -0
- package/lib/__tests__/managers/discount.manager.test.js.map +1 -0
- package/lib/__tests__/managers/fbs.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/fbs.manager.test.js +349 -0
- package/lib/__tests__/managers/fbs.manager.test.js.map +1 -0
- package/lib/__tests__/managers/first-mile.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/first-mile.manager.test.js +629 -0
- package/lib/__tests__/managers/first-mile.manager.test.js.map +1 -0
- package/lib/__tests__/managers/follow-prize.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/follow-prize.manager.test.js +408 -0
- package/lib/__tests__/managers/follow-prize.manager.test.js.map +1 -0
- package/lib/__tests__/managers/global-product.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/global-product.manager.test.js +1253 -0
- package/lib/__tests__/managers/global-product.manager.test.js.map +1 -0
- package/lib/__tests__/managers/livestream.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/livestream.manager.test.js +877 -0
- package/lib/__tests__/managers/livestream.manager.test.js.map +1 -0
- package/lib/__tests__/managers/logistics.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/logistics.manager.test.js +1125 -0
- package/lib/__tests__/managers/logistics.manager.test.js.map +1 -0
- package/lib/__tests__/managers/media-space.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/media-space.manager.test.js +556 -0
- package/lib/__tests__/managers/media-space.manager.test.js.map +1 -0
- package/lib/__tests__/managers/media.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/media.manager.test.js +681 -0
- package/lib/__tests__/managers/media.manager.test.js.map +1 -0
- package/lib/__tests__/managers/merchant.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/merchant.manager.test.js +328 -0
- package/lib/__tests__/managers/merchant.manager.test.js.map +1 -0
- package/lib/__tests__/managers/order.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/order.manager.test.js +937 -0
- package/lib/__tests__/managers/order.manager.test.js.map +1 -0
- package/lib/__tests__/managers/payment.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/payment.manager.test.js +1167 -0
- package/lib/__tests__/managers/payment.manager.test.js.map +1 -0
- package/lib/__tests__/managers/product.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/product.manager.test.js +2247 -0
- package/lib/__tests__/managers/product.manager.test.js.map +1 -0
- package/lib/__tests__/managers/public.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/public.manager.test.js +209 -0
- package/lib/__tests__/managers/public.manager.test.js.map +1 -0
- package/lib/__tests__/managers/push.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/push.manager.test.js +244 -0
- package/lib/__tests__/managers/push.manager.test.js.map +1 -0
- package/lib/__tests__/managers/returns.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/returns.manager.test.js +783 -0
- package/lib/__tests__/managers/returns.manager.test.js.map +1 -0
- package/lib/__tests__/managers/sbs.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/sbs.manager.test.js +492 -0
- package/lib/__tests__/managers/sbs.manager.test.js.map +1 -0
- package/lib/__tests__/managers/shop-category.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/shop-category.manager.test.js +425 -0
- package/lib/__tests__/managers/shop-category.manager.test.js.map +1 -0
- package/lib/__tests__/managers/shop-flash-sale.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/shop-flash-sale.manager.test.js +492 -0
- package/lib/__tests__/managers/shop-flash-sale.manager.test.js.map +1 -0
- package/lib/__tests__/managers/shop.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/shop.manager.test.js +637 -0
- package/lib/__tests__/managers/shop.manager.test.js.map +1 -0
- package/lib/__tests__/managers/top-picks.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/top-picks.manager.test.js +324 -0
- package/lib/__tests__/managers/top-picks.manager.test.js.map +1 -0
- package/lib/__tests__/managers/video.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/video.manager.test.js +1039 -0
- package/lib/__tests__/managers/video.manager.test.js.map +1 -0
- package/lib/__tests__/managers/voucher.manager.test.d.ts +1 -0
- package/lib/__tests__/managers/voucher.manager.test.js +442 -0
- package/lib/__tests__/managers/voucher.manager.test.js.map +1 -0
- package/lib/__tests__/sdk.test.d.ts +1 -0
- package/lib/__tests__/sdk.test.js +316 -0
- package/lib/__tests__/sdk.test.js.map +1 -0
- package/lib/__tests__/storage/custom-token-storage.test.d.ts +1 -0
- package/lib/__tests__/storage/custom-token-storage.test.js +337 -0
- package/lib/__tests__/storage/custom-token-storage.test.js.map +1 -0
- package/lib/__tests__/utils/signature.test.d.ts +1 -0
- package/lib/__tests__/utils/signature.test.js +38 -0
- package/lib/__tests__/utils/signature.test.js.map +1 -0
- package/lib/__tests__/utils/spec-audit.test.d.ts +1 -0
- package/lib/__tests__/utils/spec-audit.test.js +176 -0
- package/lib/__tests__/utils/spec-audit.test.js.map +1 -0
- package/lib/errors.js +2 -0
- package/lib/errors.js.map +1 -1
- package/lib/fetch.js +1 -1
- package/lib/fetch.js.map +1 -1
- package/lib/managers/ads.manager.d.ts +1 -41
- package/lib/managers/ads.manager.js +0 -54
- package/lib/managers/ads.manager.js.map +1 -1
- package/lib/managers/auth.manager.d.ts +2 -1
- package/lib/managers/auth.manager.js +2 -5
- package/lib/managers/auth.manager.js.map +1 -1
- package/lib/managers/base.manager.js +1 -0
- package/lib/managers/base.manager.js.map +1 -1
- package/lib/managers/media.manager.d.ts +36 -1
- package/lib/managers/media.manager.js +68 -0
- package/lib/managers/media.manager.js.map +1 -1
- package/lib/managers/order.manager.js +1 -0
- package/lib/managers/order.manager.js.map +1 -1
- package/lib/managers/payment.manager.d.ts +13 -1
- package/lib/managers/payment.manager.js +26 -0
- package/lib/managers/payment.manager.js.map +1 -1
- package/lib/managers/product.manager.js +1 -1
- package/lib/managers/product.manager.js.map +1 -1
- package/lib/schemas/ads.d.ts +2 -56
- package/lib/schemas/ams.d.ts +92 -0
- package/lib/schemas/base.d.ts +2 -0
- package/lib/schemas/discount.d.ts +4 -0
- package/lib/schemas/fetch.d.ts +1 -1
- package/lib/schemas/livestream.d.ts +14 -0
- package/lib/schemas/media.d.ts +107 -0
- package/lib/schemas/merchant.d.ts +2 -0
- package/lib/schemas/order.d.ts +22 -0
- package/lib/schemas/payment.d.ts +96 -0
- package/lib/schemas/product.d.ts +253 -15
- package/lib/schemas/public.d.ts +3 -0
- package/lib/schemas/region.d.ts +9 -2
- package/lib/schemas/region.js +9 -2
- package/lib/schemas/region.js.map +1 -1
- package/lib/schemas/returns.d.ts +38 -1
- package/lib/schemas/shop.d.ts +16 -0
- package/lib/schemas/video.d.ts +83 -37
- package/lib/schemas/voucher.d.ts +2 -0
- package/lib/sdk.d.ts +6 -1
- package/lib/sdk.js +53 -6
- package/lib/sdk.js.map +1 -1
- package/lib/storage/custom-token-storage.js +2 -0
- package/lib/storage/custom-token-storage.js.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +3 -3
package/lib/schemas/media.d.ts
CHANGED
|
@@ -228,3 +228,110 @@ export interface CancelVideoUploadParams {
|
|
|
228
228
|
*/
|
|
229
229
|
export interface CancelVideoUploadResponse extends BaseResponse {
|
|
230
230
|
}
|
|
231
|
+
/**
|
|
232
|
+
* Parameters for v2.media.init_video_upload
|
|
233
|
+
*/
|
|
234
|
+
export interface InitMediaVideoUploadParams {
|
|
235
|
+
/** Defines the business type of the uploaded image. Supported values: 3 = Video */
|
|
236
|
+
business: number;
|
|
237
|
+
/** Defines the purpose of the uploaded image under the specified business type. Supported values: If business = 3 (Video): 1 = Shopee Video */
|
|
238
|
+
scene: number;
|
|
239
|
+
/** Original video file name */
|
|
240
|
+
file_name: string;
|
|
241
|
+
/** Total video file size in bytes. Maximum 1GB. */
|
|
242
|
+
file_size: number;
|
|
243
|
+
/** Video duration in seconds. 1s~180s. */
|
|
244
|
+
duration: number;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Response for v2.media.init_video_upload
|
|
248
|
+
*/
|
|
249
|
+
export interface InitMediaVideoUploadResponse extends BaseResponse {
|
|
250
|
+
response: {
|
|
251
|
+
/** Unique upload session ID */
|
|
252
|
+
video_upload_id: string;
|
|
253
|
+
/** The size of each part. When uploading video chunks, the video must be split according to this part size for each upload request. */
|
|
254
|
+
part_size: number;
|
|
255
|
+
};
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* Parameters for v2.media.upload_video_part
|
|
259
|
+
*/
|
|
260
|
+
export interface UploadMediaVideoPartParams {
|
|
261
|
+
/** The unique ID of the upload task, returned by v2.media.init_video_upload */
|
|
262
|
+
video_upload_id: string;
|
|
263
|
+
/** Sequence number of this part, starting from 0 */
|
|
264
|
+
part_seq: number;
|
|
265
|
+
/** The content of this part of file. Part size should be exactly equal to part_size returned in v2.media.init_video_upload, except last part of file. */
|
|
266
|
+
part_content: string | Buffer;
|
|
267
|
+
/** MD5 checksum of this part for data integrity validation */
|
|
268
|
+
part_md5: string;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* Response for v2.media.upload_video_part
|
|
272
|
+
*/
|
|
273
|
+
export interface UploadMediaVideoPartResponse extends BaseResponse {
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* Parameters for v2.media.complete_video_upload
|
|
277
|
+
*/
|
|
278
|
+
export interface CompleteMediaVideoUploadParams {
|
|
279
|
+
/** The unique ID of the upload task, returned by v2.media.init_video_upload */
|
|
280
|
+
video_upload_id: string;
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* Response for v2.media.complete_video_upload
|
|
284
|
+
*/
|
|
285
|
+
export interface CompleteMediaVideoUploadResponse extends BaseResponse {
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* Parameters for v2.media.get_video_upload_result
|
|
289
|
+
*/
|
|
290
|
+
export interface GetMediaVideoUploadResultParams extends Record<string, string | number | boolean | null | undefined> {
|
|
291
|
+
/** The unique ID of the upload task, returned by v2.media.init_video_upload */
|
|
292
|
+
video_upload_id: string;
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* Transcoded video info inside media video upload result
|
|
296
|
+
*/
|
|
297
|
+
export interface MediaVideoUploadResultVideoInfo {
|
|
298
|
+
/** Video playback url */
|
|
299
|
+
video_url: string;
|
|
300
|
+
/** Video thumbnail image url */
|
|
301
|
+
video_thumbnail_url: string;
|
|
302
|
+
/** Video thumbnail image width */
|
|
303
|
+
thumbnail_width: number;
|
|
304
|
+
/** Video thumbnail image height */
|
|
305
|
+
thumbnail_height: number;
|
|
306
|
+
/** Video duration in seconds */
|
|
307
|
+
duration: number;
|
|
308
|
+
/** Video resolution, e.g., "960x540" */
|
|
309
|
+
resolution: string;
|
|
310
|
+
}
|
|
311
|
+
/**
|
|
312
|
+
* Response for v2.media.get_video_upload_result
|
|
313
|
+
*/
|
|
314
|
+
export interface GetMediaVideoUploadResultResponse extends BaseResponse {
|
|
315
|
+
response: {
|
|
316
|
+
/** Current status of the upload task: INITIATED, UPLOADING, UPLOADED, PROCESSING, SUCCEEDED, FAILED, CANCELLED */
|
|
317
|
+
status: string;
|
|
318
|
+
/** Detailed fail or cancel reason, will be returned if status is FAILED or CANCELLED */
|
|
319
|
+
reason?: string;
|
|
320
|
+
/** The time of video status updates */
|
|
321
|
+
update_time?: number;
|
|
322
|
+
/** Transcoded video info, will be returned if status is SUCCEEDED */
|
|
323
|
+
video_info?: MediaVideoUploadResultVideoInfo;
|
|
324
|
+
};
|
|
325
|
+
}
|
|
326
|
+
/**
|
|
327
|
+
* Parameters for v2.media.cancel_video_upload
|
|
328
|
+
*/
|
|
329
|
+
export interface CancelMediaVideoUploadParams {
|
|
330
|
+
/** The unique ID of the upload task, returned by v2.media.init_video_upload */
|
|
331
|
+
video_upload_id: string;
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* Response for v2.media.cancel_video_upload
|
|
335
|
+
*/
|
|
336
|
+
export interface CancelMediaVideoUploadResponse extends BaseResponse {
|
|
337
|
+
}
|
|
@@ -93,6 +93,8 @@ export type GetMerchantPrepaidAccountListResponse = MerchantResponse<{
|
|
|
93
93
|
export interface GetMerchantWarehouseListParams {
|
|
94
94
|
/** Pagination cursor */
|
|
95
95
|
cursor: DoubleSidedCursor;
|
|
96
|
+
/** Type of warehouse: 1 = pickup, 2 = return */
|
|
97
|
+
warehouse_type?: number;
|
|
96
98
|
}
|
|
97
99
|
/**
|
|
98
100
|
* Address information
|
package/lib/schemas/order.d.ts
CHANGED
|
@@ -858,6 +858,22 @@ export interface HandlePrescriptionCheckParams {
|
|
|
858
858
|
operation: "APPROVE" | "REJECT";
|
|
859
859
|
/** The reason for rejection. Required when operation is REJECT */
|
|
860
860
|
reject_reason?: string;
|
|
861
|
+
/** Shopee's unique identifier for an order */
|
|
862
|
+
order_sn?: string;
|
|
863
|
+
/** Indicate whether the prescription is approved or not */
|
|
864
|
+
is_approved?: boolean;
|
|
865
|
+
/** Reject reason code */
|
|
866
|
+
reject_reason_code?: number;
|
|
867
|
+
/** Prescription check items */
|
|
868
|
+
items?: Array<{
|
|
869
|
+
item_id?: number;
|
|
870
|
+
model_id?: number;
|
|
871
|
+
prescription_status?: number;
|
|
872
|
+
}>;
|
|
873
|
+
/** Name of the pharmacist */
|
|
874
|
+
pharmacist_name?: string;
|
|
875
|
+
/** Free text remarks */
|
|
876
|
+
free_text?: string;
|
|
861
877
|
}
|
|
862
878
|
/**
|
|
863
879
|
* Response for handling prescription check
|
|
@@ -890,6 +906,10 @@ export interface UploadInvoiceDocParams {
|
|
|
890
906
|
order_sn: string;
|
|
891
907
|
/** The invoice document file */
|
|
892
908
|
invoice_file: string;
|
|
909
|
+
/** File type (PDF, etc) */
|
|
910
|
+
file_type?: string;
|
|
911
|
+
/** File content/name */
|
|
912
|
+
file?: string;
|
|
893
913
|
}
|
|
894
914
|
/**
|
|
895
915
|
* Response for uploading invoice document
|
|
@@ -902,6 +922,8 @@ export interface UploadInvoiceDocResponse extends FetchResponse<null> {
|
|
|
902
922
|
export interface GetBookingDetailParams {
|
|
903
923
|
/** The set of booking_sn. If there are multiple booking_sn, you need to use English comma to connect them. limit [1,50] */
|
|
904
924
|
booking_sn_list: string[];
|
|
925
|
+
/** Optional fields in response */
|
|
926
|
+
response_optional_fields?: string;
|
|
905
927
|
}
|
|
906
928
|
/**
|
|
907
929
|
* Booking detail information
|
package/lib/schemas/payment.d.ts
CHANGED
|
@@ -652,6 +652,10 @@ export type GenerateIncomeReportParams = {
|
|
|
652
652
|
end_time: number;
|
|
653
653
|
/** Currency for the report */
|
|
654
654
|
currency?: string;
|
|
655
|
+
/** Release time from */
|
|
656
|
+
release_time_from?: number;
|
|
657
|
+
/** Release time to */
|
|
658
|
+
release_time_to?: number;
|
|
655
659
|
};
|
|
656
660
|
/**
|
|
657
661
|
* Response for generate income report API
|
|
@@ -692,6 +696,12 @@ export type GenerateIncomeStatementParams = {
|
|
|
692
696
|
start_time: number;
|
|
693
697
|
/** End time for the statement (timestamp) */
|
|
694
698
|
end_time: number;
|
|
699
|
+
/** Release time from */
|
|
700
|
+
release_time_from?: number;
|
|
701
|
+
/** Release time to */
|
|
702
|
+
release_time_to?: number;
|
|
703
|
+
/** Statement type */
|
|
704
|
+
statement_type?: string;
|
|
695
705
|
};
|
|
696
706
|
/**
|
|
697
707
|
* Response for generate income statement API
|
|
@@ -824,6 +834,8 @@ export type GetPayoutInfoParams = {
|
|
|
824
834
|
page_no?: number;
|
|
825
835
|
/** Page size, max 100, default 40 */
|
|
826
836
|
page_size?: number;
|
|
837
|
+
/** Pagination cursor */
|
|
838
|
+
cursor?: string;
|
|
827
839
|
};
|
|
828
840
|
/**
|
|
829
841
|
* Payout info item
|
|
@@ -853,3 +865,87 @@ export interface GetPayoutInfoResponse extends BaseResponse {
|
|
|
853
865
|
more: boolean;
|
|
854
866
|
};
|
|
855
867
|
}
|
|
868
|
+
/**
|
|
869
|
+
* Parameters for v2.payment.get_income_detail
|
|
870
|
+
*/
|
|
871
|
+
export interface GetIncomeDetailParams extends Record<string, string | number | boolean | null | undefined> {
|
|
872
|
+
/** Start date (YYYY-MM-DD) of the income reference period. This field is only used for Income Status = Released, the other statuses will display all records currently in that status. */
|
|
873
|
+
date_from: string;
|
|
874
|
+
/** End date (YYYY-MM-DD) of the income reference period. Must be later than date_from. This field is only used for Income Status = Released, the other statuses will display all records currently in that status. */
|
|
875
|
+
date_to: string;
|
|
876
|
+
/** Status of Seller Income payout. Supported values: Local: 1 - Released, 2 - Pending. CB: 0 - To Release, 1 - Released, 2 - Pending. */
|
|
877
|
+
income_status: number;
|
|
878
|
+
/** Pagination token for the next set of results. Use an empty string "" for the first request. */
|
|
879
|
+
cursor?: string;
|
|
880
|
+
/** Number of income detail records to retrieve per page */
|
|
881
|
+
page_size: number;
|
|
882
|
+
}
|
|
883
|
+
export interface IncomeDetailNextPage {
|
|
884
|
+
/** Token to retrieve the next page of results. Returns empty if there is no more data. */
|
|
885
|
+
cursor: string;
|
|
886
|
+
/** Number of records returned per page. */
|
|
887
|
+
page_size: number;
|
|
888
|
+
}
|
|
889
|
+
export interface IncomeDetailListItem {
|
|
890
|
+
/** Payment channel or method used for the order */
|
|
891
|
+
payment_method?: string;
|
|
892
|
+
/** Unique order serial number associated with the income record. */
|
|
893
|
+
order_sn?: string;
|
|
894
|
+
/** Type of income or billing item — e.g., Order Income, Adjustment etc */
|
|
895
|
+
description?: string;
|
|
896
|
+
/** Status description of the order income or payout. */
|
|
897
|
+
status?: string;
|
|
898
|
+
/** Currency in which the income was transacted. */
|
|
899
|
+
currency?: string;
|
|
900
|
+
/** Estimated escrow amount pending release for the order. */
|
|
901
|
+
estimated_escrow_amount?: number;
|
|
902
|
+
/** Estimated payout time (Unix timestamp). Applicable for Pending/To Release status. */
|
|
903
|
+
estimated_payout_time?: number;
|
|
904
|
+
/** Amount that is queued for release to seller (Cross Border only). */
|
|
905
|
+
to_release_amount?: number;
|
|
906
|
+
/** Order creation timestamp (Unix format). */
|
|
907
|
+
creation_date?: number;
|
|
908
|
+
/** Amount successfully released to the seller. */
|
|
909
|
+
released_amount?: number;
|
|
910
|
+
/** Actual payout time (Unix timestamp) when funds were transferred. */
|
|
911
|
+
actual_payout_time?: number;
|
|
912
|
+
}
|
|
913
|
+
export interface IncomeDetailList {
|
|
914
|
+
next_page?: IncomeDetailNextPage;
|
|
915
|
+
list?: IncomeDetailListItem[];
|
|
916
|
+
}
|
|
917
|
+
/**
|
|
918
|
+
* Response for v2.payment.get_income_detail
|
|
919
|
+
*/
|
|
920
|
+
export interface GetIncomeDetailResponse extends BaseResponse {
|
|
921
|
+
/** List of income detail records returned for the specified time range and status. */
|
|
922
|
+
income_detail_list?: IncomeDetailList;
|
|
923
|
+
}
|
|
924
|
+
/**
|
|
925
|
+
* Parameters for v2.payment.get_income_overview
|
|
926
|
+
*/
|
|
927
|
+
export interface GetIncomeOverviewParams extends Record<string, string | number | boolean | null | undefined> {
|
|
928
|
+
/** Status of Seller Income payout. Supported values: Local Shop: 1 - Released, 2 - Pending. CB Shop: 0 - To Release, 1 - Released, 2 - Pending. */
|
|
929
|
+
income_status?: number;
|
|
930
|
+
}
|
|
931
|
+
export interface TotalIncome {
|
|
932
|
+
/** Total amount pending release (Local: orders before ESCROW_PAID; CB: orders before ESCROW_PAYOUT). */
|
|
933
|
+
pending_amount?: number;
|
|
934
|
+
/** Amount queued for release in the next payout cycle (CB only). Not applicable for Local shops. */
|
|
935
|
+
to_release_amount?: number;
|
|
936
|
+
/** Total amount successfully released to the seller. */
|
|
937
|
+
released_amount?: number;
|
|
938
|
+
}
|
|
939
|
+
/**
|
|
940
|
+
* Response for v2.payment.get_income_overview
|
|
941
|
+
*/
|
|
942
|
+
export interface GetIncomeOverviewResponse extends BaseResponse {
|
|
943
|
+
response?: {
|
|
944
|
+
/** The latest payout date for the released income. Format: YYYY-MM-DD. Only for CN shops. */
|
|
945
|
+
latest_payout_date?: string;
|
|
946
|
+
/** Object containing total income components. */
|
|
947
|
+
total_income?: TotalIncome;
|
|
948
|
+
};
|
|
949
|
+
/** Object containing total income components (fallback top-level). */
|
|
950
|
+
total_income?: TotalIncome;
|
|
951
|
+
}
|