@gofynd/fdk-client-javascript 0.1.35 → 0.1.36
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/documentation/application/CART.md +256 -239
- package/documentation/application/CATALOG.md +413 -409
- package/documentation/application/COMMON.md +4 -0
- package/documentation/application/COMMUNICATION.md +4 -0
- package/documentation/application/CONFIGURATION.md +4 -0
- package/documentation/application/CONTENT.md +7 -20
- package/documentation/application/FILESTORAGE.md +85 -0
- package/documentation/application/LEAD.md +6 -2
- package/documentation/application/LOGISTIC.md +4 -0
- package/documentation/application/ORDER.md +307 -303
- package/documentation/application/PAYMENT.md +445 -259
- package/documentation/application/POSCART.md +317 -300
- package/documentation/application/REWARDS.md +153 -160
- package/documentation/application/SHARE.md +4 -0
- package/documentation/application/THEME.md +4 -0
- package/documentation/application/USER.md +4 -0
- package/documentation/platform/ANALYTICS.md +4 -0
- package/documentation/platform/AUDITTRAIL.md +4 -0
- package/documentation/platform/BILLING.md +4 -0
- package/documentation/platform/CART.md +480 -463
- package/documentation/platform/CATALOG.md +3895 -2942
- package/documentation/platform/COMMON.md +4 -0
- package/documentation/platform/COMMUNICATION.md +4 -0
- package/documentation/platform/COMPANYPROFILE.md +224 -193
- package/documentation/platform/CONFIGURATION.md +4 -0
- package/documentation/platform/CONTENT.md +8 -21
- package/documentation/platform/DISCOUNT.md +4 -0
- package/documentation/platform/FILESTORAGE.md +85 -0
- package/documentation/platform/INVENTORY.md +4 -0
- package/documentation/platform/LEAD.md +6 -2
- package/documentation/platform/ORDER.md +6298 -1448
- package/documentation/platform/PARTNER.md +12 -8
- package/documentation/platform/PAYMENT.md +107 -103
- package/documentation/platform/README.md +2 -2
- package/documentation/platform/REWARDS.md +219 -152
- package/documentation/platform/SHARE.md +4 -0
- package/documentation/platform/THEME.md +4 -0
- package/documentation/platform/USER.md +4 -0
- package/documentation/platform/WEBHOOK.md +4 -0
- package/documentation/public/CONFIGURATION.md +4 -0
- package/documentation/public/INVENTORY.md +4 -0
- package/documentation/public/WEBHOOK.md +4 -0
- package/package.json +1 -1
- package/sdk/application/ApplicationModels.d.ts +77 -73
- package/sdk/application/ApplicationModels.js +1751 -1725
- package/sdk/application/client/CartApplicationClient.d.ts +36 -36
- package/sdk/application/client/CatalogApplicationClient.d.ts +39 -39
- package/sdk/application/client/CatalogApplicationClient.js +16 -16
- package/sdk/application/client/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/client/CommunicationApplicationClient.d.ts +5 -5
- package/sdk/application/client/ConfigurationApplicationClient.d.ts +17 -17
- package/sdk/application/client/ContentApplicationClient.d.ts +19 -19
- package/sdk/application/client/FileStorageApplicationClient.d.ts +14 -6
- package/sdk/application/client/FileStorageApplicationClient.js +2 -0
- package/sdk/application/client/LeadApplicationClient.d.ts +10 -10
- package/sdk/application/client/LogisticApplicationClient.d.ts +5 -5
- package/sdk/application/client/OrderApplicationClient.d.ts +15 -15
- package/sdk/application/client/OrderApplicationClient.js +1 -1
- package/sdk/application/client/PaymentApplicationClient.d.ts +79 -57
- package/sdk/application/client/PaymentApplicationClient.js +66 -0
- package/sdk/application/client/PosCartApplicationClient.d.ts +38 -38
- package/sdk/application/client/RewardsApplicationClient.d.ts +34 -34
- package/sdk/application/client/RewardsApplicationClient.js +77 -77
- package/sdk/application/client/ShareApplicationClient.d.ts +8 -8
- package/sdk/application/client/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/client/UserApplicationClient.d.ts +63 -63
- package/sdk/application/models/CatalogValidator.d.ts +1 -1
- package/sdk/application/models/CatalogValidator.js +2 -2
- package/sdk/application/models/PaymentValidator.d.ts +2 -0
- package/sdk/application/models/PaymentValidator.js +12 -0
- package/sdk/application/models/RewardsValidator.d.ts +3 -3
- package/sdk/application/models/RewardsValidator.js +12 -12
- package/sdk/common/AxiosHelper.js +1 -1
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/platform/PlatformApplicationClient.d.ts +8600 -7286
- package/sdk/platform/PlatformApplicationClient.js +4338 -3678
- package/sdk/platform/PlatformApplicationModels.d.ts +21 -26
- package/sdk/platform/PlatformApplicationModels.js +5561 -4301
- package/sdk/platform/PlatformClient.d.ts +3448 -2801
- package/sdk/platform/PlatformClient.js +3903 -3108
- package/sdk/platform/PlatformModels.d.ts +352 -278
- package/sdk/platform/PlatformModels.js +5230 -3942
- package/sdk/platform/client/AnalyticsPlatformClient.d.ts +5 -5
- package/sdk/platform/client/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/client/BillingPlatformClient.d.ts +4 -4
- package/sdk/platform/client/CatalogPlatformClient.d.ts +209 -150
- package/sdk/platform/client/CatalogPlatformClient.js +441 -294
- package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +8 -8
- package/sdk/platform/client/ConfigurationPlatformClient.d.ts +9 -9
- package/sdk/platform/client/DiscountPlatformClient.d.ts +4 -4
- package/sdk/platform/client/FileStoragePlatformClient.d.ts +20 -4
- package/sdk/platform/client/FileStoragePlatformClient.js +49 -0
- package/sdk/platform/client/InventoryPlatformClient.d.ts +3 -3
- package/sdk/platform/client/LeadPlatformClient.d.ts +6 -6
- package/sdk/platform/client/OrderPlatformClient.d.ts +557 -131
- package/sdk/platform/client/OrderPlatformClient.js +1551 -247
- package/sdk/platform/client/PaymentPlatformClient.d.ts +4 -4
- package/sdk/platform/client/WebhookPlatformClient.d.ts +2 -2
- package/sdk/platform/models/CatalogValidator.d.ts +24 -21
- package/sdk/platform/models/CatalogValidator.js +103 -72
- package/sdk/platform/models/OrderValidator.d.ts +43 -11
- package/sdk/platform/models/OrderValidator.js +312 -51
- package/sdk/public/client/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/client/InventoryPublicClient.d.ts +7 -7
- package/sdk/public/client/WebhookPublicClient.d.ts +3 -3
- package/tests/common/schema/action-url.json +15 -0
- package/tests/common/schema/url-action.json +16 -0
|
@@ -2,10 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
|
|
5
|
+
|
|
5
6
|
##### [Back to Application docs](./README.md)
|
|
6
7
|
|
|
7
8
|
## Order Methods
|
|
8
9
|
Handles all Application order and shipment api(s)
|
|
10
|
+
|
|
9
11
|
* [getOrders](#getorders)
|
|
10
12
|
* [getOrderById](#getorderbyid)
|
|
11
13
|
* [getPosOrderById](#getposorderbyid)
|
|
@@ -24,6 +26,8 @@ Handles all Application order and shipment api(s)
|
|
|
24
26
|
## Methods with example and description
|
|
25
27
|
|
|
26
28
|
|
|
29
|
+
|
|
30
|
+
|
|
27
31
|
### getOrders
|
|
28
32
|
Get all orders
|
|
29
33
|
|
|
@@ -2481,287 +2485,274 @@ Successfully updateShipmentStatus!
|
|
|
2481
2485
|
|
|
2482
2486
|
|
|
2483
2487
|
|
|
2484
|
-
#### [
|
|
2488
|
+
#### [BreakupValues](#BreakupValues)
|
|
2485
2489
|
|
|
2486
2490
|
| Properties | Type | Nullable | Description |
|
|
2487
2491
|
| ---------- | ---- | -------- | ----------- |
|
|
2488
|
-
|
|
|
2489
|
-
|
|
|
2490
|
-
|
|
|
2491
|
-
| type | string | no | |
|
|
2492
|
-
| size | number | no | |
|
|
2492
|
+
| value | number | no | |
|
|
2493
|
+
| display | string | no | |
|
|
2494
|
+
| name | string | no | |
|
|
2493
2495
|
|
|
2494
2496
|
---
|
|
2495
2497
|
|
|
2496
2498
|
|
|
2497
2499
|
|
|
2498
2500
|
|
|
2499
|
-
#### [
|
|
2501
|
+
#### [UserInfo](#UserInfo)
|
|
2500
2502
|
|
|
2501
2503
|
| Properties | Type | Nullable | Description |
|
|
2502
2504
|
| ---------- | ---- | -------- | ----------- |
|
|
2503
|
-
|
|
|
2504
|
-
|
|
|
2505
|
-
|
|
|
2505
|
+
| email | string | no | |
|
|
2506
|
+
| mobile | string | no | |
|
|
2507
|
+
| name | string | no | |
|
|
2508
|
+
| gender | string | no | |
|
|
2506
2509
|
|
|
2507
2510
|
---
|
|
2508
2511
|
|
|
2509
2512
|
|
|
2510
2513
|
|
|
2511
2514
|
|
|
2512
|
-
#### [
|
|
2515
|
+
#### [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment)
|
|
2513
2516
|
|
|
2514
2517
|
| Properties | Type | Nullable | Description |
|
|
2515
2518
|
| ---------- | ---- | -------- | ----------- |
|
|
2516
|
-
|
|
|
2519
|
+
| level | string | no | |
|
|
2520
|
+
| strategy | string | no | |
|
|
2517
2521
|
|
|
2518
2522
|
---
|
|
2519
2523
|
|
|
2520
2524
|
|
|
2521
2525
|
|
|
2522
2526
|
|
|
2523
|
-
#### [
|
|
2527
|
+
#### [BagsForReorder](#BagsForReorder)
|
|
2524
2528
|
|
|
2525
2529
|
| Properties | Type | Nullable | Description |
|
|
2526
2530
|
| ---------- | ---- | -------- | ----------- |
|
|
2527
|
-
|
|
|
2528
|
-
|
|
|
2529
|
-
|
|
|
2530
|
-
|
|
|
2531
|
+
| item_size | string | no | |
|
|
2532
|
+
| store_id | number | no | |
|
|
2533
|
+
| seller_id | number | no | |
|
|
2534
|
+
| quantity | number | no | |
|
|
2535
|
+
| item_id | number | no | |
|
|
2536
|
+
| article_assignment | [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment) | no | |
|
|
2531
2537
|
|
|
2532
2538
|
---
|
|
2533
2539
|
|
|
2534
2540
|
|
|
2535
2541
|
|
|
2536
2542
|
|
|
2537
|
-
#### [
|
|
2543
|
+
#### [FulfillingCompany](#FulfillingCompany)
|
|
2538
2544
|
|
|
2539
2545
|
| Properties | Type | Nullable | Description |
|
|
2540
2546
|
| ---------- | ---- | -------- | ----------- |
|
|
2541
|
-
|
|
|
2542
|
-
|
|
|
2543
|
-
| total_price | number | no | |
|
|
2547
|
+
| id | number | no | |
|
|
2548
|
+
| name | string | no | |
|
|
2544
2549
|
|
|
2545
2550
|
---
|
|
2546
2551
|
|
|
2547
2552
|
|
|
2548
2553
|
|
|
2549
2554
|
|
|
2550
|
-
#### [
|
|
2555
|
+
#### [FulfillingStore](#FulfillingStore)
|
|
2551
2556
|
|
|
2552
2557
|
| Properties | Type | Nullable | Description |
|
|
2553
2558
|
| ---------- | ---- | -------- | ----------- |
|
|
2554
|
-
|
|
|
2555
|
-
|
|
|
2556
|
-
|
|
|
2557
|
-
|
|
|
2558
|
-
|
|
|
2559
|
-
| value_of_good | number | no | |
|
|
2560
|
-
| coupon_value | number | no | |
|
|
2561
|
-
| promotion_effective_discount | number | no | |
|
|
2562
|
-
| amount_paid_roundoff | number | no | |
|
|
2563
|
-
| coupon_effective_discount | number | no | |
|
|
2564
|
-
| brand_calculated_amount | number | no | |
|
|
2565
|
-
| amount_paid | number | no | |
|
|
2566
|
-
| fynd_credits | number | no | |
|
|
2567
|
-
| cashback_applied | number | no | |
|
|
2568
|
-
| delivery_charge | number | no | |
|
|
2569
|
-
| cashback | number | no | |
|
|
2570
|
-
| discount | number | no | |
|
|
2571
|
-
| gst_tax_percentage | number | no | |
|
|
2572
|
-
| transfer_price | number | no | |
|
|
2573
|
-
| refund_credit | number | no | |
|
|
2559
|
+
| id | number | no | |
|
|
2560
|
+
| company_name | string | no | |
|
|
2561
|
+
| name | string | no | |
|
|
2562
|
+
| company_id | number | no | |
|
|
2563
|
+
| code | string | no | |
|
|
2574
2564
|
|
|
2575
2565
|
---
|
|
2576
2566
|
|
|
2577
2567
|
|
|
2578
2568
|
|
|
2579
2569
|
|
|
2580
|
-
#### [
|
|
2570
|
+
#### [Invoice](#Invoice)
|
|
2581
2571
|
|
|
2582
2572
|
| Properties | Type | Nullable | Description |
|
|
2583
2573
|
| ---------- | ---- | -------- | ----------- |
|
|
2584
|
-
|
|
|
2585
|
-
|
|
|
2586
|
-
|
|
|
2587
|
-
| logo | string | no | |
|
|
2588
|
-
| status | string | no | |
|
|
2589
|
-
| payment_mode | string | no | |
|
|
2574
|
+
| label_url | string | no | |
|
|
2575
|
+
| invoice_url | string | no | |
|
|
2576
|
+
| updated_date | string | no | |
|
|
2590
2577
|
|
|
2591
2578
|
---
|
|
2592
2579
|
|
|
2593
2580
|
|
|
2594
2581
|
|
|
2595
2582
|
|
|
2596
|
-
#### [
|
|
2583
|
+
#### [DeliveryAddress](#DeliveryAddress)
|
|
2597
2584
|
|
|
2598
2585
|
| Properties | Type | Nullable | Description |
|
|
2599
2586
|
| ---------- | ---- | -------- | ----------- |
|
|
2600
|
-
|
|
|
2587
|
+
| version | string | no | |
|
|
2588
|
+
| country | string | no | |
|
|
2589
|
+
| state | string | no | |
|
|
2590
|
+
| area | string | no | |
|
|
2601
2591
|
| name | string | no | |
|
|
2592
|
+
| contact_person | string | no | |
|
|
2593
|
+
| pincode | string | no | |
|
|
2602
2594
|
| updated_at | string | no | |
|
|
2603
|
-
|
|
|
2595
|
+
| latitude | number | no | |
|
|
2596
|
+
| city | string | no | |
|
|
2597
|
+
| address_type | string | no | |
|
|
2598
|
+
| phone | string | no | |
|
|
2599
|
+
| address_category | string | no | |
|
|
2600
|
+
| created_at | string | no | |
|
|
2601
|
+
| address2 | string | no | |
|
|
2602
|
+
| address1 | string | no | |
|
|
2603
|
+
| landmark | string | no | |
|
|
2604
|
+
| address | string | no | |
|
|
2605
|
+
| longitude | number | no | |
|
|
2606
|
+
| email | string | no | |
|
|
2604
2607
|
|
|
2605
2608
|
---
|
|
2606
2609
|
|
|
2607
2610
|
|
|
2608
2611
|
|
|
2609
2612
|
|
|
2610
|
-
#### [
|
|
2613
|
+
#### [TimeStampData](#TimeStampData)
|
|
2611
2614
|
|
|
2612
2615
|
| Properties | Type | Nullable | Description |
|
|
2613
2616
|
| ---------- | ---- | -------- | ----------- |
|
|
2614
|
-
|
|
|
2615
|
-
|
|
|
2616
|
-
| quantity | number | no | |
|
|
2617
|
-
| parent_item_identifier | string | no | |
|
|
2617
|
+
| min | string | no | |
|
|
2618
|
+
| max | string | no | |
|
|
2618
2619
|
|
|
2619
2620
|
---
|
|
2620
2621
|
|
|
2621
2622
|
|
|
2622
2623
|
|
|
2623
2624
|
|
|
2624
|
-
#### [
|
|
2625
|
+
#### [Promise](#Promise)
|
|
2625
2626
|
|
|
2626
2627
|
| Properties | Type | Nullable | Description |
|
|
2627
2628
|
| ---------- | ---- | -------- | ----------- |
|
|
2628
|
-
|
|
|
2629
|
-
|
|
|
2630
|
-
| promotion_type | string | no | |
|
|
2631
|
-
| amount | number | no | |
|
|
2632
|
-
| mrp_promotion | boolean | no | |
|
|
2633
|
-
| promo_id | string | no | |
|
|
2634
|
-
| promotion_name | string | no | |
|
|
2629
|
+
| show_promise | boolean | no | |
|
|
2630
|
+
| timestamp | [TimeStampData](#TimeStampData) | no | |
|
|
2635
2631
|
|
|
2636
2632
|
---
|
|
2637
2633
|
|
|
2638
2634
|
|
|
2639
2635
|
|
|
2640
2636
|
|
|
2641
|
-
#### [
|
|
2637
|
+
#### [ShipmentStatus](#ShipmentStatus)
|
|
2642
2638
|
|
|
2643
2639
|
| Properties | Type | Nullable | Description |
|
|
2644
2640
|
| ---------- | ---- | -------- | ----------- |
|
|
2645
|
-
|
|
|
2646
|
-
|
|
|
2641
|
+
| title | string | no | |
|
|
2642
|
+
| hex_code | string | no | |
|
|
2647
2643
|
|
|
2648
2644
|
---
|
|
2649
2645
|
|
|
2650
2646
|
|
|
2651
2647
|
|
|
2652
2648
|
|
|
2653
|
-
#### [
|
|
2649
|
+
#### [ShipmentTotalDetails](#ShipmentTotalDetails)
|
|
2650
|
+
|
|
2651
|
+
| Properties | Type | Nullable | Description |
|
|
2652
|
+
| ---------- | ---- | -------- | ----------- |
|
|
2653
|
+
| sizes | number | no | |
|
|
2654
|
+
| total_price | number | no | |
|
|
2655
|
+
| pieces | number | no | |
|
|
2656
|
+
|
|
2657
|
+
---
|
|
2658
|
+
|
|
2659
|
+
|
|
2660
|
+
|
|
2661
|
+
|
|
2662
|
+
#### [Prices](#Prices)
|
|
2654
2663
|
|
|
2655
2664
|
| Properties | Type | Nullable | Description |
|
|
2656
2665
|
| ---------- | ---- | -------- | ----------- |
|
|
2657
|
-
| price_marked | number | no | |
|
|
2658
|
-
| cod_charges | number | no | |
|
|
2659
|
-
| size | string | no | |
|
|
2660
|
-
| added_to_fynd_cash | boolean | no | |
|
|
2661
|
-
| refund_amount | number | no | |
|
|
2662
2666
|
| price_effective | number | no | |
|
|
2663
2667
|
| value_of_good | number | no | |
|
|
2664
|
-
| coupon_value | number | no | |
|
|
2665
|
-
| gst_tag | string | no | |
|
|
2666
|
-
| promotion_effective_discount | number | no | |
|
|
2667
2668
|
| amount_paid_roundoff | number | no | |
|
|
2669
|
+
| cashback | number | no | |
|
|
2670
|
+
| price_marked | number | no | |
|
|
2668
2671
|
| coupon_effective_discount | number | no | |
|
|
2669
|
-
|
|
|
2672
|
+
| coupon_value | number | no | |
|
|
2670
2673
|
| amount_paid | number | no | |
|
|
2671
|
-
|
|
|
2672
|
-
| cashback_applied | number | no | |
|
|
2673
|
-
| gst_fee | number | no | |
|
|
2674
|
-
| delivery_charge | number | no | |
|
|
2675
|
-
| cashback | number | no | |
|
|
2674
|
+
| refund_credit | number | no | |
|
|
2676
2675
|
| discount | number | no | |
|
|
2677
|
-
| item_name | string | no | |
|
|
2678
|
-
| total_units | number | no | |
|
|
2679
|
-
| hsn_code | string | no | |
|
|
2680
|
-
| gst_tax_percentage | number | no | |
|
|
2681
2676
|
| transfer_price | number | no | |
|
|
2682
|
-
|
|
|
2683
|
-
|
|
|
2677
|
+
| cashback_applied | number | no | |
|
|
2678
|
+
| promotion_effective_discount | number | no | |
|
|
2679
|
+
| fynd_credits | number | no | |
|
|
2680
|
+
| gst_tax_percentage | number | no | |
|
|
2681
|
+
| brand_calculated_amount | number | no | |
|
|
2682
|
+
| refund_amount | number | no | |
|
|
2683
|
+
| delivery_charge | number | no | |
|
|
2684
|
+
| added_to_fynd_cash | boolean | no | |
|
|
2685
|
+
| cod_charges | number | no | |
|
|
2684
2686
|
|
|
2685
2687
|
---
|
|
2686
2688
|
|
|
2687
2689
|
|
|
2688
2690
|
|
|
2689
2691
|
|
|
2690
|
-
#### [
|
|
2692
|
+
#### [ShipmentUserInfo](#ShipmentUserInfo)
|
|
2691
2693
|
|
|
2692
2694
|
| Properties | Type | Nullable | Description |
|
|
2693
2695
|
| ---------- | ---- | -------- | ----------- |
|
|
2694
|
-
|
|
|
2695
|
-
|
|
|
2696
|
+
| last_name | string | no | |
|
|
2697
|
+
| mobile | string | no | |
|
|
2698
|
+
| first_name | string | no | |
|
|
2699
|
+
| gender | string | no | |
|
|
2696
2700
|
|
|
2697
2701
|
---
|
|
2698
2702
|
|
|
2699
2703
|
|
|
2700
2704
|
|
|
2701
2705
|
|
|
2702
|
-
#### [
|
|
2706
|
+
#### [NestedTrackingDetails](#NestedTrackingDetails)
|
|
2703
2707
|
|
|
2704
2708
|
| Properties | Type | Nullable | Description |
|
|
2705
2709
|
| ---------- | ---- | -------- | ----------- |
|
|
2706
|
-
|
|
|
2707
|
-
|
|
|
2708
|
-
|
|
|
2709
|
-
|
|
|
2710
|
-
| size | string | no | |
|
|
2711
|
-
| slug_key | string | no | |
|
|
2712
|
-
| image | [string] | no | |
|
|
2713
|
-
| brand | [ItemBrand](#ItemBrand) | no | |
|
|
2710
|
+
| is_passed | boolean | no | |
|
|
2711
|
+
| time | string | no | |
|
|
2712
|
+
| status | string | no | |
|
|
2713
|
+
| is_current | boolean | no | |
|
|
2714
2714
|
|
|
2715
2715
|
---
|
|
2716
2716
|
|
|
2717
2717
|
|
|
2718
2718
|
|
|
2719
2719
|
|
|
2720
|
-
#### [
|
|
2720
|
+
#### [TrackingDetails](#TrackingDetails)
|
|
2721
2721
|
|
|
2722
2722
|
| Properties | Type | Nullable | Description |
|
|
2723
2723
|
| ---------- | ---- | -------- | ----------- |
|
|
2724
|
-
|
|
|
2725
|
-
|
|
|
2726
|
-
|
|
|
2727
|
-
|
|
|
2728
|
-
|
|
|
2729
|
-
| applied_promos | [[AppliedPromos](#AppliedPromos)] | no | |
|
|
2730
|
-
| financial_breakup | [[FinancialBreakup](#FinancialBreakup)] | no | |
|
|
2731
|
-
| seller_identifier | string | no | |
|
|
2732
|
-
| prices | [Prices](#Prices) | no | |
|
|
2733
|
-
| id | number | no | |
|
|
2734
|
-
| delivery_date | string | no | |
|
|
2735
|
-
| item | [Item](#Item) | no | |
|
|
2736
|
-
| parent_promo_bags | string | no | |
|
|
2737
|
-
| returnable_date | string | no | |
|
|
2724
|
+
| is_passed | boolean | no | |
|
|
2725
|
+
| tracking_details | [[NestedTrackingDetails](#NestedTrackingDetails)] | no | |
|
|
2726
|
+
| time | string | no | |
|
|
2727
|
+
| status | string | no | |
|
|
2728
|
+
| is_current | boolean | no | |
|
|
2738
2729
|
|
|
2739
2730
|
---
|
|
2740
2731
|
|
|
2741
2732
|
|
|
2742
2733
|
|
|
2743
2734
|
|
|
2744
|
-
#### [
|
|
2735
|
+
#### [ShipmentPayment](#ShipmentPayment)
|
|
2745
2736
|
|
|
2746
2737
|
| Properties | Type | Nullable | Description |
|
|
2747
2738
|
| ---------- | ---- | -------- | ----------- |
|
|
2748
|
-
|
|
|
2749
|
-
|
|
|
2750
|
-
|
|
|
2751
|
-
|
|
|
2752
|
-
|
|
|
2739
|
+
| mop | string | no | |
|
|
2740
|
+
| payment_mode | string | no | |
|
|
2741
|
+
| display_name | string | no | |
|
|
2742
|
+
| status | string | no | |
|
|
2743
|
+
| mode | string | no | |
|
|
2744
|
+
| logo | string | no | |
|
|
2753
2745
|
|
|
2754
2746
|
---
|
|
2755
2747
|
|
|
2756
2748
|
|
|
2757
2749
|
|
|
2758
2750
|
|
|
2759
|
-
#### [
|
|
2751
|
+
#### [ItemBrand](#ItemBrand)
|
|
2760
2752
|
|
|
2761
2753
|
| Properties | Type | Nullable | Description |
|
|
2762
2754
|
| ---------- | ---- | -------- | ----------- |
|
|
2763
|
-
|
|
|
2764
|
-
| display | string | no | |
|
|
2755
|
+
| logo | string | no | |
|
|
2765
2756
|
| name | string | no | |
|
|
2766
2757
|
|
|
2767
2758
|
---
|
|
@@ -2769,224 +2760,237 @@ Successfully updateShipmentStatus!
|
|
|
2769
2760
|
|
|
2770
2761
|
|
|
2771
2762
|
|
|
2772
|
-
#### [
|
|
2763
|
+
#### [Item](#Item)
|
|
2773
2764
|
|
|
2774
2765
|
| Properties | Type | Nullable | Description |
|
|
2775
2766
|
| ---------- | ---- | -------- | ----------- |
|
|
2776
|
-
|
|
|
2777
|
-
| address_type | string | no | |
|
|
2778
|
-
| email | string | no | |
|
|
2779
|
-
| contact_person | string | no | |
|
|
2780
|
-
| latitude | number | no | |
|
|
2781
|
-
| area | string | no | |
|
|
2782
|
-
| created_at | string | no | |
|
|
2783
|
-
| country | string | no | |
|
|
2767
|
+
| id | number | no | |
|
|
2784
2768
|
| name | string | no | |
|
|
2785
|
-
|
|
|
2786
|
-
|
|
|
2787
|
-
|
|
|
2788
|
-
|
|
|
2789
|
-
|
|
|
2790
|
-
|
|
|
2791
|
-
| address_category | string | no | |
|
|
2792
|
-
| state | string | no | |
|
|
2793
|
-
| pincode | string | no | |
|
|
2794
|
-
| city | string | no | |
|
|
2795
|
-
| landmark | string | no | |
|
|
2796
|
-
|
|
2797
|
-
---
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
#### [ShipmentUserInfo](#ShipmentUserInfo)
|
|
2803
|
-
|
|
2804
|
-
| Properties | Type | Nullable | Description |
|
|
2805
|
-
| ---------- | ---- | -------- | ----------- |
|
|
2806
|
-
| gender | string | no | |
|
|
2807
|
-
| last_name | string | no | |
|
|
2808
|
-
| mobile | string | no | |
|
|
2809
|
-
| first_name | string | no | |
|
|
2769
|
+
| brand | [ItemBrand](#ItemBrand) | no | |
|
|
2770
|
+
| image | [string] | no | |
|
|
2771
|
+
| size | string | no | |
|
|
2772
|
+
| slug_key | string | no | |
|
|
2773
|
+
| code | string | no | |
|
|
2774
|
+
| seller_identifier | string | no | |
|
|
2810
2775
|
|
|
2811
2776
|
---
|
|
2812
2777
|
|
|
2813
2778
|
|
|
2814
2779
|
|
|
2815
2780
|
|
|
2816
|
-
#### [
|
|
2781
|
+
#### [CurrentStatus](#CurrentStatus)
|
|
2817
2782
|
|
|
2818
2783
|
| Properties | Type | Nullable | Description |
|
|
2819
2784
|
| ---------- | ---- | -------- | ----------- |
|
|
2785
|
+
| updated_at | string | no | |
|
|
2820
2786
|
| name | string | no | |
|
|
2821
|
-
|
|
|
2787
|
+
| status | string | no | |
|
|
2788
|
+
| journey_type | string | no | |
|
|
2822
2789
|
|
|
2823
2790
|
---
|
|
2824
2791
|
|
|
2825
2792
|
|
|
2826
2793
|
|
|
2827
2794
|
|
|
2828
|
-
#### [
|
|
2795
|
+
#### [Identifiers](#Identifiers)
|
|
2829
2796
|
|
|
2830
2797
|
| Properties | Type | Nullable | Description |
|
|
2831
2798
|
| ---------- | ---- | -------- | ----------- |
|
|
2832
|
-
|
|
|
2833
|
-
|
|
|
2799
|
+
| ean | string | no | |
|
|
2800
|
+
| sku_code | string | no | |
|
|
2834
2801
|
|
|
2835
2802
|
---
|
|
2836
2803
|
|
|
2837
2804
|
|
|
2838
2805
|
|
|
2839
2806
|
|
|
2840
|
-
#### [
|
|
2807
|
+
#### [FinancialBreakup](#FinancialBreakup)
|
|
2841
2808
|
|
|
2842
2809
|
| Properties | Type | Nullable | Description |
|
|
2843
2810
|
| ---------- | ---- | -------- | ----------- |
|
|
2844
|
-
|
|
|
2845
|
-
|
|
|
2846
|
-
|
|
|
2847
|
-
|
|
|
2811
|
+
| item_name | string | no | |
|
|
2812
|
+
| price_effective | number | no | |
|
|
2813
|
+
| value_of_good | number | no | |
|
|
2814
|
+
| gst_fee | number | no | |
|
|
2815
|
+
| amount_paid_roundoff | number | no | |
|
|
2816
|
+
| hsn_code | string | no | |
|
|
2817
|
+
| cashback | number | no | |
|
|
2818
|
+
| price_marked | number | no | |
|
|
2819
|
+
| coupon_effective_discount | number | no | |
|
|
2820
|
+
| gst_tag | string | no | |
|
|
2821
|
+
| coupon_value | number | no | |
|
|
2822
|
+
| amount_paid | number | no | |
|
|
2823
|
+
| refund_credit | number | no | |
|
|
2824
|
+
| discount | number | no | |
|
|
2825
|
+
| transfer_price | number | no | |
|
|
2826
|
+
| cashback_applied | number | no | |
|
|
2827
|
+
| identifiers | [Identifiers](#Identifiers) | no | |
|
|
2828
|
+
| promotion_effective_discount | number | no | |
|
|
2829
|
+
| fynd_credits | number | no | |
|
|
2830
|
+
| gst_tax_percentage | number | no | |
|
|
2831
|
+
| brand_calculated_amount | number | no | |
|
|
2832
|
+
| refund_amount | number | no | |
|
|
2833
|
+
| delivery_charge | number | no | |
|
|
2834
|
+
| size | string | no | |
|
|
2835
|
+
| added_to_fynd_cash | boolean | no | |
|
|
2836
|
+
| cod_charges | number | no | |
|
|
2837
|
+
| total_units | number | no | |
|
|
2848
2838
|
|
|
2849
2839
|
---
|
|
2850
2840
|
|
|
2851
2841
|
|
|
2852
2842
|
|
|
2853
2843
|
|
|
2854
|
-
#### [
|
|
2844
|
+
#### [AppliedFreeArticles](#AppliedFreeArticles)
|
|
2855
2845
|
|
|
2856
2846
|
| Properties | Type | Nullable | Description |
|
|
2857
2847
|
| ---------- | ---- | -------- | ----------- |
|
|
2858
|
-
|
|
|
2859
|
-
|
|
|
2860
|
-
|
|
|
2861
|
-
|
|
|
2862
|
-
| is_current | boolean | no | |
|
|
2848
|
+
| parent_item_identifier | string | no | |
|
|
2849
|
+
| free_gift_item_details | string | no | |
|
|
2850
|
+
| quantity | number | no | |
|
|
2851
|
+
| article_id | string | no | |
|
|
2863
2852
|
|
|
2864
2853
|
---
|
|
2865
2854
|
|
|
2866
2855
|
|
|
2867
2856
|
|
|
2868
2857
|
|
|
2869
|
-
#### [
|
|
2858
|
+
#### [AppliedPromos](#AppliedPromos)
|
|
2870
2859
|
|
|
2871
2860
|
| Properties | Type | Nullable | Description |
|
|
2872
2861
|
| ---------- | ---- | -------- | ----------- |
|
|
2873
|
-
|
|
|
2874
|
-
|
|
|
2862
|
+
| promotion_type | string | no | |
|
|
2863
|
+
| article_quantity | number | no | |
|
|
2864
|
+
| promo_id | string | no | |
|
|
2865
|
+
| amount | number | no | |
|
|
2866
|
+
| applied_free_articles | [[AppliedFreeArticles](#AppliedFreeArticles)] | no | |
|
|
2867
|
+
| promotion_name | string | no | |
|
|
2868
|
+
| mrp_promotion | boolean | no | |
|
|
2875
2869
|
|
|
2876
2870
|
---
|
|
2877
2871
|
|
|
2878
2872
|
|
|
2879
2873
|
|
|
2880
2874
|
|
|
2881
|
-
#### [
|
|
2875
|
+
#### [Bags](#Bags)
|
|
2882
2876
|
|
|
2883
2877
|
| Properties | Type | Nullable | Description |
|
|
2884
2878
|
| ---------- | ---- | -------- | ----------- |
|
|
2885
|
-
|
|
|
2886
|
-
|
|
|
2879
|
+
| id | number | no | |
|
|
2880
|
+
| parent_promo_bags | string | no | |
|
|
2881
|
+
| line_number | number | no | |
|
|
2882
|
+
| item | [Item](#Item) | no | |
|
|
2883
|
+
| prices | [Prices](#Prices) | no | |
|
|
2884
|
+
| returnable_date | string | no | |
|
|
2885
|
+
| current_status | [CurrentStatus](#CurrentStatus) | no | |
|
|
2886
|
+
| can_cancel | boolean | no | |
|
|
2887
|
+
| quantity | number | no | |
|
|
2888
|
+
| financial_breakup | [[FinancialBreakup](#FinancialBreakup)] | no | |
|
|
2889
|
+
| applied_promos | [[AppliedPromos](#AppliedPromos)] | no | |
|
|
2890
|
+
| can_return | boolean | no | |
|
|
2891
|
+
| seller_identifier | string | no | |
|
|
2892
|
+
| delivery_date | string | no | |
|
|
2887
2893
|
|
|
2888
2894
|
---
|
|
2889
2895
|
|
|
2890
2896
|
|
|
2891
2897
|
|
|
2892
2898
|
|
|
2893
|
-
#### [
|
|
2899
|
+
#### [Shipments](#Shipments)
|
|
2894
2900
|
|
|
2895
2901
|
| Properties | Type | Nullable | Description |
|
|
2896
2902
|
| ---------- | ---- | -------- | ----------- |
|
|
2897
|
-
|
|
|
2898
|
-
|
|
|
2899
|
-
|
|
|
2903
|
+
| awb_no | string | no | |
|
|
2904
|
+
| fulfilling_company | [FulfillingCompany](#FulfillingCompany) | no | |
|
|
2905
|
+
| order_id | string | no | |
|
|
2906
|
+
| fulfilling_store | [FulfillingStore](#FulfillingStore) | no | |
|
|
2907
|
+
| delivery_date | string | no | |
|
|
2908
|
+
| invoice | [Invoice](#Invoice) | no | |
|
|
2909
|
+
| shipment_id | string | no | |
|
|
2910
|
+
| show_track_link | boolean | no | |
|
|
2911
|
+
| refund_details | string | no | |
|
|
2912
|
+
| shipment_created_at | string | no | |
|
|
2913
|
+
| show_download_invoice | boolean | no | |
|
|
2914
|
+
| delivery_address | [DeliveryAddress](#DeliveryAddress) | no | |
|
|
2915
|
+
| promise | [Promise](#Promise) | no | |
|
|
2916
|
+
| dp_name | string | no | |
|
|
2917
|
+
| shipment_status | [ShipmentStatus](#ShipmentStatus) | no | |
|
|
2918
|
+
| total_details | [ShipmentTotalDetails](#ShipmentTotalDetails) | no | |
|
|
2919
|
+
| breakup_values | [[BreakupValues](#BreakupValues)] | no | |
|
|
2920
|
+
| prices | [Prices](#Prices) | no | |
|
|
2921
|
+
| returnable_date | string | no | |
|
|
2922
|
+
| user_info | [ShipmentUserInfo](#ShipmentUserInfo) | no | |
|
|
2923
|
+
| size_info | string | no | |
|
|
2924
|
+
| can_return | boolean | no | |
|
|
2925
|
+
| need_help_url | string | no | |
|
|
2926
|
+
| beneficiary_details | boolean | no | |
|
|
2927
|
+
| tracking_details | [[TrackingDetails](#TrackingDetails)] | no | |
|
|
2928
|
+
| comment | string | no | |
|
|
2929
|
+
| custom_meta | [string] | no | |
|
|
2930
|
+
| payment | [ShipmentPayment](#ShipmentPayment) | no | |
|
|
2931
|
+
| traking_no | string | no | |
|
|
2932
|
+
| track_url | string | no | |
|
|
2933
|
+
| can_cancel | boolean | no | |
|
|
2934
|
+
| total_bags | number | no | |
|
|
2935
|
+
| order_type | string | no | |
|
|
2936
|
+
| bags | [[Bags](#Bags)] | no | |
|
|
2937
|
+
| can_break | string | no | |
|
|
2900
2938
|
|
|
2901
2939
|
---
|
|
2902
2940
|
|
|
2903
2941
|
|
|
2904
2942
|
|
|
2905
2943
|
|
|
2906
|
-
#### [
|
|
2944
|
+
#### [OrderSchema](#OrderSchema)
|
|
2907
2945
|
|
|
2908
2946
|
| Properties | Type | Nullable | Description |
|
|
2909
2947
|
| ---------- | ---- | -------- | ----------- |
|
|
2910
|
-
|
|
|
2911
|
-
| can_cancel | boolean | no | |
|
|
2912
|
-
| total_details | [ShipmentTotalDetails](#ShipmentTotalDetails) | no | |
|
|
2913
|
-
| total_bags | number | no | |
|
|
2914
|
-
| prices | [Prices](#Prices) | no | |
|
|
2915
|
-
| order_type | string | no | |
|
|
2916
|
-
| track_url | string | no | |
|
|
2917
|
-
| delivery_date | string | no | |
|
|
2918
|
-
| need_help_url | string | no | |
|
|
2919
|
-
| payment | [ShipmentPayment](#ShipmentPayment) | no | |
|
|
2920
|
-
| size_info | string | no | |
|
|
2921
|
-
| custom_meta | [string] | no | |
|
|
2922
|
-
| shipment_created_at | string | no | |
|
|
2923
|
-
| bags | [[Bags](#Bags)] | no | |
|
|
2924
|
-
| fulfilling_store | [FulfillingStore](#FulfillingStore) | no | |
|
|
2948
|
+
| total_shipments_in_order | number | no | |
|
|
2925
2949
|
| breakup_values | [[BreakupValues](#BreakupValues)] | no | |
|
|
2926
|
-
|
|
|
2927
|
-
|
|
|
2928
|
-
| beneficiary_details | boolean | no | |
|
|
2929
|
-
| delivery_address | [DeliveryAddress](#DeliveryAddress) | no | |
|
|
2930
|
-
| user_info | [ShipmentUserInfo](#ShipmentUserInfo) | no | |
|
|
2931
|
-
| fulfilling_company | [FulfillingCompany](#FulfillingCompany) | no | |
|
|
2932
|
-
| shipment_status | [ShipmentStatus](#ShipmentStatus) | no | |
|
|
2933
|
-
| shipment_id | string | no | |
|
|
2934
|
-
| tracking_details | [[TrackingDetails](#TrackingDetails)] | no | |
|
|
2935
|
-
| comment | string | no | |
|
|
2936
|
-
| can_return | boolean | no | |
|
|
2937
|
-
| show_track_link | boolean | no | |
|
|
2938
|
-
| dp_name | string | no | |
|
|
2939
|
-
| can_break | string | no | |
|
|
2950
|
+
| order_created_time | string | no | |
|
|
2951
|
+
| user_info | [UserInfo](#UserInfo) | no | |
|
|
2940
2952
|
| order_id | string | no | |
|
|
2941
|
-
|
|
|
2942
|
-
|
|
|
2943
|
-
| invoice | [Invoice](#Invoice) | no | |
|
|
2944
|
-
| show_download_invoice | boolean | no | |
|
|
2953
|
+
| bags_for_reorder | [[BagsForReorder](#BagsForReorder)] | no | |
|
|
2954
|
+
| shipments | [[Shipments](#Shipments)] | no | |
|
|
2945
2955
|
|
|
2946
2956
|
---
|
|
2947
2957
|
|
|
2948
2958
|
|
|
2949
2959
|
|
|
2950
2960
|
|
|
2951
|
-
#### [
|
|
2961
|
+
#### [OrderStatuses](#OrderStatuses)
|
|
2952
2962
|
|
|
2953
2963
|
| Properties | Type | Nullable | Description |
|
|
2954
2964
|
| ---------- | ---- | -------- | ----------- |
|
|
2955
|
-
|
|
|
2956
|
-
|
|
|
2965
|
+
| value | number | no | |
|
|
2966
|
+
| is_selected | boolean | no | |
|
|
2967
|
+
| display | string | no | |
|
|
2957
2968
|
|
|
2958
2969
|
---
|
|
2959
2970
|
|
|
2960
2971
|
|
|
2961
2972
|
|
|
2962
2973
|
|
|
2963
|
-
#### [
|
|
2974
|
+
#### [OrderFilters](#OrderFilters)
|
|
2964
2975
|
|
|
2965
2976
|
| Properties | Type | Nullable | Description |
|
|
2966
2977
|
| ---------- | ---- | -------- | ----------- |
|
|
2967
|
-
|
|
|
2968
|
-
| quantity | number | no | |
|
|
2969
|
-
| item_size | string | no | |
|
|
2970
|
-
| store_id | number | no | |
|
|
2971
|
-
| article_assignment | [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment) | no | |
|
|
2972
|
-
| item_id | number | no | |
|
|
2978
|
+
| statuses | [[OrderStatuses](#OrderStatuses)] | no | |
|
|
2973
2979
|
|
|
2974
2980
|
---
|
|
2975
2981
|
|
|
2976
2982
|
|
|
2977
2983
|
|
|
2978
2984
|
|
|
2979
|
-
#### [
|
|
2985
|
+
#### [OrderPage](#OrderPage)
|
|
2980
2986
|
|
|
2981
2987
|
| Properties | Type | Nullable | Description |
|
|
2982
2988
|
| ---------- | ---- | -------- | ----------- |
|
|
2983
|
-
|
|
|
2984
|
-
|
|
|
2985
|
-
|
|
|
2986
|
-
|
|
|
2987
|
-
|
|
|
2988
|
-
| breakup_values | [[BreakupValues](#BreakupValues)] | no | |
|
|
2989
|
-
| bags_for_reorder | [[BagsForReorder](#BagsForReorder)] | no | |
|
|
2989
|
+
| size | number | no | |
|
|
2990
|
+
| item_total | number | no | |
|
|
2991
|
+
| current | number | no | |
|
|
2992
|
+
| has_next | boolean | no | |
|
|
2993
|
+
| type | string | no | |
|
|
2990
2994
|
|
|
2991
2995
|
---
|
|
2992
2996
|
|
|
@@ -2997,9 +3001,9 @@ Successfully updateShipmentStatus!
|
|
|
2997
3001
|
|
|
2998
3002
|
| Properties | Type | Nullable | Description |
|
|
2999
3003
|
| ---------- | ---- | -------- | ----------- |
|
|
3000
|
-
| page | [OrderPage](#OrderPage) | no | |
|
|
3001
|
-
| filters | [OrderFilters](#OrderFilters) | no | |
|
|
3002
3004
|
| items | [[OrderSchema](#OrderSchema)] | no | |
|
|
3005
|
+
| filters | [OrderFilters](#OrderFilters) | no | |
|
|
3006
|
+
| page | [OrderPage](#OrderPage) | no | |
|
|
3003
3007
|
|
|
3004
3008
|
---
|
|
3005
3009
|
|
|
@@ -3044,10 +3048,10 @@ Successfully updateShipmentStatus!
|
|
|
3044
3048
|
|
|
3045
3049
|
| Properties | Type | Nullable | Description |
|
|
3046
3050
|
| ---------- | ---- | -------- | ----------- |
|
|
3047
|
-
| presigned_url | string | yes | |
|
|
3048
|
-
| success | boolean | yes | |
|
|
3049
|
-
| presigned_type | string | yes | |
|
|
3050
3051
|
| shipment_id | string | yes | |
|
|
3052
|
+
| presigned_type | string | yes | |
|
|
3053
|
+
| success | boolean | yes | |
|
|
3054
|
+
| presigned_url | string | yes | |
|
|
3051
3055
|
|
|
3052
3056
|
---
|
|
3053
3057
|
|
|
@@ -3058,14 +3062,14 @@ Successfully updateShipmentStatus!
|
|
|
3058
3062
|
|
|
3059
3063
|
| Properties | Type | Nullable | Description |
|
|
3060
3064
|
| ---------- | ---- | -------- | ----------- |
|
|
3061
|
-
|
|
|
3065
|
+
| account_name | string | no | |
|
|
3066
|
+
| awb | string | no | |
|
|
3062
3067
|
| shipment_type | string | no | |
|
|
3063
|
-
| status | string | no | |
|
|
3064
3068
|
| updated_at | string | no | |
|
|
3065
|
-
|
|
|
3069
|
+
| status | string | no | |
|
|
3066
3070
|
| updated_time | string | no | |
|
|
3067
|
-
|
|
|
3068
|
-
|
|
|
3071
|
+
| last_location_recieved_at | string | no | |
|
|
3072
|
+
| reason | string | no | |
|
|
3069
3073
|
|
|
3070
3074
|
---
|
|
3071
3075
|
|
|
@@ -3087,11 +3091,11 @@ Successfully updateShipmentStatus!
|
|
|
3087
3091
|
|
|
3088
3092
|
| Properties | Type | Nullable | Description |
|
|
3089
3093
|
| ---------- | ---- | -------- | ----------- |
|
|
3090
|
-
| phone | string | no | |
|
|
3091
|
-
| name | string | no | |
|
|
3092
|
-
| order_id | string | no | |
|
|
3093
3094
|
| shipment_id | string | no | |
|
|
3095
|
+
| name | string | no | |
|
|
3096
|
+
| phone | string | no | |
|
|
3094
3097
|
| country | string | no | |
|
|
3098
|
+
| order_id | string | no | |
|
|
3095
3099
|
|
|
3096
3100
|
---
|
|
3097
3101
|
|
|
@@ -3102,10 +3106,10 @@ Successfully updateShipmentStatus!
|
|
|
3102
3106
|
|
|
3103
3107
|
| Properties | Type | Nullable | Description |
|
|
3104
3108
|
| ---------- | ---- | -------- | ----------- |
|
|
3105
|
-
|
|
|
3109
|
+
| request_id | string | no | |
|
|
3106
3110
|
| success | boolean | no | |
|
|
3111
|
+
| resend_timer | number | no | |
|
|
3107
3112
|
| message | string | no | |
|
|
3108
|
-
| request_id | string | no | |
|
|
3109
3113
|
|
|
3110
3114
|
---
|
|
3111
3115
|
|
|
@@ -3150,8 +3154,8 @@ Successfully updateShipmentStatus!
|
|
|
3150
3154
|
|
|
3151
3155
|
| Properties | Type | Nullable | Description |
|
|
3152
3156
|
| ---------- | ---- | -------- | ----------- |
|
|
3153
|
-
| display_name | string | no | |
|
|
3154
3157
|
| id | number | no | |
|
|
3158
|
+
| display_name | string | no | |
|
|
3155
3159
|
|
|
3156
3160
|
---
|
|
3157
3161
|
|
|
@@ -3162,12 +3166,12 @@ Successfully updateShipmentStatus!
|
|
|
3162
3166
|
|
|
3163
3167
|
| Properties | Type | Nullable | Description |
|
|
3164
3168
|
| ---------- | ---- | -------- | ----------- |
|
|
3165
|
-
|
|
|
3169
|
+
| id | number | no | |
|
|
3170
|
+
| qc_type | [string] | no | |
|
|
3171
|
+
| reasons | [[BagReasons](#BagReasons)] | no | |
|
|
3166
3172
|
| meta | [BagReasonMeta](#BagReasonMeta) | no | |
|
|
3167
3173
|
| question_set | [[QuestionSet](#QuestionSet)] | no | |
|
|
3168
|
-
|
|
|
3169
|
-
| qc_type | [string] | no | |
|
|
3170
|
-
| id | number | no | |
|
|
3174
|
+
| display_name | string | no | |
|
|
3171
3175
|
|
|
3172
3176
|
---
|
|
3173
3177
|
|
|
@@ -3178,8 +3182,8 @@ Successfully updateShipmentStatus!
|
|
|
3178
3182
|
|
|
3179
3183
|
| Properties | Type | Nullable | Description |
|
|
3180
3184
|
| ---------- | ---- | -------- | ----------- |
|
|
3181
|
-
| reasons | [[BagReasons](#BagReasons)] | no | |
|
|
3182
3185
|
| success | boolean | no | |
|
|
3186
|
+
| reasons | [[BagReasons](#BagReasons)] | no | |
|
|
3183
3187
|
|
|
3184
3188
|
---
|
|
3185
3189
|
|
|
@@ -3191,11 +3195,11 @@ Successfully updateShipmentStatus!
|
|
|
3191
3195
|
| Properties | Type | Nullable | Description |
|
|
3192
3196
|
| ---------- | ---- | -------- | ----------- |
|
|
3193
3197
|
| reason_text | string | no | |
|
|
3194
|
-
| flow | string | no | |
|
|
3195
|
-
| feedback_type | string | no | |
|
|
3196
|
-
| priority | number | no | |
|
|
3197
3198
|
| reason_id | number | no | |
|
|
3199
|
+
| priority | number | no | |
|
|
3200
|
+
| flow | string | no | |
|
|
3198
3201
|
| show_text_area | boolean | no | |
|
|
3202
|
+
| feedback_type | string | no | |
|
|
3199
3203
|
|
|
3200
3204
|
---
|
|
3201
3205
|
|
|
@@ -3213,134 +3217,134 @@ Successfully updateShipmentStatus!
|
|
|
3213
3217
|
|
|
3214
3218
|
|
|
3215
3219
|
|
|
3216
|
-
#### [
|
|
3220
|
+
#### [Products](#Products)
|
|
3217
3221
|
|
|
3218
3222
|
| Properties | Type | Nullable | Description |
|
|
3219
3223
|
| ---------- | ---- | -------- | ----------- |
|
|
3220
|
-
|
|
|
3221
|
-
|
|
|
3224
|
+
| line_number | number | no | |
|
|
3225
|
+
| identifier | string | no | |
|
|
3226
|
+
| quantity | number | no | |
|
|
3222
3227
|
|
|
3223
3228
|
---
|
|
3224
3229
|
|
|
3225
3230
|
|
|
3226
3231
|
|
|
3227
3232
|
|
|
3228
|
-
#### [
|
|
3233
|
+
#### [ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)
|
|
3229
3234
|
|
|
3230
3235
|
| Properties | Type | Nullable | Description |
|
|
3231
3236
|
| ---------- | ---- | -------- | ----------- |
|
|
3232
|
-
|
|
|
3233
|
-
|
|
|
3237
|
+
| line_number | number | no | |
|
|
3238
|
+
| identifier | string | no | |
|
|
3234
3239
|
|
|
3235
3240
|
---
|
|
3236
3241
|
|
|
3237
3242
|
|
|
3238
3243
|
|
|
3239
3244
|
|
|
3240
|
-
#### [
|
|
3245
|
+
#### [ProductsDataUpdates](#ProductsDataUpdates)
|
|
3241
3246
|
|
|
3242
3247
|
| Properties | Type | Nullable | Description |
|
|
3243
3248
|
| ---------- | ---- | -------- | ----------- |
|
|
3244
|
-
|
|
|
3245
|
-
|
|
|
3246
|
-
| identifier | string | no | |
|
|
3249
|
+
| filters | [[ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)] | no | |
|
|
3250
|
+
| data | string | no | |
|
|
3247
3251
|
|
|
3248
3252
|
---
|
|
3249
3253
|
|
|
3250
3254
|
|
|
3251
3255
|
|
|
3252
3256
|
|
|
3253
|
-
#### [
|
|
3257
|
+
#### [EntitiesDataUpdates](#EntitiesDataUpdates)
|
|
3254
3258
|
|
|
3255
3259
|
| Properties | Type | Nullable | Description |
|
|
3256
3260
|
| ---------- | ---- | -------- | ----------- |
|
|
3257
|
-
|
|
|
3258
|
-
|
|
|
3261
|
+
| filters | [string] | no | |
|
|
3262
|
+
| data | string | no | |
|
|
3259
3263
|
|
|
3260
3264
|
---
|
|
3261
3265
|
|
|
3262
3266
|
|
|
3263
3267
|
|
|
3264
3268
|
|
|
3265
|
-
#### [
|
|
3269
|
+
#### [DataUpdates](#DataUpdates)
|
|
3266
3270
|
|
|
3267
3271
|
| Properties | Type | Nullable | Description |
|
|
3268
3272
|
| ---------- | ---- | -------- | ----------- |
|
|
3269
|
-
|
|
|
3270
|
-
|
|
|
3273
|
+
| products | [[ProductsDataUpdates](#ProductsDataUpdates)] | no | |
|
|
3274
|
+
| entities | [[EntitiesDataUpdates](#EntitiesDataUpdates)] | no | |
|
|
3271
3275
|
|
|
3272
3276
|
---
|
|
3273
3277
|
|
|
3274
3278
|
|
|
3275
3279
|
|
|
3276
3280
|
|
|
3277
|
-
#### [
|
|
3281
|
+
#### [ProductsReasonsFilters](#ProductsReasonsFilters)
|
|
3278
3282
|
|
|
3279
3283
|
| Properties | Type | Nullable | Description |
|
|
3280
3284
|
| ---------- | ---- | -------- | ----------- |
|
|
3281
|
-
|
|
|
3282
|
-
|
|
|
3285
|
+
| line_number | number | no | |
|
|
3286
|
+
| identifier | string | no | |
|
|
3287
|
+
| quantity | number | no | |
|
|
3283
3288
|
|
|
3284
3289
|
---
|
|
3285
3290
|
|
|
3286
3291
|
|
|
3287
3292
|
|
|
3288
3293
|
|
|
3289
|
-
#### [
|
|
3294
|
+
#### [ProductsReasonsData](#ProductsReasonsData)
|
|
3290
3295
|
|
|
3291
3296
|
| Properties | Type | Nullable | Description |
|
|
3292
3297
|
| ---------- | ---- | -------- | ----------- |
|
|
3293
|
-
|
|
|
3294
|
-
|
|
|
3295
|
-
| identifier | string | no | |
|
|
3298
|
+
| reason_id | number | no | |
|
|
3299
|
+
| reason_text | string | no | |
|
|
3296
3300
|
|
|
3297
3301
|
---
|
|
3298
3302
|
|
|
3299
3303
|
|
|
3300
3304
|
|
|
3301
3305
|
|
|
3302
|
-
#### [
|
|
3306
|
+
#### [ProductsReasons](#ProductsReasons)
|
|
3303
3307
|
|
|
3304
3308
|
| Properties | Type | Nullable | Description |
|
|
3305
3309
|
| ---------- | ---- | -------- | ----------- |
|
|
3306
|
-
| filters | [
|
|
3307
|
-
| data |
|
|
3310
|
+
| filters | [[ProductsReasonsFilters](#ProductsReasonsFilters)] | no | |
|
|
3311
|
+
| data | [ProductsReasonsData](#ProductsReasonsData) | no | |
|
|
3308
3312
|
|
|
3309
3313
|
---
|
|
3310
3314
|
|
|
3311
3315
|
|
|
3312
3316
|
|
|
3313
3317
|
|
|
3314
|
-
#### [
|
|
3318
|
+
#### [EntityReasonData](#EntityReasonData)
|
|
3315
3319
|
|
|
3316
3320
|
| Properties | Type | Nullable | Description |
|
|
3317
3321
|
| ---------- | ---- | -------- | ----------- |
|
|
3318
|
-
|
|
|
3319
|
-
|
|
|
3322
|
+
| reason_id | number | no | |
|
|
3323
|
+
| reason_text | string | no | |
|
|
3320
3324
|
|
|
3321
3325
|
---
|
|
3322
3326
|
|
|
3323
3327
|
|
|
3324
3328
|
|
|
3325
3329
|
|
|
3326
|
-
#### [
|
|
3330
|
+
#### [EntitiesReasons](#EntitiesReasons)
|
|
3327
3331
|
|
|
3328
3332
|
| Properties | Type | Nullable | Description |
|
|
3329
3333
|
| ---------- | ---- | -------- | ----------- |
|
|
3330
|
-
| filters | [
|
|
3331
|
-
| data |
|
|
3334
|
+
| filters | [string] | no | |
|
|
3335
|
+
| data | [EntityReasonData](#EntityReasonData) | no | |
|
|
3332
3336
|
|
|
3333
3337
|
---
|
|
3334
3338
|
|
|
3335
3339
|
|
|
3336
3340
|
|
|
3337
3341
|
|
|
3338
|
-
#### [
|
|
3342
|
+
#### [ReasonsData](#ReasonsData)
|
|
3339
3343
|
|
|
3340
3344
|
| Properties | Type | Nullable | Description |
|
|
3341
3345
|
| ---------- | ---- | -------- | ----------- |
|
|
3342
|
-
|
|
|
3343
|
-
|
|
|
3346
|
+
| products | [[ProductsReasons](#ProductsReasons)] | no | |
|
|
3347
|
+
| entities | [[EntitiesReasons](#EntitiesReasons)] | no | |
|
|
3344
3348
|
|
|
3345
3349
|
---
|
|
3346
3350
|
|
|
@@ -3351,10 +3355,10 @@ Successfully updateShipmentStatus!
|
|
|
3351
3355
|
|
|
3352
3356
|
| Properties | Type | Nullable | Description |
|
|
3353
3357
|
| ---------- | ---- | -------- | ----------- |
|
|
3354
|
-
| reasons | [ReasonsData](#ReasonsData) | no | |
|
|
3355
3358
|
| products | [[Products](#Products)] | no | |
|
|
3356
|
-
| identifier | string | yes | |
|
|
3357
3359
|
| data_updates | [DataUpdates](#DataUpdates) | no | |
|
|
3360
|
+
| identifier | string | yes | |
|
|
3361
|
+
| reasons | [ReasonsData](#ReasonsData) | no | |
|
|
3358
3362
|
|
|
3359
3363
|
---
|
|
3360
3364
|
|
|
@@ -3365,9 +3369,9 @@ Successfully updateShipmentStatus!
|
|
|
3365
3369
|
|
|
3366
3370
|
| Properties | Type | Nullable | Description |
|
|
3367
3371
|
| ---------- | ---- | -------- | ----------- |
|
|
3368
|
-
| status | string | no | |
|
|
3369
|
-
| exclude_bags_next_state | string | no | |
|
|
3370
3372
|
| shipments | [[ShipmentsRequest](#ShipmentsRequest)] | no | |
|
|
3373
|
+
| exclude_bags_next_state | string | no | |
|
|
3374
|
+
| status | string | no | |
|
|
3371
3375
|
|
|
3372
3376
|
---
|
|
3373
3377
|
|
|
@@ -3378,11 +3382,11 @@ Successfully updateShipmentStatus!
|
|
|
3378
3382
|
|
|
3379
3383
|
| Properties | Type | Nullable | Description |
|
|
3380
3384
|
| ---------- | ---- | -------- | ----------- |
|
|
3381
|
-
| lock_after_transition | boolean | no | |
|
|
3382
3385
|
| unlock_before_transition | boolean | no | |
|
|
3383
|
-
|
|
|
3386
|
+
| lock_after_transition | boolean | no | |
|
|
3384
3387
|
| statuses | [[StatuesRequest](#StatuesRequest)] | no | |
|
|
3385
3388
|
| task | boolean | no | |
|
|
3389
|
+
| force_transition | boolean | no | |
|
|
3386
3390
|
|
|
3387
3391
|
---
|
|
3388
3392
|
|
|
@@ -3417,9 +3421,9 @@ Successfully updateShipmentStatus!
|
|
|
3417
3421
|
| ---------- | ---- | -------- | ----------- |
|
|
3418
3422
|
| stack_trace | string | no | |
|
|
3419
3423
|
| exception | string | no | |
|
|
3424
|
+
| message | string | no | |
|
|
3420
3425
|
| status | number | no | |
|
|
3421
3426
|
| code | string | no | |
|
|
3422
|
-
| message | string | no | |
|
|
3423
3427
|
|
|
3424
3428
|
---
|
|
3425
3429
|
|