@redotech/redo-api-schema 2.2.162 → 2.2.174

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/lib/openapi.d.ts CHANGED
@@ -448,6 +448,11 @@ export interface components {
448
448
  */
449
449
  phoneNumber?: components["schemas"]["phone-number.schema"];
450
450
  };
451
+ /**
452
+ * Discounts
453
+ * @description The total amount discounted on the order before returns. This includes both order and line level discounts.
454
+ */
455
+ discounts: components["schemas"]["money.schema"];
451
456
  /**
452
457
  * External ID
453
458
  * @description Shopify ID
@@ -482,11 +487,31 @@ export interface components {
482
487
  /** Variant */
483
488
  variant: components["schemas"]["product-variant.schema"];
484
489
  })[];
490
+ /**
491
+ * Line Items Total
492
+ * @description Total price of all line items before discounts, shipping, and taxes.
493
+ */
494
+ lineItemsTotal: components["schemas"]["money.schema"];
485
495
  /**
486
496
  * Name
487
497
  * @description Shopify name.
488
498
  */
489
499
  name: string;
500
+ /**
501
+ * Shipping Cost
502
+ * @description The total shipping cost for the order. This includes fees and any related discounts that were refunded.
503
+ */
504
+ shippingCost: components["schemas"]["money.schema"];
505
+ /**
506
+ * Taxes
507
+ * @description Total taxes applied to the order.
508
+ */
509
+ taxes: components["schemas"]["money.schema"];
510
+ /**
511
+ * Total
512
+ * @description The total price of the order, before returns. This includes taxes, discounts, and shipping costs.
513
+ */
514
+ total: components["schemas"]["money.schema"];
490
515
  };
491
516
  /**
492
517
  * Parcel Type
@@ -636,6 +661,11 @@ export interface components {
636
661
  * @description Return identifier.
637
662
  */
638
663
  id: string;
664
+ /**
665
+ * Internal Created By Name
666
+ * @description Name of the internal team member who created this return
667
+ */
668
+ internalCreatedByName?: string;
639
669
  /** @description Return items */
640
670
  items: {
641
671
  /** @description Customer's comment about the return */
@@ -828,6 +858,11 @@ export interface components {
828
858
  * @description Tracking number
829
859
  */
830
860
  tracker?: string;
861
+ /**
862
+ * Tracking URL
863
+ * @description Tracking URL
864
+ */
865
+ trackingUrl?: string;
831
866
  };
832
867
  /**
833
868
  * Return status
@@ -1030,50 +1065,6 @@ export interface components {
1030
1065
  * @description Total price.
1031
1066
  */
1032
1067
  priceTotal?: components["schemas"]["money.schema"];
1033
- /**
1034
- * Products
1035
- * @description Product information.
1036
- */
1037
- products?: {
1038
- /**
1039
- * ID
1040
- * @description Identifier of the product.
1041
- */
1042
- id: string;
1043
- }[];
1044
- /**
1045
- * Variants
1046
- * @description Variant information.
1047
- */
1048
- variants?: {
1049
- /**
1050
- * Height
1051
- * @description Height of an item.
1052
- */
1053
- height?: components["schemas"]["length.schema"];
1054
- /**
1055
- * ID
1056
- * @description Identifier of the variant.
1057
- */
1058
- id: string;
1059
- /**
1060
- * Length
1061
- * @description Length of an item.
1062
- */
1063
- length?: components["schemas"]["length.schema"];
1064
- /** Title */
1065
- title?: string;
1066
- /**
1067
- * Weight
1068
- * @description Weight of an item.
1069
- */
1070
- weight?: components["schemas"]["weight.schema"];
1071
- /**
1072
- * Width
1073
- * @description Width of an item.
1074
- */
1075
- width?: components["schemas"]["length.schema"];
1076
- }[];
1077
1068
  };
1078
1069
  /**
1079
1070
  * Storefront Customer
@@ -1567,8 +1558,52 @@ export interface operations {
1567
1558
  requestBody: {
1568
1559
  content: {
1569
1560
  "application/json": {
1570
- cart: components["schemas"]["storefront-cart.schema"];
1561
+ cart?: components["schemas"]["storefront-cart.schema"];
1571
1562
  customer?: components["schemas"]["storefront-customer.schema"];
1563
+ /**
1564
+ * Products
1565
+ * @description Product information.
1566
+ */
1567
+ products?: {
1568
+ /**
1569
+ * ID
1570
+ * @description Identifier of the product.
1571
+ */
1572
+ id: string;
1573
+ }[];
1574
+ /**
1575
+ * Variants
1576
+ * @description Variant information.
1577
+ */
1578
+ variants?: {
1579
+ /**
1580
+ * Height
1581
+ * @description Height of an item.
1582
+ */
1583
+ height?: components["schemas"]["length.schema"];
1584
+ /**
1585
+ * ID
1586
+ * @description Identifier of the variant.
1587
+ */
1588
+ id: string;
1589
+ /**
1590
+ * Length
1591
+ * @description Length of an item.
1592
+ */
1593
+ length?: components["schemas"]["length.schema"];
1594
+ /** Title */
1595
+ title?: string;
1596
+ /**
1597
+ * Weight
1598
+ * @description Weight of an item.
1599
+ */
1600
+ weight?: components["schemas"]["weight.schema"];
1601
+ /**
1602
+ * Width
1603
+ * @description Width of an item.
1604
+ */
1605
+ width?: components["schemas"]["length.schema"];
1606
+ }[];
1572
1607
  };
1573
1608
  };
1574
1609
  };
package/lib/openapi.yaml CHANGED
@@ -370,6 +370,10 @@ components:
370
370
  required:
