@congminh1254/shopee-sdk 0.9.0 → 1.0.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.
Files changed (137) hide show
  1. package/README.md +178 -36
  2. package/lib/fetch.js +13 -0
  3. package/lib/fetch.js.map +1 -1
  4. package/lib/managers/add-on-deal.manager.d.ts +140 -0
  5. package/lib/managers/add-on-deal.manager.js +240 -0
  6. package/lib/managers/add-on-deal.manager.js.map +1 -0
  7. package/lib/managers/ads.manager.d.ts +217 -1
  8. package/lib/managers/ads.manager.js +312 -0
  9. package/lib/managers/ads.manager.js.map +1 -1
  10. package/lib/managers/bundle-deal.manager.d.ts +106 -0
  11. package/lib/managers/bundle-deal.manager.js +178 -0
  12. package/lib/managers/bundle-deal.manager.js.map +1 -0
  13. package/lib/managers/discount.manager.d.ts +102 -0
  14. package/lib/managers/discount.manager.js +167 -0
  15. package/lib/managers/discount.manager.js.map +1 -0
  16. package/lib/managers/fbs.manager.d.ts +115 -0
  17. package/lib/managers/fbs.manager.js +145 -0
  18. package/lib/managers/fbs.manager.js.map +1 -0
  19. package/lib/managers/first-mile.manager.d.ts +150 -0
  20. package/lib/managers/first-mile.manager.js +264 -0
  21. package/lib/managers/first-mile.manager.js.map +1 -0
  22. package/lib/managers/follow-prize.manager.d.ts +108 -0
  23. package/lib/managers/follow-prize.manager.js +152 -0
  24. package/lib/managers/follow-prize.manager.js.map +1 -0
  25. package/lib/managers/global-product.manager.d.ts +664 -0
  26. package/lib/managers/global-product.manager.js +904 -0
  27. package/lib/managers/global-product.manager.js.map +1 -0
  28. package/lib/managers/index.d.ts +17 -1
  29. package/lib/managers/index.js +17 -1
  30. package/lib/managers/index.js.map +1 -1
  31. package/lib/managers/livestream.manager.d.ts +377 -0
  32. package/lib/managers/livestream.manager.js +529 -0
  33. package/lib/managers/livestream.manager.js.map +1 -0
  34. package/lib/managers/logistics.manager.d.ts +267 -1
  35. package/lib/managers/logistics.manager.js +544 -0
  36. package/lib/managers/logistics.manager.js.map +1 -1
  37. package/lib/managers/media-space.manager.d.ts +179 -0
  38. package/lib/managers/media-space.manager.js +220 -0
  39. package/lib/managers/media-space.manager.js.map +1 -0
  40. package/lib/managers/media.manager.d.ts +226 -0
  41. package/lib/managers/media.manager.js +274 -0
  42. package/lib/managers/media.manager.js.map +1 -0
  43. package/lib/managers/merchant.manager.d.ts +100 -0
  44. package/lib/managers/merchant.manager.js +144 -0
  45. package/lib/managers/merchant.manager.js.map +1 -0
  46. package/lib/managers/order.manager.d.ts +213 -1
  47. package/lib/managers/order.manager.js +305 -0
  48. package/lib/managers/order.manager.js.map +1 -1
  49. package/lib/managers/payment.manager.d.ts +186 -1
  50. package/lib/managers/payment.manager.js +288 -0
  51. package/lib/managers/payment.manager.js.map +1 -1
  52. package/lib/managers/product.manager.d.ts +346 -1
  53. package/lib/managers/product.manager.js +718 -0
  54. package/lib/managers/product.manager.js.map +1 -1
  55. package/lib/managers/returns.manager.d.ts +200 -0
  56. package/lib/managers/returns.manager.js +300 -0
  57. package/lib/managers/returns.manager.js.map +1 -0
  58. package/lib/managers/sbs.manager.d.ts +112 -0
  59. package/lib/managers/sbs.manager.js +149 -0
  60. package/lib/managers/sbs.manager.js.map +1 -0
  61. package/lib/managers/shop-category.manager.d.ts +207 -0
  62. package/lib/managers/shop-category.manager.js +258 -0
  63. package/lib/managers/shop-category.manager.js.map +1 -0
  64. package/lib/managers/shop-flash-sale.manager.d.ts +242 -0
  65. package/lib/managers/shop-flash-sale.manager.js +321 -0
  66. package/lib/managers/shop-flash-sale.manager.js.map +1 -0
  67. package/lib/managers/shop.manager.d.ts +173 -0
  68. package/lib/managers/shop.manager.js +217 -0
  69. package/lib/managers/shop.manager.js.map +1 -0
  70. package/lib/managers/top-picks.manager.d.ts +62 -0
  71. package/lib/managers/top-picks.manager.js +91 -0
  72. package/lib/managers/top-picks.manager.js.map +1 -0
  73. package/lib/schemas/add-on-deal.d.ts +390 -0
  74. package/lib/schemas/add-on-deal.js +45 -0
  75. package/lib/schemas/add-on-deal.js.map +1 -0
  76. package/lib/schemas/ads.d.ts +437 -0
  77. package/lib/schemas/bundle-deal.d.ts +300 -0
  78. package/lib/schemas/bundle-deal.js +27 -0
  79. package/lib/schemas/bundle-deal.js.map +1 -0
  80. package/lib/schemas/discount.d.ts +334 -0
  81. package/lib/schemas/discount.js +15 -0
  82. package/lib/schemas/discount.js.map +1 -0
  83. package/lib/schemas/fbs.d.ts +117 -0
  84. package/lib/schemas/fbs.js +2 -0
  85. package/lib/schemas/fbs.js.map +1 -0
  86. package/lib/schemas/first-mile.d.ts +551 -0
  87. package/lib/schemas/first-mile.js +2 -0
  88. package/lib/schemas/first-mile.js.map +1 -0
  89. package/lib/schemas/follow-prize.d.ts +198 -0
  90. package/lib/schemas/follow-prize.js +27 -0
  91. package/lib/schemas/follow-prize.js.map +1 -0
  92. package/lib/schemas/global-product.d.ts +1127 -0
  93. package/lib/schemas/global-product.js +2 -0
  94. package/lib/schemas/global-product.js.map +1 -0
  95. package/lib/schemas/index.d.ts +13 -0
  96. package/lib/schemas/index.js +17 -0
  97. package/lib/schemas/index.js.map +1 -1
  98. package/lib/schemas/livestream.d.ts +649 -0
  99. package/lib/schemas/livestream.js +2 -0
  100. package/lib/schemas/livestream.js.map +1 -0
  101. package/lib/schemas/logistics.d.ts +979 -0
  102. package/lib/schemas/logistics.js +13 -0
  103. package/lib/schemas/logistics.js.map +1 -1
  104. package/lib/schemas/media-space.d.ts +189 -0
  105. package/lib/schemas/media-space.js +2 -0
  106. package/lib/schemas/media-space.js.map +1 -0
  107. package/lib/schemas/media.d.ts +230 -0
  108. package/lib/schemas/media.js +2 -0
  109. package/lib/schemas/media.js.map +1 -0
  110. package/lib/schemas/merchant.d.ts +236 -0
  111. package/lib/schemas/merchant.js +2 -0
  112. package/lib/schemas/merchant.js.map +1 -0
  113. package/lib/schemas/order.d.ts +431 -0
  114. package/lib/schemas/payment.d.ts +397 -0
  115. package/lib/schemas/product.d.ts +1157 -0
  116. package/lib/schemas/returns.d.ts +632 -0
  117. package/lib/schemas/returns.js +63 -0
  118. package/lib/schemas/returns.js.map +1 -0
  119. package/lib/schemas/sbs.d.ts +484 -0
  120. package/lib/schemas/sbs.js +2 -0
  121. package/lib/schemas/sbs.js.map +1 -0
  122. package/lib/schemas/shop-category.d.ts +176 -0
  123. package/lib/schemas/shop-category.js +2 -0
  124. package/lib/schemas/shop-category.js.map +1 -0
  125. package/lib/schemas/shop-flash-sale.d.ts +473 -0
  126. package/lib/schemas/shop-flash-sale.js +43 -0
  127. package/lib/schemas/shop-flash-sale.js.map +1 -0
  128. package/lib/schemas/shop.d.ts +250 -0
  129. package/lib/schemas/shop.js +2 -0
  130. package/lib/schemas/shop.js.map +1 -0
  131. package/lib/schemas/top-picks.d.ts +99 -0
  132. package/lib/schemas/top-picks.js +2 -0
  133. package/lib/schemas/top-picks.js.map +1 -0
  134. package/lib/sdk.d.ts +34 -0
  135. package/lib/sdk.js +34 -0
  136. package/lib/sdk.js.map +1 -1
  137. package/package.json +7 -4
