@redotech/redo-api-schema 2.2.238 → 2.2.315
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 +167 -54
- package/lib/openapi.yaml +162 -38
- package/package.json +1 -1
package/lib/openapi.d.ts
CHANGED
|
@@ -12,21 +12,21 @@ type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A
|
|
|
12
12
|
export interface paths {
|
|
13
13
|
"/invoices/{invoiceId}/items.csv": {
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Invoice (CSV)
|
|
16
16
|
* @description Get an invoice as a CSV.
|
|
17
17
|
*/
|
|
18
18
|
get: operations["Invoice csv get"];
|
|
19
19
|
};
|
|
20
20
|
"/invoices/pending/items.csv": {
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* Pending Invoice (CSV)
|
|
23
23
|
* @description Get an invoice as a CSV.
|
|
24
24
|
*/
|
|
25
25
|
get: operations["Invoice pending csv get"];
|
|
26
26
|
};
|
|
27
27
|
"/returns/{returnId}": {
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Return
|
|
30
30
|
* @description Get return.
|
|
31
31
|
*/
|
|
32
32
|
get: operations["Return get"];
|
|
@@ -38,12 +38,12 @@ export interface paths {
|
|
|
38
38
|
};
|
|
39
39
|
"/returns/{returnId}/comments": {
|
|
40
40
|
/**
|
|
41
|
-
* List
|
|
41
|
+
* List Return Comments
|
|
42
42
|
* @description List return comments.
|
|
43
43
|
*/
|
|
44
44
|
get: operations["Return comments get"];
|
|
45
45
|
/**
|
|
46
|
-
* Create
|
|
46
|
+
* Create Return Comment
|
|
47
47
|
* @description Create return comment.
|
|
48
48
|
*/
|
|
49
49
|
post: operations["Return comment create"];
|
|
@@ -55,7 +55,7 @@ export interface paths {
|
|
|
55
55
|
};
|
|
56
56
|
"/returns/{returnId}/process": {
|
|
57
57
|
/**
|
|
58
|
-
* Process
|
|
58
|
+
* Process Return
|
|
59
59
|
* @description **BETA**: This endpoint is in beta and subject to change.
|
|
60
60
|
*
|
|
61
61
|
* Trigger processing of a return with specified products.
|
|
@@ -69,68 +69,86 @@ export interface paths {
|
|
|
69
69
|
};
|
|
70
70
|
"/returns/{returnId}/status": {
|
|
71
71
|
/**
|
|
72
|
-
*
|
|
72
|
+
* Return Status
|
|
73
73
|
* @description Get return status.
|
|
74
74
|
*/
|
|
75
75
|
get: operations["Return status get"];
|
|
76
76
|
/**
|
|
77
|
-
* Update
|
|
77
|
+
* Update Return Status
|
|
78
78
|
* @description Update return status.
|
|
79
79
|
*/
|
|
80
80
|
put: operations["Return status update"];
|
|
81
81
|
};
|
|
82
82
|
"/stores/{storeId}/admin": {
|
|
83
83
|
/**
|
|
84
|
-
* Navigate to
|
|
84
|
+
* Navigate to Merchant Admin
|
|
85
85
|
* @description Navigate to the merchant admin page.
|
|
86
86
|
*/
|
|
87
87
|
get: operations["Merchant admin navigate"];
|
|
88
88
|
};
|
|
89
89
|
"/stores/{storeId}/checkout-buttons-ui": {
|
|
90
90
|
/**
|
|
91
|
-
*
|
|
92
|
-
* @description Generate HTML and CSS for checkout buttons
|
|
91
|
+
* Checkout Buttons UI
|
|
92
|
+
* @description Generate rendered HTML and CSS for checkout buttons.
|
|
93
93
|
*/
|
|
94
94
|
get: operations["Checkout buttons UI"];
|
|
95
95
|
};
|
|
96
96
|
"/stores/{storeId}/coverage-info": {
|
|
97
97
|
/**
|
|
98
|
-
* Navigate to
|
|
98
|
+
* Navigate to Coverage Info
|
|
99
99
|
* @description Navigate to the coverage info page.
|
|
100
100
|
*/
|
|
101
101
|
get: operations["Coverage info navigate"];
|
|
102
102
|
};
|
|
103
103
|
"/stores/{storeId}/coverage-products": {
|
|
104
104
|
/**
|
|
105
|
-
*
|
|
105
|
+
* Coverage Products
|
|
106
106
|
* @description Get available coverage products.
|
|
107
107
|
*/
|
|
108
108
|
post: operations["Coverage products"];
|
|
109
109
|
};
|
|
110
110
|
"/stores/{storeId}/customer-portal": {
|
|
111
111
|
/**
|
|
112
|
-
* Navigate to
|
|
112
|
+
* Navigate to Customer Portal
|
|
113
113
|
* @description Navigate to the customer portal.
|
|
114
114
|
*/
|
|
115
115
|
get: operations["Customer portal navigate"];
|
|
116
116
|
};
|
|
117
117
|
"/stores/{storeId}/customer-subscriptions": {
|
|
118
118
|
/**
|
|
119
|
-
* Update
|
|
119
|
+
* Update Customer Subscriptions
|
|
120
120
|
* @description Update customer subscription status for SMS and email marketing and transactional messages. If the customer with that phone number or email does not exist, it will be created.
|
|
121
121
|
*/
|
|
122
122
|
post: operations["Customer subscriptions update"];
|
|
123
123
|
};
|
|
124
|
+
"/stores/{storeId}/events": {
|
|
125
|
+
/**
|
|
126
|
+
* Create custom event
|
|
127
|
+
* @description Create a custom event to trigger flows with merchant-defined event names and properties.
|
|
128
|
+
*
|
|
129
|
+
* Custom events allow merchants to trigger flows based on events from their own systems.
|
|
130
|
+
* Events can include custom properties that are accessible in email and SMS templates.
|
|
131
|
+
*
|
|
132
|
+
* ## Customer Matching
|
|
133
|
+
* The API matches customers by email or phone number. At least one must be provided.
|
|
134
|
+
*
|
|
135
|
+
* If no matching customer is found, the request will fail with a 404 error.
|
|
136
|
+
*
|
|
137
|
+
* ## Rate Limiting
|
|
138
|
+
* This endpoint is rate-limited to 100 requests per second per store.
|
|
139
|
+
*/
|
|
140
|
+
post: operations["Custom event create"];
|
|
141
|
+
};
|
|
124
142
|
"/stores/{storeId}/invoices": {
|
|
125
143
|
/**
|
|
126
|
-
*
|
|
144
|
+
* List Invoices
|
|
127
145
|
* @description Get a list of invoices.
|
|
128
146
|
*/
|
|
129
147
|
get: operations["Invoice list"];
|
|
130
148
|
};
|
|
131
149
|
"/stores/{storeId}/returns": {
|
|
132
150
|
/**
|
|
133
|
-
* List
|
|
151
|
+
* List Returns
|
|
134
152
|
* @description List returns, sorted by most recent to least recent.
|
|
135
153
|
*/
|
|
136
154
|
get: operations["Returns list"];
|
|
@@ -142,7 +160,7 @@ export interface paths {
|
|
|
142
160
|
};
|
|
143
161
|
"/stores/{storeId}/shipments/{shipmentId}/documents/{documentType}": {
|
|
144
162
|
/**
|
|
145
|
-
* Download
|
|
163
|
+
* Download Shipment Document
|
|
146
164
|
* @description Get a shipment document (label, commercial invoice, etc).
|
|
147
165
|
*/
|
|
148
166
|
get: operations["Shipment document download"];
|
|
@@ -154,7 +172,7 @@ export interface paths {
|
|
|
154
172
|
};
|
|
155
173
|
"/stores/{storeId}/shipments/buy": {
|
|
156
174
|
/**
|
|
157
|
-
* Purchase
|
|
175
|
+
* Purchase Shipping Label
|
|
158
176
|
* @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
|
|
159
177
|
*/
|
|
160
178
|
post: operations["Shipment buy"];
|
|
@@ -166,7 +184,7 @@ export interface paths {
|
|
|
166
184
|
};
|
|
167
185
|
"/stores/{storeId}/shipments/rates": {
|
|
168
186
|
/**
|
|
169
|
-
*
|
|
187
|
+
* Shipping Rates
|
|
170
188
|
* @description Get available shipping rates based on origin, destination, and parcel information.
|
|
171
189
|
*/
|
|
172
190
|
post: operations["Shipment rates"];
|
|
@@ -178,19 +196,19 @@ export interface paths {
|
|
|
178
196
|
};
|
|
179
197
|
"/stores/{storeId}/storefront/events": {
|
|
180
198
|
/**
|
|
181
|
-
* Receive
|
|
199
|
+
* Receive Storefront Events
|
|
182
200
|
* @description Processes events from storefronts using Shopify pixel event schema
|
|
183
201
|
*/
|
|
184
202
|
post: operations["Storefront Event"];
|
|
185
203
|
};
|
|
186
204
|
"/stores/{storeId}/webhooks": {
|
|
187
205
|
/**
|
|
188
|
-
* List
|
|
206
|
+
* List Webhooks
|
|
189
207
|
* @description List webhooks for store.
|
|
190
208
|
*/
|
|
191
209
|
get: operations["Webhooks list"];
|
|
192
210
|
/**
|
|
193
|
-
* Create or
|
|
211
|
+
* Create or Update Webhook
|
|
194
212
|
* @description Create webhook for store. Or if webhook already exists with `externalId`, update it.
|
|
195
213
|
*/
|
|
196
214
|
post: operations["Webhook create"];
|
|
@@ -202,24 +220,24 @@ export interface paths {
|
|
|
202
220
|
};
|
|
203
221
|
"/webhooks/{webhookId}": {
|
|
204
222
|
/**
|
|
205
|
-
*
|
|
223
|
+
* Webhook
|
|
206
224
|
* @description Get a webhook.
|
|
207
225
|
*/
|
|
208
226
|
get: operations["Webhook get"];
|
|
209
227
|
/**
|
|
210
|
-
* Update
|
|
228
|
+
* Update Webhook
|
|
211
229
|
* @description Update a webhook.
|
|
212
230
|
*/
|
|
213
231
|
put: operations["Webhook update"];
|
|
214
232
|
/**
|
|
215
|
-
* Delete
|
|
233
|
+
* Delete Webhook
|
|
216
234
|
* @description Delete a webhook.
|
|
217
235
|
*/
|
|
218
236
|
delete: operations["Webhook delete"];
|
|
219
237
|
};
|
|
220
238
|
"/webhooks/{webhookId}/replay": {
|
|
221
239
|
/**
|
|
222
|
-
* Replay
|
|
240
|
+
* Replay Webhook
|
|
223
241
|
* @description Replay a webhook.
|
|
224
242
|
*/
|
|
225
243
|
post: operations["Webhook replay"];
|
|
@@ -325,6 +343,42 @@ export interface components {
|
|
|
325
343
|
*/
|
|
326
344
|
price: components["schemas"]["money.schema"];
|
|
327
345
|
};
|
|
346
|
+
/**
|
|
347
|
+
* Custom Event Request
|
|
348
|
+
* @description Custom event to trigger flows with merchant-defined event names and properties.
|
|
349
|
+
*/
|
|
350
|
+
"custom-event-request.schema": {
|
|
351
|
+
/** @description Customer email address (one of email or phone is required). */
|
|
352
|
+
email?: string;
|
|
353
|
+
/** @description The name of the custom event (e.g., 'user_registered', 'purchase_completed'). */
|
|
354
|
+
event_name: string;
|
|
355
|
+
/**
|
|
356
|
+
* Format: date-time
|
|
357
|
+
* @description ISO 8601 timestamp when the event occurred. Defaults to current time if not provided.
|
|
358
|
+
*/
|
|
359
|
+
event_timestamp?: string;
|
|
360
|
+
/** @description Customer phone number (one of email or phone is required). */
|
|
361
|
+
phone?: string;
|
|
362
|
+
/** @description Custom properties for this event. Access in templates using dot notation (e.g., {{ properties.product_name }}). */
|
|
363
|
+
properties?: {
|
|
364
|
+
[key: string]: unknown;
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
/**
|
|
368
|
+
* Custom Event Response
|
|
369
|
+
* @description Response after successfully creating a custom event.
|
|
370
|
+
*/
|
|
371
|
+
"custom-event-response.schema": {
|
|
372
|
+
/** @description The unique identifier for the created event. */
|
|
373
|
+
event_id: string;
|
|
374
|
+
/** @description The name of the custom event that was created. */
|
|
375
|
+
event_name: string;
|
|
376
|
+
/**
|
|
377
|
+
* @description Status of the event processing.
|
|
378
|
+
* @enum {string}
|
|
379
|
+
*/
|
|
380
|
+
status: "processed";
|
|
381
|
+
};
|
|
328
382
|
/** @description Email subscription updates */
|
|
329
383
|
"customer-subscription-email.schema": {
|
|
330
384
|
/**
|
|
@@ -1395,7 +1449,7 @@ export type external = Record<string, never>;
|
|
|
1395
1449
|
export interface operations {
|
|
1396
1450
|
|
|
1397
1451
|
/**
|
|
1398
|
-
*
|
|
1452
|
+
* Invoice (CSV)
|
|
1399
1453
|
* @description Get an invoice as a CSV.
|
|
1400
1454
|
*/
|
|
1401
1455
|
"Invoice csv get": {
|
|
@@ -1420,7 +1474,7 @@ export interface operations {
|
|
|
1420
1474
|
};
|
|
1421
1475
|
};
|
|
1422
1476
|
/**
|
|
1423
|
-
*
|
|
1477
|
+
* Pending Invoice (CSV)
|
|
1424
1478
|
* @description Get an invoice as a CSV.
|
|
1425
1479
|
*/
|
|
1426
1480
|
"Invoice pending csv get": {
|
|
@@ -1440,7 +1494,7 @@ export interface operations {
|
|
|
1440
1494
|
};
|
|
1441
1495
|
};
|
|
1442
1496
|
/**
|
|
1443
|
-
*
|
|
1497
|
+
* Return
|
|
1444
1498
|
* @description Get return.
|
|
1445
1499
|
*/
|
|
1446
1500
|
"Return get": {
|
|
@@ -1468,7 +1522,7 @@ export interface operations {
|
|
|
1468
1522
|
};
|
|
1469
1523
|
};
|
|
1470
1524
|
/**
|
|
1471
|
-
* List
|
|
1525
|
+
* List Return Comments
|
|
1472
1526
|
* @description List return comments.
|
|
1473
1527
|
*/
|
|
1474
1528
|
"Return comments get": {
|
|
@@ -1493,7 +1547,7 @@ export interface operations {
|
|
|
1493
1547
|
};
|
|
1494
1548
|
};
|
|
1495
1549
|
/**
|
|
1496
|
-
* Create
|
|
1550
|
+
* Create Return Comment
|
|
1497
1551
|
* @description Create return comment.
|
|
1498
1552
|
*/
|
|
1499
1553
|
"Return comment create": {
|
|
@@ -1527,7 +1581,7 @@ export interface operations {
|
|
|
1527
1581
|
};
|
|
1528
1582
|
};
|
|
1529
1583
|
/**
|
|
1530
|
-
* Process
|
|
1584
|
+
* Process Return
|
|
1531
1585
|
* @description **BETA**: This endpoint is in beta and subject to change.
|
|
1532
1586
|
*
|
|
1533
1587
|
* Trigger processing of a return with specified products.
|
|
@@ -1591,7 +1645,7 @@ export interface operations {
|
|
|
1591
1645
|
};
|
|
1592
1646
|
};
|
|
1593
1647
|
/**
|
|
1594
|
-
*
|
|
1648
|
+
* Return Status
|
|
1595
1649
|
* @description Get return status.
|
|
1596
1650
|
*/
|
|
1597
1651
|
"Return status get": {
|
|
@@ -1618,7 +1672,7 @@ export interface operations {
|
|
|
1618
1672
|
};
|
|
1619
1673
|
};
|
|
1620
1674
|
/**
|
|
1621
|
-
* Update
|
|
1675
|
+
* Update Return Status
|
|
1622
1676
|
* @description Update return status.
|
|
1623
1677
|
*/
|
|
1624
1678
|
"Return status update": {
|
|
@@ -1648,7 +1702,7 @@ export interface operations {
|
|
|
1648
1702
|
};
|
|
1649
1703
|
};
|
|
1650
1704
|
/**
|
|
1651
|
-
* Navigate to
|
|
1705
|
+
* Navigate to Merchant Admin
|
|
1652
1706
|
* @description Navigate to the merchant admin page.
|
|
1653
1707
|
*/
|
|
1654
1708
|
"Merchant admin navigate": {
|
|
@@ -1665,8 +1719,8 @@ export interface operations {
|
|
|
1665
1719
|
};
|
|
1666
1720
|
};
|
|
1667
1721
|
/**
|
|
1668
|
-
*
|
|
1669
|
-
* @description Generate HTML and CSS for checkout buttons
|
|
1722
|
+
* Checkout Buttons UI
|
|
1723
|
+
* @description Generate rendered HTML and CSS for checkout buttons.
|
|
1670
1724
|
*/
|
|
1671
1725
|
"Checkout buttons UI": {
|
|
1672
1726
|
parameters: {
|
|
@@ -1695,7 +1749,7 @@ export interface operations {
|
|
|
1695
1749
|
};
|
|
1696
1750
|
};
|
|
1697
1751
|
/**
|
|
1698
|
-
* Navigate to
|
|
1752
|
+
* Navigate to Coverage Info
|
|
1699
1753
|
* @description Navigate to the coverage info page.
|
|
1700
1754
|
*/
|
|
1701
1755
|
"Coverage info navigate": {
|
|
@@ -1712,7 +1766,7 @@ export interface operations {
|
|
|
1712
1766
|
};
|
|
1713
1767
|
};
|
|
1714
1768
|
/**
|
|
1715
|
-
*
|
|
1769
|
+
* Coverage Products
|
|
1716
1770
|
* @description Get available coverage products.
|
|
1717
1771
|
*/
|
|
1718
1772
|
"Coverage products": {
|
|
@@ -1795,7 +1849,7 @@ export interface operations {
|
|
|
1795
1849
|
};
|
|
1796
1850
|
};
|
|
1797
1851
|
/**
|
|
1798
|
-
* Navigate to
|
|
1852
|
+
* Navigate to Customer Portal
|
|
1799
1853
|
* @description Navigate to the customer portal.
|
|
1800
1854
|
*/
|
|
1801
1855
|
"Customer portal navigate": {
|
|
@@ -1818,7 +1872,7 @@ export interface operations {
|
|
|
1818
1872
|
};
|
|
1819
1873
|
};
|
|
1820
1874
|
/**
|
|
1821
|
-
* Update
|
|
1875
|
+
* Update Customer Subscriptions
|
|
1822
1876
|
* @description Update customer subscription status for SMS and email marketing and transactional messages. If the customer with that phone number or email does not exist, it will be created.
|
|
1823
1877
|
*/
|
|
1824
1878
|
"Customer subscriptions update": {
|
|
@@ -1863,7 +1917,66 @@ export interface operations {
|
|
|
1863
1917
|
};
|
|
1864
1918
|
};
|
|
1865
1919
|
/**
|
|
1866
|
-
*
|
|
1920
|
+
* Create custom event
|
|
1921
|
+
* @description Create a custom event to trigger flows with merchant-defined event names and properties.
|
|
1922
|
+
*
|
|
1923
|
+
* Custom events allow merchants to trigger flows based on events from their own systems.
|
|
1924
|
+
* Events can include custom properties that are accessible in email and SMS templates.
|
|
1925
|
+
*
|
|
1926
|
+
* ## Customer Matching
|
|
1927
|
+
* The API matches customers by email or phone number. At least one must be provided.
|
|
1928
|
+
*
|
|
1929
|
+
* If no matching customer is found, the request will fail with a 404 error.
|
|
1930
|
+
*
|
|
1931
|
+
* ## Rate Limiting
|
|
1932
|
+
* This endpoint is rate-limited to 100 requests per second per store.
|
|
1933
|
+
*/
|
|
1934
|
+
"Custom event create": {
|
|
1935
|
+
parameters: {
|
|
1936
|
+
path: {
|
|
1937
|
+
storeId: components["parameters"]["store-id.param"];
|
|
1938
|
+
};
|
|
1939
|
+
};
|
|
1940
|
+
requestBody: {
|
|
1941
|
+
content: {
|
|
1942
|
+
"application/json": components["schemas"]["custom-event-request.schema"];
|
|
1943
|
+
};
|
|
1944
|
+
};
|
|
1945
|
+
responses: {
|
|
1946
|
+
/** @description Event created successfully */
|
|
1947
|
+
200: {
|
|
1948
|
+
content: {
|
|
1949
|
+
"application/json": components["schemas"]["custom-event-response.schema"];
|
|
1950
|
+
};
|
|
1951
|
+
};
|
|
1952
|
+
/** @description Invalid request body or missing required customer identifier */
|
|
1953
|
+
400: {
|
|
1954
|
+
content: {
|
|
1955
|
+
"application/json": components["schemas"]["error.schema"];
|
|
1956
|
+
};
|
|
1957
|
+
};
|
|
1958
|
+
/** @description Customer not found with provided identifier */
|
|
1959
|
+
404: {
|
|
1960
|
+
content: {
|
|
1961
|
+
"application/json": components["schemas"]["error.schema"];
|
|
1962
|
+
};
|
|
1963
|
+
};
|
|
1964
|
+
/** @description Rate limit exceeded */
|
|
1965
|
+
429: {
|
|
1966
|
+
content: {
|
|
1967
|
+
"application/json": components["schemas"]["error.schema"];
|
|
1968
|
+
};
|
|
1969
|
+
};
|
|
1970
|
+
/** @description Error */
|
|
1971
|
+
default: {
|
|
1972
|
+
content: {
|
|
1973
|
+
"application/problem+json": components["schemas"]["error.schema"];
|
|
1974
|
+
};
|
|
1975
|
+
};
|
|
1976
|
+
};
|
|
1977
|
+
};
|
|
1978
|
+
/**
|
|
1979
|
+
* List Invoices
|
|
1867
1980
|
* @description Get a list of invoices.
|
|
1868
1981
|
*/
|
|
1869
1982
|
"Invoice list": {
|
|
@@ -1890,7 +2003,7 @@ export interface operations {
|
|
|
1890
2003
|
};
|
|
1891
2004
|
};
|
|
1892
2005
|
/**
|
|
1893
|
-
* List
|
|
2006
|
+
* List Returns
|
|
1894
2007
|
* @description List returns, sorted by most recent to least recent.
|
|
1895
2008
|
*/
|
|
1896
2009
|
"Returns list": {
|
|
@@ -1931,7 +2044,7 @@ export interface operations {
|
|
|
1931
2044
|
};
|
|
1932
2045
|
};
|
|
1933
2046
|
/**
|
|
1934
|
-
* Download
|
|
2047
|
+
* Download Shipment Document
|
|
1935
2048
|
* @description Get a shipment document (label, commercial invoice, etc).
|
|
1936
2049
|
*/
|
|
1937
2050
|
"Shipment document download": {
|
|
@@ -1959,7 +2072,7 @@ export interface operations {
|
|
|
1959
2072
|
};
|
|
1960
2073
|
};
|
|
1961
2074
|
/**
|
|
1962
|
-
* Purchase
|
|
2075
|
+
* Purchase Shipping Label
|
|
1963
2076
|
* @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
|
|
1964
2077
|
*/
|
|
1965
2078
|
"Shipment buy": {
|
|
@@ -2006,7 +2119,7 @@ export interface operations {
|
|
|
2006
2119
|
};
|
|
2007
2120
|
};
|
|
2008
2121
|
/**
|
|
2009
|
-
*
|
|
2122
|
+
* Shipping Rates
|
|
2010
2123
|
* @description Get available shipping rates based on origin, destination, and parcel information.
|
|
2011
2124
|
*/
|
|
2012
2125
|
"Shipment rates": {
|
|
@@ -2047,7 +2160,7 @@ export interface operations {
|
|
|
2047
2160
|
};
|
|
2048
2161
|
};
|
|
2049
2162
|
/**
|
|
2050
|
-
* Receive
|
|
2163
|
+
* Receive Storefront Events
|
|
2051
2164
|
* @description Processes events from storefronts using Shopify pixel event schema
|
|
2052
2165
|
*/
|
|
2053
2166
|
"Storefront Event": {
|
|
@@ -2081,7 +2194,7 @@ export interface operations {
|
|
|
2081
2194
|
};
|
|
2082
2195
|
};
|
|
2083
2196
|
/**
|
|
2084
|
-
* List
|
|
2197
|
+
* List Webhooks
|
|
2085
2198
|
* @description List webhooks for store.
|
|
2086
2199
|
*/
|
|
2087
2200
|
"Webhooks list": {
|
|
@@ -2108,7 +2221,7 @@ export interface operations {
|
|
|
2108
2221
|
};
|
|
2109
2222
|
};
|
|
2110
2223
|
/**
|
|
2111
|
-
* Create or
|
|
2224
|
+
* Create or Update Webhook
|
|
2112
2225
|
* @description Create webhook for store. Or if webhook already exists with `externalId`, update it.
|
|
2113
2226
|
*/
|
|
2114
2227
|
"Webhook create": {
|
|
@@ -2150,7 +2263,7 @@ export interface operations {
|
|
|
2150
2263
|
};
|
|
2151
2264
|
};
|
|
2152
2265
|
/**
|
|
2153
|
-
*
|
|
2266
|
+
* Webhook
|
|
2154
2267
|
* @description Get a webhook.
|
|
2155
2268
|
*/
|
|
2156
2269
|
"Webhook get": {
|
|
@@ -2171,7 +2284,7 @@ export interface operations {
|
|
|
2171
2284
|
};
|
|
2172
2285
|
};
|
|
2173
2286
|
/**
|
|
2174
|
-
* Update
|
|
2287
|
+
* Update Webhook
|
|
2175
2288
|
* @description Update a webhook.
|
|
2176
2289
|
*/
|
|
2177
2290
|
"Webhook update": {
|
|
@@ -2201,7 +2314,7 @@ export interface operations {
|
|
|
2201
2314
|
};
|
|
2202
2315
|
};
|
|
2203
2316
|
/**
|
|
2204
|
-
* Delete
|
|
2317
|
+
* Delete Webhook
|
|
2205
2318
|
* @description Delete a webhook.
|
|
2206
2319
|
*/
|
|
2207
2320
|
"Webhook delete": {
|
|
@@ -2218,7 +2331,7 @@ export interface operations {
|
|
|
2218
2331
|
};
|
|
2219
2332
|
};
|
|
2220
2333
|
/**
|
|
2221
|
-
* Replay
|
|
2334
|
+
* Replay Webhook
|
|
2222
2335
|
* @description Replay a webhook.
|
|
2223
2336
|
*/
|
|
2224
2337
|
"Webhook replay": {
|
package/lib/openapi.yaml
CHANGED
|
@@ -217,6 +217,52 @@ components:
|
|
|
217
217
|
- price
|
|
218
218
|
title: Coverage product
|
|
219
219
|
type: object
|
|
220
|
+
custom-event-request.schema:
|
|
221
|
+
additionalProperties: false
|
|
222
|
+
description: Custom event to trigger flows with merchant-defined event names and properties.
|
|
223
|
+
properties:
|
|
224
|
+
email:
|
|
225
|
+
description: Customer email address (one of email or phone is required).
|
|
226
|
+
type: string
|
|
227
|
+
event_name:
|
|
228
|
+
description: The name of the custom event (e.g., 'user_registered', 'purchase_completed').
|
|
229
|
+
type: string
|
|
230
|
+
event_timestamp:
|
|
231
|
+
description: ISO 8601 timestamp when the event occurred. Defaults to current time if not provided.
|
|
232
|
+
format: date-time
|
|
233
|
+
type: string
|
|
234
|
+
phone:
|
|
235
|
+
description: Customer phone number (one of email or phone is required).
|
|
236
|
+
type: string
|
|
237
|
+
properties:
|
|
238
|
+
additionalProperties: true
|
|
239
|
+
description: Custom properties for this event. Access in templates using dot notation (e.g., {{ properties.product_name }}).
|
|
240
|
+
type: object
|
|
241
|
+
required:
|
|
242
|
+
- event_name
|
|
243
|
+
title: Custom Event Request
|
|
244
|
+
type: object
|
|
245
|
+
custom-event-response.schema:
|
|
246
|
+
additionalProperties: false
|
|
247
|
+
description: Response after successfully creating a custom event.
|
|
248
|
+
properties:
|
|
249
|
+
event_id:
|
|
250
|
+
description: The unique identifier for the created event.
|
|
251
|
+
type: string
|
|
252
|
+
event_name:
|
|
253
|
+
description: The name of the custom event that was created.
|
|
254
|
+
type: string
|
|
255
|
+
status:
|
|
256
|
+
description: Status of the event processing.
|
|
257
|
+
enum:
|
|
258
|
+
- processed
|
|
259
|
+
type: string
|
|
260
|
+
required:
|
|
261
|
+
- event_id
|
|
262
|
+
- status
|
|
263
|
+
- event_name
|
|
264
|
+
title: Custom Event Response
|
|
265
|
+
type: object
|
|
220
266
|
customer-subscription-email.schema:
|
|
221
267
|
description: Email subscription updates
|
|
222
268
|
properties:
|
|
@@ -1599,9 +1645,9 @@ paths:
|
|
|
1599
1645
|
description: Error
|
|
1600
1646
|
security:
|
|
1601
1647
|
- Bearer: []
|
|
1602
|
-
summary:
|
|
1648
|
+
summary: Pending Invoice (CSV)
|
|
1603
1649
|
tags:
|
|
1604
|
-
-
|
|
1650
|
+
- Invoices
|
|
1605
1651
|
summary: Pending invoice
|
|
1606
1652
|
/invoices/{invoiceId}/items.csv:
|
|
1607
1653
|
description: Return invoice CSV file.
|
|
@@ -1626,9 +1672,9 @@ paths:
|
|
|
1626
1672
|
description: Error
|
|
1627
1673
|
security:
|
|
1628
1674
|
- Bearer: []
|
|
1629
|
-
summary:
|
|
1675
|
+
summary: Invoice (CSV)
|
|
1630
1676
|
tags:
|
|
1631
|
-
-
|
|
1677
|
+
- Invoices
|
|
1632
1678
|
summary: Invoice
|
|
1633
1679
|
/returns/{returnId}:
|
|
1634
1680
|
description: Return.
|
|
@@ -1658,7 +1704,7 @@ paths:
|
|
|
1658
1704
|
description: Error
|
|
1659
1705
|
security:
|
|
1660
1706
|
- Bearer: []
|
|
1661
|
-
summary:
|
|
1707
|
+
summary: Return
|
|
1662
1708
|
tags:
|
|
1663
1709
|
- Returns
|
|
1664
1710
|
parameters:
|
|
@@ -1685,7 +1731,7 @@ paths:
|
|
|
1685
1731
|
- comments
|
|
1686
1732
|
type: object
|
|
1687
1733
|
description: Success
|
|
1688
|
-
summary: List
|
|
1734
|
+
summary: List Return Comments
|
|
1689
1735
|
tags:
|
|
1690
1736
|
- Returns
|
|
1691
1737
|
parameters:
|
|
@@ -1724,7 +1770,7 @@ paths:
|
|
|
1724
1770
|
description: Error
|
|
1725
1771
|
security:
|
|
1726
1772
|
- Bearer: []
|
|
1727
|
-
summary: Create
|
|
1773
|
+
summary: Create Return Comment
|
|
1728
1774
|
tags:
|
|
1729
1775
|
- Returns
|
|
1730
1776
|
summary: Return comment
|
|
@@ -1806,7 +1852,7 @@ paths:
|
|
|
1806
1852
|
description: Error
|
|
1807
1853
|
security:
|
|
1808
1854
|
- Bearer: []
|
|
1809
|
-
summary: Process
|
|
1855
|
+
summary: Process Return
|
|
1810
1856
|
tags:
|
|
1811
1857
|
- Returns
|
|
1812
1858
|
summary: Process return
|
|
@@ -1837,7 +1883,7 @@ paths:
|
|
|
1837
1883
|
description: Error
|
|
1838
1884
|
security:
|
|
1839
1885
|
- Bearer: []
|
|
1840
|
-
summary:
|
|
1886
|
+
summary: Return Status
|
|
1841
1887
|
tags:
|
|
1842
1888
|
- Returns
|
|
1843
1889
|
put:
|
|
@@ -1867,7 +1913,7 @@ paths:
|
|
|
1867
1913
|
description: Error
|
|
1868
1914
|
security:
|
|
1869
1915
|
- Bearer: []
|
|
1870
|
-
summary: Update
|
|
1916
|
+
summary: Update Return Status
|
|
1871
1917
|
tags:
|
|
1872
1918
|
- Returns
|
|
1873
1919
|
summary: Return status
|
|
@@ -1881,14 +1927,14 @@ paths:
|
|
|
1881
1927
|
responses:
|
|
1882
1928
|
'302':
|
|
1883
1929
|
description: Redirect
|
|
1884
|
-
summary: Navigate to
|
|
1930
|
+
summary: Navigate to Merchant Admin
|
|
1885
1931
|
tags:
|
|
1886
|
-
- Merchant
|
|
1932
|
+
- Merchant Admin
|
|
1887
1933
|
summary: Merchant admin
|
|
1888
1934
|
/stores/{storeId}/checkout-buttons-ui:
|
|
1889
|
-
description: Generate HTML and CSS for checkout buttons
|
|
1935
|
+
description: Generate HTML and CSS for checkout buttons to enable or disable returns coverage.
|
|
1890
1936
|
get:
|
|
1891
|
-
description: Generate HTML and CSS for checkout buttons
|
|
1937
|
+
description: Generate rendered HTML and CSS for checkout buttons.
|
|
1892
1938
|
operationId: Checkout buttons UI
|
|
1893
1939
|
parameters:
|
|
1894
1940
|
- $ref: '#/components/parameters/store-id.param'
|
|
@@ -1907,10 +1953,9 @@ paths:
|
|
|
1907
1953
|
title: Checkout buttons HTML
|
|
1908
1954
|
type: string
|
|
1909
1955
|
description: Success
|
|
1910
|
-
summary:
|
|
1956
|
+
summary: Checkout Buttons UI
|
|
1911
1957
|
tags:
|
|
1912
|
-
- Checkout
|
|
1913
|
-
- UI
|
|
1958
|
+
- Checkout Buttons
|
|
1914
1959
|
summary: Checkout buttons UI
|
|
1915
1960
|
/stores/{storeId}/coverage-info:
|
|
1916
1961
|
description: Navigate to the coverage info page.
|
|
@@ -1922,9 +1967,9 @@ paths:
|
|
|
1922
1967
|
responses:
|
|
1923
1968
|
'302':
|
|
1924
1969
|
description: Redirect
|
|
1925
|
-
summary: Navigate to
|
|
1970
|
+
summary: Navigate to Coverage Info
|
|
1926
1971
|
tags:
|
|
1927
|
-
- Coverage
|
|
1972
|
+
- Coverage Info
|
|
1928
1973
|
summary: Coverage info
|
|
1929
1974
|
/stores/{storeId}/coverage-products:
|
|
1930
1975
|
description: Available coverage products.
|
|
@@ -2011,9 +2056,9 @@ paths:
|
|
|
2011
2056
|
schema:
|
|
2012
2057
|
$ref: '#/components/schemas/error.schema'
|
|
2013
2058
|
description: Error
|
|
2014
|
-
summary:
|
|
2059
|
+
summary: Coverage Products
|
|
2015
2060
|
tags:
|
|
2016
|
-
- Coverage
|
|
2061
|
+
- Coverage Products
|
|
2017
2062
|
summary: Coverage products
|
|
2018
2063
|
/stores/{storeId}/customer-portal:
|
|
2019
2064
|
description: Navigate to the customer portal.
|
|
@@ -2035,9 +2080,9 @@ paths:
|
|
|
2035
2080
|
responses:
|
|
2036
2081
|
'302':
|
|
2037
2082
|
description: Redirect
|
|
2038
|
-
summary: Navigate to
|
|
2083
|
+
summary: Navigate to Customer Portal
|
|
2039
2084
|
tags:
|
|
2040
|
-
- Customer
|
|
2085
|
+
- Customer Portal
|
|
2041
2086
|
summary: Customer portal
|
|
2042
2087
|
/stores/{storeId}/customer-subscriptions:
|
|
2043
2088
|
description: Update customer subscription preferences for marketing and transactional messages.
|
|
@@ -2084,10 +2129,89 @@ paths:
|
|
|
2084
2129
|
description: Error
|
|
2085
2130
|
security:
|
|
2086
2131
|
- Bearer: []
|
|
2087
|
-
summary: Update
|
|
2132
|
+
summary: Update Customer Subscriptions
|
|
2088
2133
|
tags:
|
|
2089
|
-
- Customer
|
|
2134
|
+
- Customer Subscriptions
|
|
2090
2135
|
summary: Customer subscriptions
|
|
2136
|
+
/stores/{storeId}/events:
|
|
2137
|
+
post:
|
|
2138
|
+
description: |
|
|
2139
|
+
Create a custom event to trigger flows with merchant-defined event names and properties.
|
|
2140
|
+
|
|
2141
|
+
Custom events allow merchants to trigger flows based on events from their own systems.
|
|
2142
|
+
Events can include custom properties that are accessible in email and SMS templates.
|
|
2143
|
+
|
|
2144
|
+
## Customer Matching
|
|
2145
|
+
The API matches customers by email or phone number. At least one must be provided.
|
|
2146
|
+
|
|
2147
|
+
If no matching customer is found, the request will fail with a 404 error.
|
|
2148
|
+
|
|
2149
|
+
## Rate Limiting
|
|
2150
|
+
This endpoint is rate-limited to 100 requests per second per store.
|
|
2151
|
+
operationId: Custom event create
|
|
2152
|
+
parameters:
|
|
2153
|
+
- $ref: '#/components/parameters/store-id.param'
|
|
2154
|
+
requestBody:
|
|
2155
|
+
content:
|
|
2156
|
+
application/json:
|
|
2157
|
+
examples:
|
|
2158
|
+
purchase_milestone:
|
|
2159
|
+
summary: Purchase milestone event
|
|
2160
|
+
value:
|
|
2161
|
+
event_name: purchase_milestone_reached
|
|
2162
|
+
phone: '+12065551234'
|
|
2163
|
+
properties:
|
|
2164
|
+
milestone_type: 100th_purchase
|
|
2165
|
+
total_spent: 5000
|
|
2166
|
+
vip_tier: gold
|
|
2167
|
+
user_registered:
|
|
2168
|
+
summary: User registration event
|
|
2169
|
+
value:
|
|
2170
|
+
email: customer@example.com
|
|
2171
|
+
event_name: user_registered
|
|
2172
|
+
properties:
|
|
2173
|
+
plan_type: premium
|
|
2174
|
+
referral_code: FRIEND123
|
|
2175
|
+
source: mobile_app
|
|
2176
|
+
schema:
|
|
2177
|
+
$ref: '#/components/schemas/custom-event-request.schema'
|
|
2178
|
+
required: true
|
|
2179
|
+
responses:
|
|
2180
|
+
'200':
|
|
2181
|
+
content:
|
|
2182
|
+
application/json:
|
|
2183
|
+
schema:
|
|
2184
|
+
$ref: '#/components/schemas/custom-event-response.schema'
|
|
2185
|
+
description: Event created successfully
|
|
2186
|
+
'400':
|
|
2187
|
+
content:
|
|
2188
|
+
application/json:
|
|
2189
|
+
schema:
|
|
2190
|
+
$ref: '#/components/schemas/error.schema'
|
|
2191
|
+
description: Invalid request body or missing required customer identifier
|
|
2192
|
+
'404':
|
|
2193
|
+
content:
|
|
2194
|
+
application/json:
|
|
2195
|
+
schema:
|
|
2196
|
+
$ref: '#/components/schemas/error.schema'
|
|
2197
|
+
description: Customer not found with provided identifier
|
|
2198
|
+
'429':
|
|
2199
|
+
content:
|
|
2200
|
+
application/json:
|
|
2201
|
+
schema:
|
|
2202
|
+
$ref: '#/components/schemas/error.schema'
|
|
2203
|
+
description: Rate limit exceeded
|
|
2204
|
+
default:
|
|
2205
|
+
content:
|
|
2206
|
+
application/problem+json:
|
|
2207
|
+
schema:
|
|
2208
|
+
$ref: '#/components/schemas/error.schema'
|
|
2209
|
+
description: Error
|
|
2210
|
+
security:
|
|
2211
|
+
- Bearer: []
|
|
2212
|
+
summary: Create custom event
|
|
2213
|
+
tags:
|
|
2214
|
+
- Custom Events
|
|
2091
2215
|
/stores/{storeId}/invoices:
|
|
2092
2216
|
description: Return a list of invoices.
|
|
2093
2217
|
get:
|
|
@@ -2117,9 +2241,9 @@ paths:
|
|
|
2117
2241
|
description: Error
|
|
2118
2242
|
security:
|
|
2119
2243
|
- Bearer: []
|
|
2120
|
-
summary:
|
|
2244
|
+
summary: List Invoices
|
|
2121
2245
|
tags:
|
|
2122
|
-
-
|
|
2246
|
+
- Invoices
|
|
2123
2247
|
summary: Invoice
|
|
2124
2248
|
/stores/{storeId}/returns:
|
|
2125
2249
|
description: List of returns for store.
|
|
@@ -2163,7 +2287,7 @@ paths:
|
|
|
2163
2287
|
description: Error
|
|
2164
2288
|
security:
|
|
2165
2289
|
- Bearer: []
|
|
2166
|
-
summary: List
|
|
2290
|
+
summary: List Returns
|
|
2167
2291
|
tags:
|
|
2168
2292
|
- Returns
|
|
2169
2293
|
parameters:
|
|
@@ -2235,7 +2359,7 @@ paths:
|
|
|
2235
2359
|
description: Error
|
|
2236
2360
|
security:
|
|
2237
2361
|
- Bearer: []
|
|
2238
|
-
summary: Purchase
|
|
2362
|
+
summary: Purchase Shipping Label
|
|
2239
2363
|
tags:
|
|
2240
2364
|
- Shipping
|
|
2241
2365
|
summary: Shipment Buy
|
|
@@ -2296,7 +2420,7 @@ paths:
|
|
|
2296
2420
|
description: Error
|
|
2297
2421
|
security:
|
|
2298
2422
|
- Bearer: []
|
|
2299
|
-
summary:
|
|
2423
|
+
summary: Shipping Rates
|
|
2300
2424
|
tags:
|
|
2301
2425
|
- Shipping
|
|
2302
2426
|
summary: Shipment Rates
|
|
@@ -2328,7 +2452,7 @@ paths:
|
|
|
2328
2452
|
description: Error
|
|
2329
2453
|
security:
|
|
2330
2454
|
- Bearer: []
|
|
2331
|
-
summary: Download
|
|
2455
|
+
summary: Download Shipment Document
|
|
2332
2456
|
tags:
|
|
2333
2457
|
- Shipping
|
|
2334
2458
|
parameters:
|
|
@@ -2363,7 +2487,7 @@ paths:
|
|
|
2363
2487
|
description: Error
|
|
2364
2488
|
security:
|
|
2365
2489
|
- Bearer: []
|
|
2366
|
-
summary: Receive
|
|
2490
|
+
summary: Receive Storefront Events
|
|
2367
2491
|
tags:
|
|
2368
2492
|
- Storefront
|
|
2369
2493
|
/stores/{storeId}/webhooks:
|
|
@@ -2391,7 +2515,7 @@ paths:
|
|
|
2391
2515
|
schema:
|
|
2392
2516
|
$ref: '#/components/schemas/error.schema'
|
|
2393
2517
|
description: Error
|
|
2394
|
-
summary: List
|
|
2518
|
+
summary: List Webhooks
|
|
2395
2519
|
tags:
|
|
2396
2520
|
- Webhooks
|
|
2397
2521
|
parameters:
|
|
@@ -2435,7 +2559,7 @@ paths:
|
|
|
2435
2559
|
description: Error
|
|
2436
2560
|
security:
|
|
2437
2561
|
- Bearer: []
|
|
2438
|
-
summary: Create or
|
|
2562
|
+
summary: Create or Update Webhook
|
|
2439
2563
|
tags:
|
|
2440
2564
|
- Webhooks
|
|
2441
2565
|
summary: Webhooks
|
|
@@ -2450,7 +2574,7 @@ paths:
|
|
|
2450
2574
|
description: Deleted
|
|
2451
2575
|
security:
|
|
2452
2576
|
- Bearer: []
|
|
2453
|
-
summary: Delete
|
|
2577
|
+
summary: Delete Webhook
|
|
2454
2578
|
tags:
|
|
2455
2579
|
- Webhooks
|
|
2456
2580
|
description: Webhook.
|
|
@@ -2471,7 +2595,7 @@ paths:
|
|
|
2471
2595
|
- webhook
|
|
2472
2596
|
type: object
|
|
2473
2597
|
description: Success
|
|
2474
|
-
summary:
|
|
2598
|
+
summary: Webhook
|
|
2475
2599
|
tags:
|
|
2476
2600
|
- Webhooks
|
|
2477
2601
|
put:
|
|
@@ -2499,7 +2623,7 @@ paths:
|
|
|
2499
2623
|
schema:
|
|
2500
2624
|
$ref: '#/components/schemas/error.schema'
|
|
2501
2625
|
description: Error
|
|
2502
|
-
summary: Update
|
|
2626
|
+
summary: Update Webhook
|
|
2503
2627
|
tags:
|
|
2504
2628
|
- Webhooks
|
|
2505
2629
|
summary: Webhook
|
|
@@ -2531,7 +2655,7 @@ paths:
|
|
|
2531
2655
|
schema:
|
|
2532
2656
|
$ref: '#/components/schemas/error.schema'
|
|
2533
2657
|
description: Error
|
|
2534
|
-
summary: Replay
|
|
2658
|
+
summary: Replay Webhook
|
|
2535
2659
|
tags:
|
|
2536
2660
|
- Webhooks
|
|
2537
2661
|
summary: Webhook replay
|
package/package.json
CHANGED