@epilot/pricing-client 3.9.2 → 3.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/openapi.d.ts +54 -30
- package/dist/openapi.json +231 -62
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -496,13 +496,19 @@ declare namespace Components {
|
|
|
496
496
|
files?: string[];
|
|
497
497
|
status?: /**
|
|
498
498
|
*
|
|
499
|
-
* | status
|
|
500
|
-
*
|
|
501
|
-
* | `
|
|
502
|
-
* | `
|
|
503
|
-
* | `
|
|
504
|
-
* | `
|
|
505
|
-
* | `
|
|
499
|
+
* | status | description |
|
|
500
|
+
* |-------------|----------|
|
|
501
|
+
* | `new` | Starting state for all orders, at this point we can still edit the order |
|
|
502
|
+
* | `draft` | old value of 'new' |
|
|
503
|
+
* | `in_progress` | The order is open to accept by user |
|
|
504
|
+
* | `open_for_acceptance` | old value of 'in_progress' |
|
|
505
|
+
* | `offer` | The order is in a quoting phase, bound to an expiration date |
|
|
506
|
+
* | `quote` | old value of offer |
|
|
507
|
+
* | `order_accepted` | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |
|
|
508
|
+
* | `placed` | old value of order_accepted |
|
|
509
|
+
* | `lost ` | The order has been cancelled |
|
|
510
|
+
* | `cancelled` | old value of lost |
|
|
511
|
+
* | `complete` | The order is now closed and finalized |
|
|
506
512
|
*
|
|
507
513
|
*/
|
|
508
514
|
OrderStatus;
|
|
@@ -1273,13 +1279,19 @@ declare namespace Components {
|
|
|
1273
1279
|
cart_id?: string;
|
|
1274
1280
|
status?: /**
|
|
1275
1281
|
*
|
|
1276
|
-
* | status
|
|
1277
|
-
*
|
|
1278
|
-
* | `
|
|
1279
|
-
* | `
|
|
1280
|
-
* | `
|
|
1281
|
-
* | `
|
|
1282
|
-
* | `
|
|
1282
|
+
* | status | description |
|
|
1283
|
+
* |-------------|----------|
|
|
1284
|
+
* | `new` | Starting state for all orders, at this point we can still edit the order |
|
|
1285
|
+
* | `draft` | old value of 'new' |
|
|
1286
|
+
* | `in_progress` | The order is open to accept by user |
|
|
1287
|
+
* | `open_for_acceptance` | old value of 'in_progress' |
|
|
1288
|
+
* | `offer` | The order is in a quoting phase, bound to an expiration date |
|
|
1289
|
+
* | `quote` | old value of offer |
|
|
1290
|
+
* | `order_accepted` | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |
|
|
1291
|
+
* | `placed` | old value of order_accepted |
|
|
1292
|
+
* | `lost ` | The order has been cancelled |
|
|
1293
|
+
* | `cancelled` | old value of lost |
|
|
1294
|
+
* | `complete` | The order is now closed and finalized |
|
|
1283
1295
|
*
|
|
1284
1296
|
*/
|
|
1285
1297
|
OrderStatus;
|
|
@@ -1404,13 +1416,19 @@ declare namespace Components {
|
|
|
1404
1416
|
[name: string]: any;
|
|
1405
1417
|
status?: /**
|
|
1406
1418
|
*
|
|
1407
|
-
* | status
|
|
1408
|
-
*
|
|
1409
|
-
* | `
|
|
1410
|
-
* | `
|
|
1411
|
-
* | `
|
|
1412
|
-
* | `
|
|
1413
|
-
* | `
|
|
1419
|
+
* | status | description |
|
|
1420
|
+
* |-------------|----------|
|
|
1421
|
+
* | `new` | Starting state for all orders, at this point we can still edit the order |
|
|
1422
|
+
* | `draft` | old value of 'new' |
|
|
1423
|
+
* | `in_progress` | The order is open to accept by user |
|
|
1424
|
+
* | `open_for_acceptance` | old value of 'in_progress' |
|
|
1425
|
+
* | `offer` | The order is in a quoting phase, bound to an expiration date |
|
|
1426
|
+
* | `quote` | old value of offer |
|
|
1427
|
+
* | `order_accepted` | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |
|
|
1428
|
+
* | `placed` | old value of order_accepted |
|
|
1429
|
+
* | `lost ` | The order has been cancelled |
|
|
1430
|
+
* | `cancelled` | old value of lost |
|
|
1431
|
+
* | `complete` | The order is now closed and finalized |
|
|
1414
1432
|
*
|
|
1415
1433
|
*/
|
|
1416
1434
|
OrderStatus;
|
|
@@ -1477,16 +1495,22 @@ declare namespace Components {
|
|
|
1477
1495
|
}
|
|
1478
1496
|
/**
|
|
1479
1497
|
*
|
|
1480
|
-
* | status
|
|
1481
|
-
*
|
|
1482
|
-
* | `
|
|
1483
|
-
* | `
|
|
1484
|
-
* | `
|
|
1485
|
-
* | `
|
|
1486
|
-
* | `
|
|
1498
|
+
* | status | description |
|
|
1499
|
+
* |-------------|----------|
|
|
1500
|
+
* | `new` | Starting state for all orders, at this point we can still edit the order |
|
|
1501
|
+
* | `draft` | old value of 'new' |
|
|
1502
|
+
* | `in_progress` | The order is open to accept by user |
|
|
1503
|
+
* | `open_for_acceptance` | old value of 'in_progress' |
|
|
1504
|
+
* | `offer` | The order is in a quoting phase, bound to an expiration date |
|
|
1505
|
+
* | `quote` | old value of offer |
|
|
1506
|
+
* | `order_accepted` | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |
|
|
1507
|
+
* | `placed` | old value of order_accepted |
|
|
1508
|
+
* | `lost ` | The order has been cancelled |
|
|
1509
|
+
* | `cancelled` | old value of lost |
|
|
1510
|
+
* | `complete` | The order is now closed and finalized |
|
|
1487
1511
|
*
|
|
1488
1512
|
*/
|
|
1489
|
-
export type OrderStatus = "draft" | "quote" | "placed" | "cancelled" | "
|
|
1513
|
+
export type OrderStatus = "draft" | "new" | "open_for_acceptance" | "in_progress" | "quote" | "offer" | "placed" | "order_accepted" | "cancelled" | "lost" | "complete";
|
|
1490
1514
|
/**
|
|
1491
1515
|
* A PaymentMethod represent your customer's payment instruments.
|
|
1492
1516
|
*
|
|
@@ -2624,7 +2648,7 @@ declare namespace Components {
|
|
|
2624
2648
|
*/
|
|
2625
2649
|
msg: string;
|
|
2626
2650
|
/**
|
|
2627
|
-
* Data related
|
|
2651
|
+
* Data related to the error
|
|
2628
2652
|
*/
|
|
2629
2653
|
data?: string;
|
|
2630
2654
|
}
|
package/dist/openapi.json
CHANGED
|
@@ -66,15 +66,24 @@
|
|
|
66
66
|
"x-tagGroups": [
|
|
67
67
|
{
|
|
68
68
|
"name": "Commerce Schemas",
|
|
69
|
-
"tags": [
|
|
69
|
+
"tags": [
|
|
70
|
+
"order_schema",
|
|
71
|
+
"opportunity_schema"
|
|
72
|
+
]
|
|
70
73
|
},
|
|
71
74
|
{
|
|
72
75
|
"name": "Pricing Schemas",
|
|
73
|
-
"tags": [
|
|
76
|
+
"tags": [
|
|
77
|
+
"product_schema",
|
|
78
|
+
"simple_price_schema",
|
|
79
|
+
"dynamic_price_schema"
|
|
80
|
+
]
|
|
74
81
|
},
|
|
75
82
|
{
|
|
76
83
|
"name": "Examples",
|
|
77
|
-
"tags": [
|
|
84
|
+
"tags": [
|
|
85
|
+
"order_composite_prices"
|
|
86
|
+
]
|
|
78
87
|
},
|
|
79
88
|
{
|
|
80
89
|
"name": "APIs",
|
|
@@ -106,7 +115,9 @@
|
|
|
106
115
|
"description": "Create an order",
|
|
107
116
|
"operationId": "createOrder",
|
|
108
117
|
"summary": "createOrder",
|
|
109
|
-
"tags": [
|
|
118
|
+
"tags": [
|
|
119
|
+
"Order API"
|
|
120
|
+
],
|
|
110
121
|
"requestBody": {
|
|
111
122
|
"required": true,
|
|
112
123
|
"content": {
|
|
@@ -172,7 +183,9 @@
|
|
|
172
183
|
"delivery_address": [],
|
|
173
184
|
"dates": [
|
|
174
185
|
{
|
|
175
|
-
"_tags": [
|
|
186
|
+
"_tags": [
|
|
187
|
+
"Instalation Date"
|
|
188
|
+
],
|
|
176
189
|
"dates": "",
|
|
177
190
|
"value": "2022-06-30T16:29:00.000Z"
|
|
178
191
|
}
|
|
@@ -236,7 +249,9 @@
|
|
|
236
249
|
"delivery_address": [],
|
|
237
250
|
"dates": [
|
|
238
251
|
{
|
|
239
|
-
"_tags": [
|
|
252
|
+
"_tags": [
|
|
253
|
+
"Instalation Date"
|
|
254
|
+
],
|
|
240
255
|
"dates": "",
|
|
241
256
|
"value": "2022-06-30T16:29:00.000Z"
|
|
242
257
|
}
|
|
@@ -309,7 +324,9 @@
|
|
|
309
324
|
"delivery_address": [],
|
|
310
325
|
"dates": [
|
|
311
326
|
{
|
|
312
|
-
"_tags": [
|
|
327
|
+
"_tags": [
|
|
328
|
+
"Instalation Date"
|
|
329
|
+
],
|
|
313
330
|
"dates": "",
|
|
314
331
|
"value": "2022-06-30T16:29:00.000Z"
|
|
315
332
|
}
|
|
@@ -352,7 +369,9 @@
|
|
|
352
369
|
"description": "Update an existing Order",
|
|
353
370
|
"operationId": "putOrder",
|
|
354
371
|
"summary": "putOrder",
|
|
355
|
-
"tags": [
|
|
372
|
+
"tags": [
|
|
373
|
+
"Order API"
|
|
374
|
+
],
|
|
356
375
|
"parameters": [
|
|
357
376
|
{
|
|
358
377
|
"in": "path",
|
|
@@ -433,7 +452,9 @@
|
|
|
433
452
|
"delivery_address": [],
|
|
434
453
|
"dates": [
|
|
435
454
|
{
|
|
436
|
-
"_tags": [
|
|
455
|
+
"_tags": [
|
|
456
|
+
"Instalation Date"
|
|
457
|
+
],
|
|
437
458
|
"dates": "",
|
|
438
459
|
"value": "2022-06-30T16:29:00.000Z"
|
|
439
460
|
}
|
|
@@ -474,7 +495,9 @@
|
|
|
474
495
|
"operationId": "$checkoutCart",
|
|
475
496
|
"summary": "checkoutCart",
|
|
476
497
|
"security": [],
|
|
477
|
-
"tags": [
|
|
498
|
+
"tags": [
|
|
499
|
+
"Cart API"
|
|
500
|
+
],
|
|
478
501
|
"parameters": [
|
|
479
502
|
{
|
|
480
503
|
"in": "header",
|
|
@@ -536,7 +559,9 @@
|
|
|
536
559
|
"operationId": "$searchCatalog",
|
|
537
560
|
"summary": "searchCatalog",
|
|
538
561
|
"security": [],
|
|
539
|
-
"tags": [
|
|
562
|
+
"tags": [
|
|
563
|
+
"Catalog API"
|
|
564
|
+
],
|
|
540
565
|
"parameters": [
|
|
541
566
|
{
|
|
542
567
|
"in": "header",
|
|
@@ -588,7 +613,9 @@
|
|
|
588
613
|
"operationId": "$availabilityCheck",
|
|
589
614
|
"summary": "availabilityCheck",
|
|
590
615
|
"security": [],
|
|
591
|
-
"tags": [
|
|
616
|
+
"tags": [
|
|
617
|
+
"Availability API"
|
|
618
|
+
],
|
|
592
619
|
"parameters": [
|
|
593
620
|
{
|
|
594
621
|
"in": "header",
|
|
@@ -610,7 +637,9 @@
|
|
|
610
637
|
"examples": {
|
|
611
638
|
"Check availability with location dimension": {
|
|
612
639
|
"value": {
|
|
613
|
-
"products": [
|
|
640
|
+
"products": [
|
|
641
|
+
"cd75456a-30e4-4912-95be-e743d5ea175b"
|
|
642
|
+
],
|
|
614
643
|
"filters": {
|
|
615
644
|
"location": {
|
|
616
645
|
"postal_code": "57008",
|
|
@@ -623,7 +652,9 @@
|
|
|
623
652
|
},
|
|
624
653
|
"Check availability with location & available date dimension": {
|
|
625
654
|
"value": {
|
|
626
|
-
"products": [
|
|
655
|
+
"products": [
|
|
656
|
+
"cd75456a-30e4-4912-95be-e743d5ea175b"
|
|
657
|
+
],
|
|
627
658
|
"filters": {
|
|
628
659
|
"location": {
|
|
629
660
|
"postal_code": "57008",
|
|
@@ -668,7 +699,9 @@
|
|
|
668
699
|
},
|
|
669
700
|
"Response with available and unavailable products": {
|
|
670
701
|
"value": {
|
|
671
|
-
"availableProducts": [
|
|
702
|
+
"availableProducts": [
|
|
703
|
+
"my-product-id-123-2"
|
|
704
|
+
],
|
|
672
705
|
"checkResults": [
|
|
673
706
|
{
|
|
674
707
|
"productId": "my-product-id-123-1",
|
|
@@ -705,7 +738,9 @@
|
|
|
705
738
|
"description": "Validates an availability file, it returns an array of errors if the file is invalid",
|
|
706
739
|
"operationId": "$validateAvailabilityFile",
|
|
707
740
|
"summary": "validateAvailabilityFile",
|
|
708
|
-
"tags": [
|
|
741
|
+
"tags": [
|
|
742
|
+
"Availability API"
|
|
743
|
+
],
|
|
709
744
|
"parameters": [
|
|
710
745
|
{
|
|
711
746
|
"in": "path",
|
|
@@ -776,7 +811,9 @@
|
|
|
776
811
|
"operationId": "$createOpportunity",
|
|
777
812
|
"summary": "createOpportunity",
|
|
778
813
|
"security": [],
|
|
779
|
-
"tags": [
|
|
814
|
+
"tags": [
|
|
815
|
+
"Deprecated"
|
|
816
|
+
],
|
|
780
817
|
"parameters": [
|
|
781
818
|
{
|
|
782
819
|
"in": "header",
|
|
@@ -818,11 +855,16 @@
|
|
|
818
855
|
"$relation": [
|
|
819
856
|
{
|
|
820
857
|
"entity_id": "c8dbe8f3-28b6-4d77-aae8-47bc24a2532f",
|
|
821
|
-
"_tags": [
|
|
858
|
+
"_tags": [
|
|
859
|
+
"journey"
|
|
860
|
+
]
|
|
822
861
|
}
|
|
823
862
|
]
|
|
824
863
|
},
|
|
825
|
-
"_tags": [
|
|
864
|
+
"_tags": [
|
|
865
|
+
"journey",
|
|
866
|
+
"ORWNr4iCN"
|
|
867
|
+
]
|
|
826
868
|
}
|
|
827
869
|
}
|
|
828
870
|
}
|
|
@@ -864,7 +906,9 @@
|
|
|
864
906
|
},
|
|
865
907
|
"schemas": {
|
|
866
908
|
"Error": {
|
|
867
|
-
"required": [
|
|
909
|
+
"required": [
|
|
910
|
+
"message"
|
|
911
|
+
],
|
|
868
912
|
"properties": {
|
|
869
913
|
"message": {
|
|
870
914
|
"type": "string",
|
|
@@ -900,7 +944,10 @@
|
|
|
900
944
|
"type": {
|
|
901
945
|
"type": "string",
|
|
902
946
|
"description": "The type of Product:\n\n| type | description |\n|----| ----|\n| `product` | Represents a physical good |\n| `service` | Represents a service or virtual product |\n",
|
|
903
|
-
"enum": [
|
|
947
|
+
"enum": [
|
|
948
|
+
"product",
|
|
949
|
+
"service"
|
|
950
|
+
]
|
|
904
951
|
},
|
|
905
952
|
"name": {
|
|
906
953
|
"type": "string",
|
|
@@ -1497,7 +1544,10 @@
|
|
|
1497
1544
|
"type": {
|
|
1498
1545
|
"type": "string",
|
|
1499
1546
|
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
1500
|
-
"enum": [
|
|
1547
|
+
"enum": [
|
|
1548
|
+
"one_time",
|
|
1549
|
+
"recurring"
|
|
1550
|
+
]
|
|
1501
1551
|
},
|
|
1502
1552
|
"billing_period": {
|
|
1503
1553
|
"description": "For recurring prices `billing_period` defines the default extent of the recurrence.",
|
|
@@ -1539,7 +1589,11 @@
|
|
|
1539
1589
|
"billing_duration_unit": {
|
|
1540
1590
|
"description": "The billing period duration unit",
|
|
1541
1591
|
"type": "string",
|
|
1542
|
-
"enum": [
|
|
1592
|
+
"enum": [
|
|
1593
|
+
"weeks",
|
|
1594
|
+
"months",
|
|
1595
|
+
"years"
|
|
1596
|
+
]
|
|
1543
1597
|
},
|
|
1544
1598
|
"notice_time_amount": {
|
|
1545
1599
|
"description": "The notice period duration",
|
|
@@ -1548,7 +1602,11 @@
|
|
|
1548
1602
|
"notice_time_unit": {
|
|
1549
1603
|
"description": "The notice period duration unit",
|
|
1550
1604
|
"type": "string",
|
|
1551
|
-
"enum": [
|
|
1605
|
+
"enum": [
|
|
1606
|
+
"weeks",
|
|
1607
|
+
"months",
|
|
1608
|
+
"years"
|
|
1609
|
+
]
|
|
1552
1610
|
},
|
|
1553
1611
|
"termination_time_amount": {
|
|
1554
1612
|
"description": "The termination period duration",
|
|
@@ -1557,7 +1615,11 @@
|
|
|
1557
1615
|
"termination_time_unit": {
|
|
1558
1616
|
"description": "The termination period duration unit",
|
|
1559
1617
|
"type": "string",
|
|
1560
|
-
"enum": [
|
|
1618
|
+
"enum": [
|
|
1619
|
+
"weeks",
|
|
1620
|
+
"months",
|
|
1621
|
+
"years"
|
|
1622
|
+
]
|
|
1561
1623
|
},
|
|
1562
1624
|
"renewal_duration_amount": {
|
|
1563
1625
|
"description": "The renewal period duration",
|
|
@@ -1566,7 +1628,11 @@
|
|
|
1566
1628
|
"renewal_duration_unit": {
|
|
1567
1629
|
"description": "The renewal period duration unit",
|
|
1568
1630
|
"type": "string",
|
|
1569
|
-
"enum": [
|
|
1631
|
+
"enum": [
|
|
1632
|
+
"weeks",
|
|
1633
|
+
"months",
|
|
1634
|
+
"years"
|
|
1635
|
+
]
|
|
1570
1636
|
},
|
|
1571
1637
|
"variable_price": {
|
|
1572
1638
|
"description": "The flag for prices that can be influenced by external variables such as user input.",
|
|
@@ -1628,7 +1694,9 @@
|
|
|
1628
1694
|
}
|
|
1629
1695
|
}
|
|
1630
1696
|
},
|
|
1631
|
-
"required": [
|
|
1697
|
+
"required": [
|
|
1698
|
+
"pricing_model"
|
|
1699
|
+
]
|
|
1632
1700
|
},
|
|
1633
1701
|
"CompositePrice": {
|
|
1634
1702
|
"type": "object",
|
|
@@ -1857,7 +1925,9 @@
|
|
|
1857
1925
|
}
|
|
1858
1926
|
}
|
|
1859
1927
|
},
|
|
1860
|
-
"required": [
|
|
1928
|
+
"required": [
|
|
1929
|
+
"q"
|
|
1930
|
+
]
|
|
1861
1931
|
},
|
|
1862
1932
|
"CatalogSearchResult": {
|
|
1863
1933
|
"description": "The query result payload",
|
|
@@ -1911,7 +1981,10 @@
|
|
|
1911
1981
|
"$ref": "#/components/schemas/AvailabilityFilters"
|
|
1912
1982
|
}
|
|
1913
1983
|
},
|
|
1914
|
-
"required": [
|
|
1984
|
+
"required": [
|
|
1985
|
+
"products",
|
|
1986
|
+
"filters"
|
|
1987
|
+
]
|
|
1915
1988
|
},
|
|
1916
1989
|
"AvailabilityResult": {
|
|
1917
1990
|
"description": "The availability check result payload",
|
|
@@ -1943,11 +2016,15 @@
|
|
|
1943
2016
|
"additionalProperties": true
|
|
1944
2017
|
}
|
|
1945
2018
|
},
|
|
1946
|
-
"required": [
|
|
2019
|
+
"required": [
|
|
2020
|
+
"product_id"
|
|
2021
|
+
]
|
|
1947
2022
|
}
|
|
1948
2023
|
}
|
|
1949
2024
|
},
|
|
1950
|
-
"required": [
|
|
2025
|
+
"required": [
|
|
2026
|
+
"available_products"
|
|
2027
|
+
],
|
|
1951
2028
|
"example": {
|
|
1952
2029
|
"available_products": [],
|
|
1953
2030
|
"check_results": [
|
|
@@ -1975,11 +2052,13 @@
|
|
|
1975
2052
|
"type": "string"
|
|
1976
2053
|
},
|
|
1977
2054
|
"data": {
|
|
1978
|
-
"description": "Data related
|
|
2055
|
+
"description": "Data related to the error",
|
|
1979
2056
|
"type": "string"
|
|
1980
2057
|
}
|
|
1981
2058
|
},
|
|
1982
|
-
"required": [
|
|
2059
|
+
"required": [
|
|
2060
|
+
"msg"
|
|
2061
|
+
]
|
|
1983
2062
|
},
|
|
1984
2063
|
"ValidateAvailabilityFileResult": {
|
|
1985
2064
|
"description": "The availability map file result payload",
|
|
@@ -1988,7 +2067,10 @@
|
|
|
1988
2067
|
"status": {
|
|
1989
2068
|
"description": "The status of the validation",
|
|
1990
2069
|
"type": "string",
|
|
1991
|
-
"enum": [
|
|
2070
|
+
"enum": [
|
|
2071
|
+
"success",
|
|
2072
|
+
"error"
|
|
2073
|
+
]
|
|
1992
2074
|
},
|
|
1993
2075
|
"rules_parsed_count": {
|
|
1994
2076
|
"description": "The number of rules successfully parsed",
|
|
@@ -2002,7 +2084,11 @@
|
|
|
2002
2084
|
}
|
|
2003
2085
|
}
|
|
2004
2086
|
},
|
|
2005
|
-
"required": [
|
|
2087
|
+
"required": [
|
|
2088
|
+
"status",
|
|
2089
|
+
"rules_parsed_count",
|
|
2090
|
+
"errors"
|
|
2091
|
+
],
|
|
2006
2092
|
"example": {
|
|
2007
2093
|
"rules_parsed_count": 8,
|
|
2008
2094
|
"errors": [
|
|
@@ -2078,7 +2164,9 @@
|
|
|
2078
2164
|
"additionalProperties": true
|
|
2079
2165
|
}
|
|
2080
2166
|
},
|
|
2081
|
-
"required": [
|
|
2167
|
+
"required": [
|
|
2168
|
+
"line_items"
|
|
2169
|
+
]
|
|
2082
2170
|
},
|
|
2083
2171
|
"CheckoutCart": {
|
|
2084
2172
|
"type": "object",
|
|
@@ -2112,12 +2200,28 @@
|
|
|
2112
2200
|
"CheckoutMode": {
|
|
2113
2201
|
"type": "string",
|
|
2114
2202
|
"description": "The checkout mode for the cart checkout.",
|
|
2115
|
-
"enum": [
|
|
2203
|
+
"enum": [
|
|
2204
|
+
"create_order",
|
|
2205
|
+
"create_invoice",
|
|
2206
|
+
"create_quote"
|
|
2207
|
+
]
|
|
2116
2208
|
},
|
|
2117
2209
|
"OrderStatus": {
|
|
2118
2210
|
"type": "string",
|
|
2119
|
-
"enum": [
|
|
2120
|
-
|
|
2211
|
+
"enum": [
|
|
2212
|
+
"draft",
|
|
2213
|
+
"new",
|
|
2214
|
+
"open_for_acceptance",
|
|
2215
|
+
"in_progress",
|
|
2216
|
+
"quote",
|
|
2217
|
+
"offer",
|
|
2218
|
+
"placed",
|
|
2219
|
+
"order_accepted",
|
|
2220
|
+
"cancelled",
|
|
2221
|
+
"lost",
|
|
2222
|
+
"complete"
|
|
2223
|
+
],
|
|
2224
|
+
"description": "\n| status | description |\n|-------------|----------|\n| `new` | Starting state for all orders, at this point we can still edit the order |\n| `draft` | old value of 'new' |\n| `in_progress` | The order is open to accept by user |\n| `open_for_acceptance` | old value of 'in_progress' |\n| `offer` | The order is in a quoting phase, bound to an expiration date |\n| `quote` | old value of offer |\n| `order_accepted` | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |\n| `placed` | old value of order_accepted |\n| `lost ` | The order has been cancelled |\n| `cancelled` | old value of lost |\n| `complete` | The order is now closed and finalized |\n"
|
|
2121
2225
|
},
|
|
2122
2226
|
"PriceItemsDto": {
|
|
2123
2227
|
"description": "A valid set of product prices, quantities, (discounts) and taxes from a client.",
|
|
@@ -2210,7 +2314,10 @@
|
|
|
2210
2314
|
"type": {
|
|
2211
2315
|
"type": "string",
|
|
2212
2316
|
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
2213
|
-
"enum": [
|
|
2317
|
+
"enum": [
|
|
2318
|
+
"one_time",
|
|
2319
|
+
"recurring"
|
|
2320
|
+
]
|
|
2214
2321
|
},
|
|
2215
2322
|
"unit_amount": {
|
|
2216
2323
|
"type": "integer",
|
|
@@ -2246,7 +2353,9 @@
|
|
|
2246
2353
|
]
|
|
2247
2354
|
}
|
|
2248
2355
|
},
|
|
2249
|
-
"required": [
|
|
2356
|
+
"required": [
|
|
2357
|
+
"pricing_model"
|
|
2358
|
+
]
|
|
2250
2359
|
},
|
|
2251
2360
|
"CompositePriceItemDto": {
|
|
2252
2361
|
"allOf": [
|
|
@@ -2344,7 +2453,10 @@
|
|
|
2344
2453
|
"description": "Total of all items taxes, with same recurrence."
|
|
2345
2454
|
}
|
|
2346
2455
|
},
|
|
2347
|
-
"required": [
|
|
2456
|
+
"required": [
|
|
2457
|
+
"amount_subtotal",
|
|
2458
|
+
"amount_total"
|
|
2459
|
+
]
|
|
2348
2460
|
},
|
|
2349
2461
|
"Cart": {
|
|
2350
2462
|
"description": "Supports shopping for products and services until ready for checkout.",
|
|
@@ -2359,7 +2471,11 @@
|
|
|
2359
2471
|
"readOnly": true
|
|
2360
2472
|
},
|
|
2361
2473
|
"status": {
|
|
2362
|
-
"enum": [
|
|
2474
|
+
"enum": [
|
|
2475
|
+
"open",
|
|
2476
|
+
"complete",
|
|
2477
|
+
"expired"
|
|
2478
|
+
],
|
|
2363
2479
|
"type": "string",
|
|
2364
2480
|
"readOnly": true,
|
|
2365
2481
|
"description": "The status of the Cart:\n- open - the cart checkout is still in progress. Payment processing has not started\n- complete - the cart checkout is complete. Payment processing may still be in progress\n- expired - the cart checkout has expired. No further processing will occur\n"
|
|
@@ -2659,7 +2775,10 @@
|
|
|
2659
2775
|
"type": {
|
|
2660
2776
|
"type": "string",
|
|
2661
2777
|
"description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
|
|
2662
|
-
"enum": [
|
|
2778
|
+
"enum": [
|
|
2779
|
+
"one_time",
|
|
2780
|
+
"recurring"
|
|
2781
|
+
]
|
|
2663
2782
|
},
|
|
2664
2783
|
"pricing_model": {
|
|
2665
2784
|
"type": "string",
|
|
@@ -2672,7 +2791,9 @@
|
|
|
2672
2791
|
]
|
|
2673
2792
|
}
|
|
2674
2793
|
},
|
|
2675
|
-
"required": [
|
|
2794
|
+
"required": [
|
|
2795
|
+
"pricing_model"
|
|
2796
|
+
]
|
|
2676
2797
|
},
|
|
2677
2798
|
"TaxAmount": {
|
|
2678
2799
|
"type": "object",
|
|
@@ -2758,7 +2879,10 @@
|
|
|
2758
2879
|
"description": "Total of all items taxes, with same recurrence."
|
|
2759
2880
|
}
|
|
2760
2881
|
},
|
|
2761
|
-
"required": [
|
|
2882
|
+
"required": [
|
|
2883
|
+
"amount_subtotal",
|
|
2884
|
+
"amount_total"
|
|
2885
|
+
]
|
|
2762
2886
|
},
|
|
2763
2887
|
"TotalDetails": {
|
|
2764
2888
|
"type": "object",
|
|
@@ -2850,7 +2974,11 @@
|
|
|
2850
2974
|
},
|
|
2851
2975
|
"SalesTax": {
|
|
2852
2976
|
"type": "string",
|
|
2853
|
-
"enum": [
|
|
2977
|
+
"enum": [
|
|
2978
|
+
"nontaxable",
|
|
2979
|
+
"reduced",
|
|
2980
|
+
"standard"
|
|
2981
|
+
]
|
|
2854
2982
|
},
|
|
2855
2983
|
"AvailabilityLocation": {
|
|
2856
2984
|
"type": "object",
|
|
@@ -2908,7 +3036,9 @@
|
|
|
2908
3036
|
"description": "A value to be matched against the availability window (start & end date)"
|
|
2909
3037
|
}
|
|
2910
3038
|
},
|
|
2911
|
-
"required": [
|
|
3039
|
+
"required": [
|
|
3040
|
+
"location"
|
|
3041
|
+
]
|
|
2912
3042
|
},
|
|
2913
3043
|
"Address": {
|
|
2914
3044
|
"type": "object",
|
|
@@ -2919,7 +3049,9 @@
|
|
|
2919
3049
|
"items": {
|
|
2920
3050
|
"type": "string"
|
|
2921
3051
|
},
|
|
2922
|
-
"example": [
|
|
3052
|
+
"example": [
|
|
3053
|
+
"billing"
|
|
3054
|
+
]
|
|
2923
3055
|
},
|
|
2924
3056
|
"street": {
|
|
2925
3057
|
"type": "string",
|
|
@@ -3046,10 +3178,15 @@
|
|
|
3046
3178
|
"type": "string"
|
|
3047
3179
|
}
|
|
3048
3180
|
},
|
|
3049
|
-
"required": [
|
|
3181
|
+
"required": [
|
|
3182
|
+
"bucket",
|
|
3183
|
+
"key"
|
|
3184
|
+
]
|
|
3050
3185
|
}
|
|
3051
3186
|
},
|
|
3052
|
-
"required": [
|
|
3187
|
+
"required": [
|
|
3188
|
+
"s3ref"
|
|
3189
|
+
]
|
|
3053
3190
|
}
|
|
3054
3191
|
},
|
|
3055
3192
|
"_schema": {
|
|
@@ -3132,7 +3269,10 @@
|
|
|
3132
3269
|
"_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
3133
3270
|
"_org": "123",
|
|
3134
3271
|
"_schema": "contact",
|
|
3135
|
-
"_tags": [
|
|
3272
|
+
"_tags": [
|
|
3273
|
+
"example",
|
|
3274
|
+
"mock"
|
|
3275
|
+
],
|
|
3136
3276
|
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
3137
3277
|
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
3138
3278
|
}
|
|
@@ -3197,7 +3337,11 @@
|
|
|
3197
3337
|
},
|
|
3198
3338
|
"type": {
|
|
3199
3339
|
"type": "string",
|
|
3200
|
-
"enum": [
|
|
3340
|
+
"enum": [
|
|
3341
|
+
"VAT",
|
|
3342
|
+
"GST",
|
|
3343
|
+
"Custom"
|
|
3344
|
+
]
|
|
3201
3345
|
},
|
|
3202
3346
|
"description": {
|
|
3203
3347
|
"type": "string"
|
|
@@ -3224,7 +3368,10 @@
|
|
|
3224
3368
|
"region_label": "Germany",
|
|
3225
3369
|
"_org": "123",
|
|
3226
3370
|
"_schema": "tax",
|
|
3227
|
-
"_tags": [
|
|
3371
|
+
"_tags": [
|
|
3372
|
+
"example",
|
|
3373
|
+
"mock"
|
|
3374
|
+
],
|
|
3228
3375
|
"_created_at": "2021-02-09T12:41:43.662Z",
|
|
3229
3376
|
"_updated_at": "2021-02-09T12:41:43.662Z"
|
|
3230
3377
|
}
|
|
@@ -3237,7 +3384,11 @@
|
|
|
3237
3384
|
},
|
|
3238
3385
|
"type": {
|
|
3239
3386
|
"type": "string",
|
|
3240
|
-
"enum": [
|
|
3387
|
+
"enum": [
|
|
3388
|
+
"VAT",
|
|
3389
|
+
"GST",
|
|
3390
|
+
"Custom"
|
|
3391
|
+
]
|
|
3241
3392
|
},
|
|
3242
3393
|
"_id": {
|
|
3243
3394
|
"type": "string"
|
|
@@ -3270,7 +3421,10 @@
|
|
|
3270
3421
|
},
|
|
3271
3422
|
"PriceTierDisplayMode": {
|
|
3272
3423
|
"type": "string",
|
|
3273
|
-
"enum": [
|
|
3424
|
+
"enum": [
|
|
3425
|
+
"hidden",
|
|
3426
|
+
"on_request"
|
|
3427
|
+
]
|
|
3274
3428
|
}
|
|
3275
3429
|
},
|
|
3276
3430
|
"examples": {
|
|
@@ -3747,8 +3901,14 @@
|
|
|
3747
3901
|
"_id": "065d6618-cc59-45f4-8e3a-700edf6813c3",
|
|
3748
3902
|
"name": "Smartmeter: Schneider Electric PM5000 LCD Energiemessgerät / 3-phasig",
|
|
3749
3903
|
"code": "1312378123",
|
|
3750
|
-
"_tags": [
|
|
3751
|
-
|
|
3904
|
+
"_tags": [
|
|
3905
|
+
"wallbox",
|
|
3906
|
+
"review demo",
|
|
3907
|
+
"1"
|
|
3908
|
+
],
|
|
3909
|
+
"categories": [
|
|
3910
|
+
"Power"
|
|
3911
|
+
],
|
|
3752
3912
|
"type": "product",
|
|
3753
3913
|
"active": true,
|
|
3754
3914
|
"feature": [
|
|
@@ -3954,7 +4114,9 @@
|
|
|
3954
4114
|
"delivery_address": [],
|
|
3955
4115
|
"dates": [
|
|
3956
4116
|
{
|
|
3957
|
-
"_tags": [
|
|
4117
|
+
"_tags": [
|
|
4118
|
+
"Instalation Date"
|
|
4119
|
+
],
|
|
3958
4120
|
"dates": "",
|
|
3959
4121
|
"value": "2022-06-30T16:29:00.000Z"
|
|
3960
4122
|
}
|
|
@@ -4032,7 +4194,9 @@
|
|
|
4032
4194
|
"delivery_address": [],
|
|
4033
4195
|
"dates": [
|
|
4034
4196
|
{
|
|
4035
|
-
"_tags": [
|
|
4197
|
+
"_tags": [
|
|
4198
|
+
"Instalation Date"
|
|
4199
|
+
],
|
|
4036
4200
|
"dates": "",
|
|
4037
4201
|
"value": "2022-06-30T16:29:00.000Z"
|
|
4038
4202
|
}
|
|
@@ -4051,7 +4215,10 @@
|
|
|
4051
4215
|
"value": "journey checkout"
|
|
4052
4216
|
}
|
|
4053
4217
|
],
|
|
4054
|
-
"_tags": [
|
|
4218
|
+
"_tags": [
|
|
4219
|
+
"journey",
|
|
4220
|
+
"automation"
|
|
4221
|
+
],
|
|
4055
4222
|
"status": "quote",
|
|
4056
4223
|
"order_number": "OREabZxnO",
|
|
4057
4224
|
"billing_first_name": "Paulo",
|
|
@@ -4458,7 +4625,9 @@
|
|
|
4458
4625
|
},
|
|
4459
4626
|
"dates": [
|
|
4460
4627
|
{
|
|
4461
|
-
"_tags": [
|
|
4628
|
+
"_tags": [
|
|
4629
|
+
"Installation Date"
|
|
4630
|
+
],
|
|
4462
4631
|
"dates": "",
|
|
4463
4632
|
"value": "2022-06-30T15:21:00.000Z"
|
|
4464
4633
|
}
|