371
371
  - name
372
372
  type: object
373
+ discounts:
374
+ $ref: '#/components/schemas/money.schema'
375
+ description: The total amount discounted on the order before returns. This includes both order and line level discounts.
376
+ title: Discounts
373
377
  externalId:
374
378
  description: Shopify ID
375
379
  examples:
@@ -419,17 +423,38 @@ components:
419
423
  - fulfillmentLocationId
420
424
  title: Line items
421
425
  type: array
426
+ lineItemsTotal:
427
+ $ref: '#/components/schemas/money.schema'
428
+ description: Total price of all line items before discounts, shipping, and taxes.
429
+ title: Line Items Total
422
430
  name:
423
431
  description: Shopify name.
424
432
  examples:
425
433
  - '#123'
426
434
  title: Name
427
435
  type: string
436
+ shippingCost:
437
+ $ref: '#/components/schemas/money.schema'
438
+ description: The total shipping cost for the order. This includes fees and any related discounts that were refunded.
439
+ title: Shipping Cost
440
+ taxes:
441
+ $ref: '#/components/schemas/money.schema'
442
+ description: Total taxes applied to the order.
443
+ title: Taxes
444
+ total:
445
+ $ref: '#/components/schemas/money.schema'
446
+ description: The total price of the order, before returns. This includes taxes, discounts, and shipping costs.
447
+ title: Total
428
448
  required:
429
449
  - customer
430
450
  - id
431
451
  - items
432
452
  - name
453
+ - discounts
454
+ - lineItemsTotal
455
+ - shippingCost
456
+ - total
457
+ - taxes
433
458
  title: Order
434
459
  type: object
435
460
  parcel-type.schema:
@@ -632,6 +657,10 @@ components:
632
657
  - 64df65d4c5a4ca3eff4b4e43
633
658
  title: Identifier
634
659
  type: string
660
+ internalCreatedByName:
661
+ description: Name of the internal team member who created this return
662
+ title: Internal Created By Name
663
+ type: string
635
664
  items:
636
665
  description: Return items
637
666
  items:
@@ -894,6 +923,10 @@ components:
894
923
  description: Tracking number
895
924
  title: Tracker
896
925
  type: string
926
+ trackingUrl:
927
+ description: Tracking URL
928
+ title: Tracking URL
929
+ type: string
897
930
  title: Return Shipment
898
931
  type: object
899
932
  return-status-update.schema:
@@ -1168,51 +1201,6 @@ components:
1168
1201
  $ref: '#/components/schemas/money.schema'
1169
1202
  description: Total price.
1170
1203
  title: Price
1171
- products:
1172
- description: Product information.
1173
- items:
1174
- properties:
1175
- id:
1176
- description: Identifier of the product.
1177
- title: ID
1178
- type: string
1179
- required:
1180
- - id
1181
- type: object
1182
- title: Products
1183
- type: array
1184
- variants:
1185
- description: Variant information.
1186
- items:
1187
- properties:
1188
- height:
1189
- $ref: '#/components/schemas/length.schema'
1190
- description: Height of an item.
1191
- title: Height
1192
- id:
1193
- description: Identifier of the variant.
1194
- title: ID
1195
- type: string
1196
- length:
1197
- $ref: '#/components/schemas/length.schema'
1198
- description: Length of an item.
1199
- title: Length
1200
- title:
1201
- title: Title
1202
- type: string
1203
- weight:
1204
- $ref: '#/components/schemas/weight.schema'
1205
- description: Weight of an item.
1206
- title: Weight
1207
- width:
1208
- $ref: '#/components/schemas/length.schema'
1209
- description: Width of an item.
1210
- title: Width
1211
- required:
1212
- - id
1213
- type: object
1214
- title: Variants
1215
- type: array
1216
1204
  required:
1217
1205
  - lineItems
1218
1206
  title: Storefront Cart
@@ -1746,8 +1734,51 @@ paths:
1746
1734
  $ref: '#/components/schemas/storefront-cart.schema'
1747
1735
  customer:
1748
1736
  $ref: '#/components/schemas/storefront-customer.schema'
1749
- required:
1750
- - cart
1737
+ products:
1738
+ description: Product information.
1739
+ items:
1740
+ properties:
1741
+ id:
1742
+ description: Identifier of the product.
1743
+ title: ID
1744
+ type: string
1745
+ required:
1746
+ - id
1747
+ type: object
1748
+ title: Products
1749
+ type: array
1750
+ variants:
1751
+ description: Variant information.
1752
+ items:
1753
+ properties:
1754
+ height:
1755
+ $ref: '#/components/schemas/length.schema'
1756
+ description: Height of an item.
1757
+ title: Height
1758
+ id:
1759
+ description: Identifier of the variant.
1760
+ title: ID
1761
+ type: string
1762
+ length:
1763
+ $ref: '#/components/schemas/length.schema'
1764
+ description: Length of an item.
1765
+ title: Length
1766
+ title:
1767
+ title: Title
1768
+ type: string
1769
+ weight:
1770
+ $ref: '#/components/schemas/weight.schema'
1771
+ description: Weight of an item.
1772
+ title: Weight
1773
+ width:
1774
+ $ref: '#/components/schemas/length.schema'
1775
+ description: Width of an item.
1776
+ title: Width
1777
+ required:
1778
+ - id
1779
+ type: object
1780
+ title: Variants
1781
+ type: array
1751
1782
  type: object
1752
1783
  required: true
1753
1784
  responses:
package/package.json CHANGED
@@ -31,5 +31,5 @@
31
31
  ]
32
32
  }
33
33
  },
34
- "version": "2.2.162"
34
+ "version": "2.2.174"
35
35
  }