@@ -155,3 +155,982 @@ export interface GetTrackingInfoResponse extends BaseResponse {
155
155
  tracking_info: TrackingInfo[];
156
156
  };
157
157
  }
158
+ /**
159
+ * Weight limit for logistics channel
160
+ */
161
+ export interface WeightLimit {
162
+ /** Max weight for an item on this logistic channel */
163
+ item_max_weight: number;
164
+ /** Min weight for an item on this logistic channel */
165
+ item_min_weight: number;
166
+ }
167
+ /**
168
+ * Dimension limit for logistics channel
169
+ */
170
+ export interface ItemMaxDimension {
171
+ /** Max height limit */
172
+ height: number;
173
+ /** Max width limit */
174
+ width: number;
175
+ /** Max length limit */
176
+ length: number;
177
+ /** Unit for the limit */
178
+ unit: string;
179
+ /** Sum of the item's dimension */
180
+ dimension_sum: number;
181
+ }
182
+ /**
183
+ * Volume limit for logistics channel
184
+ */
185
+ export interface VolumeLimit {
186
+ /** Max volume for an item on this logistic channel */
187
+ item_max_volume: number;
188
+ /** Min volume for an item on this logistic channel */
189
+ item_min_volume: number;
190
+ }
191
+ /**
192
+ * Size information for logistics channel
193
+ */
194
+ export interface SizeInfo {
195
+ /** Identity of size */
196
+ size_id: string;
197
+ /** Name of size */
198
+ name: string;
199
+ /** Pre-defined shipping fee for the specific size */
200
+ default_price: number;
201
+ }
202
+ /**
203
+ * Logistics capability
204
+ */
205
+ export interface LogisticsCapability {
206
+ /** Whether it's a Seller logistics channel */
207
+ seller_logistics: boolean;
208
+ }
209
+ /**
210
+ * Logistics channel information
211
+ */
212
+ export interface LogisticsChannel {
213
+ /** Identity of logistic channel */
214
+ logistics_channel_id: number;
215
+ /** Name of logistic channel */
216
+ logistics_channel_name: string;
217
+ /** Whether this logistic channel supports COD */
218
+ cod_enabled: boolean;
219
+ /** Whether this logistic channel is enabled on shop level */
220
+ enabled: boolean;
221
+ /** Fee type: SIZE_SELECTION, SIZE_INPUT, FIXED_DEFAULT_PRICE, CUSTOM_PRICE */
222
+ fee_type: string;
223
+ /** List of sizes (only for fee_type SIZE_SELECTION) */
224
+ size_list: SizeInfo[];
225
+ /** Weight limit for this logistic channel */
226
+ weight_limit: WeightLimit;
227
+ /** Dimension limit for this logistic channel */
228
+ item_max_dimension: ItemMaxDimension;
229
+ /** Volume limit */
230
+ volume_limit: VolumeLimit;
231
+ /** Description of logistics channel */
232
+ logistics_description: string;
233
+ /** Whether the logistic channel is force enabled on Shop Level */
234
+ force_enable: boolean;
235
+ /** Parent logistic channel ID */
236
+ mask_channel_id: number;
237
+ /** Whether the channel is blocked to use seller cover shipping fee function */
238
+ block_seller_cover_shipping_fee?: boolean;
239
+ /** Whether this channel support cross border shipping */
240
+ support_cross_border?: boolean;
241
+ /** Whether seller has set the Seller logistics configuration */
242
+ seller_logistic_has_configuration?: boolean | null;
243
+ /** Capability of one logistic channel */
244
+ logistics_capability?: LogisticsCapability;
245
+ /** Whether this channel support pre-print AWB */
246
+ preprint?: boolean;
247
+ }
248
+ /**
249
+ * Response for get channel list API
250
+ */
251
+ export interface GetChannelListResponse extends BaseResponse {
252
+ response: {
253
+ /** List of logistics channels */
254
+ logistics_channel_list: LogisticsChannel[];
255
+ };
256
+ }
257
+ /**
258
+ * Pickup time slot information
259
+ */
260
+ export interface PickupTimeSlot {
261
+ /** Date of pickup time (timestamp) */
262
+ date: number;
263
+ /** Text description of pickup time */
264
+ time_text?: string;
265
+ /** Identity of pickup time */
266
+ pickup_time_id: string;
267
+ /** Flags for recommended time slots */
268
+ flags?: string[];
269
+ }
270
+ /**
271
+ * Pickup address information
272
+ */
273
+ export interface PickupAddress {
274
+ /** Identity of address */
275
+ address_id: number;
276
+ /** Region of address */
277
+ region: string;
278
+ /** State of address */
279
+ state: string;
280
+ /** City of address */
281
+ city: string;
282
+ /** District of address */
283
+ district: string;
284
+ /** Town of address */
285
+ town: string;
286
+ /** Address description */
287
+ address: string;
288
+ /** Zipcode of address */
289
+ zipcode: string;
290
+ /** Flags of shop address */
291
+ address_flag?: string[];
292
+ /** List of pickup time information */
293
+ time_slot_list?: PickupTimeSlot[];
294
+ }
295
+ /**
296
+ * Dropoff branch information
297
+ */
298
+ export interface DropoffBranch {
299
+ /** Identity of logistics branch */
300
+ branch_id: number;
301
+ /** Region of address */
302
+ region: string;
303
+ /** State of address */
304
+ state: string;
305
+ /** City of address */
306
+ city: string;
307
+ /** Address description */
308
+ address: string;
309
+ /** Zipcode of address */
310
+ zipcode: string;
311
+ /** District of address */
312
+ district: string;
313
+ /** Town of address */
314
+ town: string;
315
+ }
316
+ /**
317
+ * Slug information for TW 3PL drop-off partners
318
+ */
319
+ export interface SlugInfo {
320
+ /** Identity of slug */
321
+ slug: string;
322
+ /** Name of slug */
323
+ slug_name: string;
324
+ }
325
+ /**
326
+ * Info needed for shipping
327
+ */
328
+ export interface InfoNeeded {
329
+ /** Dropoff requirements */
330
+ dropoff?: string[];
331
+ /** Pickup requirements */
332
+ pickup?: string[];
333
+ /** Non-integrated requirements */
334
+ non_integrated?: string[];
335
+ }
336
+ /**
337
+ * Dropoff information
338
+ */
339
+ export interface DropoffInfo {
340
+ /** List of available dropoff branches */
341
+ branch_list?: DropoffBranch[];
342
+ /** List of available TW 3PL drop-off partners */
343
+ slug_list?: SlugInfo[];
344
+ }
345
+ /**
346
+ * Pickup information
347
+ */
348
+ export interface PickupInfo {
349
+ /** List of available pickup addresses */
350
+ address_list?: PickupAddress[];
351
+ }
352
+ /**
353
+ * Parameters for getting shipping parameter
354
+ */
355
+ export type GetShippingParameterParams = {
356
+ /** Shopee's unique identifier for an order */
357
+ order_sn: string;
358
+ /**
359
+ * Shopee's unique identifier for the package under an order.
360
+ * You shouldn't fill the field with empty string when there isn't a package number.
361
+ */
362
+ package_number?: string;
363
+ } & Record<string, string | number | boolean | null | undefined>;
364
+ /**
365
+ * Response for get shipping parameter API
366
+ */
367
+ export interface GetShippingParameterResponse extends BaseResponse {
368
+ response: {
369
+ /** Parameters required to initialize logistics */
370
+ info_needed?: InfoNeeded;
371
+ /** Logistics information for dropoff mode */
372
+ dropoff?: DropoffInfo;
373
+ /** Logistics information for pickup mode */
374
+ pickup?: PickupInfo;
375
+ };
376
+ }
377
+ /**
378
+ * Parameters for getting tracking number
379
+ */
380
+ export type GetTrackingNumberParams = {
381
+ /** Shopee's unique identifier for an order */
382
+ order_sn: string;
383
+ /** Shopee's unique identifier for the package under an order */
384
+ package_number?: string;
385
+ /** Optional fields to include in response */
386
+ response_optional_fields?: string;
387
+ } & Record<string, string | number | boolean | null | undefined>;
388
+ /**
389
+ * Response for get tracking number API
390
+ */
391
+ export interface GetTrackingNumberResponse extends BaseResponse {
392
+ response: {
393
+ /** The tracking number of this order */
394
+ tracking_number: string;
395
+ /** The unique identifier for package of BR correios */
396
+ plp_number?: string;
397
+ /** The first mile tracking number of the order (Cross Border Seller only) */
398
+ first_mile_tracking_number?: string;
399
+ /** The last mile tracking number of the order (Cross Border BR seller only) */
400
+ last_mile_tracking_number?: string;
401
+ /** Hint information if cannot get some fields under special scenarios */
402
+ hint?: string;
403
+ /** Pickup code for drivers (ID local orders using instant+sameday) */
404
+ pickup_code?: string;
405
+ };
406
+ }
407
+ /**
408
+ * Pickup information for ship order
409
+ */
410
+ export interface ShipOrderPickup {
411
+ /** Identity of address */
412
+ address_id: number;
413
+ /** Pickup time id */
414
+ pickup_time_id?: string;
415
+ /** Tracking number from third-party shipping carrier */
416
+ tracking_number?: string;
417
+ }
418
+ /**
419
+ * Dropoff information for ship order
420
+ */
421
+ export interface ShipOrderDropoff {
422
+ /** Identity of branch */
423
+ branch_id?: number;
424
+ /** Real name of sender */
425
+ sender_real_name?: string;
426
+ /** Tracking number from third-party shipping carrier */
427
+ tracking_number?: string;
428
+ /** Selected 3PL partner for drop-off */
429
+ slug?: string;
430
+ }
431
+ /**
432
+ * Non-integrated channel information for ship order
433
+ */
434
+ export interface ShipOrderNonIntegrated {
435
+ /** Tracking number assigned by shipping carrier */
436
+ tracking_number?: string;
437
+ }
438
+ /**
439
+ * Parameters for ship order
440
+ */
441
+ export type ShipOrderParams = {
442
+ /** Shopee's unique identifier for an order */
443
+ order_sn: string;
444
+ /** Shopee's unique identifier for the package under an order */
445
+ package_number?: string;
446
+ /** Pickup information (required if get_shipping_parameter returns "pickup") */
447
+ pickup?: ShipOrderPickup;
448
+ /** Dropoff information (required if get_shipping_parameter returns "dropoff") */
449
+ dropoff?: ShipOrderDropoff;
450
+ /** Non-integrated channel information */
451
+ non_integrated?: ShipOrderNonIntegrated;
452
+ } & Record<string, string | number | boolean | object | null | undefined>;
453
+ /**
454
+ * Response for ship order API
455
+ */
456
+ export interface ShipOrderResponse extends BaseResponse {
457
+ response?: Record<string, never>;
458
+ }
459
+ /**
460
+ * Address information
461
+ */
462
+ export interface Address {
463
+ /** Identity of address */
464
+ address_id: number;
465
+ /** Region of address */
466
+ region: string;
467
+ /** State of address */
468
+ state: string;
469
+ /** City of address */
470
+ city: string;
471
+ /** District of address */
472
+ district: string;
473
+ /** Town of address */
474
+ town: string;
475
+ /** Full address description */
476
+ address: string;
477
+ /** Zipcode */
478
+ zipcode: string;
479
+ /** Address type flags */
480
+ address_flag?: string[];
481
+ /** Address status */
482
+ address_status?: string;
483
+ /** Full address string */
484
+ full_address?: string;
485
+ }
486
+ /**
487
+ * Response for get address list API
488
+ */
489
+ export interface GetAddressListResponse extends BaseResponse {
490
+ response: {
491
+ /** Whether to show pickup address */
492
+ show_pickup_address: boolean;
493
+ /** List of addresses */
494
+ address_list: Address[];
495
+ };
496
+ }
497
+ /**
498
+ * Order item for batch ship order
499
+ */
500
+ export interface BatchShipOrderItem {
501
+ /** Shopee's unique identifier for an order */
502
+ order_sn: string;
503
+ /** Shopee's unique identifier for the package under an order */
504
+ package_number?: string;
505
+ /** Pickup information */
506
+ pickup?: ShipOrderPickup;
507
+ /** Dropoff information */
508
+ dropoff?: ShipOrderDropoff;
509
+ /** Non-integrated channel information */
510
+ non_integrated?: ShipOrderNonIntegrated;
511
+ }
512
+ /**
513
+ * Parameters for batch ship order
514
+ */
515
+ export type BatchShipOrderParams = {
516
+ /** List of order items to ship */
517
+ order_list: BatchShipOrderItem[];
518
+ } & Record<string, string | number | boolean | object | null | undefined>;
519
+ /**
520
+ * Batch ship order result item
521
+ */
522
+ export interface BatchShipOrderResultItem {
523
+ /** Order serial number */
524
+ order_sn: string;
525
+ /** Error code if failed */
526
+ error?: string;
527
+ /** Error message if failed */
528
+ message?: string;
529
+ }
530
+ /**
531
+ * Response for batch ship order API
532
+ */
533
+ export interface BatchShipOrderResponse extends BaseResponse {
534
+ response?: {
535
+ /** List of results */
536
+ result_list?: BatchShipOrderResultItem[];
537
+ };
538
+ }
539
+ /**
540
+ * Parameters for mass ship order
541
+ */
542
+ export type MassShipOrderParams = {
543
+ /** List of package numbers */
544
+ package_number_list: string[];
545
+ /** Pickup information */
546
+ pickup?: ShipOrderPickup;
547
+ /** Dropoff information */
548
+ dropoff?: ShipOrderDropoff;
549
+ } & Record<string, string | number | boolean | object | null | undefined>;
550
+ /**
551
+ * Response for mass ship order API
552
+ */
553
+ export interface MassShipOrderResponse extends BaseResponse {
554
+ response?: Record<string, never>;
555
+ }
556
+ /**
557
+ * Parameters for ship booking
558
+ */
559
+ export type ShipBookingParams = {
560
+ /** Booking serial number */
561
+ booking_sn: string;
562
+ /** Pickup information */
563
+ pickup?: ShipOrderPickup;
564
+ /** Dropoff information */
565
+ dropoff?: ShipOrderDropoff;
566
+ } & Record<string, string | number | boolean | object | null | undefined>;
567
+ /**
568
+ * Response for ship booking API
569
+ */
570
+ export interface ShipBookingResponse extends BaseResponse {
571
+ response?: Record<string, never>;
572
+ }
573
+ /**
574
+ * Parameters for get booking shipping parameter
575
+ */
576
+ export type GetBookingShippingParameterParams = {
577
+ /** Booking serial number */
578
+ booking_sn: string;
579
+ } & Record<string, string | number | boolean | null | undefined>;
580
+ /**
581
+ * Response for get booking shipping parameter API
582
+ */
583
+ export interface GetBookingShippingParameterResponse extends BaseResponse {
584
+ response: {
585
+ /** Parameters required to initialize logistics */
586
+ info_needed?: InfoNeeded;
587
+ /** Logistics information for dropoff mode */
588
+ dropoff?: DropoffInfo;
589
+ /** Logistics information for pickup mode */
590
+ pickup?: PickupInfo;
591
+ };
592
+ }
593
+ /**
594
+ * Parameters for get booking tracking info
595
+ */
596
+ export type GetBookingTrackingInfoParams = {
597
+ /** Booking serial number */
598
+ booking_sn: string;
599
+ } & Record<string, string | number | boolean | null | undefined>;
600
+ /**
601
+ * Response for get booking tracking info API
602
+ */
603
+ export interface GetBookingTrackingInfoResponse extends BaseResponse {
604
+ response: {
605
+ /** Booking serial number */
606
+ booking_sn: string;
607
+ /** Current logistics status */
608
+ logistics_status: LogisticsStatus;
609
+ /** Tracking info events */
610
+ tracking_info: TrackingInfo[];
611
+ };
612
+ }
613
+ /**
614
+ * Parameters for get booking tracking number
615
+ */
616
+ export type GetBookingTrackingNumberParams = {
617
+ /** Booking serial number */
618
+ booking_sn: string;
619
+ /** Optional fields to include in response */
620
+ response_optional_fields?: string;
621
+ } & Record<string, string | number | boolean | null | undefined>;
622
+ /**
623
+ * Response for get booking tracking number API
624
+ */
625
+ export interface GetBookingTrackingNumberResponse extends BaseResponse {
626
+ response: {
627
+ /** The tracking number */
628
+ tracking_number: string;
629
+ /** Hint information */
630
+ hint?: string;
631
+ };
632
+ }
633
+ /**
634
+ * Parameters for get mass shipping parameter
635
+ */
636
+ export type GetMassShippingParameterParams = {
637
+ /** List of package numbers */
638
+ package_number_list: string[];
639
+ } & Record<string, string | number | boolean | null | undefined>;
640
+ /**
641
+ * Response for get mass shipping parameter API
642
+ */
643
+ export interface GetMassShippingParameterResponse extends BaseResponse {
644
+ response: {
645
+ /** Parameters required */
646
+ info_needed?: InfoNeeded;
647
+ /** Dropoff information */
648
+ dropoff?: DropoffInfo;
649
+ /** Pickup information */
650
+ pickup?: PickupInfo;
651
+ };
652
+ }
653
+ /**
654
+ * Parameters for get mass tracking number
655
+ */
656
+ export type GetMassTrackingNumberParams = {
657
+ /** List of order serial numbers */
658
+ order_sn_list: string[];
659
+ } & Record<string, string | number | boolean | null | undefined>;
660
+ /**
661
+ * Mass tracking result item
662
+ */
663
+ export interface MassTrackingResultItem {
664
+ /** Order serial number */
665
+ order_sn: string;
666
+ /** Tracking number */
667
+ tracking_number?: string;
668
+ /** Hint information */
669
+ hint?: string;
670
+ }
671
+ /**
672
+ * Response for get mass tracking number API
673
+ */
674
+ export interface GetMassTrackingNumberResponse extends BaseResponse {
675
+ response?: {
676
+ /** List of tracking results */
677
+ result_list?: MassTrackingResultItem[];
678
+ };
679
+ }
680
+ /**
681
+ * Parameters for set address config
682
+ */
683
+ export type SetAddressConfigParams = {
684
+ /** Address ID */
685
+ address_id: number;
686
+ /** Address flags */
687
+ address_flag?: string[];
688
+ } & Record<string, string | number | boolean | object | null | undefined>;
689
+ /**
690
+ * Response for set address config API
691
+ */
692
+ export interface SetAddressConfigResponse extends BaseResponse {
693
+ response?: Record<string, never>;
694
+ }
695
+ /**
696
+ * Parameters for delete address
697
+ */
698
+ export type DeleteAddressParams = {
699
+ /** Address ID to delete */
700
+ address_id: number;
701
+ } & Record<string, string | number | boolean | null | undefined>;
702
+ /**
703
+ * Response for delete address API
704
+ */
705
+ export interface DeleteAddressResponse extends BaseResponse {
706
+ response?: Record<string, never>;
707
+ }
708
+ /**
709
+ * Shipping document type enum
710
+ */
711
+ export declare enum ShippingDocumentType {
712
+ NORMAL_AIR_WAYBILL = "NORMAL_AIR_WAYBILL",
713
+ THERMAL_AIR_WAYBILL = "THERMAL_AIR_WAYBILL",
714
+ NORMAL_JOB_AIR_WAYBILL = "NORMAL_JOB_AIR_WAYBILL",
715
+ THERMAL_JOB_AIR_WAYBILL = "THERMAL_JOB_AIR_WAYBILL"
716
+ }
717
+ /**
718
+ * Parameters for create shipping document
719
+ */
720
+ export type CreateShippingDocumentParams = {
721
+ /** List of order SNs */
722
+ order_sn_list: string[];
723
+ /** Document type */
724
+ shipping_document_type: string;
725
+ } & Record<string, string | number | boolean | object | null | undefined>;
726
+ /**
727
+ * Response for create shipping document API
728
+ */
729
+ export interface CreateShippingDocumentResponse extends BaseResponse {
730
+ response?: Record<string, never>;
731
+ }
732
+ /**
733
+ * Parameters for download shipping document
734
+ */
735
+ export type DownloadShippingDocumentParams = {
736
+ /** List of order SNs */
737
+ order_sn_list: string[];
738
+ /** Document type */
739
+ shipping_document_type: string;
740
+ } & Record<string, string | number | boolean | null | undefined>;
741
+ /**
742
+ * Response for download shipping document API
743
+ */
744
+ export interface DownloadShippingDocumentResponse extends BaseResponse {
745
+ response?: {
746
+ /** URL to download document */
747
+ result?: string;
748
+ };
749
+ }
750
+ /**
751
+ * Parameters for get shipping document parameter
752
+ */
753
+ export type GetShippingDocumentParameterParams = {
754
+ /** List of order SNs */
755
+ order_sn_list: string[];
756
+ } & Record<string, string | number | boolean | null | undefined>;
757
+ /**
758
+ * Response for get shipping document parameter API
759
+ */
760
+ export interface GetShippingDocumentParameterResponse extends BaseResponse {
761
+ response?: {
762
+ /** Suggested document type */
763
+ suggested_shipping_document_type?: string;
764
+ /** Selectable document types */
765
+ selectable_shipping_document_type?: string[];
766
+ };
767
+ }
768
+ /**
769
+ * Parameters for get shipping document result
770
+ */
771
+ export type GetShippingDocumentResultParams = {
772
+ /** List of order SNs */
773
+ order_sn_list: string[];
774
+ /** Document type */
775
+ shipping_document_type: string;
776
+ } & Record<string, string | number | boolean | null | undefined>;
777
+ /**
778
+ * Shipping document result item
779
+ */
780
+ export interface ShippingDocumentResultItem {
781
+ /** Order serial number */
782
+ order_sn: string;
783
+ /** Result status */
784
+ status?: string;
785
+ /** Error message if failed */
786
+ error?: string;
787
+ }
788
+ /**
789
+ * Response for get shipping document result API
790
+ */
791
+ export interface GetShippingDocumentResultResponse extends BaseResponse {
792
+ response?: {
793
+ /** List of results */
794
+ result_list?: ShippingDocumentResultItem[];
795
+ };
796
+ }
797
+ /**
798
+ * Parameters for get shipping document data info
799
+ */
800
+ export type GetShippingDocumentDataInfoParams = {
801
+ /** List of order SNs */
802
+ order_sn_list: string[];
803
+ } & Record<string, string | number | boolean | null | undefined>;
804
+ /**
805
+ * Response for get shipping document data info API
806
+ */
807
+ export interface GetShippingDocumentDataInfoResponse extends BaseResponse {
808
+ response?: {
809
+ /** Document data list */
810
+ data_list?: any[];
811
+ };
812
+ }
813
+ /**
814
+ * Parameters for create booking shipping document
815
+ */
816
+ export type CreateBookingShippingDocumentParams = {
817
+ /** List of booking SNs */
818
+ booking_sn_list: string[];
819
+ /** Document type */
820
+ shipping_document_type: string;
821
+ } & Record<string, string | number | boolean | object | null | undefined>;
822
+ /**
823
+ * Response for create booking shipping document API
824
+ */
825
+ export interface CreateBookingShippingDocumentResponse extends BaseResponse {
826
+ response?: Record<string, never>;
827
+ }
828
+ /**
829
+ * Parameters for download booking shipping document
830
+ */
831
+ export type DownloadBookingShippingDocumentParams = {
832
+ /** List of booking SNs */
833
+ booking_sn_list: string[];
834
+ /** Document type */
835
+ shipping_document_type: string;
836
+ } & Record<string, string | number | boolean | null | undefined>;
837
+ /**
838
+ * Response for download booking shipping document API
839
+ */
840
+ export interface DownloadBookingShippingDocumentResponse extends BaseResponse {
841
+ response?: {
842
+ /** URL to download document */
843
+ result?: string;
844
+ };
845
+ }
846
+ /**
847
+ * Parameters for get booking shipping document parameter
848
+ */
849
+ export type GetBookingShippingDocumentParameterParams = {
850
+ /** List of booking SNs */
851
+ booking_sn_list: string[];
852
+ } & Record<string, string | number | boolean | null | undefined>;
853
+ /**
854
+ * Response for get booking shipping document parameter API
855
+ */
856
+ export interface GetBookingShippingDocumentParameterResponse extends BaseResponse {
857
+ response?: {
858
+ /** Suggested document type */
859
+ suggested_shipping_document_type?: string;
860
+ /** Selectable document types */
861
+ selectable_shipping_document_type?: string[];
862
+ };
863
+ }
864
+ /**
865
+ * Parameters for get booking shipping document result
866
+ */
867
+ export type GetBookingShippingDocumentResultParams = {
868
+ /** List of booking SNs */
869
+ booking_sn_list: string[];
870
+ /** Document type */
871
+ shipping_document_type: string;
872
+ } & Record<string, string | number | boolean | null | undefined>;
873
+ /**
874
+ * Response for get booking shipping document result API
875
+ */
876
+ export interface GetBookingShippingDocumentResultResponse extends BaseResponse {
877
+ response?: {
878
+ /** List of results */
879
+ result_list?: any[];
880
+ };
881
+ }
882
+ /**
883
+ * Parameters for get booking shipping document data info
884
+ */
885
+ export type GetBookingShippingDocumentDataInfoParams = {
886
+ /** List of booking SNs */
887
+ booking_sn_list: string[];
888
+ } & Record<string, string | number | boolean | null | undefined>;
889
+ /**
890
+ * Response for get booking shipping document data info API
891
+ */
892
+ export interface GetBookingShippingDocumentDataInfoResponse extends BaseResponse {
893
+ response?: {
894
+ /** Document data list */
895
+ data_list?: any[];
896
+ };
897
+ }
898
+ /**
899
+ * Parameters for create shipping document job
900
+ */
901
+ export type CreateShippingDocumentJobParams = {
902
+ /** Job identifier */
903
+ job_id?: string;
904
+ } & Record<string, string | number | boolean | object | null | undefined>;
905
+ /**
906
+ * Response for create shipping document job API
907
+ */
908
+ export interface CreateShippingDocumentJobResponse extends BaseResponse {
909
+ response?: {
910
+ /** Job ID */
911
+ job_id?: string;
912
+ };
913
+ }
914
+ /**
915
+ * Parameters for download shipping document job
916
+ */
917
+ export type DownloadShippingDocumentJobParams = {
918
+ /** Job ID */
919
+ job_id: string;
920
+ } & Record<string, string | number | boolean | null | undefined>;
921
+ /**
922
+ * Response for download shipping document job API
923
+ */
924
+ export interface DownloadShippingDocumentJobResponse extends BaseResponse {
925
+ response?: {
926
+ /** Download URL */
927
+ result?: string;
928
+ };
929
+ }
930
+ /**
931
+ * Parameters for get shipping document job status
932
+ */
933
+ export type GetShippingDocumentJobStatusParams = {
934
+ /** Job ID */
935
+ job_id: string;
936
+ } & Record<string, string | number | boolean | null | undefined>;
937
+ /**
938
+ * Response for get shipping document job status API
939
+ */
940
+ export interface GetShippingDocumentJobStatusResponse extends BaseResponse {
941
+ response?: {
942
+ /** Job status */
943
+ status?: string;
944
+ /** Error message if failed */
945
+ error?: string;
946
+ };
947
+ }
948
+ /**
949
+ * Parameters for download to label
950
+ */
951
+ export type DownloadToLabelParams = {
952
+ /** List of order SNs */
953
+ order_sn_list: string[];
954
+ } & Record<string, string | number | boolean | null | undefined>;
955
+ /**
956
+ * Response for download to label API
957
+ */
958
+ export interface DownloadToLabelResponse extends BaseResponse {
959
+ response?: {
960
+ /** Download URL */
961
+ result?: string;
962
+ };
963
+ }
964
+ /**
965
+ * Parameters for update channel
966
+ */
967
+ export type UpdateChannelParams = {
968
+ /** Logistics channel ID */
969
+ logistics_channel_id: number;
970
+ /** Whether to enable the channel */
971
+ enabled?: boolean;
972
+ /** COD enabled */
973
+ cod_enabled?: boolean;
974
+ } & Record<string, string | number | boolean | object | null | undefined>;
975
+ /**
976
+ * Response for update channel API
977
+ */
978
+ export interface UpdateChannelResponse extends BaseResponse {
979
+ response?: Record<string, never>;
980
+ }
981
+ /**
982
+ * Parameters for update shipping order
983
+ */
984
+ export type UpdateShippingOrderParams = {
985
+ /** Order serial number */
986
+ order_sn: string;
987
+ /** Package number */
988
+ package_number?: string;
989
+ /** Pickup information */
990
+ pickup?: ShipOrderPickup;
991
+ } & Record<string, string | number | boolean | object | null | undefined>;
992
+ /**
993
+ * Response for update shipping order API
994
+ */
995
+ export interface UpdateShippingOrderResponse extends BaseResponse {
996
+ response?: Record<string, never>;
997
+ }
998
+ /**
999
+ * Parameters for update tracking status
1000
+ */
1001
+ export type UpdateTrackingStatusParams = {
1002
+ /** Order serial number */
1003
+ order_sn: string;
1004
+ /** Package number */
1005
+ package_number?: string;
1006
+ /** Tracking status */
1007
+ tracking_status?: string;
1008
+ } & Record<string, string | number | boolean | object | null | undefined>;
1009
+ /**
1010
+ * Response for update tracking status API
1011
+ */
1012
+ export interface UpdateTrackingStatusResponse extends BaseResponse {
1013
+ response?: Record<string, never>;
1014
+ }
1015
+ /**
1016
+ * Parameters for update self collection order logistics
1017
+ */
1018
+ export type UpdateSelfCollectionOrderLogisticsParams = {
1019
+ /** Order serial number */
1020
+ order_sn: string;
1021
+ /** Package number */
1022
+ package_number: string;
1023
+ /** Self collection status */
1024
+ self_collection_status: string;
1025
+ } & Record<string, string | number | boolean | object | null | undefined>;
1026
+ /**
1027
+ * Response for update self collection order logistics API
1028
+ */
1029
+ export interface UpdateSelfCollectionOrderLogisticsResponse extends BaseResponse {
1030
+ response?: Record<string, never>;
1031
+ }
1032
+ /**
1033
+ * Parameters for get operating hours
1034
+ */
1035
+ export type GetOperatingHoursParams = Record<string, string | number | boolean | null | undefined>;
1036
+ /**
1037
+ * Response for get operating hours API
1038
+ */
1039
+ export interface GetOperatingHoursResponse extends BaseResponse {
1040
+ response?: {
1041
+ /** Operating hours data */
1042
+ operating_hours?: any[];
1043
+ };
1044
+ }
1045
+ /**
1046
+ * Parameters for update operating hours
1047
+ */
1048
+ export type UpdateOperatingHoursParams = {
1049
+ /** Operating hours data */
1050
+ operating_hours?: any[];
1051
+ } & Record<string, string | number | boolean | object | null | undefined>;
1052
+ /**
1053
+ * Response for update operating hours API
1054
+ */
1055
+ export interface UpdateOperatingHoursResponse extends BaseResponse {
1056
+ response?: Record<string, never>;
1057
+ }
1058
+ /**
1059
+ * Parameters for get operating hour restrictions
1060
+ */
1061
+ export type GetOperatingHourRestrictionsParams = Record<string, string | number | boolean | null | undefined>;
1062
+ /**
1063
+ * Response for get operating hour restrictions API
1064
+ */
1065
+ export interface GetOperatingHourRestrictionsResponse extends BaseResponse {
1066
+ response?: {
1067
+ /** Restrictions data */
1068
+ restrictions?: any[];
1069
+ };
1070
+ }
1071
+ /**
1072
+ * Parameters for delete special operating hour
1073
+ */
1074
+ export type DeleteSpecialOperatingHourParams = {
1075
+ /** Date to delete */
1076
+ date?: string;
1077
+ } & Record<string, string | number | boolean | null | undefined>;
1078
+ /**
1079
+ * Response for delete special operating hour API
1080
+ */
1081
+ export interface DeleteSpecialOperatingHourResponse extends BaseResponse {
1082
+ response?: Record<string, never>;
1083
+ }
1084
+ /**
1085
+ * Parameters for get mart packaging info
1086
+ */
1087
+ export type GetMartPackagingInfoParams = {
1088
+ /** Order serial number */
1089
+ order_sn: string;
1090
+ } & Record<string, string | number | boolean | null | undefined>;
1091
+ /**
1092
+ * Response for get mart packaging info API
1093
+ */
1094
+ export interface GetMartPackagingInfoResponse extends BaseResponse {
1095
+ response?: {
1096
+ /** Packaging info */
1097
+ packaging_info?: any;
1098
+ };
1099
+ }
1100
+ /**
1101
+ * Parameters for set mart packaging info
1102
+ */
1103
+ export type SetMartPackagingInfoParams = {
1104
+ /** Order serial number */
1105
+ order_sn: string;
1106
+ /** Packaging data */
1107
+ packaging_data?: any;
1108
+ } & Record<string, string | number | boolean | object | null | undefined>;
1109
+ /**
1110
+ * Response for set mart packaging info API
1111
+ */
1112
+ export interface SetMartPackagingInfoResponse extends BaseResponse {
1113
+ response?: Record<string, never>;
1114
+ }
1115
+ /**
1116
+ * TPF tracking status item
1117
+ */
1118
+ export interface TPFTrackingStatusItem {
1119
+ /** Package number */
1120
+ package_number: string;
1121
+ /** Tracking status */
1122
+ tracking_status: string;
1123
+ }
1124
+ /**
1125
+ * Parameters for batch update TPF warehouse tracking status
1126
+ */
1127
+ export type BatchUpdateTPFWarehouseTrackingStatusParams = {
1128
+ /** List of tracking status items */
1129
+ tracking_status_list: TPFTrackingStatusItem[];
1130
+ } & Record<string, string | number | boolean | object | null | undefined>;
1131
+ /**
1132
+ * Response for batch update TPF warehouse tracking status API
1133
+ */
1134
+ export interface BatchUpdateTPFWarehouseTrackingStatusResponse extends BaseResponse {
1135
+ response?: Record<string, never>;
1136
+ }