@gofynd/fdk-client-javascript 1.4.12-beta.1 → 1.4.13
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 +1 -1
- package/package.json +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +38 -35
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +42 -39
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -23
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +14 -12
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1104 -230
- package/sdk/platform/Catalog/CatalogPlatformModel.js +461 -222
- package/sdk/platform/Order/OrderPlatformClient.d.ts +5 -49
- package/sdk/platform/Order/OrderPlatformClient.js +32 -328
- package/sdk/platform/Order/OrderPlatformModel.d.ts +2607 -1393
- package/sdk/platform/Order/OrderPlatformModel.js +1069 -1402
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +142 -110
- package/sdk/platform/Order/OrderPlatformValidator.js +64 -91
|
@@ -86,11 +86,14 @@ export = CatalogPlatformModel;
|
|
|
86
86
|
*/
|
|
87
87
|
/**
|
|
88
88
|
* @typedef ApplicationBrandJson
|
|
89
|
-
* @property {Object} _custom_json
|
|
89
|
+
* @property {Object} _custom_json - A custom JSON object containing additional
|
|
90
|
+
* brand-specific configurations or data. The structure is flexible and may
|
|
91
|
+
* vary based on application needs.
|
|
90
92
|
*/
|
|
91
93
|
/**
|
|
92
94
|
* @typedef ApplicationCategoryJson
|
|
93
|
-
* @property {Object} _custom_json
|
|
95
|
+
* @property {Object} _custom_json - A custom JSON object containing additional
|
|
96
|
+
* details or configurations specific to the application category.
|
|
94
97
|
*/
|
|
95
98
|
/**
|
|
96
99
|
* @typedef ApplicationDepartment
|
|
@@ -304,9 +307,12 @@ export = CatalogPlatformModel;
|
|
|
304
307
|
*/
|
|
305
308
|
/**
|
|
306
309
|
* @typedef BannerImage
|
|
307
|
-
* @property {string} [aspect_ratio]
|
|
308
|
-
*
|
|
309
|
-
* @property {string} [
|
|
310
|
+
* @property {string} [aspect_ratio] - The aspect ratio of the banner image,
|
|
311
|
+
* typically represented as a ratio (e.g., '16:9' or '4:3').
|
|
312
|
+
* @property {string} [type] - The type of media, such as 'image' or 'banner',
|
|
313
|
+
* indicating the format of the banner.
|
|
314
|
+
* @property {string} [url] - The URL where the banner image is located,
|
|
315
|
+
* typically a web address pointing to the image resource.
|
|
310
316
|
*/
|
|
311
317
|
/**
|
|
312
318
|
* @typedef BaseAppCategoryReturnConfig
|
|
@@ -329,25 +335,80 @@ export = CatalogPlatformModel;
|
|
|
329
335
|
* @typedef BrandItem
|
|
330
336
|
* @property {Action} [action]
|
|
331
337
|
* @property {ImageUrls} [banners]
|
|
332
|
-
* @property {string[]} [departments]
|
|
333
|
-
*
|
|
334
|
-
* @property {
|
|
335
|
-
*
|
|
336
|
-
* @property {
|
|
337
|
-
* @property {
|
|
338
|
+
* @property {string[]} [departments] - An array of department names or
|
|
339
|
+
* categories that the brand belongs to, represented as strings.
|
|
340
|
+
* @property {string} [discount] - A string representing the discount offered by
|
|
341
|
+
* the brand, such as percentage or amount off.
|
|
342
|
+
* @property {BrandMedia} [logo]
|
|
343
|
+
* @property {string} [name] - The name of the brand.
|
|
344
|
+
* @property {string} [slug] - A URL-friendly identifier for the brand, often
|
|
345
|
+
* used in website routing.
|
|
346
|
+
* @property {number} [uid] - A unique identifier for the brand, typically used
|
|
347
|
+
* for internal reference.
|
|
338
348
|
*/
|
|
339
349
|
/**
|
|
340
350
|
* @typedef BrandListingResponse
|
|
341
|
-
* @property {BrandItem[]} [items]
|
|
351
|
+
* @property {BrandItem[]} [items] - An array of brand items, each containing
|
|
352
|
+
* detailed information about the brand, such as action, banners, departments,
|
|
353
|
+
* discount, logo, and other related fields.
|
|
342
354
|
* @property {Page} page
|
|
343
355
|
*/
|
|
356
|
+
/**
|
|
357
|
+
* @typedef ApplicationBrandListingItemSchema
|
|
358
|
+
* @property {Object} [_custom_json] - Custom JSON object for additional data.
|
|
359
|
+
* @property {Object} [_locale_language] - Custom object for locale-specific
|
|
360
|
+
* language data.
|
|
361
|
+
* @property {string} [brand_banner_portrait_url] - URL of the brand's portrait banner.
|
|
362
|
+
* @property {string} [brand_banner_url] - URL of the brand's landscape banner.
|
|
363
|
+
* @property {string} [brand_logo_url] - URL of the brand's logo.
|
|
364
|
+
* @property {string} [description] - Description of the brand.
|
|
365
|
+
* @property {string} [name] - Name of the brand.
|
|
366
|
+
* @property {string} [slug_key] - Unique slug key for the brand.
|
|
367
|
+
* @property {number} [priority] - Priority of the brand in listing.
|
|
368
|
+
* @property {number} [uid] - Unique identifier of the brand.
|
|
369
|
+
* @property {string} [created_on] - Timestamp when the category was created.
|
|
370
|
+
* @property {string} [last_updated] - Timestamp when the category was created.
|
|
371
|
+
* @property {boolean} [is_active] - Indicates if the brand is active.
|
|
372
|
+
* @property {number[]} [departments] - List of department IDs associated with the brand.
|
|
373
|
+
* @property {string} [modified_on] - Timestamp when the brand was last modified.
|
|
374
|
+
* @property {boolean} [active] - Boolean indicating whether the brand is
|
|
375
|
+
* currently active or not.
|
|
376
|
+
*/
|
|
377
|
+
/**
|
|
378
|
+
* @typedef ApplicationBrandListingSchema
|
|
379
|
+
* @property {ApplicationBrandListingItemSchema[]} [items]
|
|
380
|
+
* @property {Page} [page]
|
|
381
|
+
*/
|
|
382
|
+
/**
|
|
383
|
+
* @typedef ApplicationCategoryListingSchema
|
|
384
|
+
* @property {ApplicationCategoryListingItemSchema[]} [items]
|
|
385
|
+
* @property {Page} [page]
|
|
386
|
+
*/
|
|
387
|
+
/**
|
|
388
|
+
* @typedef ApplicationCategoryListingItemSchema
|
|
389
|
+
* @property {string} [name] - Name of the category.
|
|
390
|
+
* @property {string} [logo] - URL of the category's logo.
|
|
391
|
+
* @property {number[]} [departments] - List of department IDs.
|
|
392
|
+
* @property {string} [attr_name] - Attribute name of the category.
|
|
393
|
+
* @property {string} [landscape_url] - URL of the landscape banner.
|
|
394
|
+
* @property {string} [portrait_url] - URL of the portrait banner.
|
|
395
|
+
* @property {Object} [_custom_json] - Custom JSON object for additional data.
|
|
396
|
+
* @property {number} [priority] - Priority of the category.
|
|
397
|
+
* @property {CreatedBy} [created_by]
|
|
398
|
+
* @property {string} [created_on] - Timestamp when the category was created.
|
|
399
|
+
* @property {CreatedBy} [modified_by]
|
|
400
|
+
* @property {string} [modified_on] - Timestamp when the category was last modified.
|
|
401
|
+
* @property {string} [app_id] - Application ID associated with the category.
|
|
402
|
+
* @property {boolean} [is_active] - Indicates whether the category is active.
|
|
403
|
+
* @property {number} [uid] - Unique identifier of the category.
|
|
404
|
+
*/
|
|
344
405
|
/**
|
|
345
406
|
* @typedef BrandMeta
|
|
346
407
|
* @property {number} id
|
|
347
408
|
* @property {string} name
|
|
348
409
|
*/
|
|
349
410
|
/**
|
|
350
|
-
* @typedef
|
|
411
|
+
* @typedef InventoryBrandMeta
|
|
351
412
|
* @property {number} [id]
|
|
352
413
|
* @property {string} [name]
|
|
353
414
|
*/
|
|
@@ -439,18 +500,25 @@ export = CatalogPlatformModel;
|
|
|
439
500
|
*/
|
|
440
501
|
/**
|
|
441
502
|
* @typedef CatalogInsightBrand
|
|
442
|
-
* @property {number} [article_freshness]
|
|
443
|
-
*
|
|
444
|
-
* @property {number} [
|
|
445
|
-
*
|
|
446
|
-
* @property {number} [
|
|
447
|
-
*
|
|
503
|
+
* @property {number} [article_freshness] - The average freshness of the
|
|
504
|
+
* articles based on the time since they were added to the catalog.
|
|
505
|
+
* @property {number} [available_articles] - The number of articles that are
|
|
506
|
+
* currently available for purchase.
|
|
507
|
+
* @property {number} [available_sizes] - The total number of unique sizes
|
|
508
|
+
* available across all articles.
|
|
509
|
+
* @property {string} [name] - The name of the brand.
|
|
510
|
+
* @property {number} [total_articles] - The total number of articles listed
|
|
511
|
+
* under the brand.
|
|
512
|
+
* @property {number} [total_sizes] - The total number of sizes offered across
|
|
513
|
+
* all articles for the brand.
|
|
448
514
|
*/
|
|
449
515
|
/**
|
|
450
516
|
* @typedef CatalogInsightItem
|
|
451
|
-
* @property {number} [count]
|
|
452
|
-
* @property {number} [out_of_stock_count]
|
|
453
|
-
*
|
|
517
|
+
* @property {number} [count] - The total number of catalog items available.
|
|
518
|
+
* @property {number} [out_of_stock_count] - The number of items that are
|
|
519
|
+
* currently out of stock.
|
|
520
|
+
* @property {number} [sellable_count] - The number of items that are currently
|
|
521
|
+
* sellable (in stock).
|
|
454
522
|
*/
|
|
455
523
|
/**
|
|
456
524
|
* @typedef CatalogInsightResponse
|
|
@@ -493,6 +561,7 @@ export = CatalogPlatformModel;
|
|
|
493
561
|
*/
|
|
494
562
|
/**
|
|
495
563
|
* @typedef CategoryItems
|
|
564
|
+
* @property {Object} [_custom_json]
|
|
496
565
|
* @property {Action} [action]
|
|
497
566
|
* @property {ImageUrls} [banners]
|
|
498
567
|
* @property {Child[]} [childs]
|
|
@@ -502,8 +571,12 @@ export = CatalogPlatformModel;
|
|
|
502
571
|
*/
|
|
503
572
|
/**
|
|
504
573
|
* @typedef CategoryListingResponse
|
|
505
|
-
* @property {DepartmentCategoryTree[]} [data]
|
|
506
|
-
*
|
|
574
|
+
* @property {DepartmentCategoryTree[]} [data] - An array containing the
|
|
575
|
+
* department category trees, which provide hierarchical information about
|
|
576
|
+
* categories and their associated departments.
|
|
577
|
+
* @property {DepartmentIdentifier[]} [departments] - An array of department
|
|
578
|
+
* identifiers, each providing basic information like name, slug, and unique
|
|
579
|
+
* ID for departments within the catalog.
|
|
507
580
|
*/
|
|
508
581
|
/**
|
|
509
582
|
* @typedef CategoryMapping
|
|
@@ -527,18 +600,22 @@ export = CatalogPlatformModel;
|
|
|
527
600
|
*/
|
|
528
601
|
/**
|
|
529
602
|
* @typedef Child
|
|
530
|
-
* @property {Object} [_custom_json]
|
|
603
|
+
* @property {Object} [_custom_json] - Custom JSON object to store additional
|
|
604
|
+
* data for the child.
|
|
531
605
|
* @property {Action} [action]
|
|
532
606
|
* @property {ImageUrls} [banners]
|
|
533
|
-
* @property {SecondLevelChild[]} [childs]
|
|
534
|
-
*
|
|
535
|
-
* @property {string} [
|
|
536
|
-
* @property {
|
|
607
|
+
* @property {SecondLevelChild[]} [childs] - A list of second-level child
|
|
608
|
+
* elements under the current child.
|
|
609
|
+
* @property {string} [name] - Name of the child element.
|
|
610
|
+
* @property {string} [slug] - Slug or URL-friendly identifier for the child element.
|
|
611
|
+
* @property {number} [uid] - Unique identifier for the child element.
|
|
537
612
|
*/
|
|
538
613
|
/**
|
|
539
614
|
* @typedef CollectionBadge
|
|
540
|
-
* @property {string} [color]
|
|
541
|
-
*
|
|
615
|
+
* @property {string} [color] - The color of the badge displayed with the
|
|
616
|
+
* collection, typically represented as a string (e.g., a hex code or color name).
|
|
617
|
+
* @property {string} [text] - The text displayed on the badge, which may
|
|
618
|
+
* indicate a label or promotion related to the collection.
|
|
542
619
|
*/
|
|
543
620
|
/**
|
|
544
621
|
* @typedef CollectionBanner
|
|
@@ -547,26 +624,41 @@ export = CatalogPlatformModel;
|
|
|
547
624
|
*/
|
|
548
625
|
/**
|
|
549
626
|
* @typedef CollectionCreateResponse
|
|
550
|
-
* @property {string} [uid]
|
|
551
|
-
* @property {
|
|
552
|
-
* @property {boolean} [allow_facets]
|
|
553
|
-
*
|
|
554
|
-
* @property {
|
|
555
|
-
*
|
|
627
|
+
* @property {string} [uid] - Unique identifier for the collection.
|
|
628
|
+
* @property {CollectionSchedule} [_schedule]
|
|
629
|
+
* @property {boolean} [allow_facets] - Indicates whether facet-based filtering
|
|
630
|
+
* is allowed for the collection.
|
|
631
|
+
* @property {boolean} [allow_sort] - Indicates whether sorting options are
|
|
632
|
+
* allowed for the collection.
|
|
633
|
+
* @property {string} [app_id] - The application ID associated with the collection.
|
|
634
|
+
* @property {Object} [badge] - Details of the badge associated with the collection.
|
|
556
635
|
* @property {ImageUrls} [banners]
|
|
557
|
-
* @property {
|
|
558
|
-
* @property {
|
|
559
|
-
* @property {boolean} [is_active]
|
|
636
|
+
* @property {string} [description] - A description of the collection.
|
|
637
|
+
* @property {boolean} [is_active] - Indicates whether the collection is currently active.
|
|
560
638
|
* @property {BannerImage} [logo]
|
|
561
|
-
* @property {Object} [meta]
|
|
562
|
-
* @property {string} [name]
|
|
563
|
-
* @property {number} [priority]
|
|
564
|
-
*
|
|
565
|
-
* @property {
|
|
566
|
-
*
|
|
567
|
-
* @property {string
|
|
568
|
-
* @property {string} [
|
|
569
|
-
*
|
|
639
|
+
* @property {Object} [meta] - Additional metadata related to the collection.
|
|
640
|
+
* @property {string} [name] - The name of the collection.
|
|
641
|
+
* @property {number} [priority] - The priority level of the collection, used to
|
|
642
|
+
* determine its display order.
|
|
643
|
+
* @property {CollectionQuery[]} [query] - Query objects that define how the
|
|
644
|
+
* collection's items are retrieved or filtered.
|
|
645
|
+
* @property {string} [slug] - The URL-friendly identifier for the collection.
|
|
646
|
+
* @property {string} [sort_on] - The default sorting order for items in the
|
|
647
|
+
* collection, e.g., 'popular'.
|
|
648
|
+
* @property {string[]} [tag] - Array of tags associated with the collection for
|
|
649
|
+
* categorization and filtering.
|
|
650
|
+
* @property {string} [type] - The type of collection, such as 'items' for
|
|
651
|
+
* manually added items or 'query' for dynamically fetched items.
|
|
652
|
+
* @property {string[]} [visible_facets_keys] - Keys of the facets that are
|
|
653
|
+
* visible and can be used for filtering the collection.
|
|
654
|
+
* @property {boolean} [published] - Indicates whether the collection is published.
|
|
655
|
+
* @property {string[]} [tags] - List of tags associated with the collection.
|
|
656
|
+
* @property {Action} [action]
|
|
657
|
+
* @property {Object} [_custom_json] - Custom JSON data for additional information.
|
|
658
|
+
* @property {Object} [_locale_language] - Locale language settings for the collection.
|
|
659
|
+
* @property {SeoDetail} [seo]
|
|
660
|
+
* @property {boolean} [is_visible] - Indicates if the collection is visible to users.
|
|
661
|
+
* @property {string} [id] - Unique identifier for the collection.
|
|
570
662
|
*/
|
|
571
663
|
/**
|
|
572
664
|
* @typedef CollectionDetailResponse
|
|
@@ -592,8 +684,11 @@ export = CatalogPlatformModel;
|
|
|
592
684
|
*/
|
|
593
685
|
/**
|
|
594
686
|
* @typedef CollectionImage
|
|
595
|
-
* @property {string} aspect_ratio
|
|
596
|
-
*
|
|
687
|
+
* @property {string} aspect_ratio - The aspect ratio of the image, typically
|
|
688
|
+
* represented as a string (e.g., "16:9" or "4:3") to indicate the
|
|
689
|
+
* proportional relationship between the image's width and height.
|
|
690
|
+
* @property {string} url - The URL of the image, which provides the location
|
|
691
|
+
* where the image is hosted and can be accessed.
|
|
597
692
|
*/
|
|
598
693
|
/**
|
|
599
694
|
* @typedef CollectionItem
|
|
@@ -612,20 +707,22 @@ export = CatalogPlatformModel;
|
|
|
612
707
|
*/
|
|
613
708
|
/**
|
|
614
709
|
* @typedef CollectionListingFilter
|
|
615
|
-
* @property {CollectionListingFilterTag[]} [tags]
|
|
616
|
-
*
|
|
710
|
+
* @property {CollectionListingFilterTag[]} [tags] - A list of tags used to
|
|
711
|
+
* filter the collection listing.
|
|
712
|
+
* @property {CollectionListingFilterType[]} [type] - A list of types used to
|
|
713
|
+
* filter the collection listing.
|
|
617
714
|
*/
|
|
618
715
|
/**
|
|
619
716
|
* @typedef CollectionListingFilterTag
|
|
620
|
-
* @property {string} [display]
|
|
621
|
-
* @property {boolean} [is_selected]
|
|
622
|
-
* @property {string} [name]
|
|
717
|
+
* @property {string} [display] - The display name of the tag for the collection listing.
|
|
718
|
+
* @property {boolean} [is_selected] - Indicates whether the tag is currently selected.
|
|
719
|
+
* @property {string} [name] - The name of the tag.
|
|
623
720
|
*/
|
|
624
721
|
/**
|
|
625
722
|
* @typedef CollectionListingFilterType
|
|
626
|
-
* @property {string} [display]
|
|
627
|
-
* @property {boolean} [is_selected]
|
|
628
|
-
* @property {string} [name]
|
|
723
|
+
* @property {string} [display] - The display name of the type for the collection listing.
|
|
724
|
+
* @property {boolean} [is_selected] - Indicates whether the type is currently selected.
|
|
725
|
+
* @property {string} [name] - The internal name of the type.
|
|
629
726
|
*/
|
|
630
727
|
/**
|
|
631
728
|
* @typedef CollectionQuery
|
|
@@ -636,11 +733,17 @@ export = CatalogPlatformModel;
|
|
|
636
733
|
*/
|
|
637
734
|
/**
|
|
638
735
|
* @typedef CollectionSchedule
|
|
639
|
-
* @property {string} [cron]
|
|
640
|
-
*
|
|
641
|
-
*
|
|
642
|
-
* @property {
|
|
643
|
-
*
|
|
736
|
+
* @property {string} [cron] - The cron expression that defines the scheduling
|
|
737
|
+
* pattern, allowing for tasks or events to be repeated at specific intervals
|
|
738
|
+
* (e.g., daily, weekly).
|
|
739
|
+
* @property {number} [duration] - The duration in seconds for which the
|
|
740
|
+
* collection is active or valid.
|
|
741
|
+
* @property {string} [end] - The end date and time for the collection's
|
|
742
|
+
* schedule, formatted as a date-time string.
|
|
743
|
+
* @property {NextSchedule[]} [next_schedule] - The next set of scheduled times
|
|
744
|
+
* when the collection will become active, based on the cron expression.
|
|
745
|
+
* @property {string} [start] - The start date and time for the collection's
|
|
746
|
+
* schedule, formatted as a date-time string.
|
|
644
747
|
*/
|
|
645
748
|
/**
|
|
646
749
|
* @typedef CompanyBrandDetail
|
|
@@ -654,7 +757,7 @@ export = CatalogPlatformModel;
|
|
|
654
757
|
* @property {number} id
|
|
655
758
|
*/
|
|
656
759
|
/**
|
|
657
|
-
* @typedef
|
|
760
|
+
* @typedef InventoryCompanyMeta
|
|
658
761
|
* @property {number} [id]
|
|
659
762
|
*/
|
|
660
763
|
/**
|
|
@@ -778,31 +881,45 @@ export = CatalogPlatformModel;
|
|
|
778
881
|
*/
|
|
779
882
|
/**
|
|
780
883
|
* @typedef CreateCollection
|
|
781
|
-
* @property {Object} [_custom_json]
|
|
782
|
-
*
|
|
884
|
+
* @property {Object} [_custom_json] - Custom JSON data for the collection, used
|
|
885
|
+
* for any additional information.
|
|
886
|
+
* @property {Object} [_locale_language] - Locale-specific data for supporting
|
|
887
|
+
* multiple languages.
|
|
783
888
|
* @property {CollectionSchedule} [_schedule]
|
|
784
|
-
* @property {boolean} [allow_facets]
|
|
785
|
-
*
|
|
786
|
-
* @property {
|
|
889
|
+
* @property {boolean} [allow_facets] - Indicates whether facet-based filtering
|
|
890
|
+
* is allowed for the collection.
|
|
891
|
+
* @property {boolean} [allow_sort] - Indicates whether sorting options are
|
|
892
|
+
* allowed for the collection.
|
|
893
|
+
* @property {string} app_id - The application ID associated with the collection.
|
|
787
894
|
* @property {CollectionBadge} [badge]
|
|
788
895
|
* @property {CollectionBanner} banners
|
|
789
|
-
* @property {UserInfo} [created_by]
|
|
790
|
-
*
|
|
791
|
-
* @property {
|
|
792
|
-
* @property {boolean} [
|
|
896
|
+
* @property {UserInfo} [created_by] - Information about the user who created
|
|
897
|
+
* the collection.
|
|
898
|
+
* @property {string} [description] - A description of the collection.
|
|
899
|
+
* @property {boolean} [is_active] - Indicates whether the collection is currently active.
|
|
900
|
+
* @property {boolean} [is_visible] - Indicates whether the collection is
|
|
901
|
+
* visible to users.
|
|
793
902
|
* @property {CollectionImage} logo
|
|
794
|
-
* @property {Object} [meta]
|
|
795
|
-
* @property {UserInfo} [modified_by]
|
|
796
|
-
*
|
|
797
|
-
* @property {
|
|
798
|
-
* @property {
|
|
799
|
-
*
|
|
903
|
+
* @property {Object} [meta] - Additional metadata related to the collection.
|
|
904
|
+
* @property {UserInfo} [modified_by] - Information about the user who last
|
|
905
|
+
* modified the collection.
|
|
906
|
+
* @property {string} name - The name of the collection.
|
|
907
|
+
* @property {number} [priority] - The priority level of the collection, used to
|
|
908
|
+
* determine its display order.
|
|
909
|
+
* @property {boolean} [published] - Indicates whether the collection is
|
|
910
|
+
* published and available to users.
|
|
911
|
+
* @property {CollectionQuery[]} [query] - Query objects that define how the
|
|
912
|
+
* collection's items are retrieved or filtered.
|
|
800
913
|
* @property {SeoDetail} [seo]
|
|
801
|
-
* @property {string} slug
|
|
802
|
-
* @property {string} [sort_on]
|
|
803
|
-
*
|
|
804
|
-
* @property {string}
|
|
805
|
-
*
|
|
914
|
+
* @property {string} slug - The URL-friendly identifier for the collection.
|
|
915
|
+
* @property {string} [sort_on] - The default sorting order for items in the
|
|
916
|
+
* collection, e.g., 'popular'.
|
|
917
|
+
* @property {string[]} [tags] - Array of tags associated with the collection
|
|
918
|
+
* for categorization and filtering.
|
|
919
|
+
* @property {string} type - The type of collection, either 'items' for manually
|
|
920
|
+
* added items or 'query' for dynamically fetched items.
|
|
921
|
+
* @property {string[]} [visible_facets_keys] - Keys of the facets that are
|
|
922
|
+
* visible and can be used for filtering the collection.
|
|
806
923
|
*/
|
|
807
924
|
/**
|
|
808
925
|
* @typedef CreateSearchConfigurationRequest
|
|
@@ -893,8 +1010,10 @@ export = CatalogPlatformModel;
|
|
|
893
1010
|
*/
|
|
894
1011
|
/**
|
|
895
1012
|
* @typedef DepartmentCategoryTree
|
|
896
|
-
* @property {string} [department]
|
|
897
|
-
*
|
|
1013
|
+
* @property {string} [department] - The name of the department that this
|
|
1014
|
+
* category tree belongs to, such as 'Men', 'Women', or 'Electronics'.
|
|
1015
|
+
* @property {CategoryItems[]} [items] - An array of categories that fall under
|
|
1016
|
+
* the specified department, each containing details about category items.
|
|
898
1017
|
*/
|
|
899
1018
|
/**
|
|
900
1019
|
* @typedef DepartmentErrorResponse
|
|
@@ -906,8 +1025,12 @@ export = CatalogPlatformModel;
|
|
|
906
1025
|
*/
|
|
907
1026
|
/**
|
|
908
1027
|
* @typedef DepartmentIdentifier
|
|
909
|
-
* @property {string} [
|
|
910
|
-
*
|
|
1028
|
+
* @property {string} [name] - The name of the department, such as
|
|
1029
|
+
* 'Electronics', 'Apparel', or 'Home Appliances'.
|
|
1030
|
+
* @property {string} [slug] - A URL-friendly identifier for the department,
|
|
1031
|
+
* often used in creating department-specific links or routes.
|
|
1032
|
+
* @property {number} [uid] - A unique identifier for the department, used to
|
|
1033
|
+
* distinguish it from other departments in the system.
|
|
911
1034
|
*/
|
|
912
1035
|
/**
|
|
913
1036
|
* @typedef DepartmentResponse
|
|
@@ -927,7 +1050,7 @@ export = CatalogPlatformModel;
|
|
|
927
1050
|
* @property {number} width - The width dimension.
|
|
928
1051
|
*/
|
|
929
1052
|
/**
|
|
930
|
-
* @typedef
|
|
1053
|
+
* @typedef InventoryDimensionResponse
|
|
931
1054
|
* @property {number} [height]
|
|
932
1055
|
* @property {number} [length]
|
|
933
1056
|
* @property {string} [unit]
|
|
@@ -952,11 +1075,12 @@ export = CatalogPlatformModel;
|
|
|
952
1075
|
*/
|
|
953
1076
|
/**
|
|
954
1077
|
* @typedef ErrorResponse
|
|
955
|
-
* @property {string} [code]
|
|
956
|
-
* @property {string} [error]
|
|
957
|
-
* @property {string} [message]
|
|
958
|
-
* @property {Object} [meta]
|
|
959
|
-
*
|
|
1078
|
+
* @property {string} [code] - A string representing the specific error code.
|
|
1079
|
+
* @property {string} [error] - A brief description of the error type.
|
|
1080
|
+
* @property {string} [message] - A detailed message explaining the error.
|
|
1081
|
+
* @property {Object} [meta] - Additional metadata or context about the error,
|
|
1082
|
+
* if available.
|
|
1083
|
+
* @property {number} [status] - The HTTP status code associated with the error.
|
|
960
1084
|
*/
|
|
961
1085
|
/**
|
|
962
1086
|
* @typedef FilerList
|
|
@@ -1115,38 +1239,52 @@ export = CatalogPlatformModel;
|
|
|
1115
1239
|
*/
|
|
1116
1240
|
/**
|
|
1117
1241
|
* @typedef GetCollectionDetailNest
|
|
1118
|
-
* @property {
|
|
1242
|
+
* @property {CollectionSchedule} [_schedule]
|
|
1119
1243
|
* @property {Action} [action]
|
|
1120
|
-
* @property {boolean} [allow_facets]
|
|
1121
|
-
*
|
|
1122
|
-
* @property {
|
|
1123
|
-
*
|
|
1244
|
+
* @property {boolean} [allow_facets] - Indicates whether facets are allowed for
|
|
1245
|
+
* filtering the collection.
|
|
1246
|
+
* @property {boolean} [allow_sort] - Indicates whether sorting options are
|
|
1247
|
+
* allowed for the collection.
|
|
1248
|
+
* @property {string} [app_id] - The application ID associated with the collection.
|
|
1249
|
+
* @property {CollectionBadge} [badge]
|
|
1124
1250
|
* @property {ImageUrls} [banners]
|
|
1125
|
-
* @property {
|
|
1126
|
-
* @property {
|
|
1127
|
-
* @property {boolean} [is_active]
|
|
1251
|
+
* @property {string} [description] - A description of the collection.
|
|
1252
|
+
* @property {boolean} [is_active] - Indicates whether the collection is currently active.
|
|
1128
1253
|
* @property {Media} [logo]
|
|
1129
|
-
* @property {Object} [meta]
|
|
1130
|
-
* @property {string} [name]
|
|
1131
|
-
* @property {number} [priority]
|
|
1132
|
-
*
|
|
1133
|
-
* @property {
|
|
1134
|
-
*
|
|
1135
|
-
* @property {string} [
|
|
1136
|
-
* @property {string} [
|
|
1137
|
-
* @property {string
|
|
1254
|
+
* @property {Object} [meta] - Additional metadata related to the collection.
|
|
1255
|
+
* @property {string} [name] - The name of the collection.
|
|
1256
|
+
* @property {number} [priority] - The priority level of the collection in the
|
|
1257
|
+
* display list.
|
|
1258
|
+
* @property {CollectionQuery[]} [query] - Array of queries that define how the
|
|
1259
|
+
* collection is fetched or filtered.
|
|
1260
|
+
* @property {string} [slug] - The URL-friendly identifier of the collection.
|
|
1261
|
+
* @property {string[]} [tag] - Array of tags associated with the collection.
|
|
1262
|
+
* @property {string} [type] - The type of collection, such as manual or automated.
|
|
1263
|
+
* @property {string} [uid] - The unique identifier for the collection.
|
|
1264
|
+
* @property {string[]} [visible_facets_keys] - List of facet keys that are
|
|
1265
|
+
* visible for filtering the collection.
|
|
1266
|
+
* @property {string} [_id] - Internal identifier for the collection.
|
|
1267
|
+
* @property {boolean} [published] - Indicates if the collection is published.
|
|
1268
|
+
* @property {string[]} [tags] - Tags associated with the collection.
|
|
1269
|
+
* @property {string} [sort_on] - Sort criteria for the collection.
|
|
1270
|
+
* @property {Object} [_custom_json] - Custom JSON data for the collection.
|
|
1271
|
+
* @property {Object} [_locale_language] - Locale-specific language settings.
|
|
1272
|
+
* @property {SeoDetail} [seo]
|
|
1273
|
+
* @property {boolean} [is_visible] - Indicates if the collection is visible.
|
|
1138
1274
|
*/
|
|
1139
1275
|
/**
|
|
1140
1276
|
* @typedef GetCollectionItemsResponse
|
|
1141
|
-
* @property {ProductFilters[]} [filters]
|
|
1142
|
-
*
|
|
1277
|
+
* @property {ProductFilters[]} [filters] - An array of filters applicable to
|
|
1278
|
+
* the products in the collection.
|
|
1279
|
+
* @property {ProductListingDetail[]} [items] - List of product details in the collection.
|
|
1143
1280
|
* @property {Page} [page]
|
|
1144
|
-
* @property {ProductSortOn[]} [sort_on]
|
|
1281
|
+
* @property {ProductSortOn[]} [sort_on] - Sorting options available for the
|
|
1282
|
+
* products in the collection.
|
|
1145
1283
|
*/
|
|
1146
1284
|
/**
|
|
1147
1285
|
* @typedef GetCollectionListingResponse
|
|
1148
1286
|
* @property {CollectionListingFilter} [filters]
|
|
1149
|
-
* @property {GetCollectionDetailNest[]} [items]
|
|
1287
|
+
* @property {GetCollectionDetailNest[]} [items] - Array of nested collection details.
|
|
1150
1288
|
* @property {Page} [page]
|
|
1151
1289
|
*/
|
|
1152
1290
|
/**
|
|
@@ -1212,12 +1350,12 @@ export = CatalogPlatformModel;
|
|
|
1212
1350
|
*/
|
|
1213
1351
|
/**
|
|
1214
1352
|
* @typedef GetDepartment
|
|
1215
|
-
* @property {
|
|
1353
|
+
* @property {RequestUserSerializer} [created_by]
|
|
1216
1354
|
* @property {string} [created_on]
|
|
1217
1355
|
* @property {boolean} [is_active]
|
|
1218
1356
|
* @property {string} [item_type]
|
|
1219
1357
|
* @property {string} [logo]
|
|
1220
|
-
* @property {
|
|
1358
|
+
* @property {RequestUserSerializer} [modified_by]
|
|
1221
1359
|
* @property {string} [modified_on]
|
|
1222
1360
|
* @property {string} [name]
|
|
1223
1361
|
* @property {number} [page_no]
|
|
@@ -1230,24 +1368,24 @@ export = CatalogPlatformModel;
|
|
|
1230
1368
|
*/
|
|
1231
1369
|
/**
|
|
1232
1370
|
* @typedef GetInventories
|
|
1233
|
-
* @property {
|
|
1234
|
-
* @property {
|
|
1371
|
+
* @property {InventoryBrandMeta} [brand]
|
|
1372
|
+
* @property {InventoryCompanyMeta} [company]
|
|
1235
1373
|
* @property {string} [country_of_origin]
|
|
1236
|
-
* @property {
|
|
1374
|
+
* @property {RequestUserSerializer} [created_by]
|
|
1237
1375
|
* @property {DateMeta} [date_meta]
|
|
1238
|
-
* @property {
|
|
1376
|
+
* @property {InventoryDimensionResponse} [dimension]
|
|
1239
1377
|
* @property {string} [expiration_date]
|
|
1240
1378
|
* @property {string} [id]
|
|
1241
1379
|
* @property {Object} [identifier]
|
|
1242
1380
|
* @property {string} [inventory_updated_on]
|
|
1243
1381
|
* @property {boolean} [is_set]
|
|
1244
1382
|
* @property {number} [item_id]
|
|
1245
|
-
* @property {
|
|
1246
|
-
* @property {
|
|
1383
|
+
* @property {InventoryManufacturerResponse} [manufacturer]
|
|
1384
|
+
* @property {RequestUserSerializer} [modified_by]
|
|
1247
1385
|
* @property {Object} [platforms]
|
|
1248
1386
|
* @property {PriceArticle} [price]
|
|
1249
1387
|
* @property {QuantitiesArticle} [quantities]
|
|
1250
|
-
* @property {
|
|
1388
|
+
* @property {ReturnConfig} [return_config]
|
|
1251
1389
|
* @property {string} [seller_identifier]
|
|
1252
1390
|
* @property {string} [size]
|
|
1253
1391
|
* @property {string} [stage]
|
|
@@ -1257,9 +1395,9 @@ export = CatalogPlatformModel;
|
|
|
1257
1395
|
* @property {number} [total_quantity]
|
|
1258
1396
|
* @property {string} [trace_id]
|
|
1259
1397
|
* @property {boolean} [track_inventory]
|
|
1260
|
-
* @property {
|
|
1398
|
+
* @property {TraderResponse[]} [trader]
|
|
1261
1399
|
* @property {string} [uid]
|
|
1262
|
-
* @property {
|
|
1400
|
+
* @property {InventoryWeightResponse} [weight]
|
|
1263
1401
|
*/
|
|
1264
1402
|
/**
|
|
1265
1403
|
* @typedef GetInventoriesResponse
|
|
@@ -1970,7 +2108,7 @@ export = CatalogPlatformModel;
|
|
|
1970
2108
|
* @property {string} name - The name of the manufacturer.
|
|
1971
2109
|
*/
|
|
1972
2110
|
/**
|
|
1973
|
-
* @typedef
|
|
2111
|
+
* @typedef InventoryManufacturerResponse
|
|
1974
2112
|
* @property {string} [address]
|
|
1975
2113
|
* @property {boolean} [is_default]
|
|
1976
2114
|
* @property {string} [name]
|
|
@@ -1993,6 +2131,15 @@ export = CatalogPlatformModel;
|
|
|
1993
2131
|
* @property {string} [type]
|
|
1994
2132
|
* @property {string} [url]
|
|
1995
2133
|
*/
|
|
2134
|
+
/**
|
|
2135
|
+
* @typedef BrandMedia
|
|
2136
|
+
* @property {string} [aspect_ratio] - The aspect ratio of the media, typically
|
|
2137
|
+
* represented as a string like '16:9' or '4:3'.
|
|
2138
|
+
* @property {string} [type] - The type of media, such as 'image', 'video', or
|
|
2139
|
+
* 'audio', describing the content format.
|
|
2140
|
+
* @property {string} [url] - The URL where the media file is hosted, typically
|
|
2141
|
+
* a link to an image or video resource.
|
|
2142
|
+
*/
|
|
1996
2143
|
/**
|
|
1997
2144
|
* @typedef Meta
|
|
1998
2145
|
* @property {Object} [headers]
|
|
@@ -2044,8 +2191,8 @@ export = CatalogPlatformModel;
|
|
|
2044
2191
|
*/
|
|
2045
2192
|
/**
|
|
2046
2193
|
* @typedef NextSchedule
|
|
2047
|
-
* @property {string} [end]
|
|
2048
|
-
* @property {string} [start]
|
|
2194
|
+
* @property {string} [end] - The end time of the schedule.
|
|
2195
|
+
* @property {string} [start] - The start time of the schedule.
|
|
2049
2196
|
*/
|
|
2050
2197
|
/**
|
|
2051
2198
|
* @typedef OptInPostRequest
|
|
@@ -2117,15 +2264,6 @@ export = CatalogPlatformModel;
|
|
|
2117
2264
|
* the filter.
|
|
2118
2265
|
* @property {number} [size] - It is the size of each page.
|
|
2119
2266
|
*/
|
|
2120
|
-
/**
|
|
2121
|
-
* @typedef PageResponse1
|
|
2122
|
-
* @property {number} [current]
|
|
2123
|
-
* @property {boolean} [has_next]
|
|
2124
|
-
* @property {boolean} [has_previous]
|
|
2125
|
-
* @property {number} [item_total]
|
|
2126
|
-
* @property {number} [size]
|
|
2127
|
-
* @property {string} [type]
|
|
2128
|
-
*/
|
|
2129
2267
|
/**
|
|
2130
2268
|
* @typedef PageResponseType
|
|
2131
2269
|
* @property {number} current
|
|
@@ -2755,33 +2893,39 @@ export = CatalogPlatformModel;
|
|
|
2755
2893
|
*/
|
|
2756
2894
|
/**
|
|
2757
2895
|
* @typedef Sitemap
|
|
2758
|
-
* @property {number} [priority]
|
|
2759
|
-
*
|
|
2896
|
+
* @property {number} [priority] - Indicates the priority of this URL relative
|
|
2897
|
+
* to other URLs on the site. A value between 0.0 and 1.0, where 1.0 is the
|
|
2898
|
+
* highest priority.
|
|
2899
|
+
* @property {string} [frequency] - How frequently the content at the URL is
|
|
2900
|
+
* likely to change.
|
|
2760
2901
|
*/
|
|
2761
2902
|
/**
|
|
2762
2903
|
* @typedef ApplicationItemSeoAction
|
|
2763
|
-
* @property {Object} [page]
|
|
2764
|
-
* @property {string} type
|
|
2904
|
+
* @property {Object} [page] - Details of the page associated with this SEO action.
|
|
2905
|
+
* @property {string} type - Type of action, such as navigation or redirection.
|
|
2765
2906
|
*/
|
|
2766
2907
|
/**
|
|
2767
2908
|
* @typedef ApplicationItemSeoBreadcrumbs
|
|
2768
|
-
* @property {string} [url]
|
|
2769
|
-
* @property {ApplicationItemSeoAction[]} [action]
|
|
2909
|
+
* @property {string} [url] - The URL that this breadcrumb points to.
|
|
2910
|
+
* @property {ApplicationItemSeoAction[]} [action] - The actions available for
|
|
2911
|
+
* this breadcrumb, defining what happens when it's clicked or interacted with.
|
|
2770
2912
|
*/
|
|
2771
2913
|
/**
|
|
2772
2914
|
* @typedef ApplicationItemSeoMetaTagItem
|
|
2773
|
-
* @property {string} key
|
|
2774
|
-
* @property {string} value
|
|
2915
|
+
* @property {string} key - The name of the meta tag.
|
|
2916
|
+
* @property {string} value - The value associated with the meta tag.
|
|
2775
2917
|
*/
|
|
2776
2918
|
/**
|
|
2777
2919
|
* @typedef ApplicationItemSeoMetaTags
|
|
2778
|
-
* @property {string} title
|
|
2779
|
-
* @property {ApplicationItemSeoMetaTagItem[]} [items]
|
|
2920
|
+
* @property {string} title - The title for this set of meta tags.
|
|
2921
|
+
* @property {ApplicationItemSeoMetaTagItem[]} [items] - A list of meta tag
|
|
2922
|
+
* items, each defined by key-value pairs.
|
|
2780
2923
|
*/
|
|
2781
2924
|
/**
|
|
2782
2925
|
* @typedef Metatags
|
|
2783
|
-
* @property {string} [title]
|
|
2784
|
-
* @property {ApplicationItemSeoMetaTagItem[]} [items]
|
|
2926
|
+
* @property {string} [title] - The title or heading for the meta tags section.
|
|
2927
|
+
* @property {ApplicationItemSeoMetaTagItem[]} [items] - An array of meta tag
|
|
2928
|
+
* items, each consisting of key-value pairs.
|
|
2785
2929
|
*/
|
|
2786
2930
|
/**
|
|
2787
2931
|
* @typedef SizePromotionThreshold
|
|
@@ -2813,13 +2957,16 @@ export = CatalogPlatformModel;
|
|
|
2813
2957
|
*/
|
|
2814
2958
|
/**
|
|
2815
2959
|
* @typedef SecondLevelChild
|
|
2816
|
-
* @property {Object} [_custom_json]
|
|
2960
|
+
* @property {Object} [_custom_json] - Custom JSON object to store additional
|
|
2961
|
+
* data for the second-level child.
|
|
2817
2962
|
* @property {Action} [action]
|
|
2818
2963
|
* @property {ImageUrls} [banners]
|
|
2819
|
-
* @property {ThirdLevelChild[]} [childs]
|
|
2820
|
-
*
|
|
2821
|
-
* @property {string} [
|
|
2822
|
-
* @property {
|
|
2964
|
+
* @property {ThirdLevelChild[]} [childs] - A list of third-level child elements
|
|
2965
|
+
* under the second-level child.
|
|
2966
|
+
* @property {string} [name] - Name of the second-level child element.
|
|
2967
|
+
* @property {string} [slug] - Slug or URL-friendly identifier for the
|
|
2968
|
+
* second-level child element.
|
|
2969
|
+
* @property {number} [uid] - Unique identifier for the second-level child element.
|
|
2823
2970
|
*/
|
|
2824
2971
|
/**
|
|
2825
2972
|
* @typedef SellerPhoneNumber
|
|
@@ -2828,12 +2975,20 @@ export = CatalogPlatformModel;
|
|
|
2828
2975
|
*/
|
|
2829
2976
|
/**
|
|
2830
2977
|
* @typedef SeoDetail
|
|
2831
|
-
* @property {string} [description]
|
|
2832
|
-
*
|
|
2833
|
-
* @property {
|
|
2834
|
-
*
|
|
2835
|
-
* @property {
|
|
2836
|
-
*
|
|
2978
|
+
* @property {string} [description] - SEO meta description for the item or
|
|
2979
|
+
* collection. This is used to describe the content for search engines.
|
|
2980
|
+
* @property {string} [title] - SEO meta title for the item or collection. It is
|
|
2981
|
+
* used as the title that appears in search results.
|
|
2982
|
+
* @property {Object} [sitemap] - Information regarding the sitemap
|
|
2983
|
+
* configuration for the item or collection.
|
|
2984
|
+
* @property {ApplicationItemSeoBreadcrumbs[]} [breadcrumbs] - List of
|
|
2985
|
+
* breadcrumbs for navigation, showing the hierarchy of pages leading to the
|
|
2986
|
+
* current page.
|
|
2987
|
+
* @property {Metatags[]} [meta_tags] - An array of meta tags, each containing
|
|
2988
|
+
* key-value pairs for various SEO meta tags used to enhance search visibility.
|
|
2989
|
+
* @property {string} [canonical_url] - The canonical URL for the item or
|
|
2990
|
+
* collection, which tells search engines the preferred version of the URL to
|
|
2991
|
+
* avoid duplicate content issues.
|
|
2837
2992
|
*/
|
|
2838
2993
|
/**
|
|
2839
2994
|
* @typedef SetSize
|
|
@@ -2920,9 +3075,10 @@ export = CatalogPlatformModel;
|
|
|
2920
3075
|
* @property {boolean} [success]
|
|
2921
3076
|
*/
|
|
2922
3077
|
/**
|
|
2923
|
-
* @typedef
|
|
2924
|
-
* @property {boolean} [success]
|
|
2925
|
-
* @property {number} [uid]
|
|
3078
|
+
* @typedef SuccessResponseObject
|
|
3079
|
+
* @property {boolean} [success] - Indicates whether the operation was successful or not.
|
|
3080
|
+
* @property {number} [uid] - A unique identifier associated with the successful
|
|
3081
|
+
* operation.
|
|
2926
3082
|
*/
|
|
2927
3083
|
/**
|
|
2928
3084
|
* @typedef TaxIdentifier
|
|
@@ -2975,13 +3131,16 @@ export = CatalogPlatformModel;
|
|
|
2975
3131
|
*/
|
|
2976
3132
|
/**
|
|
2977
3133
|
* @typedef ThirdLevelChild
|
|
2978
|
-
* @property {Object} [_custom_json]
|
|
3134
|
+
* @property {Object} [_custom_json] - Custom JSON object to store additional
|
|
3135
|
+
* data for the third-level child.
|
|
2979
3136
|
* @property {Action} [action]
|
|
2980
3137
|
* @property {ImageUrls} [banners]
|
|
2981
|
-
* @property {Object[]} [childs]
|
|
2982
|
-
*
|
|
2983
|
-
* @property {string} [
|
|
2984
|
-
* @property {
|
|
3138
|
+
* @property {Object[]} [childs] - A list of further nested child elements under
|
|
3139
|
+
* the third-level child (if applicable).
|
|
3140
|
+
* @property {string} [name] - Name of the third-level child element.
|
|
3141
|
+
* @property {string} [slug] - Slug or URL-friendly identifier for the
|
|
3142
|
+
* third-level child element.
|
|
3143
|
+
* @property {number} [uid] - Unique identifier for the third-level child element.
|
|
2985
3144
|
*/
|
|
2986
3145
|
/**
|
|
2987
3146
|
* @typedef Trader
|
|
@@ -2996,7 +3155,7 @@ export = CatalogPlatformModel;
|
|
|
2996
3155
|
* @property {string} type
|
|
2997
3156
|
*/
|
|
2998
3157
|
/**
|
|
2999
|
-
* @typedef
|
|
3158
|
+
* @typedef TraderResponse
|
|
3000
3159
|
* @property {string[]} [address]
|
|
3001
3160
|
* @property {string} [name]
|
|
3002
3161
|
* @property {string} [type]
|
|
@@ -3015,7 +3174,7 @@ export = CatalogPlatformModel;
|
|
|
3015
3174
|
* @property {boolean} [is_visible]
|
|
3016
3175
|
* @property {CollectionImage} [logo]
|
|
3017
3176
|
* @property {Object} [meta]
|
|
3018
|
-
* @property {
|
|
3177
|
+
* @property {UserInfo} [modified_by]
|
|
3019
3178
|
* @property {string} [name]
|
|
3020
3179
|
* @property {number} [priority]
|
|
3021
3180
|
* @property {boolean} [published]
|
|
@@ -3102,7 +3261,7 @@ export = CatalogPlatformModel;
|
|
|
3102
3261
|
* @property {string} [username] - The username of the user.
|
|
3103
3262
|
*/
|
|
3104
3263
|
/**
|
|
3105
|
-
* @typedef
|
|
3264
|
+
* @typedef RequestUserSerializer
|
|
3106
3265
|
* @property {string} [_id]
|
|
3107
3266
|
* @property {string} [contact]
|
|
3108
3267
|
* @property {string} [uid]
|
|
@@ -3161,7 +3320,7 @@ export = CatalogPlatformModel;
|
|
|
3161
3320
|
* @property {string} unit - The unit of weight.
|
|
3162
3321
|
*/
|
|
3163
3322
|
/**
|
|
3164
|
-
* @typedef
|
|
3323
|
+
* @typedef InventoryWeightResponse
|
|
3165
3324
|
* @property {number} [shipping]
|
|
3166
3325
|
* @property {string} [unit]
|
|
3167
3326
|
*/
|
|
@@ -3271,7 +3430,7 @@ export = CatalogPlatformModel;
|
|
|
3271
3430
|
declare class CatalogPlatformModel {
|
|
3272
3431
|
}
|
|
3273
3432
|
declare namespace CatalogPlatformModel {
|
|
3274
|
-
export { Action, AllSizes, AllowSingleRequest, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponse, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponse, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductListingResponse, ApplicationStoreJson, AppReturnConfigResponse, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponse, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSerializer, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponse, Brand, BrandItem, BrandListingResponse, BrandMeta,
|
|
3433
|
+
export { Action, AllSizes, AllowSingleRequest, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponse, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponse, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductListingResponse, ApplicationStoreJson, AppReturnConfigResponse, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponse, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSerializer, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponse, Brand, BrandItem, BrandListingResponse, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponse, BulkHsnResponse, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkProductJob, BulkJob, BulkProductRequest, BulkResponse, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponse, CategoriesResponse, Category, CategoryItems, CategoryListingResponse, CategoryMapping, CategoryMappingValues, CategoryResponse, Child, CollectionBadge, CollectionBanner, CollectionCreateResponse, CollectionDetailResponse, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponse, ConfigSuccessResponse, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponse, CreateCollection, CreateSearchConfigurationRequest, CreateSearchConfigurationResponse, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponse, CustomOrder, DateMeta, DefaultKeyRequest, DeleteAppCategoryReturnConfig, DeleteResponse, DeleteSearchConfigurationResponse, Department, DepartmentCategoryTree, DepartmentErrorResponse, DepartmentIdentifier, DepartmentResponse, DepartmentsResponse, DimensionResponse, InventoryDimensionResponse, Document, EntityConfiguration, ErrorResponse, FilerList, RawProduct, RawProductListingResponse, GTIN, AttributeDetail, GetAddressSerializer, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponse, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponse, GetCollectionListingResponse, GetCollectionQueryOptionResponse, GetCompanySerializer, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponse, GetConfigMetadataValues, GetConfigResponse, GetDepartment, GetInventories, GetInventoriesResponse, GetLocationSerializer, GetOptInPlatform, GetProductBundleCreateResponse, GetProductBundleListingResponse, GetProductBundleResponse, GetProducts, GetCollectionDetailResponse, CommonResponseSchemaCollection, GetQueryFiltersKeysResponse, GetQueryFiltersResponse, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponse, GetSearchWordsData, GetSearchWordsDetailResponse, GetSearchWordsResponse, GlobalValidation, Guide, HSNCodesResponse, HSNData, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequest, InventoryConfig, InventoryCreateRequest, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponse, InventoryExportQuantityFilter, InventoryExportRequest, InventoryExportResponse, InventoryFailedReason, InventoryJobDetailResponse, InventoryJobFilters, InventoryJobPayload, InventoryPage, InventoryPayload, InventoryRequest, InventoryRequestSchemaV2, InventoryResponse, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, InventorySellerResponse, InventorySet, InventoryStockResponse, InventoryUpdateResponse, InventoryValidationResponse, InvoiceCredSerializer, InvoiceDetailsSerializer, ItemQuery, Items, LimitedProductData, ListSizeGuide, LocationDayWiseSerializer, LocationIntegrationType, LocationListSerializer, LocationManagerSerializer, LocationTimingSerializer, Logo, MOQData, ManufacturerResponse, InventoryManufacturerResponse, Media, Media1, Media2, BrandMedia, Meta, MetaDataListingFilterMetaResponse, MetaDataListingFilterResponse, MetaDataListingResponse, MetaDataListingSortMetaResponse, MetaDataListingSortResponse, MetaFields, NetQuantity, NetQuantityResponse, NextSchedule, OptInPostRequest, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponse, PTErrorResponse, Page, PageResponse, PageResponseType, Price, Price1, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponse, Product, ProductAttributesResponse, ProductBrand, ProductBulkAssets, ProductBulkRequest, ProductBulkRequestList, ProductBundleItem, ProductBundleRequest, ProductBundleUpdateRequest, ProductConfigurationDownloads, ProductCreateUpdateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponse, ProductFilters, GetQueryFiltersValuesResponse, ProductFiltersKeysOnly, ProductFiltersKey, ProductFiltersValue, ProductListingDetail, ProductListingPrice, ProductListingResponse, ProductListingResponseV2, ProductPublish, ProductPublish1, ProductPublished, ProductReturnConfigSerializer, ProductReturnConfigBaseSerializer, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponse, ProductSizeDeleteResponse, ProductSortOn, ProductTagsViewResponse, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequest, ProductTemplateExportResponse, ProductVariants, ProductVariantsResponse, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, ReturnConfig1, ReturnConfig2, ReturnConfigResponse, Sitemap, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, SeoDetail, SetSize, SingleCategoryResponse, SingleProductResponse, Size, SizeDistribution, SizeGuideResponse, StoreAssignResponse, StoreDetail, StoreMeta, SuccessResponse, SuccessResponseObject, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateValidationData, TemplatesResponse, TemplatesValidationResponse, ThirdLevelChild, Trader, Trader1, TraderResponse, UpdateCollection, UpdateSearchConfigurationRequest, UpdateSearchConfigurationResponse, CreateMarketplaceOptinResponse, UserCommon, UserDetail, UserDetail1, UserInfo, UserInfo1, UserSerializer, RequestUserSerializer, UserSerializer2, UserSerializer3, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponse, InventoryWeightResponse, CreatedBy, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequest, UpdateMarketplaceOptinResponse, ActionPage, PageType };
|
|
3275
3434
|
}
|
|
3276
3435
|
/** @returns {Action} */
|
|
3277
3436
|
declare function Action(): Action;
|
|
@@ -3388,11 +3547,20 @@ type AppConfigurationsSort = {
|
|
|
3388
3547
|
/** @returns {ApplicationBrandJson} */
|
|
3389
3548
|
declare function ApplicationBrandJson(): ApplicationBrandJson;
|
|
3390
3549
|
type ApplicationBrandJson = {
|
|
3550
|
+
/**
|
|
3551
|
+
* - A custom JSON object containing additional
|
|
3552
|
+
* brand-specific configurations or data. The structure is flexible and may
|
|
3553
|
+
* vary based on application needs.
|
|
3554
|
+
*/
|
|
3391
3555
|
_custom_json: any;
|
|
3392
3556
|
};
|
|
3393
3557
|
/** @returns {ApplicationCategoryJson} */
|
|
3394
3558
|
declare function ApplicationCategoryJson(): ApplicationCategoryJson;
|
|
3395
3559
|
type ApplicationCategoryJson = {
|
|
3560
|
+
/**
|
|
3561
|
+
* - A custom JSON object containing additional
|
|
3562
|
+
* details or configurations specific to the application category.
|
|
3563
|
+
*/
|
|
3396
3564
|
_custom_json: any;
|
|
3397
3565
|
};
|
|
3398
3566
|
/** @returns {ApplicationDepartment} */
|
|
@@ -3702,8 +3870,20 @@ type AutocompleteResult = {
|
|
|
3702
3870
|
/** @returns {BannerImage} */
|
|
3703
3871
|
declare function BannerImage(): BannerImage;
|
|
3704
3872
|
type BannerImage = {
|
|
3873
|
+
/**
|
|
3874
|
+
* - The aspect ratio of the banner image,
|
|
3875
|
+
* typically represented as a ratio (e.g., '16:9' or '4:3').
|
|
3876
|
+
*/
|
|
3705
3877
|
aspect_ratio?: string;
|
|
3878
|
+
/**
|
|
3879
|
+
* - The type of media, such as 'image' or 'banner',
|
|
3880
|
+
* indicating the format of the banner.
|
|
3881
|
+
*/
|
|
3706
3882
|
type?: string;
|
|
3883
|
+
/**
|
|
3884
|
+
* - The URL where the banner image is located,
|
|
3885
|
+
* typically a web address pointing to the image resource.
|
|
3886
|
+
*/
|
|
3707
3887
|
url?: string;
|
|
3708
3888
|
};
|
|
3709
3889
|
/** @returns {BaseAppCategoryReturnConfig} */
|
|
@@ -3740,28 +3920,192 @@ declare function BrandItem(): BrandItem;
|
|
|
3740
3920
|
type BrandItem = {
|
|
3741
3921
|
action?: Action;
|
|
3742
3922
|
banners?: ImageUrls;
|
|
3923
|
+
/**
|
|
3924
|
+
* - An array of department names or
|
|
3925
|
+
* categories that the brand belongs to, represented as strings.
|
|
3926
|
+
*/
|
|
3743
3927
|
departments?: string[];
|
|
3928
|
+
/**
|
|
3929
|
+
* - A string representing the discount offered by
|
|
3930
|
+
* the brand, such as percentage or amount off.
|
|
3931
|
+
*/
|
|
3744
3932
|
discount?: string;
|
|
3745
|
-
logo?:
|
|
3933
|
+
logo?: BrandMedia;
|
|
3934
|
+
/**
|
|
3935
|
+
* - The name of the brand.
|
|
3936
|
+
*/
|
|
3746
3937
|
name?: string;
|
|
3938
|
+
/**
|
|
3939
|
+
* - A URL-friendly identifier for the brand, often
|
|
3940
|
+
* used in website routing.
|
|
3941
|
+
*/
|
|
3747
3942
|
slug?: string;
|
|
3943
|
+
/**
|
|
3944
|
+
* - A unique identifier for the brand, typically used
|
|
3945
|
+
* for internal reference.
|
|
3946
|
+
*/
|
|
3748
3947
|
uid?: number;
|
|
3749
3948
|
};
|
|
3750
3949
|
/** @returns {BrandListingResponse} */
|
|
3751
3950
|
declare function BrandListingResponse(): BrandListingResponse;
|
|
3752
3951
|
type BrandListingResponse = {
|
|
3952
|
+
/**
|
|
3953
|
+
* - An array of brand items, each containing
|
|
3954
|
+
* detailed information about the brand, such as action, banners, departments,
|
|
3955
|
+
* discount, logo, and other related fields.
|
|
3956
|
+
*/
|
|
3753
3957
|
items?: BrandItem[];
|
|
3754
3958
|
page: Page;
|
|
3755
3959
|
};
|
|
3960
|
+
/** @returns {ApplicationBrandListingItemSchema} */
|
|
3961
|
+
declare function ApplicationBrandListingItemSchema(): ApplicationBrandListingItemSchema;
|
|
3962
|
+
type ApplicationBrandListingItemSchema = {
|
|
3963
|
+
/**
|
|
3964
|
+
* - Custom JSON object for additional data.
|
|
3965
|
+
*/
|
|
3966
|
+
_custom_json?: any;
|
|
3967
|
+
/**
|
|
3968
|
+
* - Custom object for locale-specific
|
|
3969
|
+
* language data.
|
|
3970
|
+
*/
|
|
3971
|
+
_locale_language?: any;
|
|
3972
|
+
/**
|
|
3973
|
+
* - URL of the brand's portrait banner.
|
|
3974
|
+
*/
|
|
3975
|
+
brand_banner_portrait_url?: string;
|
|
3976
|
+
/**
|
|
3977
|
+
* - URL of the brand's landscape banner.
|
|
3978
|
+
*/
|
|
3979
|
+
brand_banner_url?: string;
|
|
3980
|
+
/**
|
|
3981
|
+
* - URL of the brand's logo.
|
|
3982
|
+
*/
|
|
3983
|
+
brand_logo_url?: string;
|
|
3984
|
+
/**
|
|
3985
|
+
* - Description of the brand.
|
|
3986
|
+
*/
|
|
3987
|
+
description?: string;
|
|
3988
|
+
/**
|
|
3989
|
+
* - Name of the brand.
|
|
3990
|
+
*/
|
|
3991
|
+
name?: string;
|
|
3992
|
+
/**
|
|
3993
|
+
* - Unique slug key for the brand.
|
|
3994
|
+
*/
|
|
3995
|
+
slug_key?: string;
|
|
3996
|
+
/**
|
|
3997
|
+
* - Priority of the brand in listing.
|
|
3998
|
+
*/
|
|
3999
|
+
priority?: number;
|
|
4000
|
+
/**
|
|
4001
|
+
* - Unique identifier of the brand.
|
|
4002
|
+
*/
|
|
4003
|
+
uid?: number;
|
|
4004
|
+
/**
|
|
4005
|
+
* - Timestamp when the category was created.
|
|
4006
|
+
*/
|
|
4007
|
+
created_on?: string;
|
|
4008
|
+
/**
|
|
4009
|
+
* - Timestamp when the category was created.
|
|
4010
|
+
*/
|
|
4011
|
+
last_updated?: string;
|
|
4012
|
+
/**
|
|
4013
|
+
* - Indicates if the brand is active.
|
|
4014
|
+
*/
|
|
4015
|
+
is_active?: boolean;
|
|
4016
|
+
/**
|
|
4017
|
+
* - List of department IDs associated with the brand.
|
|
4018
|
+
*/
|
|
4019
|
+
departments?: number[];
|
|
4020
|
+
/**
|
|
4021
|
+
* - Timestamp when the brand was last modified.
|
|
4022
|
+
*/
|
|
4023
|
+
modified_on?: string;
|
|
4024
|
+
/**
|
|
4025
|
+
* - Boolean indicating whether the brand is
|
|
4026
|
+
* currently active or not.
|
|
4027
|
+
*/
|
|
4028
|
+
active?: boolean;
|
|
4029
|
+
};
|
|
4030
|
+
/** @returns {ApplicationBrandListingSchema} */
|
|
4031
|
+
declare function ApplicationBrandListingSchema(): ApplicationBrandListingSchema;
|
|
4032
|
+
type ApplicationBrandListingSchema = {
|
|
4033
|
+
items?: ApplicationBrandListingItemSchema[];
|
|
4034
|
+
page?: Page;
|
|
4035
|
+
};
|
|
4036
|
+
/** @returns {ApplicationCategoryListingSchema} */
|
|
4037
|
+
declare function ApplicationCategoryListingSchema(): ApplicationCategoryListingSchema;
|
|
4038
|
+
type ApplicationCategoryListingSchema = {
|
|
4039
|
+
items?: ApplicationCategoryListingItemSchema[];
|
|
4040
|
+
page?: Page;
|
|
4041
|
+
};
|
|
4042
|
+
/** @returns {ApplicationCategoryListingItemSchema} */
|
|
4043
|
+
declare function ApplicationCategoryListingItemSchema(): ApplicationCategoryListingItemSchema;
|
|
4044
|
+
type ApplicationCategoryListingItemSchema = {
|
|
4045
|
+
/**
|
|
4046
|
+
* - Name of the category.
|
|
4047
|
+
*/
|
|
4048
|
+
name?: string;
|
|
4049
|
+
/**
|
|
4050
|
+
* - URL of the category's logo.
|
|
4051
|
+
*/
|
|
4052
|
+
logo?: string;
|
|
4053
|
+
/**
|
|
4054
|
+
* - List of department IDs.
|
|
4055
|
+
*/
|
|
4056
|
+
departments?: number[];
|
|
4057
|
+
/**
|
|
4058
|
+
* - Attribute name of the category.
|
|
4059
|
+
*/
|
|
4060
|
+
attr_name?: string;
|
|
4061
|
+
/**
|
|
4062
|
+
* - URL of the landscape banner.
|
|
4063
|
+
*/
|
|
4064
|
+
landscape_url?: string;
|
|
4065
|
+
/**
|
|
4066
|
+
* - URL of the portrait banner.
|
|
4067
|
+
*/
|
|
4068
|
+
portrait_url?: string;
|
|
4069
|
+
/**
|
|
4070
|
+
* - Custom JSON object for additional data.
|
|
4071
|
+
*/
|
|
4072
|
+
_custom_json?: any;
|
|
4073
|
+
/**
|
|
4074
|
+
* - Priority of the category.
|
|
4075
|
+
*/
|
|
4076
|
+
priority?: number;
|
|
4077
|
+
created_by?: CreatedBy;
|
|
4078
|
+
/**
|
|
4079
|
+
* - Timestamp when the category was created.
|
|
4080
|
+
*/
|
|
4081
|
+
created_on?: string;
|
|
4082
|
+
modified_by?: CreatedBy;
|
|
4083
|
+
/**
|
|
4084
|
+
* - Timestamp when the category was last modified.
|
|
4085
|
+
*/
|
|
4086
|
+
modified_on?: string;
|
|
4087
|
+
/**
|
|
4088
|
+
* - Application ID associated with the category.
|
|
4089
|
+
*/
|
|
4090
|
+
app_id?: string;
|
|
4091
|
+
/**
|
|
4092
|
+
* - Indicates whether the category is active.
|
|
4093
|
+
*/
|
|
4094
|
+
is_active?: boolean;
|
|
4095
|
+
/**
|
|
4096
|
+
* - Unique identifier of the category.
|
|
4097
|
+
*/
|
|
4098
|
+
uid?: number;
|
|
4099
|
+
};
|
|
3756
4100
|
/** @returns {BrandMeta} */
|
|
3757
4101
|
declare function BrandMeta(): BrandMeta;
|
|
3758
4102
|
type BrandMeta = {
|
|
3759
4103
|
id: number;
|
|
3760
4104
|
name: string;
|
|
3761
4105
|
};
|
|
3762
|
-
/** @returns {
|
|
3763
|
-
declare function
|
|
3764
|
-
type
|
|
4106
|
+
/** @returns {InventoryBrandMeta} */
|
|
4107
|
+
declare function InventoryBrandMeta(): InventoryBrandMeta;
|
|
4108
|
+
type InventoryBrandMeta = {
|
|
3765
4109
|
id?: number;
|
|
3766
4110
|
name?: string;
|
|
3767
4111
|
};
|
|
@@ -3897,18 +4241,52 @@ type BulkResponse = {
|
|
|
3897
4241
|
/** @returns {CatalogInsightBrand} */
|
|
3898
4242
|
declare function CatalogInsightBrand(): CatalogInsightBrand;
|
|
3899
4243
|
type CatalogInsightBrand = {
|
|
4244
|
+
/**
|
|
4245
|
+
* - The average freshness of the
|
|
4246
|
+
* articles based on the time since they were added to the catalog.
|
|
4247
|
+
*/
|
|
3900
4248
|
article_freshness?: number;
|
|
4249
|
+
/**
|
|
4250
|
+
* - The number of articles that are
|
|
4251
|
+
* currently available for purchase.
|
|
4252
|
+
*/
|
|
3901
4253
|
available_articles?: number;
|
|
4254
|
+
/**
|
|
4255
|
+
* - The total number of unique sizes
|
|
4256
|
+
* available across all articles.
|
|
4257
|
+
*/
|
|
3902
4258
|
available_sizes?: number;
|
|
4259
|
+
/**
|
|
4260
|
+
* - The name of the brand.
|
|
4261
|
+
*/
|
|
3903
4262
|
name?: string;
|
|
4263
|
+
/**
|
|
4264
|
+
* - The total number of articles listed
|
|
4265
|
+
* under the brand.
|
|
4266
|
+
*/
|
|
3904
4267
|
total_articles?: number;
|
|
4268
|
+
/**
|
|
4269
|
+
* - The total number of sizes offered across
|
|
4270
|
+
* all articles for the brand.
|
|
4271
|
+
*/
|
|
3905
4272
|
total_sizes?: number;
|
|
3906
4273
|
};
|
|
3907
4274
|
/** @returns {CatalogInsightItem} */
|
|
3908
4275
|
declare function CatalogInsightItem(): CatalogInsightItem;
|
|
3909
4276
|
type CatalogInsightItem = {
|
|
4277
|
+
/**
|
|
4278
|
+
* - The total number of catalog items available.
|
|
4279
|
+
*/
|
|
3910
4280
|
count?: number;
|
|
4281
|
+
/**
|
|
4282
|
+
* - The number of items that are
|
|
4283
|
+
* currently out of stock.
|
|
4284
|
+
*/
|
|
3911
4285
|
out_of_stock_count?: number;
|
|
4286
|
+
/**
|
|
4287
|
+
* - The number of items that are currently
|
|
4288
|
+
* sellable (in stock).
|
|
4289
|
+
*/
|
|
3912
4290
|
sellable_count?: number;
|
|
3913
4291
|
};
|
|
3914
4292
|
/** @returns {CatalogInsightResponse} */
|
|
@@ -4007,6 +4385,7 @@ type Category = {
|
|
|
4007
4385
|
/** @returns {CategoryItems} */
|
|
4008
4386
|
declare function CategoryItems(): CategoryItems;
|
|
4009
4387
|
type CategoryItems = {
|
|
4388
|
+
_custom_json?: any;
|
|
4010
4389
|
action?: Action;
|
|
4011
4390
|
banners?: ImageUrls;
|
|
4012
4391
|
childs?: Child[];
|
|
@@ -4017,7 +4396,17 @@ type CategoryItems = {
|
|
|
4017
4396
|
/** @returns {CategoryListingResponse} */
|
|
4018
4397
|
declare function CategoryListingResponse(): CategoryListingResponse;
|
|
4019
4398
|
type CategoryListingResponse = {
|
|
4399
|
+
/**
|
|
4400
|
+
* - An array containing the
|
|
4401
|
+
* department category trees, which provide hierarchical information about
|
|
4402
|
+
* categories and their associated departments.
|
|
4403
|
+
*/
|
|
4020
4404
|
data?: DepartmentCategoryTree[];
|
|
4405
|
+
/**
|
|
4406
|
+
* - An array of department
|
|
4407
|
+
* identifiers, each providing basic information like name, slug, and unique
|
|
4408
|
+
* ID for departments within the catalog.
|
|
4409
|
+
*/
|
|
4021
4410
|
departments?: DepartmentIdentifier[];
|
|
4022
4411
|
};
|
|
4023
4412
|
/** @returns {CategoryMapping} */
|
|
@@ -4061,18 +4450,43 @@ type CategoryResponse = {
|
|
|
4061
4450
|
/** @returns {Child} */
|
|
4062
4451
|
declare function Child(): Child;
|
|
4063
4452
|
type Child = {
|
|
4453
|
+
/**
|
|
4454
|
+
* - Custom JSON object to store additional
|
|
4455
|
+
* data for the child.
|
|
4456
|
+
*/
|
|
4064
4457
|
_custom_json?: any;
|
|
4065
4458
|
action?: Action;
|
|
4066
4459
|
banners?: ImageUrls;
|
|
4460
|
+
/**
|
|
4461
|
+
* - A list of second-level child
|
|
4462
|
+
* elements under the current child.
|
|
4463
|
+
*/
|
|
4067
4464
|
childs?: SecondLevelChild[];
|
|
4465
|
+
/**
|
|
4466
|
+
* - Name of the child element.
|
|
4467
|
+
*/
|
|
4068
4468
|
name?: string;
|
|
4469
|
+
/**
|
|
4470
|
+
* - Slug or URL-friendly identifier for the child element.
|
|
4471
|
+
*/
|
|
4069
4472
|
slug?: string;
|
|
4473
|
+
/**
|
|
4474
|
+
* - Unique identifier for the child element.
|
|
4475
|
+
*/
|
|
4070
4476
|
uid?: number;
|
|
4071
4477
|
};
|
|
4072
4478
|
/** @returns {CollectionBadge} */
|
|
4073
4479
|
declare function CollectionBadge(): CollectionBadge;
|
|
4074
4480
|
type CollectionBadge = {
|
|
4481
|
+
/**
|
|
4482
|
+
* - The color of the badge displayed with the
|
|
4483
|
+
* collection, typically represented as a string (e.g., a hex code or color name).
|
|
4484
|
+
*/
|
|
4075
4485
|
color?: string;
|
|
4486
|
+
/**
|
|
4487
|
+
* - The text displayed on the badge, which may
|
|
4488
|
+
* indicate a label or promotion related to the collection.
|
|
4489
|
+
*/
|
|
4076
4490
|
text?: string;
|
|
4077
4491
|
};
|
|
4078
4492
|
/** @returns {CollectionBanner} */
|
|
@@ -4084,26 +4498,107 @@ type CollectionBanner = {
|
|
|
4084
4498
|
/** @returns {CollectionCreateResponse} */
|
|
4085
4499
|
declare function CollectionCreateResponse(): CollectionCreateResponse;
|
|
4086
4500
|
type CollectionCreateResponse = {
|
|
4501
|
+
/**
|
|
4502
|
+
* - Unique identifier for the collection.
|
|
4503
|
+
*/
|
|
4087
4504
|
uid?: string;
|
|
4088
|
-
_schedule?:
|
|
4505
|
+
_schedule?: CollectionSchedule;
|
|
4506
|
+
/**
|
|
4507
|
+
* - Indicates whether facet-based filtering
|
|
4508
|
+
* is allowed for the collection.
|
|
4509
|
+
*/
|
|
4089
4510
|
allow_facets?: boolean;
|
|
4511
|
+
/**
|
|
4512
|
+
* - Indicates whether sorting options are
|
|
4513
|
+
* allowed for the collection.
|
|
4514
|
+
*/
|
|
4090
4515
|
allow_sort?: boolean;
|
|
4516
|
+
/**
|
|
4517
|
+
* - The application ID associated with the collection.
|
|
4518
|
+
*/
|
|
4091
4519
|
app_id?: string;
|
|
4520
|
+
/**
|
|
4521
|
+
* - Details of the badge associated with the collection.
|
|
4522
|
+
*/
|
|
4092
4523
|
badge?: any;
|
|
4093
4524
|
banners?: ImageUrls;
|
|
4094
|
-
|
|
4525
|
+
/**
|
|
4526
|
+
* - A description of the collection.
|
|
4527
|
+
*/
|
|
4095
4528
|
description?: string;
|
|
4529
|
+
/**
|
|
4530
|
+
* - Indicates whether the collection is currently active.
|
|
4531
|
+
*/
|
|
4096
4532
|
is_active?: boolean;
|
|
4097
4533
|
logo?: BannerImage;
|
|
4534
|
+
/**
|
|
4535
|
+
* - Additional metadata related to the collection.
|
|
4536
|
+
*/
|
|
4098
4537
|
meta?: any;
|
|
4538
|
+
/**
|
|
4539
|
+
* - The name of the collection.
|
|
4540
|
+
*/
|
|
4099
4541
|
name?: string;
|
|
4542
|
+
/**
|
|
4543
|
+
* - The priority level of the collection, used to
|
|
4544
|
+
* determine its display order.
|
|
4545
|
+
*/
|
|
4100
4546
|
priority?: number;
|
|
4547
|
+
/**
|
|
4548
|
+
* - Query objects that define how the
|
|
4549
|
+
* collection's items are retrieved or filtered.
|
|
4550
|
+
*/
|
|
4101
4551
|
query?: CollectionQuery[];
|
|
4552
|
+
/**
|
|
4553
|
+
* - The URL-friendly identifier for the collection.
|
|
4554
|
+
*/
|
|
4102
4555
|
slug?: string;
|
|
4556
|
+
/**
|
|
4557
|
+
* - The default sorting order for items in the
|
|
4558
|
+
* collection, e.g., 'popular'.
|
|
4559
|
+
*/
|
|
4103
4560
|
sort_on?: string;
|
|
4561
|
+
/**
|
|
4562
|
+
* - Array of tags associated with the collection for
|
|
4563
|
+
* categorization and filtering.
|
|
4564
|
+
*/
|
|
4104
4565
|
tag?: string[];
|
|
4566
|
+
/**
|
|
4567
|
+
* - The type of collection, such as 'items' for
|
|
4568
|
+
* manually added items or 'query' for dynamically fetched items.
|
|
4569
|
+
*/
|
|
4105
4570
|
type?: string;
|
|
4571
|
+
/**
|
|
4572
|
+
* - Keys of the facets that are
|
|
4573
|
+
* visible and can be used for filtering the collection.
|
|
4574
|
+
*/
|
|
4106
4575
|
visible_facets_keys?: string[];
|
|
4576
|
+
/**
|
|
4577
|
+
* - Indicates whether the collection is published.
|
|
4578
|
+
*/
|
|
4579
|
+
published?: boolean;
|
|
4580
|
+
/**
|
|
4581
|
+
* - List of tags associated with the collection.
|
|
4582
|
+
*/
|
|
4583
|
+
tags?: string[];
|
|
4584
|
+
action?: Action;
|
|
4585
|
+
/**
|
|
4586
|
+
* - Custom JSON data for additional information.
|
|
4587
|
+
*/
|
|
4588
|
+
_custom_json?: any;
|
|
4589
|
+
/**
|
|
4590
|
+
* - Locale language settings for the collection.
|
|
4591
|
+
*/
|
|
4592
|
+
_locale_language?: any;
|
|
4593
|
+
seo?: SeoDetail;
|
|
4594
|
+
/**
|
|
4595
|
+
* - Indicates if the collection is visible to users.
|
|
4596
|
+
*/
|
|
4597
|
+
is_visible?: boolean;
|
|
4598
|
+
/**
|
|
4599
|
+
* - Unique identifier for the collection.
|
|
4600
|
+
*/
|
|
4601
|
+
id?: string;
|
|
4107
4602
|
};
|
|
4108
4603
|
/** @returns {CollectionDetailResponse} */
|
|
4109
4604
|
declare function CollectionDetailResponse(): CollectionDetailResponse;
|
|
@@ -4131,7 +4626,16 @@ type CollectionDetailResponse = {
|
|
|
4131
4626
|
/** @returns {CollectionImage} */
|
|
4132
4627
|
declare function CollectionImage(): CollectionImage;
|
|
4133
4628
|
type CollectionImage = {
|
|
4629
|
+
/**
|
|
4630
|
+
* - The aspect ratio of the image, typically
|
|
4631
|
+
* represented as a string (e.g., "16:9" or "4:3") to indicate the
|
|
4632
|
+
* proportional relationship between the image's width and height.
|
|
4633
|
+
*/
|
|
4134
4634
|
aspect_ratio: string;
|
|
4635
|
+
/**
|
|
4636
|
+
* - The URL of the image, which provides the location
|
|
4637
|
+
* where the image is hosted and can be accessed.
|
|
4638
|
+
*/
|
|
4135
4639
|
url: string;
|
|
4136
4640
|
};
|
|
4137
4641
|
/** @returns {CollectionItem} */
|
|
@@ -4154,21 +4658,47 @@ type CollectionItemUpdate = {
|
|
|
4154
4658
|
/** @returns {CollectionListingFilter} */
|
|
4155
4659
|
declare function CollectionListingFilter(): CollectionListingFilter;
|
|
4156
4660
|
type CollectionListingFilter = {
|
|
4661
|
+
/**
|
|
4662
|
+
* - A list of tags used to
|
|
4663
|
+
* filter the collection listing.
|
|
4664
|
+
*/
|
|
4157
4665
|
tags?: CollectionListingFilterTag[];
|
|
4666
|
+
/**
|
|
4667
|
+
* - A list of types used to
|
|
4668
|
+
* filter the collection listing.
|
|
4669
|
+
*/
|
|
4158
4670
|
type?: CollectionListingFilterType[];
|
|
4159
4671
|
};
|
|
4160
4672
|
/** @returns {CollectionListingFilterTag} */
|
|
4161
4673
|
declare function CollectionListingFilterTag(): CollectionListingFilterTag;
|
|
4162
4674
|
type CollectionListingFilterTag = {
|
|
4675
|
+
/**
|
|
4676
|
+
* - The display name of the tag for the collection listing.
|
|
4677
|
+
*/
|
|
4163
4678
|
display?: string;
|
|
4679
|
+
/**
|
|
4680
|
+
* - Indicates whether the tag is currently selected.
|
|
4681
|
+
*/
|
|
4164
4682
|
is_selected?: boolean;
|
|
4683
|
+
/**
|
|
4684
|
+
* - The name of the tag.
|
|
4685
|
+
*/
|
|
4165
4686
|
name?: string;
|
|
4166
4687
|
};
|
|
4167
4688
|
/** @returns {CollectionListingFilterType} */
|
|
4168
4689
|
declare function CollectionListingFilterType(): CollectionListingFilterType;
|
|
4169
4690
|
type CollectionListingFilterType = {
|
|
4691
|
+
/**
|
|
4692
|
+
* - The display name of the type for the collection listing.
|
|
4693
|
+
*/
|
|
4170
4694
|
display?: string;
|
|
4695
|
+
/**
|
|
4696
|
+
* - Indicates whether the type is currently selected.
|
|
4697
|
+
*/
|
|
4171
4698
|
is_selected?: boolean;
|
|
4699
|
+
/**
|
|
4700
|
+
* - The internal name of the type.
|
|
4701
|
+
*/
|
|
4172
4702
|
name?: string;
|
|
4173
4703
|
};
|
|
4174
4704
|
/** @returns {CollectionQuery} */
|
|
@@ -4191,10 +4721,31 @@ type CollectionQuery = {
|
|
|
4191
4721
|
/** @returns {CollectionSchedule} */
|
|
4192
4722
|
declare function CollectionSchedule(): CollectionSchedule;
|
|
4193
4723
|
type CollectionSchedule = {
|
|
4724
|
+
/**
|
|
4725
|
+
* - The cron expression that defines the scheduling
|
|
4726
|
+
* pattern, allowing for tasks or events to be repeated at specific intervals
|
|
4727
|
+
* (e.g., daily, weekly).
|
|
4728
|
+
*/
|
|
4194
4729
|
cron?: string;
|
|
4730
|
+
/**
|
|
4731
|
+
* - The duration in seconds for which the
|
|
4732
|
+
* collection is active or valid.
|
|
4733
|
+
*/
|
|
4195
4734
|
duration?: number;
|
|
4735
|
+
/**
|
|
4736
|
+
* - The end date and time for the collection's
|
|
4737
|
+
* schedule, formatted as a date-time string.
|
|
4738
|
+
*/
|
|
4196
4739
|
end?: string;
|
|
4740
|
+
/**
|
|
4741
|
+
* - The next set of scheduled times
|
|
4742
|
+
* when the collection will become active, based on the cron expression.
|
|
4743
|
+
*/
|
|
4197
4744
|
next_schedule?: NextSchedule[];
|
|
4745
|
+
/**
|
|
4746
|
+
* - The start date and time for the collection's
|
|
4747
|
+
* schedule, formatted as a date-time string.
|
|
4748
|
+
*/
|
|
4198
4749
|
start?: string;
|
|
4199
4750
|
};
|
|
4200
4751
|
/** @returns {CompanyBrandDetail} */
|
|
@@ -4210,9 +4761,9 @@ declare function CompanyMeta(): CompanyMeta;
|
|
|
4210
4761
|
type CompanyMeta = {
|
|
4211
4762
|
id: number;
|
|
4212
4763
|
};
|
|
4213
|
-
/** @returns {
|
|
4214
|
-
declare function
|
|
4215
|
-
type
|
|
4764
|
+
/** @returns {InventoryCompanyMeta} */
|
|
4765
|
+
declare function InventoryCompanyMeta(): InventoryCompanyMeta;
|
|
4766
|
+
type InventoryCompanyMeta = {
|
|
4216
4767
|
id?: number;
|
|
4217
4768
|
};
|
|
4218
4769
|
/** @returns {CompanyOptIn} */
|
|
@@ -4354,30 +4905,104 @@ type CreateAutocompleteWordsResponse = {
|
|
|
4354
4905
|
/** @returns {CreateCollection} */
|
|
4355
4906
|
declare function CreateCollection(): CreateCollection;
|
|
4356
4907
|
type CreateCollection = {
|
|
4908
|
+
/**
|
|
4909
|
+
* - Custom JSON data for the collection, used
|
|
4910
|
+
* for any additional information.
|
|
4911
|
+
*/
|
|
4357
4912
|
_custom_json?: any;
|
|
4913
|
+
/**
|
|
4914
|
+
* - Locale-specific data for supporting
|
|
4915
|
+
* multiple languages.
|
|
4916
|
+
*/
|
|
4358
4917
|
_locale_language?: any;
|
|
4359
4918
|
_schedule?: CollectionSchedule;
|
|
4919
|
+
/**
|
|
4920
|
+
* - Indicates whether facet-based filtering
|
|
4921
|
+
* is allowed for the collection.
|
|
4922
|
+
*/
|
|
4360
4923
|
allow_facets?: boolean;
|
|
4924
|
+
/**
|
|
4925
|
+
* - Indicates whether sorting options are
|
|
4926
|
+
* allowed for the collection.
|
|
4927
|
+
*/
|
|
4361
4928
|
allow_sort?: boolean;
|
|
4929
|
+
/**
|
|
4930
|
+
* - The application ID associated with the collection.
|
|
4931
|
+
*/
|
|
4362
4932
|
app_id: string;
|
|
4363
4933
|
badge?: CollectionBadge;
|
|
4364
4934
|
banners: CollectionBanner;
|
|
4935
|
+
/**
|
|
4936
|
+
* - Information about the user who created
|
|
4937
|
+
* the collection.
|
|
4938
|
+
*/
|
|
4365
4939
|
created_by?: UserInfo;
|
|
4940
|
+
/**
|
|
4941
|
+
* - A description of the collection.
|
|
4942
|
+
*/
|
|
4366
4943
|
description?: string;
|
|
4944
|
+
/**
|
|
4945
|
+
* - Indicates whether the collection is currently active.
|
|
4946
|
+
*/
|
|
4367
4947
|
is_active?: boolean;
|
|
4948
|
+
/**
|
|
4949
|
+
* - Indicates whether the collection is
|
|
4950
|
+
* visible to users.
|
|
4951
|
+
*/
|
|
4368
4952
|
is_visible?: boolean;
|
|
4369
4953
|
logo: CollectionImage;
|
|
4954
|
+
/**
|
|
4955
|
+
* - Additional metadata related to the collection.
|
|
4956
|
+
*/
|
|
4370
4957
|
meta?: any;
|
|
4958
|
+
/**
|
|
4959
|
+
* - Information about the user who last
|
|
4960
|
+
* modified the collection.
|
|
4961
|
+
*/
|
|
4371
4962
|
modified_by?: UserInfo;
|
|
4963
|
+
/**
|
|
4964
|
+
* - The name of the collection.
|
|
4965
|
+
*/
|
|
4372
4966
|
name: string;
|
|
4967
|
+
/**
|
|
4968
|
+
* - The priority level of the collection, used to
|
|
4969
|
+
* determine its display order.
|
|
4970
|
+
*/
|
|
4373
4971
|
priority?: number;
|
|
4972
|
+
/**
|
|
4973
|
+
* - Indicates whether the collection is
|
|
4974
|
+
* published and available to users.
|
|
4975
|
+
*/
|
|
4374
4976
|
published?: boolean;
|
|
4977
|
+
/**
|
|
4978
|
+
* - Query objects that define how the
|
|
4979
|
+
* collection's items are retrieved or filtered.
|
|
4980
|
+
*/
|
|
4375
4981
|
query?: CollectionQuery[];
|
|
4376
4982
|
seo?: SeoDetail;
|
|
4983
|
+
/**
|
|
4984
|
+
* - The URL-friendly identifier for the collection.
|
|
4985
|
+
*/
|
|
4377
4986
|
slug: string;
|
|
4987
|
+
/**
|
|
4988
|
+
* - The default sorting order for items in the
|
|
4989
|
+
* collection, e.g., 'popular'.
|
|
4990
|
+
*/
|
|
4378
4991
|
sort_on?: string;
|
|
4992
|
+
/**
|
|
4993
|
+
* - Array of tags associated with the collection
|
|
4994
|
+
* for categorization and filtering.
|
|
4995
|
+
*/
|
|
4379
4996
|
tags?: string[];
|
|
4997
|
+
/**
|
|
4998
|
+
* - The type of collection, either 'items' for manually
|
|
4999
|
+
* added items or 'query' for dynamically fetched items.
|
|
5000
|
+
*/
|
|
4380
5001
|
type: string;
|
|
5002
|
+
/**
|
|
5003
|
+
* - Keys of the facets that are
|
|
5004
|
+
* visible and can be used for filtering the collection.
|
|
5005
|
+
*/
|
|
4381
5006
|
visible_facets_keys?: string[];
|
|
4382
5007
|
};
|
|
4383
5008
|
/** @returns {CreateSearchConfigurationRequest} */
|
|
@@ -4528,7 +5153,15 @@ type Department = {
|
|
|
4528
5153
|
/** @returns {DepartmentCategoryTree} */
|
|
4529
5154
|
declare function DepartmentCategoryTree(): DepartmentCategoryTree;
|
|
4530
5155
|
type DepartmentCategoryTree = {
|
|
5156
|
+
/**
|
|
5157
|
+
* - The name of the department that this
|
|
5158
|
+
* category tree belongs to, such as 'Men', 'Women', or 'Electronics'.
|
|
5159
|
+
*/
|
|
4531
5160
|
department?: string;
|
|
5161
|
+
/**
|
|
5162
|
+
* - An array of categories that fall under
|
|
5163
|
+
* the specified department, each containing details about category items.
|
|
5164
|
+
*/
|
|
4532
5165
|
items?: CategoryItems[];
|
|
4533
5166
|
};
|
|
4534
5167
|
/** @returns {DepartmentErrorResponse} */
|
|
@@ -4543,7 +5176,20 @@ type DepartmentErrorResponse = {
|
|
|
4543
5176
|
/** @returns {DepartmentIdentifier} */
|
|
4544
5177
|
declare function DepartmentIdentifier(): DepartmentIdentifier;
|
|
4545
5178
|
type DepartmentIdentifier = {
|
|
5179
|
+
/**
|
|
5180
|
+
* - The name of the department, such as
|
|
5181
|
+
* 'Electronics', 'Apparel', or 'Home Appliances'.
|
|
5182
|
+
*/
|
|
5183
|
+
name?: string;
|
|
5184
|
+
/**
|
|
5185
|
+
* - A URL-friendly identifier for the department,
|
|
5186
|
+
* often used in creating department-specific links or routes.
|
|
5187
|
+
*/
|
|
4546
5188
|
slug?: string;
|
|
5189
|
+
/**
|
|
5190
|
+
* - A unique identifier for the department, used to
|
|
5191
|
+
* distinguish it from other departments in the system.
|
|
5192
|
+
*/
|
|
4547
5193
|
uid?: number;
|
|
4548
5194
|
};
|
|
4549
5195
|
/** @returns {DepartmentResponse} */
|
|
@@ -4581,9 +5227,9 @@ type DimensionResponse = {
|
|
|
4581
5227
|
*/
|
|
4582
5228
|
width: number;
|
|
4583
5229
|
};
|
|
4584
|
-
/** @returns {
|
|
4585
|
-
declare function
|
|
4586
|
-
type
|
|
5230
|
+
/** @returns {InventoryDimensionResponse} */
|
|
5231
|
+
declare function InventoryDimensionResponse(): InventoryDimensionResponse;
|
|
5232
|
+
type InventoryDimensionResponse = {
|
|
4587
5233
|
height?: number;
|
|
4588
5234
|
length?: number;
|
|
4589
5235
|
unit?: string;
|
|
@@ -4611,10 +5257,26 @@ type EntityConfiguration = {
|
|
|
4611
5257
|
/** @returns {ErrorResponse} */
|
|
4612
5258
|
declare function ErrorResponse(): ErrorResponse;
|
|
4613
5259
|
type ErrorResponse = {
|
|
5260
|
+
/**
|
|
5261
|
+
* - A string representing the specific error code.
|
|
5262
|
+
*/
|
|
4614
5263
|
code?: string;
|
|
5264
|
+
/**
|
|
5265
|
+
* - A brief description of the error type.
|
|
5266
|
+
*/
|
|
4615
5267
|
error?: string;
|
|
5268
|
+
/**
|
|
5269
|
+
* - A detailed message explaining the error.
|
|
5270
|
+
*/
|
|
4616
5271
|
message?: string;
|
|
5272
|
+
/**
|
|
5273
|
+
* - Additional metadata or context about the error,
|
|
5274
|
+
* if available.
|
|
5275
|
+
*/
|
|
4617
5276
|
meta?: any;
|
|
5277
|
+
/**
|
|
5278
|
+
* - The HTTP status code associated with the error.
|
|
5279
|
+
*/
|
|
4618
5280
|
status?: number;
|
|
4619
5281
|
};
|
|
4620
5282
|
/** @returns {FilerList} */
|
|
@@ -4789,39 +5451,128 @@ type GetCatalogConfigurationMetaData = {
|
|
|
4789
5451
|
/** @returns {GetCollectionDetailNest} */
|
|
4790
5452
|
declare function GetCollectionDetailNest(): GetCollectionDetailNest;
|
|
4791
5453
|
type GetCollectionDetailNest = {
|
|
4792
|
-
_schedule?:
|
|
5454
|
+
_schedule?: CollectionSchedule;
|
|
4793
5455
|
action?: Action;
|
|
5456
|
+
/**
|
|
5457
|
+
* - Indicates whether facets are allowed for
|
|
5458
|
+
* filtering the collection.
|
|
5459
|
+
*/
|
|
4794
5460
|
allow_facets?: boolean;
|
|
5461
|
+
/**
|
|
5462
|
+
* - Indicates whether sorting options are
|
|
5463
|
+
* allowed for the collection.
|
|
5464
|
+
*/
|
|
4795
5465
|
allow_sort?: boolean;
|
|
5466
|
+
/**
|
|
5467
|
+
* - The application ID associated with the collection.
|
|
5468
|
+
*/
|
|
4796
5469
|
app_id?: string;
|
|
4797
|
-
badge?:
|
|
5470
|
+
badge?: CollectionBadge;
|
|
4798
5471
|
banners?: ImageUrls;
|
|
4799
|
-
|
|
5472
|
+
/**
|
|
5473
|
+
* - A description of the collection.
|
|
5474
|
+
*/
|
|
4800
5475
|
description?: string;
|
|
5476
|
+
/**
|
|
5477
|
+
* - Indicates whether the collection is currently active.
|
|
5478
|
+
*/
|
|
4801
5479
|
is_active?: boolean;
|
|
4802
5480
|
logo?: Media;
|
|
5481
|
+
/**
|
|
5482
|
+
* - Additional metadata related to the collection.
|
|
5483
|
+
*/
|
|
4803
5484
|
meta?: any;
|
|
5485
|
+
/**
|
|
5486
|
+
* - The name of the collection.
|
|
5487
|
+
*/
|
|
4804
5488
|
name?: string;
|
|
5489
|
+
/**
|
|
5490
|
+
* - The priority level of the collection in the
|
|
5491
|
+
* display list.
|
|
5492
|
+
*/
|
|
4805
5493
|
priority?: number;
|
|
5494
|
+
/**
|
|
5495
|
+
* - Array of queries that define how the
|
|
5496
|
+
* collection is fetched or filtered.
|
|
5497
|
+
*/
|
|
4806
5498
|
query?: CollectionQuery[];
|
|
5499
|
+
/**
|
|
5500
|
+
* - The URL-friendly identifier of the collection.
|
|
5501
|
+
*/
|
|
4807
5502
|
slug?: string;
|
|
5503
|
+
/**
|
|
5504
|
+
* - Array of tags associated with the collection.
|
|
5505
|
+
*/
|
|
4808
5506
|
tag?: string[];
|
|
5507
|
+
/**
|
|
5508
|
+
* - The type of collection, such as manual or automated.
|
|
5509
|
+
*/
|
|
4809
5510
|
type?: string;
|
|
5511
|
+
/**
|
|
5512
|
+
* - The unique identifier for the collection.
|
|
5513
|
+
*/
|
|
4810
5514
|
uid?: string;
|
|
5515
|
+
/**
|
|
5516
|
+
* - List of facet keys that are
|
|
5517
|
+
* visible for filtering the collection.
|
|
5518
|
+
*/
|
|
4811
5519
|
visible_facets_keys?: string[];
|
|
5520
|
+
/**
|
|
5521
|
+
* - Internal identifier for the collection.
|
|
5522
|
+
*/
|
|
5523
|
+
_id?: string;
|
|
5524
|
+
/**
|
|
5525
|
+
* - Indicates if the collection is published.
|
|
5526
|
+
*/
|
|
5527
|
+
published?: boolean;
|
|
5528
|
+
/**
|
|
5529
|
+
* - Tags associated with the collection.
|
|
5530
|
+
*/
|
|
5531
|
+
tags?: string[];
|
|
5532
|
+
/**
|
|
5533
|
+
* - Sort criteria for the collection.
|
|
5534
|
+
*/
|
|
5535
|
+
sort_on?: string;
|
|
5536
|
+
/**
|
|
5537
|
+
* - Custom JSON data for the collection.
|
|
5538
|
+
*/
|
|
5539
|
+
_custom_json?: any;
|
|
5540
|
+
/**
|
|
5541
|
+
* - Locale-specific language settings.
|
|
5542
|
+
*/
|
|
5543
|
+
_locale_language?: any;
|
|
5544
|
+
seo?: SeoDetail;
|
|
5545
|
+
/**
|
|
5546
|
+
* - Indicates if the collection is visible.
|
|
5547
|
+
*/
|
|
5548
|
+
is_visible?: boolean;
|
|
4812
5549
|
};
|
|
4813
5550
|
/** @returns {GetCollectionItemsResponse} */
|
|
4814
5551
|
declare function GetCollectionItemsResponse(): GetCollectionItemsResponse;
|
|
4815
5552
|
type GetCollectionItemsResponse = {
|
|
5553
|
+
/**
|
|
5554
|
+
* - An array of filters applicable to
|
|
5555
|
+
* the products in the collection.
|
|
5556
|
+
*/
|
|
4816
5557
|
filters?: ProductFilters[];
|
|
5558
|
+
/**
|
|
5559
|
+
* - List of product details in the collection.
|
|
5560
|
+
*/
|
|
4817
5561
|
items?: ProductListingDetail[];
|
|
4818
5562
|
page?: Page;
|
|
5563
|
+
/**
|
|
5564
|
+
* - Sorting options available for the
|
|
5565
|
+
* products in the collection.
|
|
5566
|
+
*/
|
|
4819
5567
|
sort_on?: ProductSortOn[];
|
|
4820
5568
|
};
|
|
4821
5569
|
/** @returns {GetCollectionListingResponse} */
|
|
4822
5570
|
declare function GetCollectionListingResponse(): GetCollectionListingResponse;
|
|
4823
5571
|
type GetCollectionListingResponse = {
|
|
4824
5572
|
filters?: CollectionListingFilter;
|
|
5573
|
+
/**
|
|
5574
|
+
* - Array of nested collection details.
|
|
5575
|
+
*/
|
|
4825
5576
|
items?: GetCollectionDetailNest[];
|
|
4826
5577
|
page?: Page;
|
|
4827
5578
|
};
|
|
@@ -4898,12 +5649,12 @@ type GetConfigResponse = {
|
|
|
4898
5649
|
/** @returns {GetDepartment} */
|
|
4899
5650
|
declare function GetDepartment(): GetDepartment;
|
|
4900
5651
|
type GetDepartment = {
|
|
4901
|
-
created_by?:
|
|
5652
|
+
created_by?: RequestUserSerializer;
|
|
4902
5653
|
created_on?: string;
|
|
4903
5654
|
is_active?: boolean;
|
|
4904
5655
|
item_type?: string;
|
|
4905
5656
|
logo?: string;
|
|
4906
|
-
modified_by?:
|
|
5657
|
+
modified_by?: RequestUserSerializer;
|
|
4907
5658
|
modified_on?: string;
|
|
4908
5659
|
name?: string;
|
|
4909
5660
|
page_no?: number;
|
|
@@ -4917,24 +5668,24 @@ type GetDepartment = {
|
|
|
4917
5668
|
/** @returns {GetInventories} */
|
|
4918
5669
|
declare function GetInventories(): GetInventories;
|
|
4919
5670
|
type GetInventories = {
|
|
4920
|
-
brand?:
|
|
4921
|
-
company?:
|
|
5671
|
+
brand?: InventoryBrandMeta;
|
|
5672
|
+
company?: InventoryCompanyMeta;
|
|
4922
5673
|
country_of_origin?: string;
|
|
4923
|
-
created_by?:
|
|
5674
|
+
created_by?: RequestUserSerializer;
|
|
4924
5675
|
date_meta?: DateMeta;
|
|
4925
|
-
dimension?:
|
|
5676
|
+
dimension?: InventoryDimensionResponse;
|
|
4926
5677
|
expiration_date?: string;
|
|
4927
5678
|
id?: string;
|
|
4928
5679
|
identifier?: any;
|
|
4929
5680
|
inventory_updated_on?: string;
|
|
4930
5681
|
is_set?: boolean;
|
|
4931
5682
|
item_id?: number;
|
|
4932
|
-
manufacturer?:
|
|
4933
|
-
modified_by?:
|
|
5683
|
+
manufacturer?: InventoryManufacturerResponse;
|
|
5684
|
+
modified_by?: RequestUserSerializer;
|
|
4934
5685
|
platforms?: any;
|
|
4935
5686
|
price?: PriceArticle;
|
|
4936
5687
|
quantities?: QuantitiesArticle;
|
|
4937
|
-
return_config?:
|
|
5688
|
+
return_config?: ReturnConfig;
|
|
4938
5689
|
seller_identifier?: string;
|
|
4939
5690
|
size?: string;
|
|
4940
5691
|
stage?: string;
|
|
@@ -4944,9 +5695,9 @@ type GetInventories = {
|
|
|
4944
5695
|
total_quantity?: number;
|
|
4945
5696
|
trace_id?: string;
|
|
4946
5697
|
track_inventory?: boolean;
|
|
4947
|
-
trader?:
|
|
5698
|
+
trader?: TraderResponse[];
|
|
4948
5699
|
uid?: string;
|
|
4949
|
-
weight?:
|
|
5700
|
+
weight?: InventoryWeightResponse;
|
|
4950
5701
|
};
|
|
4951
5702
|
/** @returns {GetInventoriesResponse} */
|
|
4952
5703
|
declare function GetInventoriesResponse(): GetInventoriesResponse;
|
|
@@ -6235,9 +6986,9 @@ type ManufacturerResponse = {
|
|
|
6235
6986
|
*/
|
|
6236
6987
|
name: string;
|
|
6237
6988
|
};
|
|
6238
|
-
/** @returns {
|
|
6239
|
-
declare function
|
|
6240
|
-
type
|
|
6989
|
+
/** @returns {InventoryManufacturerResponse} */
|
|
6990
|
+
declare function InventoryManufacturerResponse(): InventoryManufacturerResponse;
|
|
6991
|
+
type InventoryManufacturerResponse = {
|
|
6241
6992
|
address?: string;
|
|
6242
6993
|
is_default?: boolean;
|
|
6243
6994
|
name?: string;
|
|
@@ -6272,6 +7023,25 @@ type Media2 = {
|
|
|
6272
7023
|
type?: string;
|
|
6273
7024
|
url?: string;
|
|
6274
7025
|
};
|
|
7026
|
+
/** @returns {BrandMedia} */
|
|
7027
|
+
declare function BrandMedia(): BrandMedia;
|
|
7028
|
+
type BrandMedia = {
|
|
7029
|
+
/**
|
|
7030
|
+
* - The aspect ratio of the media, typically
|
|
7031
|
+
* represented as a string like '16:9' or '4:3'.
|
|
7032
|
+
*/
|
|
7033
|
+
aspect_ratio?: string;
|
|
7034
|
+
/**
|
|
7035
|
+
* - The type of media, such as 'image', 'video', or
|
|
7036
|
+
* 'audio', describing the content format.
|
|
7037
|
+
*/
|
|
7038
|
+
type?: string;
|
|
7039
|
+
/**
|
|
7040
|
+
* - The URL where the media file is hosted, typically
|
|
7041
|
+
* a link to an image or video resource.
|
|
7042
|
+
*/
|
|
7043
|
+
url?: string;
|
|
7044
|
+
};
|
|
6275
7045
|
/** @returns {Meta} */
|
|
6276
7046
|
declare function Meta(): Meta;
|
|
6277
7047
|
type Meta = {
|
|
@@ -6345,7 +7115,13 @@ type NetQuantityResponse = {
|
|
|
6345
7115
|
/** @returns {NextSchedule} */
|
|
6346
7116
|
declare function NextSchedule(): NextSchedule;
|
|
6347
7117
|
type NextSchedule = {
|
|
7118
|
+
/**
|
|
7119
|
+
* - The end time of the schedule.
|
|
7120
|
+
*/
|
|
6348
7121
|
end?: string;
|
|
7122
|
+
/**
|
|
7123
|
+
* - The start time of the schedule.
|
|
7124
|
+
*/
|
|
6349
7125
|
start?: string;
|
|
6350
7126
|
};
|
|
6351
7127
|
/** @returns {OptInPostRequest} */
|
|
@@ -6469,16 +7245,6 @@ type PageResponse = {
|
|
|
6469
7245
|
*/
|
|
6470
7246
|
size?: number;
|
|
6471
7247
|
};
|
|
6472
|
-
/** @returns {PageResponse1} */
|
|
6473
|
-
declare function PageResponse1(): PageResponse1;
|
|
6474
|
-
type PageResponse1 = {
|
|
6475
|
-
current?: number;
|
|
6476
|
-
has_next?: boolean;
|
|
6477
|
-
has_previous?: boolean;
|
|
6478
|
-
item_total?: number;
|
|
6479
|
-
size?: number;
|
|
6480
|
-
type?: string;
|
|
6481
|
-
};
|
|
6482
7248
|
/** @returns {PageResponseType} */
|
|
6483
7249
|
declare function PageResponseType(): PageResponseType;
|
|
6484
7250
|
type PageResponseType = {
|
|
@@ -7258,37 +8024,79 @@ type ReturnConfigResponse = {
|
|
|
7258
8024
|
/** @returns {Sitemap} */
|
|
7259
8025
|
declare function Sitemap(): Sitemap;
|
|
7260
8026
|
type Sitemap = {
|
|
8027
|
+
/**
|
|
8028
|
+
* - Indicates the priority of this URL relative
|
|
8029
|
+
* to other URLs on the site. A value between 0.0 and 1.0, where 1.0 is the
|
|
8030
|
+
* highest priority.
|
|
8031
|
+
*/
|
|
7261
8032
|
priority?: number;
|
|
8033
|
+
/**
|
|
8034
|
+
* - How frequently the content at the URL is
|
|
8035
|
+
* likely to change.
|
|
8036
|
+
*/
|
|
7262
8037
|
frequency?: string;
|
|
7263
8038
|
};
|
|
7264
8039
|
/** @returns {ApplicationItemSeoAction} */
|
|
7265
8040
|
declare function ApplicationItemSeoAction(): ApplicationItemSeoAction;
|
|
7266
8041
|
type ApplicationItemSeoAction = {
|
|
8042
|
+
/**
|
|
8043
|
+
* - Details of the page associated with this SEO action.
|
|
8044
|
+
*/
|
|
7267
8045
|
page?: any;
|
|
8046
|
+
/**
|
|
8047
|
+
* - Type of action, such as navigation or redirection.
|
|
8048
|
+
*/
|
|
7268
8049
|
type: string;
|
|
7269
8050
|
};
|
|
7270
8051
|
/** @returns {ApplicationItemSeoBreadcrumbs} */
|
|
7271
8052
|
declare function ApplicationItemSeoBreadcrumbs(): ApplicationItemSeoBreadcrumbs;
|
|
7272
8053
|
type ApplicationItemSeoBreadcrumbs = {
|
|
8054
|
+
/**
|
|
8055
|
+
* - The URL that this breadcrumb points to.
|
|
8056
|
+
*/
|
|
7273
8057
|
url?: string;
|
|
8058
|
+
/**
|
|
8059
|
+
* - The actions available for
|
|
8060
|
+
* this breadcrumb, defining what happens when it's clicked or interacted with.
|
|
8061
|
+
*/
|
|
7274
8062
|
action?: ApplicationItemSeoAction[];
|
|
7275
8063
|
};
|
|
7276
8064
|
/** @returns {ApplicationItemSeoMetaTagItem} */
|
|
7277
8065
|
declare function ApplicationItemSeoMetaTagItem(): ApplicationItemSeoMetaTagItem;
|
|
7278
8066
|
type ApplicationItemSeoMetaTagItem = {
|
|
8067
|
+
/**
|
|
8068
|
+
* - The name of the meta tag.
|
|
8069
|
+
*/
|
|
7279
8070
|
key: string;
|
|
8071
|
+
/**
|
|
8072
|
+
* - The value associated with the meta tag.
|
|
8073
|
+
*/
|
|
7280
8074
|
value: string;
|
|
7281
8075
|
};
|
|
7282
8076
|
/** @returns {ApplicationItemSeoMetaTags} */
|
|
7283
8077
|
declare function ApplicationItemSeoMetaTags(): ApplicationItemSeoMetaTags;
|
|
7284
8078
|
type ApplicationItemSeoMetaTags = {
|
|
8079
|
+
/**
|
|
8080
|
+
* - The title for this set of meta tags.
|
|
8081
|
+
*/
|
|
7285
8082
|
title: string;
|
|
8083
|
+
/**
|
|
8084
|
+
* - A list of meta tag
|
|
8085
|
+
* items, each defined by key-value pairs.
|
|
8086
|
+
*/
|
|
7286
8087
|
items?: ApplicationItemSeoMetaTagItem[];
|
|
7287
8088
|
};
|
|
7288
8089
|
/** @returns {Metatags} */
|
|
7289
8090
|
declare function Metatags(): Metatags;
|
|
7290
8091
|
type Metatags = {
|
|
8092
|
+
/**
|
|
8093
|
+
* - The title or heading for the meta tags section.
|
|
8094
|
+
*/
|
|
7291
8095
|
title?: string;
|
|
8096
|
+
/**
|
|
8097
|
+
* - An array of meta tag
|
|
8098
|
+
* items, each consisting of key-value pairs.
|
|
8099
|
+
*/
|
|
7292
8100
|
items?: ApplicationItemSeoMetaTagItem[];
|
|
7293
8101
|
};
|
|
7294
8102
|
/** @returns {SizePromotionThreshold} */
|
|
@@ -7335,12 +8143,30 @@ type SearchableAttribute = {
|
|
|
7335
8143
|
/** @returns {SecondLevelChild} */
|
|
7336
8144
|
declare function SecondLevelChild(): SecondLevelChild;
|
|
7337
8145
|
type SecondLevelChild = {
|
|
8146
|
+
/**
|
|
8147
|
+
* - Custom JSON object to store additional
|
|
8148
|
+
* data for the second-level child.
|
|
8149
|
+
*/
|
|
7338
8150
|
_custom_json?: any;
|
|
7339
8151
|
action?: Action;
|
|
7340
8152
|
banners?: ImageUrls;
|
|
8153
|
+
/**
|
|
8154
|
+
* - A list of third-level child elements
|
|
8155
|
+
* under the second-level child.
|
|
8156
|
+
*/
|
|
7341
8157
|
childs?: ThirdLevelChild[];
|
|
8158
|
+
/**
|
|
8159
|
+
* - Name of the second-level child element.
|
|
8160
|
+
*/
|
|
7342
8161
|
name?: string;
|
|
8162
|
+
/**
|
|
8163
|
+
* - Slug or URL-friendly identifier for the
|
|
8164
|
+
* second-level child element.
|
|
8165
|
+
*/
|
|
7343
8166
|
slug?: string;
|
|
8167
|
+
/**
|
|
8168
|
+
* - Unique identifier for the second-level child element.
|
|
8169
|
+
*/
|
|
7344
8170
|
uid?: number;
|
|
7345
8171
|
};
|
|
7346
8172
|
/** @returns {SellerPhoneNumber} */
|
|
@@ -7352,11 +8178,37 @@ type SellerPhoneNumber = {
|
|
|
7352
8178
|
/** @returns {SeoDetail} */
|
|
7353
8179
|
declare function SeoDetail(): SeoDetail;
|
|
7354
8180
|
type SeoDetail = {
|
|
8181
|
+
/**
|
|
8182
|
+
* - SEO meta description for the item or
|
|
8183
|
+
* collection. This is used to describe the content for search engines.
|
|
8184
|
+
*/
|
|
7355
8185
|
description?: string;
|
|
8186
|
+
/**
|
|
8187
|
+
* - SEO meta title for the item or collection. It is
|
|
8188
|
+
* used as the title that appears in search results.
|
|
8189
|
+
*/
|
|
7356
8190
|
title?: string;
|
|
8191
|
+
/**
|
|
8192
|
+
* - Information regarding the sitemap
|
|
8193
|
+
* configuration for the item or collection.
|
|
8194
|
+
*/
|
|
7357
8195
|
sitemap?: any;
|
|
8196
|
+
/**
|
|
8197
|
+
* - List of
|
|
8198
|
+
* breadcrumbs for navigation, showing the hierarchy of pages leading to the
|
|
8199
|
+
* current page.
|
|
8200
|
+
*/
|
|
7358
8201
|
breadcrumbs?: ApplicationItemSeoBreadcrumbs[];
|
|
8202
|
+
/**
|
|
8203
|
+
* - An array of meta tags, each containing
|
|
8204
|
+
* key-value pairs for various SEO meta tags used to enhance search visibility.
|
|
8205
|
+
*/
|
|
7359
8206
|
meta_tags?: Metatags[];
|
|
8207
|
+
/**
|
|
8208
|
+
* - The canonical URL for the item or
|
|
8209
|
+
* collection, which tells search engines the preferred version of the URL to
|
|
8210
|
+
* avoid duplicate content issues.
|
|
8211
|
+
*/
|
|
7360
8212
|
canonical_url?: string;
|
|
7361
8213
|
};
|
|
7362
8214
|
/** @returns {SetSize} */
|
|
@@ -7453,10 +8305,17 @@ declare function SuccessResponse(): SuccessResponse;
|
|
|
7453
8305
|
type SuccessResponse = {
|
|
7454
8306
|
success?: boolean;
|
|
7455
8307
|
};
|
|
7456
|
-
/** @returns {
|
|
7457
|
-
declare function
|
|
7458
|
-
type
|
|
8308
|
+
/** @returns {SuccessResponseObject} */
|
|
8309
|
+
declare function SuccessResponseObject(): SuccessResponseObject;
|
|
8310
|
+
type SuccessResponseObject = {
|
|
8311
|
+
/**
|
|
8312
|
+
* - Indicates whether the operation was successful or not.
|
|
8313
|
+
*/
|
|
7459
8314
|
success?: boolean;
|
|
8315
|
+
/**
|
|
8316
|
+
* - A unique identifier associated with the successful
|
|
8317
|
+
* operation.
|
|
8318
|
+
*/
|
|
7460
8319
|
uid?: number;
|
|
7461
8320
|
};
|
|
7462
8321
|
/** @returns {TaxIdentifier} */
|
|
@@ -7518,12 +8377,30 @@ type TemplatesValidationResponse = {
|
|
|
7518
8377
|
/** @returns {ThirdLevelChild} */
|
|
7519
8378
|
declare function ThirdLevelChild(): ThirdLevelChild;
|
|
7520
8379
|
type ThirdLevelChild = {
|
|
8380
|
+
/**
|
|
8381
|
+
* - Custom JSON object to store additional
|
|
8382
|
+
* data for the third-level child.
|
|
8383
|
+
*/
|
|
7521
8384
|
_custom_json?: any;
|
|
7522
8385
|
action?: Action;
|
|
7523
8386
|
banners?: ImageUrls;
|
|
8387
|
+
/**
|
|
8388
|
+
* - A list of further nested child elements under
|
|
8389
|
+
* the third-level child (if applicable).
|
|
8390
|
+
*/
|
|
7524
8391
|
childs?: any[];
|
|
8392
|
+
/**
|
|
8393
|
+
* - Name of the third-level child element.
|
|
8394
|
+
*/
|
|
7525
8395
|
name?: string;
|
|
8396
|
+
/**
|
|
8397
|
+
* - Slug or URL-friendly identifier for the
|
|
8398
|
+
* third-level child element.
|
|
8399
|
+
*/
|
|
7526
8400
|
slug?: string;
|
|
8401
|
+
/**
|
|
8402
|
+
* - Unique identifier for the third-level child element.
|
|
8403
|
+
*/
|
|
7527
8404
|
uid?: number;
|
|
7528
8405
|
};
|
|
7529
8406
|
/** @returns {Trader} */
|
|
@@ -7540,9 +8417,9 @@ type Trader1 = {
|
|
|
7540
8417
|
name: string;
|
|
7541
8418
|
type: string;
|
|
7542
8419
|
};
|
|
7543
|
-
/** @returns {
|
|
7544
|
-
declare function
|
|
7545
|
-
type
|
|
8420
|
+
/** @returns {TraderResponse} */
|
|
8421
|
+
declare function TraderResponse(): TraderResponse;
|
|
8422
|
+
type TraderResponse = {
|
|
7546
8423
|
address?: string[];
|
|
7547
8424
|
name?: string;
|
|
7548
8425
|
type?: string;
|
|
@@ -7562,10 +8439,7 @@ type UpdateCollection = {
|
|
|
7562
8439
|
is_visible?: boolean;
|
|
7563
8440
|
logo?: CollectionImage;
|
|
7564
8441
|
meta?: any;
|
|
7565
|
-
|
|
7566
|
-
* - User info.
|
|
7567
|
-
*/
|
|
7568
|
-
modified_by?: string;
|
|
8442
|
+
modified_by?: UserInfo;
|
|
7569
8443
|
name?: string;
|
|
7570
8444
|
priority?: number;
|
|
7571
8445
|
published?: boolean;
|
|
@@ -7720,9 +8594,9 @@ type UserSerializer = {
|
|
|
7720
8594
|
*/
|
|
7721
8595
|
username?: string;
|
|
7722
8596
|
};
|
|
7723
|
-
/** @returns {
|
|
7724
|
-
declare function
|
|
7725
|
-
type
|
|
8597
|
+
/** @returns {RequestUserSerializer} */
|
|
8598
|
+
declare function RequestUserSerializer(): RequestUserSerializer;
|
|
8599
|
+
type RequestUserSerializer = {
|
|
7726
8600
|
_id?: string;
|
|
7727
8601
|
contact?: string;
|
|
7728
8602
|
uid?: string;
|
|
@@ -7796,9 +8670,9 @@ type WeightResponse = {
|
|
|
7796
8670
|
*/
|
|
7797
8671
|
unit: string;
|
|
7798
8672
|
};
|
|
7799
|
-
/** @returns {
|
|
7800
|
-
declare function
|
|
7801
|
-
type
|
|
8673
|
+
/** @returns {InventoryWeightResponse} */
|
|
8674
|
+
declare function InventoryWeightResponse(): InventoryWeightResponse;
|
|
8675
|
+
type InventoryWeightResponse = {
|
|
7802
8676
|
shipping?: number;
|
|
7803
8677
|
unit?: string;
|
|
7804
8678
|
};
|