@redotech/redo-api-schema 2.2.331 → 2.2.405

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
@@ -158,42 +158,6 @@ export interface paths {
158
158
  };
159
159
  };
160
160
  };
161
- "/stores/{storeId}/shipments/{shipmentId}/documents/{documentType}": {
162
- /**
163
- * Download Shipment Document
164
- * @description Get a shipment document (label, commercial invoice, etc).
165
- */
166
- get: operations["Shipment document download"];
167
- parameters: {
168
- path: {
169
- storeId: components["parameters"]["store-id.param"];
170
- };
171
- };
172
- };
173
- "/stores/{storeId}/shipments/buy": {
174
- /**
175
- * Purchase Shipping Label
176
- * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
177
- */
178
- post: operations["Shipment buy"];
179
- parameters: {
180
- path: {
181
- storeId: components["parameters"]["store-id.param"];
182
- };
183
- };
184
- };
185
- "/stores/{storeId}/shipments/rates": {
186
- /**
187
- * Shipping Rates
188
- * @description Get available shipping rates based on origin, destination, and parcel information.
189
- */
190
- post: operations["Shipment rates"];
191
- parameters: {
192
- path: {
193
- storeId: components["parameters"]["store-id.param"];
194
- };
195
- };
196
- };
197
161
  "/stores/{storeId}/storefront/events": {
198
162
  /**
199
163
  * Receive Storefront Events
@@ -628,23 +592,6 @@ export interface components {
628
592
  */
629
593
  total: components["schemas"]["money.schema"];
630
594
  };
631
- /**
632
- * Parcel Type
633
- * @description Parcel type enum.
634
- * @enum {string}
635
- */
636
- "parcel-type.schema": "box" | "envelope" | "soft_pack";
637
- /**
638
- * Parcel
639
- * @description Parcel information for shipping.
640
- */
641
- "parcel.schema": {
642
- height: components["schemas"]["length.schema"];
643
- length: components["schemas"]["length.schema"];
644
- type: components["schemas"]["parcel-type.schema"];
645
- weight: components["schemas"]["shipping-weight.schema"];
646
- width: components["schemas"]["length.schema"];
647
- };
648
595
  /**
649
596
  * Person name
650
597
  * @description Person name.
@@ -697,6 +644,11 @@ export interface components {
697
644
  * @description Array of compensation methods available for this return
698
645
  */
699
646
  compensationMethods?: ("refund" | "store_credit" | "exchange")[];
647
+ /**
648
+ * Complete With No Action
649
+ * @description Whether this return can be completed with no action
650
+ */
651
+ completeWithNoAction?: boolean;
700
652
  /**
701
653
  * Created at
702
654
  * Format: date-time
@@ -861,6 +813,11 @@ export interface components {
861
813
  name?: string;
862
814
  };
863
815
  };
816
+ /**
817
+ * External Return Line Item ID
818
+ * @description External return line item ID
819
+ */
820
+ externalReturnLineItemId?: string;
864
821
  /** @description Whether this is a green return (no physical return required) */
865
822
  greenReturn?: boolean;
866
823
  /**
@@ -912,6 +869,11 @@ export interface components {
912
869
  /** @description Refund strategy */
913
870
  type?: string;
914
871
  };
872
+ /**
873
+ * Shipment Group IDs
874
+ * @description IDs of the shipment groups this return item belongs to
875
+ */
876
+ shipmentGroupIds?: string[];
915
877
  /** @description Product SKU */
916
878
  sku?: string;
917
879
  /** @description Return item status */
