@redotech/redo-api-schema 2.2.161 → 2.2.172
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 +83 -3
- package/lib/openapi.yaml +76 -2
- package/package.json +1 -1
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
|
|
@@ -828,6 +853,11 @@ export interface components {
|
|
|
828
853
|
* @description Tracking number
|
|
829
854
|
*/
|
|
830
855
|
tracker?: string;
|
|
856
|
+
/**
|
|
857
|
+
* Tracking URL
|
|
858
|
+
* @description Tracking URL
|
|
859
|
+
*/
|
|
860
|
+
trackingUrl?: string;
|
|
831
861
|
};
|
|
832
862
|
/**
|
|
833
863
|
* Return status
|
|
@@ -1005,7 +1035,10 @@ export interface components {
|
|
|
1005
1035
|
priceTotal: components["schemas"]["money.schema"];
|
|
1006
1036
|
/** @description Product. */
|
|
1007
1037
|
product: {
|
|
1008
|
-
/**
|
|
1038
|
+
/**
|
|
1039
|
+
* ID
|
|
1040
|
+
* @description Identifier of the product.
|
|
1041
|
+
*/
|
|
1009
1042
|
id: string;
|
|
1010
1043
|
};
|
|
1011
1044
|
/**
|
|
@@ -1015,7 +1048,10 @@ export interface components {
|
|
|
1015
1048
|
quantity: number;
|
|
1016
1049
|
/** @description Variant. */
|
|
1017
1050
|
variant: {
|
|
1018
|
-
/**
|
|
1051
|
+
/**
|
|
1052
|
+
* ID
|
|
1053
|
+
* @description Identifier of the variant.
|
|
1054
|
+
*/
|
|
1019
1055
|
id: string;
|
|
1020
1056
|
};
|
|
1021
1057
|
}[];
|
|
@@ -1517,8 +1553,52 @@ export interface operations {
|
|
|
1517
1553
|
requestBody: {
|
|
1518
1554
|
content: {
|
|
1519
1555
|
"application/json": {
|
|
1520
|
-
cart
|
|
1556
|
+
cart?: components["schemas"]["storefront-cart.schema"];
|
|
1521
1557
|
customer?: components["schemas"]["storefront-customer.schema"];
|
|
1558
|
+
/**
|
|
1559
|
+
* Products
|
|
1560
|
+
* @description Product information.
|
|
1561
|
+
*/
|
|
1562
|
+
products?: {
|
|
1563
|
+
/**
|
|
1564
|
+
* ID
|
|
1565
|
+
* @description Identifier of the product.
|
|
1566
|
+
*/
|
|
1567
|
+
id: string;
|
|
1568
|
+
}[];
|
|
1569
|
+
/**
|
|
1570
|
+
* Variants
|
|
1571
|
+
* @description Variant information.
|
|
1572
|
+
*/
|
|
1573
|
+
variants?: {
|
|
1574
|
+
/**
|
|
1575
|
+
* Height
|
|
1576
|
+
* @description Height of an item.
|
|
1577
|
+
*/
|
|
1578
|
+
height?: components["schemas"]["length.schema"];
|
|
1579
|
+
/**
|
|
1580
|
+
* ID
|
|
1581
|
+
* @description Identifier of the variant.
|
|
1582
|
+
*/
|
|
1583
|
+
id: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* Length
|
|
1586
|
+
* @description Length of an item.
|
|
1587
|
+
*/
|
|
1588
|
+
length?: components["schemas"]["length.schema"];
|
|
1589
|
+
/** Title */
|
|
1590
|
+
title?: string;
|
|
1591
|
+
/**
|
|
1592
|
+
* Weight
|
|
1593
|
+
* @description Weight of an item.
|
|
1594
|
+
*/
|
|
1595
|
+
weight?: components["schemas"]["weight.schema"];
|
|
1596
|
+
/**
|
|
1597
|
+
* Width
|
|
1598
|
+
* @description Width of an item.
|
|
1599
|
+
*/
|
|
1600
|
+
width?: components["schemas"]["length.schema"];
|
|
1601
|
+
}[];
|
|
1522
1602
|
};
|
|
1523
1603
|
};
|
|
1524
1604
|
};
|
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:
|
|
@@ -894,6 +919,10 @@ components:
|
|
|
894
919
|
description: Tracking number
|
|
895
920
|
title: Tracker
|
|
896
921
|
type: string
|
|
922
|
+
trackingUrl:
|
|
923
|
+
description: Tracking URL
|
|
924
|
+
title: Tracking URL
|
|
925
|
+
type: string
|
|
897
926
|
title: Return Shipment
|
|
898
927
|
type: object
|
|
899
928
|
return-status-update.schema:
|
|
@@ -1135,6 +1164,7 @@ components:
|
|
|
1135
1164
|
description: Product.
|
|
1136
1165
|
properties:
|
|
1137
1166
|
id:
|
|
1167
|
+
description: Identifier of the product.
|
|
1138
1168
|
title: ID
|
|
1139
1169
|
type: string
|
|
1140
1170
|
required:
|
|
@@ -1148,6 +1178,7 @@ components:
|
|
|
1148
1178
|
description: Variant.
|
|
1149
1179
|
properties:
|
|
1150
1180
|
id:
|
|
1181
|
+
description: Identifier of the variant.
|
|
1151
1182
|
title: ID
|
|
1152
1183
|
type: string
|
|
1153
1184
|
required:
|
|
@@ -1699,8 +1730,51 @@ paths:
|
|
|
1699
1730
|
$ref: '#/components/schemas/storefront-cart.schema'
|
|
1700
1731
|
customer:
|
|
1701
1732
|
$ref: '#/components/schemas/storefront-customer.schema'
|
|
1702
|
-
|
|
1703
|
-
|
|
1733
|
+
products:
|
|
1734
|
+
description: Product information.
|
|
1735
|
+
items:
|
|
1736
|
+
properties:
|
|
1737
|
+
id:
|
|
1738
|
+
description: Identifier of the product.
|
|
1739
|
+
title: ID
|
|
1740
|
+
type: string
|
|
1741
|
+
required:
|
|
1742
|
+
- id
|
|
1743
|
+
type: object
|
|
1744
|
+
title: Products
|
|
1745
|
+
type: array
|
|
1746
|
+
variants:
|
|
1747
|
+
description: Variant information.
|
|
1748
|
+
items:
|
|
1749
|
+
properties:
|
|
1750
|
+
height:
|
|
1751
|
+
$ref: '#/components/schemas/length.schema'
|
|
1752
|
+
description: Height of an item.
|
|
1753
|
+
title: Height
|
|
1754
|
+
id:
|
|
1755
|
+
description: Identifier of the variant.
|
|
1756
|
+
title: ID
|
|
1757
|
+
type: string
|
|
1758
|
+
length:
|
|
1759
|
+
$ref: '#/components/schemas/length.schema'
|
|
1760
|
+
description: Length of an item.
|
|
1761
|
+
title: Length
|
|
1762
|
+
title:
|
|
1763
|
+
title: Title
|
|
1764
|
+
type: string
|
|
1765
|
+
weight:
|
|
1766
|
+
$ref: '#/components/schemas/weight.schema'
|
|
1767
|
+
description: Weight of an item.
|
|
1768
|
+
title: Weight
|
|
1769
|
+
width:
|
|
1770
|
+
$ref: '#/components/schemas/length.schema'
|
|
1771
|
+
description: Width of an item.
|
|
1772
|
+
title: Width
|
|
1773
|
+
required:
|
|
1774
|
+
- id
|
|
1775
|
+
type: object
|
|
1776
|
+
title: Variants
|
|
1777
|
+
type: array
|
|
1704
1778
|
type: object
|
|
1705
1779
|
required: true
|
|
1706
1780
|
responses:
|
package/package.json
CHANGED