@@ -942,10 +904,15 @@ export interface components {
942
904
  order: {
943
905
  /**
944
906
  * ID
945
- * @description Order ID.
946
- * @example abc123
907
+ * @description Redo's internal identifier for the original order created in Redo.
908
+ * @example 64e4da943dd822979a70bd12
947
909
  */
948
910
  id: string;
911
+ /**
912
+ * Name
913
+ * @description Order name from the external provider, such as the Shopify order name.
914
+ */
915
+ name?: string;
949
916
  };
950
917
  /**
951
918
  * Shipment
@@ -990,6 +957,16 @@ export interface components {
990
957
  * @description Return status.
991
958
  */
992
959
  status: components["schemas"]["return-status.schema"];
960
+ /**
961
+ * Tags
962
+ * @description Tags associated with this return
963
+ */
964
+ tags?: {
965
+ /** @description The tag's display name */
966
+ name: string;
967
+ /** @description The source of the tag */
968
+ source: string;
969
+ }[];
993
970
  /**
994
971
  * Totals
995
972
  * @description Calculated totals for the return
@@ -1034,11 +1011,41 @@ export interface components {
1034
1011
  * @description Carrier code
1035
1012
  */
1036
1013
  carrier?: string;
1014
+ /**
1015
+ * Delivered At
1016
+ * @description Date and time this shipment was delivered
1017
+ */
1018
+ deliveredAt?: string;
1019
+ /**
1020
+ * Estimated Delivery Date
1021
+ * @description Estimated delivery date for this shipment
1022
+ */
1023
+ estimatedDeliveryDate?: string;
1024
+ /**
1025
+ * External Location ID
1026
+ * @description External location ID for the destination of this shipment
1027
+ */
1028
+ externalLocationId?: string;
1029
+ /**
1030
+ * Form Label
1031
+ * @description Form label URL
1032
+ */
1033
+ formLabel?: string;
1034
+ /**
1035
+ * Item IDs
1036
+ * @description IDs of the return items included in this shipment
1037
+ */
1038
+ itemIds?: string[];
1037
1039
  /**
1038
1040
  * Postage Label
1039
1041
  * @description Postage label URL
1040
1042
  */
1041
1043
  postageLabel?: string;
1044
+ /**
1045
+ * Shipment Group ID
1046
+ * @description ID of the shipment group this shipment belongs to
1047
+ */
1048
+ shipmentGroupId?: string;
1042
1049
  /**
1043
1050
  * Status
1044
1051
  * @description Status of shipment
@@ -1097,108 +1104,6 @@ export interface components {
1097
1104
  * @enum {string}
1098
1105
  */
1099
1106
  "return-type.schema": "claim" | "return" | "warranty";
1100
- /**
1101
- * Shipment Document Type
1102
- * @description Type of shipping document.
1103
- * @enum {string}
1104
- */
1105
- "shipment-document-type.schema": "label" | "commercialInvoice";
1106
- /**
1107
- * Shipment Document
1108
- * @description Shipping document information.
1109
- */
1110
- "shipment-document.schema": {
1111
- type: components["schemas"]["shipment-document-type.schema"];
1112
- };
1113
- /**
1114
- * Shipment Rate
1115
- * @description Shipping rate information.
1116
- */
1117
- "shipment-rate.schema": {
1118
- carrier: {
1119
- /**
1120
- * Carrier Account ID
1121
- * @description ID for the carrier account that provides the shipping rate.
1122
- */
1123
- id: string;
1124
- /**
1125
- * Carrier Name
1126
- * @description Carrier display name
1127
- */
1128
- name: string;
1129
- };
1130
- price: components["schemas"]["money.schema"];
1131
- service: {
1132
- /**
1133
- * Service Name
1134
- * @description Service level name
1135
- */
1136
- name: string;
1137
- };
1138
- };
1139
- /**
1140
- * Shipment Tracker
1141
- * @description Shipment tracking information.
1142
- */
1143
- "shipment-tracker.schema": {
1144
- /**
1145
- * Tracking Code
1146
- * @description Carrier tracking code
1147
- */
1148
- code: string;
1149
- };
1150
- /**
1151
- * Shipment
1152
- * @description Shipment information.
1153
- */
1154
- "shipment.schema": {
1155
- /**
1156
- * Documents
1157
- * @description Available shipping documents. You can access these documents using the GET Shipment document endpoint.
1158
- */
1159
- documents: components["schemas"]["shipment-document.schema"][];
1160
- /**
1161
- * Shipment ID
1162
- * @description Shipment identifier
1163
- */
1164
- id: string;
1165
- price: components["schemas"]["money.schema"];
1166
- tracker: components["schemas"]["shipment-tracker.schema"];
1167
- };
1168
- /**
1169
- * Shipping Contact
1170
- * @description Contact information for shipping.
1171
- */
1172
- "shipping-contact.schema": {
1173
- address: components["schemas"]["address.schema"];
1174
- /**
1175
- * Name
1176
- * @description Contact name
1177
- */
1178
- name: string;
1179
- /**
1180
- * Phone Number
1181
- * @description Contact phone number
1182
- */
1183
- phoneNumber: string;
1184
- };
1185
- /**
1186
- * Shipping Weight
1187
- * @description Weight measurement with unit for shipping.
1188
- */
1189
- "shipping-weight.schema": {
1190
- /**
1191
- * Unit
1192
- * @description Weight unit
1193
- * @enum {string}
1194
- */
1195
- unit: "g" | "kg" | "oz" | "lb";
1196
- /**
1197
- * Value
1198
- * @description Numeric weight value
1199
- */
1200
- value: number;
1201
- };
1202
1107
  /**
1203
1108
  * Storefront Cart
1204
1109
  * @description Storefront cart.
@@ -1318,7 +1223,10 @@ export interface components {
1318
1223
  urlWithParams?: string;
1319
1224
  [key: string]: unknown;
1320
1225
  };
1321
- /** @description Marketing subscription status */
1226
+ /**
1227
+ * Subscription Status Marketing
1228
+ * @description Marketing subscription status
1229
+ */
1322
1230
  "subscription-status-marketing.schema": {
1323
1231
  /**
1324
1232
  * @description Subscription status
@@ -1336,7 +1244,10 @@ export interface components {
1336
1244
  */
1337
1245
  updatedAt?: string;
1338
1246
  };
1339
- /** @description Transactional subscription status (order tracking) */
1247
+ /**
1248
+ * Subscription Status Transactional
1249
+ * @description Transactional subscription status (order tracking)
1250
+ */
1340
1251
  "subscription-status-transactional.schema": {
1341
1252
  /**
1342
1253
  * @description Subscription status. Only subscribed and unsubscribed are supported for transactional.
@@ -1469,8 +1380,6 @@ export interface components {
1469
1380
  };
1470
1381
  responses: never;
1471
1382
  parameters: {
1472
- /** @description Type of document to download */
1473
- "document-type.param": components["schemas"]["shipment-document-type.schema"];
1474
1383
  /** @description Invoice ID */
1475
1384
  "invoice-id.param": string;
1476
1385
  /**
@@ -1487,8 +1396,8 @@ export interface components {
1487
1396
  "provider-order-name"?: string;
1488
1397
  /** @description Return ID */
1489
1398
  "return-id.param": string;
1490
- /** @description Shipment ID */
1491
- "shipment-id.param": string;
1399
+ /** @description Filter returns by status */
1400
+ "return-status.param"?: components["schemas"]["return-status.schema"];
1492
1401
  /** @description Shopify specific order name */
1493
1402
  "shopify-order-name"?: string;
1494
1403
  /** @description Store ID */
@@ -1854,6 +1763,7 @@ export interface operations {
1854
1763
  customer?: components["schemas"]["storefront-customer.schema"];
1855
1764
  /**
1856
1765
  * Products
1766
+ * @deprecated
1857
1767
  * @description Product information.
1858
1768
  */
1859
1769
  products?: {
@@ -1865,6 +1775,7 @@ export interface operations {
1865
1775
  }[];
1866
1776
  /**
1867
1777
  * Variants
1778
+ * @deprecated
1868
1779
  * @description Variant information.
1869
1780
  */
1870
1781
  variants?: {
@@ -2085,6 +1996,7 @@ export interface operations {
2085
1996
  updated_at_min?: components["parameters"]["updated-at-min.param"];
2086
1997
  shopify_order_name?: components["parameters"]["shopify-order-name"];
2087
1998
  provider_order_name?: components["parameters"]["provider-order-name"];
1999
+ status?: components["parameters"]["return-status.param"];
2088
2000
  };
2089
2001
  header?: {
2090
2002
  "X-Page-Continue"?: components["parameters"]["page-continue.param"];
@@ -2115,122 +2027,6 @@ export interface operations {
2115
2027
  };
2116
2028
  };
2117
2029
  };
2118
- /**
2119
- * Download Shipment Document
2120
- * @description Get a shipment document (label, commercial invoice, etc).
2121
- */
2122
- "Shipment document download": {
2123
- parameters: {
2124
- path: {
2125
- storeId: components["parameters"]["store-id.param"];
2126
- shipmentId: components["parameters"]["shipment-id.param"];
2127
- documentType: components["parameters"]["document-type.param"];
2128
- };
2129
- };
2130
- responses: {
2131
- /** @description Success */
2132
- 200: {
2133
- content: {
2134
- "application/pdf": string;
2135
- "image/png": string;
2136
- };
2137
- };
2138
- /** @description Error */
2139
- default: {
2140
- content: {
2141
- "application/problem+json": components["schemas"]["error.schema"];
2142
- };
2143
- };
2144
- };
2145
- };
2146
- /**
2147
- * Purchase Shipping Label
2148
- * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
2149
- */
2150
- "Shipment buy": {
2151
- parameters: {
2152
- path: {
2153
- storeId: components["parameters"]["store-id.param"];
2154
- };
2155
- };
2156
- requestBody: {
2157
- content: {
2158
- "application/json": {
2159
- carrier: {
2160
- /**
2161
- * Carrier Account ID
2162
- * @description ID for the carrier account that provides the shipping rate.
2163
- */
2164
- id: string;
2165
- };
2166
- destination: components["schemas"]["shipping-contact.schema"];
2167
- origin: components["schemas"]["shipping-contact.schema"];
2168
- parcel: components["schemas"]["parcel.schema"];
2169
- service: {
2170
- /** @description Service level name */
2171
- name: string;
2172
- };
2173
- };
2174
- };
2175
- };
2176
- responses: {
2177
- /** @description Success */
2178
- 200: {
2179
- content: {
2180
- "application/json": {
2181
- shipment: components["schemas"]["shipment.schema"];
2182
- };
2183
- };
2184
- };
2185
- /** @description Error */
2186
- default: {
2187
- content: {
2188
- "application/problem+json": components["schemas"]["error.schema"];
2189
- };
2190
- };
2191
- };
2192
- };
2193
- /**
2194
- * Shipping Rates
2195
- * @description Get available shipping rates based on origin, destination, and parcel information.
2196
- */
2197
- "Shipment rates": {
2198
- parameters: {
2199
- path: {
2200
- storeId: components["parameters"]["store-id.param"];
2201
- };
2202
- };
2203
- requestBody: {
2204
- content: {
2205
- "application/json": {
2206
- destination: {
2207
- address: components["schemas"]["address.schema"];
2208
- };
2209
- origin: {
2210
- address: components["schemas"]["address.schema"];
2211
- };
2212
- parcel: components["schemas"]["parcel.schema"];
2213
- };
2214
- };
2215
- };
2216
- responses: {
2217
- /** @description Success */
2218
- 200: {
2219
- content: {
2220
- "application/json": {
2221
- /** @description Available shipping rates */
2222
- rates: components["schemas"]["shipment-rate.schema"][];
2223
- };
2224
- };
2225
- };
2226
- /** @description Error */
2227
- default: {
2228
- content: {
2229
- "application/problem+json": components["schemas"]["error.schema"];
2230
- };
2231
- };
2232
- };
2233
- };
2234
2030
  /**
2235
2031
  * Receive Storefront Events
2236
2032
  * @description Processes events from storefronts using Shopify pixel event schema
package/lib/openapi.yaml CHANGED
@@ -5,13 +5,6 @@ components:
5
5
  schema:
6
6
  type: string
7
7
  parameters:
8
- document-type.param:
9
- description: Type of document to download
10
- in: path
11
- name: documentType
12
- required: true
13
- schema:
14
- $ref: '#/components/schemas/shipment-document-type.schema'
15
8
  invoice-id.param:
16
9
  description: Invoice ID
17
10
  in: path
@@ -51,14 +44,12 @@ components:
51
44
  schema:
52
45
  example: 64e4d5e837572a4813b73e40
53
46
  type: string
54
- shipment-id.param:
55
- description: Shipment ID
56
- in: path
57
- name: shipmentId
58
- required: true
47
+ return-status.param:
48
+ description: Filter returns by status
49
+ in: query
50
+ name: status
59
51
  schema:
60
- example: 67c7e87a2c8c262c0ddc9861
61
- type: string
52
+ $ref: '#/components/schemas/return-status.schema'
62
53
  shopify-order-name:
63
54
  description: Shopify specific order name
64
55
  in: query
@@ -583,35 +574,6 @@ components:
583
574
  - taxes
584
575
  title: Order
585
576
  type: object
586
- parcel-type.schema:
587
- description: Parcel type enum.
588
- enum:
589
- - box
590
- - envelope
591
- - soft_pack
592
- title: Parcel Type
593
- type: string
594
- parcel.schema:
595
- description: Parcel information for shipping.
596
- properties:
597
- height:
598
- $ref: '#/components/schemas/length.schema'
599
- length:
600
- $ref: '#/components/schemas/length.schema'
601
- type:
602
- $ref: '#/components/schemas/parcel-type.schema'
603
- weight:
604
- $ref: '#/components/schemas/shipping-weight.schema'
605
- width:
606
- $ref: '#/components/schemas/length.schema'
607
- required:
608
- - height
609
- - length
610
- - width
611
- - weight
612
- - type
613
- title: Parcel
614
- type: object
615
577
  person-name.schema:
616
578
  description: Person name.
617
579
  properties:
@@ -684,6 +646,10 @@ components:
684
646
  type: string
685
647
  title: Compensation Methods
686
648
  type: array
649
+ completeWithNoAction:
650
+ description: Whether this return can be completed with no action
651
+ title: Complete With No Action
652
+ type: boolean
687
653
  createdAt:
688
654
  description: Time of creation.
689
655
  format: date-time
@@ -958,6 +924,10 @@ components:
958
924
  type: object
959
925
  title: Exchange item
960
926
  type: object
927
+ externalReturnLineItemId:
928
+ description: External return line item ID
929
+ title: External Return Line Item ID
930
+ type: string
961
931
  greenReturn:
962
932
  description: Whether this is a green return (no physical return required)
963
933
  type: boolean
@@ -1035,6 +1005,12 @@ components:
1035
1005
  required:
1036
1006
  - amount
1037
1007
  type: object
1008
+ shipmentGroupIds:
1009
+ description: IDs of the shipment groups this return item belongs to
1010
+ items:
1011
+ type: string
1012
+ title: Shipment Group IDs
1013
+ type: array
1038
1014
  sku:
1039
1015
  description: Product SKU
1040
1016
  type: string
@@ -1072,10 +1048,16 @@ components:
1072
1048
  description: Original order.
1073
1049
  properties:
1074
1050
  id:
1075
- description: Order ID.
1076
- example: abc123
1051
+ description: Redo's internal identifier for the original order created in Redo.
1052
+ example: 64e4da943dd822979a70bd12
1077
1053
  title: ID
1078
1054
  type: string
1055
+ name:
1056
+ description: Order name from the external provider, such as the Shopify order name.
1057
+ examples:
1058
+ - '#123'
1059
+ title: Name
1060
+ type: string
1079
1061
  required:
1080
1062
  - id
1081
1063
  title: Order
@@ -1125,6 +1107,22 @@ components:
1125
1107
  $ref: '#/components/schemas/return-status.schema'
1126
1108
  description: Return status.
1127
1109
  title: Status
1110
+ tags:
1111
+ description: Tags associated with this return
1112
+ items:
1113
+ properties:
1114
+ name:
1115
+ description: The tag's display name
1116
+ type: string
1117
+ source:
1118
+ description: The source of the tag
1119
+ type: string
1120
+ required:
1121
+ - name
1122
+ - source
1123
+ type: object
1124
+ title: Tags
1125
+ type: array
1128
1126
  totals:
1129
1127
  description: Calculated totals for the return
1130
1128
  properties:
@@ -1195,10 +1193,36 @@ components:
1195
1193
  description: Carrier code
1196
1194
  title: Carrier
1197
1195
  type: string
1196
+ deliveredAt:
1197
+ description: Date and time this shipment was delivered
1198
+ title: Delivered At
1199
+ type: string
1200
+ estimatedDeliveryDate:
1201
+ description: Estimated delivery date for this shipment
1202
+ title: Estimated Delivery Date
1203
+ type: string
1204
+ externalLocationId:
1205
+ description: External location ID for the destination of this shipment
1206
+ title: External Location ID
1207
+ type: string
1208
+ formLabel:
1209
+ description: Form label URL
1210
+ title: Form Label
1211
+ type: string
1212
+ itemIds:
1213
+ description: IDs of the return items included in this shipment
1214
+ items:
1215
+ type: string
1216
+ title: Item IDs
1217
+ type: array
1198
1218
  postageLabel:
1199
1219
  description: Postage label URL
1200
1220
  title: Postage Label
1201
1221
  type: string
1222
+ shipmentGroupId:
1223
+ description: ID of the shipment group this shipment belongs to
1224
+ title: Shipment Group ID
1225
+ type: string
1202
1226
  status:
1203
1227
  description: Status of shipment
1204
1228
  enum:
@@ -1281,150 +1305,6 @@ components:
1281
1305
  example: return
1282
1306
  title: Return type
1283
1307
  type: string
1284
- shipment-document-type.schema:
1285
- description: Type of shipping document.
1286
- enum:
1287
- - label
1288
- - commercialInvoice
1289
- title: Shipment Document Type
1290
- type: string
1291
- shipment-document.schema:
1292
- description: Shipping document information.
1293
- properties:
1294
- type:
1295
- $ref: '#/components/schemas/shipment-document-type.schema'
1296
- required:
1297
- - type
1298
- title: Shipment Document
1299
- type: object
1300
- shipment-rate.schema:
1301
- description: Shipping rate information.
1302
- properties:
1303
- carrier:
1304
- properties:
1305
- id:
1306
- description: ID for the carrier account that provides the shipping rate.
1307
- title: Carrier Account ID
1308
- type: string
1309
- name:
1310
- description: Carrier display name
1311
- examples:
1312
- - USPS
1313
- - FedEx
1314
- title: Carrier Name
1315
- type: string
1316
- required:
1317
- - id
1318
- - name
1319
- type: object
1320
- price:
1321
- $ref: '#/components/schemas/money.schema'
1322
- service:
1323
- properties:
1324
- name:
1325
- description: Service level name
1326
- examples:
1327
- - Priority
1328
- - Ground
1329
- title: Service Name
1330
- type: string
1331
- required:
1332
- - name
1333
- type: object
1334
- required:
1335
- - carrier
1336
- - price
1337
- - service
1338
- title: Shipment Rate
1339
- type: object
1340
- shipment-tracker.schema:
1341
- description: Shipment tracking information.
1342
- properties:
1343
- code:
1344
- description: Carrier tracking code
1345
- examples:
1346
- - '9400100000000000000000'
1347
- title: Tracking Code
1348
- type: string
1349
- required:
1350
- - code
1351
- title: Shipment Tracker
1352
- type: object
1353
- shipment.schema:
1354
- description: Shipment information.
1355
- properties:
1356
- documents:
1357
- description: Available shipping documents. You can access these documents using the GET Shipment document endpoint.
1358
- items:
1359
- $ref: '#/components/schemas/shipment-document.schema'
1360
- title: Documents
1361
- type: array
1362
- id:
1363
- description: Shipment identifier
1364
- title: Shipment ID
1365
- type: string
1366
- price:
1367
- $ref: '#/components/schemas/money.schema'
1368
- tracker:
1369
- $ref: '#/components/schemas/shipment-tracker.schema'
1370
- required:
1371
- - id
1372
- - documents
1373
- - tracker
1374
- - price
1375
- title: Shipment
1376
- type: object
1377
- shipping-contact.schema:
1378
- description: Contact information for shipping.
1379
- properties:
1380
- address:
1381
- $ref: '#/components/schemas/address.schema'
1382
- name:
1383
- description: Contact name
1384
- examples:
1385
- - John Doe
1386
- title: Name
1387
- type: string
1388
- phoneNumber:
1389
- description: Contact phone number
1390
- examples:
1391
- - '+12025550123'
1392
- title: Phone Number
1393
- type: string
1394
- required:
1395
- - name
1396
- - phoneNumber
1397
- - address
1398
- title: Shipping Contact
1399
- type: object
1400
- shipping-weight.schema:
1401
- description: Weight measurement with unit for shipping.
1402
- properties:
1403
- unit:
1404
- description: Weight unit
1405
- enum:
1406
- - g
1407
- - kg
1408
- - oz
1409
- - lb
1410
- examples:
1411
- - lb
1412
- - kg
1413
- title: Unit
1414
- type: string
1415
- value:
1416
- description: Numeric weight value
1417
- examples:
1418
- - 1.5
1419
- - 10
1420
- minimum: 0
1421
- title: Value
1422
- type: number
1423
- required:
1424
- - value
1425
- - unit
1426
- title: Shipping Weight
1427
- type: object
1428
1308
  storefront-cart.schema:
1429
1309
  description: Storefront cart.
1430
1310
  properties:
@@ -1606,6 +1486,7 @@ components:
1606
1486
  type: string
1607
1487
  required:
1608
1488
  - subscriptionStatus
1489
+ title: Subscription Status Marketing
1609
1490
  type: object
1610
1491
  subscription-status-transactional.schema:
1611
1492
  description: Transactional subscription status (order tracking)
@@ -1622,6 +1503,7 @@ components:
1622
1503
  type: string
1623
1504
  required:
1624
1505
  - subscriptionStatus
1506
+ title: Subscription Status Transactional
1625
1507
  type: object
1626
1508
  webhook-create.schema:
1627
1509
  description: Webhook create.
@@ -2151,6 +2033,7 @@ paths:
2151
2033
  customer:
2152
2034
  $ref: '#/components/schemas/storefront-customer.schema'
2153
2035
  products:
2036
+ deprecated: true
2154
2037
  description: Product information.
2155
2038
  items:
2156
2039
  properties:
@@ -2164,6 +2047,7 @@ paths:
2164
2047
  title: Products
2165
2048
  type: array
2166
2049
  variants:
2050
+ deprecated: true
2167
2051
  description: Variant information.
2168
2052
  items:
2169
2053
  properties:
@@ -2422,6 +2306,7 @@ paths:
2422
2306
  - $ref: '#/components/parameters/updated-at-min.param'
2423
2307
  - $ref: '#/components/parameters/shopify-order-name'
2424
2308
  - $ref: '#/components/parameters/provider-order-name'
2309
+ - $ref: '#/components/parameters/return-status.param'
2425
2310
  responses:
2426
2311
  '200':
2427
2312
  content:
@@ -2458,171 +2343,6 @@ paths:
2458
2343
  parameters:
2459
2344
  - $ref: '#/components/parameters/store-id.param'
2460
2345
  summary: Returns
2461
- /stores/{storeId}/shipments/buy:
2462
- description: Purchase a shipping label.
2463
- parameters:
2464
- - $ref: '#/components/parameters/store-id.param'
2465
- post:
2466
- description: Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
2467
- operationId: Shipment buy
2468
- requestBody:
2469
- content:
2470
- application/json:
2471
- schema:
2472
- properties:
2473
- carrier:
2474
- properties:
2475
- id:
2476
- description: ID for the carrier account that provides the shipping rate.
2477
- title: Carrier Account ID
2478
- type: string
2479
- required:
2480
- - id
2481
- type: object
2482
- destination:
2483
- $ref: '#/components/schemas/shipping-contact.schema'
2484
- origin:
2485
- $ref: '#/components/schemas/shipping-contact.schema'
2486
- parcel:
2487
- $ref: '#/components/schemas/parcel.schema'
2488
- service:
2489
- properties:
2490
- name:
2491
- description: Service level name
2492
- examples:
2493
- - Priority
2494
- - Ground
2495
- type: string
2496
- required:
2497
- - name
2498
- type: object
2499
- required:
2500
- - origin
2501
- - destination
2502
- - carrier
2503
- - service
2504
- - parcel
2505
- type: object
2506
- required: true
2507
- responses:
2508
- '200':
2509
- content:
2510
- application/json:
2511
- schema:
2512
- properties:
2513
- shipment:
2514
- $ref: '#/components/schemas/shipment.schema'
2515
- required:
2516
- - shipment
2517
- type: object
2518
- description: Success
2519
- default:
2520
- content:
2521
- application/problem+json:
2522
- schema:
2523
- $ref: '#/components/schemas/error.schema'
2524
- description: Error
2525
- security:
2526
- - Bearer: []
2527
- summary: Purchase Shipping Label
2528
- tags:
2529
- - Shipping
2530
- summary: Shipment Buy
2531
- /stores/{storeId}/shipments/rates:
2532
- description: Fetch available shipping label rates.
2533
- parameters:
2534
- - $ref: '#/components/parameters/store-id.param'
2535
- post:
2536
- description: Get available shipping rates based on origin, destination, and parcel information.
2537
- operationId: Shipment rates
2538
- requestBody:
2539
- content:
2540
- application/json:
2541
- schema:
2542
- properties:
2543
- destination:
2544
- properties:
2545
- address:
2546
- $ref: '#/components/schemas/address.schema'
2547
- required:
2548
- - address
2549
- type: object
2550
- origin:
2551
- properties:
2552
- address:
2553
- $ref: '#/components/schemas/address.schema'
2554
- required:
2555
- - address
2556
- type: object
2557
- parcel:
2558
- $ref: '#/components/schemas/parcel.schema'
2559
- required:
2560
- - origin
2561
- - destination
2562
- - parcel
2563
- type: object
2564
- required: true
2565
- responses:
2566
- '200':
2567
- content:
2568
- application/json:
2569
- schema:
2570
- properties:
2571
- rates:
2572
- description: Available shipping rates
2573
- items:
2574
- $ref: '#/components/schemas/shipment-rate.schema'
2575
- type: array
2576
- required:
2577
- - rates
2578
- type: object
2579
- description: Success
2580
- default:
2581
- content:
2582
- application/problem+json:
2583
- schema:
2584
- $ref: '#/components/schemas/error.schema'
2585
- description: Error
2586
- security:
2587
- - Bearer: []
2588
- summary: Shipping Rates
2589
- tags:
2590
- - Shipping
2591
- summary: Shipment Rates
2592
- /stores/{storeId}/shipments/{shipmentId}/documents/{documentType}:
2593
- description: Download shipment document.
2594
- get:
2595
- description: Get a shipment document (label, commercial invoice, etc).
2596
- operationId: Shipment document download
2597
- parameters:
2598
- - $ref: '#/components/parameters/shipment-id.param'
2599
- - $ref: '#/components/parameters/document-type.param'
2600
- responses:
2601
- '200':
2602
- content:
2603
- application/pdf:
2604
- schema:
2605
- format: binary
2606
- type: string
2607
- image/png:
2608
- schema:
2609
- format: binary
2610
- type: string
2611
- description: Success
2612
- default:
2613
- content:
2614
- application/problem+json:
2615
- schema:
2616
- $ref: '#/components/schemas/error.schema'
2617
- description: Error
2618
- security:
2619
- - Bearer: []
2620
- summary: Download Shipment Document
2621
- tags:
2622
- - Shipping
2623
- parameters:
2624
- - $ref: '#/components/parameters/store-id.param'
2625
- summary: Shipment Document
2626
2346
  /stores/{storeId}/storefront/events:
2627
2347
  post:
2628
2348
  description: Processes events from storefronts using Shopify pixel event schema
@@ -2826,6 +2546,18 @@ paths:
2826
2546
  summary: Webhook replay
2827
2547
  servers:
2828
2548
  - url: https://api.getredo.com/v2.2
2549
+ tags:
2550
+ - name: Checkout Buttons
2551
+ - name: Coverage Info
2552
+ - name: Coverage Products
2553
+ - name: Custom Events
2554
+ - name: Customer Portal
2555
+ - name: Customer Subscriptions
2556
+ - name: Invoices
2557
+ - name: Merchant Admin
2558
+ - name: Returns
2559
+ - name: Storefront
2560
+ - name: Webhooks
2829
2561
  webhooks:
2830
2562
  return:
2831
2563
  post:
package/package.json CHANGED
@@ -31,5 +31,5 @@
31
31
  ]
32
32
  }
33
33
  },
34
- "version": "2.2.331"
34
+ "version": "2.2.405"
35
35
  }