@medusajs/js-sdk 2.0.0 → 2.0.1-preview-20241025150152
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/admin/api-key.d.ts +8 -8
- package/dist/admin/api-key.js +8 -8
- package/dist/admin/campaign.d.ts +8 -8
- package/dist/admin/campaign.js +8 -8
- package/dist/admin/claim.d.ts +22 -22
- package/dist/admin/claim.js +22 -22
- package/dist/admin/currency.d.ts +4 -4
- package/dist/admin/currency.js +4 -4
- package/dist/admin/customer-group.d.ts +8 -8
- package/dist/admin/customer-group.js +8 -8
- package/dist/admin/customer.d.ts +27 -7
- package/dist/admin/customer.d.ts.map +1 -1
- package/dist/admin/customer.js +33 -7
- package/dist/admin/customer.js.map +1 -1
- package/dist/admin/exchange.d.ts +21 -21
- package/dist/admin/exchange.js +21 -21
- package/dist/admin/fulfillment-provider.d.ts +2 -2
- package/dist/admin/fulfillment-provider.js +2 -2
- package/dist/admin/fulfillment-set.d.ts +6 -6
- package/dist/admin/fulfillment-set.js +6 -6
- package/dist/admin/fulfillment.d.ts +3 -3
- package/dist/admin/fulfillment.js +3 -3
- package/dist/admin/inventory-item.d.ts +12 -12
- package/dist/admin/inventory-item.js +12 -12
- package/dist/admin/invite.d.ts +8 -8
- package/dist/admin/invite.js +8 -8
- package/dist/admin/payment-collection.d.ts +0 -2
- package/dist/admin/payment-collection.d.ts.map +1 -1
- package/dist/admin/payment-collection.js +0 -12
- package/dist/admin/payment-collection.js.map +1 -1
- package/dist/admin/price-list.d.ts +195 -1
- package/dist/admin/price-list.d.ts.map +1 -1
- package/dist/admin/price-list.js +194 -0
- package/dist/admin/price-list.js.map +1 -1
- package/dist/admin/price-preference.d.ts +133 -0
- package/dist/admin/price-preference.d.ts.map +1 -1
- package/dist/admin/price-preference.js +133 -0
- package/dist/admin/price-preference.js.map +1 -1
- package/dist/admin/product-category.d.ts +150 -0
- package/dist/admin/product-category.d.ts.map +1 -1
- package/dist/admin/product-category.js +150 -0
- package/dist/admin/product-category.js.map +1 -1
- package/dist/admin/product-collection.d.ts +149 -0
- package/dist/admin/product-collection.d.ts.map +1 -1
- package/dist/admin/product-collection.js +149 -0
- package/dist/admin/product-collection.js.map +1 -1
- package/dist/auth/index.d.ts +10 -10
- package/dist/auth/index.js +10 -10
- package/dist/esm/admin/api-key.d.ts +8 -8
- package/dist/esm/admin/api-key.js +8 -8
- package/dist/esm/admin/campaign.d.ts +8 -8
- package/dist/esm/admin/campaign.js +8 -8
- package/dist/esm/admin/claim.d.ts +22 -22
- package/dist/esm/admin/claim.js +22 -22
- package/dist/esm/admin/currency.d.ts +4 -4
- package/dist/esm/admin/currency.js +4 -4
- package/dist/esm/admin/customer-group.d.ts +8 -8
- package/dist/esm/admin/customer-group.js +8 -8
- package/dist/esm/admin/customer.d.ts +27 -7
- package/dist/esm/admin/customer.d.ts.map +1 -1
- package/dist/esm/admin/customer.js +35 -7
- package/dist/esm/admin/customer.js.map +1 -1
- package/dist/esm/admin/exchange.d.ts +21 -21
- package/dist/esm/admin/exchange.js +21 -21
- package/dist/esm/admin/fulfillment-provider.d.ts +2 -2
- package/dist/esm/admin/fulfillment-provider.js +2 -2
- package/dist/esm/admin/fulfillment-set.d.ts +6 -6
- package/dist/esm/admin/fulfillment-set.js +6 -6
- package/dist/esm/admin/fulfillment.d.ts +3 -3
- package/dist/esm/admin/fulfillment.js +3 -3
- package/dist/esm/admin/inventory-item.d.ts +12 -12
- package/dist/esm/admin/inventory-item.js +12 -12
- package/dist/esm/admin/invite.d.ts +8 -8
- package/dist/esm/admin/invite.js +8 -8
- package/dist/esm/admin/payment-collection.d.ts +0 -2
- package/dist/esm/admin/payment-collection.d.ts.map +1 -1
- package/dist/esm/admin/payment-collection.js +0 -16
- package/dist/esm/admin/payment-collection.js.map +1 -1
- package/dist/esm/admin/price-list.d.ts +195 -1
- package/dist/esm/admin/price-list.d.ts.map +1 -1
- package/dist/esm/admin/price-list.js +194 -0
- package/dist/esm/admin/price-list.js.map +1 -1
- package/dist/esm/admin/price-preference.d.ts +133 -0
- package/dist/esm/admin/price-preference.d.ts.map +1 -1
- package/dist/esm/admin/price-preference.js +133 -0
- package/dist/esm/admin/price-preference.js.map +1 -1
- package/dist/esm/admin/product-category.d.ts +150 -0
- package/dist/esm/admin/product-category.d.ts.map +1 -1
- package/dist/esm/admin/product-category.js +150 -0
- package/dist/esm/admin/product-category.js.map +1 -1
- package/dist/esm/admin/product-collection.d.ts +149 -0
- package/dist/esm/admin/product-collection.d.ts.map +1 -1
- package/dist/esm/admin/product-collection.js +149 -0
- package/dist/esm/admin/product-collection.js.map +1 -1
- package/dist/esm/auth/index.d.ts +10 -10
- package/dist/esm/auth/index.js +10 -10
- package/dist/esm/store/index.d.ts +73 -73
- package/dist/esm/store/index.js +73 -73
- package/dist/store/index.d.ts +73 -73
- package/dist/store/index.js +73 -73
- package/package.json +2 -2
package/dist/admin/exchange.d.ts
CHANGED
@@ -12,7 +12,7 @@ export declare class Exchange {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This method retrieves a paginated list of exchanges. It sends a request to the
|
15
|
-
* [List Exchanges](https://docs.medusajs.com/
|
15
|
+
* [List Exchanges](https://docs.medusajs.com/api/admin#exchanges_getexchanges)
|
16
16
|
* API route.
|
17
17
|
*
|
18
18
|
* @param query - Filters and pagination configurations.
|
@@ -55,12 +55,12 @@ export declare class Exchange {
|
|
55
55
|
* })
|
56
56
|
* ```
|
57
57
|
*
|
58
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
58
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
59
59
|
*/
|
60
60
|
list(query?: HttpTypes.AdminExchangeListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeListResponse>;
|
61
61
|
/**
|
62
62
|
* This method retrieves an exchange by its ID. It sends a request to the
|
63
|
-
* [Get Exchange](https://docs.medusajs.com/
|
63
|
+
* [Get Exchange](https://docs.medusajs.com/api/admin#exchanges_getexchangesid)
|
64
64
|
* API route.
|
65
65
|
*
|
66
66
|
* @param id - The exchange's ID.
|
@@ -89,12 +89,12 @@ export declare class Exchange {
|
|
89
89
|
* })
|
90
90
|
* ```
|
91
91
|
*
|
92
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
92
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
93
93
|
*/
|
94
94
|
retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
|
95
95
|
/**
|
96
96
|
* This method creates an admin exchange. It sends a request to the
|
97
|
-
* [Create Exchange](https://docs.medusajs.com/
|
97
|
+
* [Create Exchange](https://docs.medusajs.com/api/admin#exchanges_postexchanges) API route.
|
98
98
|
*
|
99
99
|
* @param body - The exchange's details.
|
100
100
|
* @param query - Configure the fields to retrieve in the exchange.
|
@@ -112,7 +112,7 @@ export declare class Exchange {
|
|
112
112
|
create(body: HttpTypes.AdminCreateExchange, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeResponse>;
|
113
113
|
/**
|
114
114
|
* This method cancels an exchange. It sends a request to the
|
115
|
-
* [Cancel Exchange](https://docs.medusajs.com/
|
115
|
+
* [Cancel Exchange](https://docs.medusajs.com/api/admin#exchanges_postexchangesidcancel) API route.
|
116
116
|
*
|
117
117
|
* @param id - The exchange's ID.
|
118
118
|
* @param query - Configure the fields to retrieve in the exchange.
|
@@ -130,7 +130,7 @@ export declare class Exchange {
|
|
130
130
|
* This method adds inbound (or return) items to an exchange. These inbound items will
|
131
131
|
* have the action `RETURN_ITEM`.
|
132
132
|
*
|
133
|
-
* This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/
|
133
|
+
* This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinbounditems)
|
134
134
|
* API route.
|
135
135
|
*
|
136
136
|
* @param id - The exchange's ID.
|
@@ -158,7 +158,7 @@ export declare class Exchange {
|
|
158
158
|
* Every item has an `actions` property, whose value is an array of actions. You can
|
159
159
|
* check the action's name using its `action` property, and use the value of the `id` property.
|
160
160
|
*
|
161
|
-
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/
|
161
|
+
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinbounditemsaction_id)
|
162
162
|
* API route.
|
163
163
|
*
|
164
164
|
* @param id - The exchange's ID.
|
@@ -188,7 +188,7 @@ export declare class Exchange {
|
|
188
188
|
* Every item has an `actions` property, whose value is an array of actions.
|
189
189
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
190
190
|
*
|
191
|
-
* This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/
|
191
|
+
* This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidinbounditemsaction_id)
|
192
192
|
* API route.
|
193
193
|
*
|
194
194
|
* @param id - The exchange's ID.
|
@@ -211,10 +211,10 @@ export declare class Exchange {
|
|
211
211
|
* This method adds an inbound (or return) shipping method to an exchange.
|
212
212
|
* The inbound shipping method will have a `SHIPPING_ADD` action.
|
213
213
|
*
|
214
|
-
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/
|
214
|
+
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinboundshippingmethod)
|
215
215
|
* API route.
|
216
216
|
*
|
217
|
-
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/
|
217
|
+
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinboundshippingmethod)
|
218
218
|
* API route.
|
219
219
|
*
|
220
220
|
* @param id - The exchange's ID.
|
@@ -239,7 +239,7 @@ export declare class Exchange {
|
|
239
239
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
240
240
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
241
241
|
*
|
242
|
-
* This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/
|
242
|
+
* This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinboundshippingmethodaction_id)
|
243
243
|
* API route.
|
244
244
|
*
|
245
245
|
* @param id - The exchange's ID.
|
@@ -269,7 +269,7 @@ export declare class Exchange {
|
|
269
269
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
270
270
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
271
271
|
*
|
272
|
-
* This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/
|
272
|
+
* This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidinboundshippingmethodaction_id)
|
273
273
|
* API route.
|
274
274
|
*
|
275
275
|
* @param id - The exchange's ID.
|
@@ -292,7 +292,7 @@ export declare class Exchange {
|
|
292
292
|
* This method adds outbound (or new) items to an exchange.
|
293
293
|
* These outbound items will have the action `ITEM_ADD`.
|
294
294
|
*
|
295
|
-
* This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/
|
295
|
+
* This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutbounditems)
|
296
296
|
* API route.
|
297
297
|
*
|
298
298
|
* @param id - The exchange's ID.
|
@@ -320,7 +320,7 @@ export declare class Exchange {
|
|
320
320
|
* Every item has an `actions` property, whose value is an array of actions.
|
321
321
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
322
322
|
*
|
323
|
-
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/
|
323
|
+
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutbounditemsaction_id)
|
324
324
|
* API route.
|
325
325
|
*
|
326
326
|
* @param id - The exchange's ID.
|
@@ -350,7 +350,7 @@ export declare class Exchange {
|
|
350
350
|
* Every item has an `actions` property, whose value is an array of actions.
|
351
351
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
352
352
|
*
|
353
|
-
* This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/
|
353
|
+
* This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidoutbounditemsaction_id)
|
354
354
|
* API route.
|
355
355
|
*
|
356
356
|
* @param id - The exchange's ID.
|
@@ -373,7 +373,7 @@ export declare class Exchange {
|
|
373
373
|
* This method adds an outbound shipping method to an exchange. The outbound shipping method
|
374
374
|
* will have a `SHIPPING_ADD` action.
|
375
375
|
*
|
376
|
-
* This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/
|
376
|
+
* This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutboundshippingmethod)
|
377
377
|
* API route.
|
378
378
|
*
|
379
379
|
* @param id - The exchange's ID.
|
@@ -398,7 +398,7 @@ export declare class Exchange {
|
|
398
398
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
399
399
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
400
400
|
*
|
401
|
-
* This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/
|
401
|
+
* This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutboundshippingmethodaction_id)
|
402
402
|
* API route.
|
403
403
|
*
|
404
404
|
* @param id - The exchange's ID.
|
@@ -428,7 +428,7 @@ export declare class Exchange {
|
|
428
428
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
429
429
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
430
430
|
*
|
431
|
-
* This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/
|
431
|
+
* This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidoutboundshippingmethodaction_id)
|
432
432
|
* API route.
|
433
433
|
*
|
434
434
|
* @param id - The exchange's ID.
|
@@ -450,7 +450,7 @@ export declare class Exchange {
|
|
450
450
|
/**
|
451
451
|
* This method confirms an exchange request, applying its changes on the associated order.
|
452
452
|
*
|
453
|
-
* This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/
|
453
|
+
* This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/api/admin#exchanges_postexchangesidrequest)
|
454
454
|
* API route.
|
455
455
|
*
|
456
456
|
* @param id - The exchange's ID.
|
@@ -468,7 +468,7 @@ export declare class Exchange {
|
|
468
468
|
request(id: string, body: HttpTypes.AdminRequestExchange, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExchangeRequestResponse>;
|
469
469
|
/**
|
470
470
|
* This method cancels an exchange request. It sends a request to the
|
471
|
-
* [Cancel Exchange Request](https://docs.medusajs.com/
|
471
|
+
* [Cancel Exchange Request](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidrequest)
|
472
472
|
* API route.
|
473
473
|
*
|
474
474
|
* @param id - The exchange's ID.
|
package/dist/admin/exchange.js
CHANGED
@@ -10,7 +10,7 @@ class Exchange {
|
|
10
10
|
}
|
11
11
|
/**
|
12
12
|
* This method retrieves a paginated list of exchanges. It sends a request to the
|
13
|
-
* [List Exchanges](https://docs.medusajs.com/
|
13
|
+
* [List Exchanges](https://docs.medusajs.com/api/admin#exchanges_getexchanges)
|
14
14
|
* API route.
|
15
15
|
*
|
16
16
|
* @param query - Filters and pagination configurations.
|
@@ -53,7 +53,7 @@ class Exchange {
|
|
53
53
|
* })
|
54
54
|
* ```
|
55
55
|
*
|
56
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
56
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
57
57
|
*/
|
58
58
|
async list(query, headers) {
|
59
59
|
return await this.client.fetch(`/admin/exchanges`, {
|
@@ -63,7 +63,7 @@ class Exchange {
|
|
63
63
|
}
|
64
64
|
/**
|
65
65
|
* This method retrieves an exchange by its ID. It sends a request to the
|
66
|
-
* [Get Exchange](https://docs.medusajs.com/
|
66
|
+
* [Get Exchange](https://docs.medusajs.com/api/admin#exchanges_getexchangesid)
|
67
67
|
* API route.
|
68
68
|
*
|
69
69
|
* @param id - The exchange's ID.
|
@@ -92,7 +92,7 @@ class Exchange {
|
|
92
92
|
* })
|
93
93
|
* ```
|
94
94
|
*
|
95
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
95
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
96
96
|
*/
|
97
97
|
async retrieve(id, query, headers) {
|
98
98
|
return await this.client.fetch(`/admin/exchanges/${id}`, {
|
@@ -102,7 +102,7 @@ class Exchange {
|
|
102
102
|
}
|
103
103
|
/**
|
104
104
|
* This method creates an admin exchange. It sends a request to the
|
105
|
-
* [Create Exchange](https://docs.medusajs.com/
|
105
|
+
* [Create Exchange](https://docs.medusajs.com/api/admin#exchanges_postexchanges) API route.
|
106
106
|
*
|
107
107
|
* @param body - The exchange's details.
|
108
108
|
* @param query - Configure the fields to retrieve in the exchange.
|
@@ -127,7 +127,7 @@ class Exchange {
|
|
127
127
|
}
|
128
128
|
/**
|
129
129
|
* This method cancels an exchange. It sends a request to the
|
130
|
-
* [Cancel Exchange](https://docs.medusajs.com/
|
130
|
+
* [Cancel Exchange](https://docs.medusajs.com/api/admin#exchanges_postexchangesidcancel) API route.
|
131
131
|
*
|
132
132
|
* @param id - The exchange's ID.
|
133
133
|
* @param query - Configure the fields to retrieve in the exchange.
|
@@ -151,7 +151,7 @@ class Exchange {
|
|
151
151
|
* This method adds inbound (or return) items to an exchange. These inbound items will
|
152
152
|
* have the action `RETURN_ITEM`.
|
153
153
|
*
|
154
|
-
* This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/
|
154
|
+
* This method sends a request to the [Add Inbound Items](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinbounditems)
|
155
155
|
* API route.
|
156
156
|
*
|
157
157
|
* @param id - The exchange's ID.
|
@@ -186,7 +186,7 @@ class Exchange {
|
|
186
186
|
* Every item has an `actions` property, whose value is an array of actions. You can
|
187
187
|
* check the action's name using its `action` property, and use the value of the `id` property.
|
188
188
|
*
|
189
|
-
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/
|
189
|
+
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinbounditemsaction_id)
|
190
190
|
* API route.
|
191
191
|
*
|
192
192
|
* @param id - The exchange's ID.
|
@@ -223,7 +223,7 @@ class Exchange {
|
|
223
223
|
* Every item has an `actions` property, whose value is an array of actions.
|
224
224
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
225
225
|
*
|
226
|
-
* This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/
|
226
|
+
* This method sends a request to the [Remove Inbound Item](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidinbounditemsaction_id)
|
227
227
|
* API route.
|
228
228
|
*
|
229
229
|
* @param id - The exchange's ID.
|
@@ -252,10 +252,10 @@ class Exchange {
|
|
252
252
|
* This method adds an inbound (or return) shipping method to an exchange.
|
253
253
|
* The inbound shipping method will have a `SHIPPING_ADD` action.
|
254
254
|
*
|
255
|
-
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/
|
255
|
+
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinboundshippingmethod)
|
256
256
|
* API route.
|
257
257
|
*
|
258
|
-
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/
|
258
|
+
* This method sends a request to the [Add Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinboundshippingmethod)
|
259
259
|
* API route.
|
260
260
|
*
|
261
261
|
* @param id - The exchange's ID.
|
@@ -287,7 +287,7 @@ class Exchange {
|
|
287
287
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
288
288
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
289
289
|
*
|
290
|
-
* This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/
|
290
|
+
* This method sends a request to the [Update Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidinboundshippingmethodaction_id)
|
291
291
|
* API route.
|
292
292
|
*
|
293
293
|
* @param id - The exchange's ID.
|
@@ -324,7 +324,7 @@ class Exchange {
|
|
324
324
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
325
325
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
326
326
|
*
|
327
|
-
* This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/
|
327
|
+
* This method sends a request to the [Remove Inbound Shipping](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidinboundshippingmethodaction_id)
|
328
328
|
* API route.
|
329
329
|
*
|
330
330
|
* @param id - The exchange's ID.
|
@@ -353,7 +353,7 @@ class Exchange {
|
|
353
353
|
* This method adds outbound (or new) items to an exchange.
|
354
354
|
* These outbound items will have the action `ITEM_ADD`.
|
355
355
|
*
|
356
|
-
* This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/
|
356
|
+
* This method sends a request to the [Add Outbound Items](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutbounditems)
|
357
357
|
* API route.
|
358
358
|
*
|
359
359
|
* @param id - The exchange's ID.
|
@@ -388,7 +388,7 @@ class Exchange {
|
|
388
388
|
* Every item has an `actions` property, whose value is an array of actions.
|
389
389
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
390
390
|
*
|
391
|
-
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/
|
391
|
+
* This method sends a request to the [Update Inbound Item](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutbounditemsaction_id)
|
392
392
|
* API route.
|
393
393
|
*
|
394
394
|
* @param id - The exchange's ID.
|
@@ -425,7 +425,7 @@ class Exchange {
|
|
425
425
|
* Every item has an `actions` property, whose value is an array of actions.
|
426
426
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
427
427
|
*
|
428
|
-
* This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/
|
428
|
+
* This method sends a request to the [Update Outbound Item](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidoutbounditemsaction_id)
|
429
429
|
* API route.
|
430
430
|
*
|
431
431
|
* @param id - The exchange's ID.
|
@@ -454,7 +454,7 @@ class Exchange {
|
|
454
454
|
* This method adds an outbound shipping method to an exchange. The outbound shipping method
|
455
455
|
* will have a `SHIPPING_ADD` action.
|
456
456
|
*
|
457
|
-
* This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/
|
457
|
+
* This method sends a request to the [Add Outbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutboundshippingmethod)
|
458
458
|
* API route.
|
459
459
|
*
|
460
460
|
* @param id - The exchange's ID.
|
@@ -486,7 +486,7 @@ class Exchange {
|
|
486
486
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
487
487
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
488
488
|
*
|
489
|
-
* This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/
|
489
|
+
* This method sends a request to the [Update Outbound Shipping](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutboundshippingmethodaction_id)
|
490
490
|
* API route.
|
491
491
|
*
|
492
492
|
* @param id - The exchange's ID.
|
@@ -523,7 +523,7 @@ class Exchange {
|
|
523
523
|
* Every shipping method has an `actions` property, whose value is an array of actions.
|
524
524
|
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
525
525
|
*
|
526
|
-
* This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/
|
526
|
+
* This method sends a request to the [Remove Outbound Shipping](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidoutboundshippingmethodaction_id)
|
527
527
|
* API route.
|
528
528
|
*
|
529
529
|
* @param id - The exchange's ID.
|
@@ -551,7 +551,7 @@ class Exchange {
|
|
551
551
|
/**
|
552
552
|
* This method confirms an exchange request, applying its changes on the associated order.
|
553
553
|
*
|
554
|
-
* This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/
|
554
|
+
* This method sends a request to the [Confirm Exchange](https://docs.medusajs.com/api/admin#exchanges_postexchangesidrequest)
|
555
555
|
* API route.
|
556
556
|
*
|
557
557
|
* @param id - The exchange's ID.
|
@@ -576,7 +576,7 @@ class Exchange {
|
|
576
576
|
}
|
577
577
|
/**
|
578
578
|
* This method cancels an exchange request. It sends a request to the
|
579
|
-
* [Cancel Exchange Request](https://docs.medusajs.com/
|
579
|
+
* [Cancel Exchange Request](https://docs.medusajs.com/api/admin#exchanges_deleteexchangesidrequest)
|
580
580
|
* API route.
|
581
581
|
*
|
582
582
|
* @param id - The exchange's ID.
|
@@ -12,7 +12,7 @@ export declare class FulfillmentProvider {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This method retrieves a paginated list of fulfillment providers. It sends a request to the
|
15
|
-
* [List Fulfillment Providers](https://docs.medusajs.com/
|
15
|
+
* [List Fulfillment Providers](https://docs.medusajs.com/api/admin#fulfillment-providers_getfulfillmentproviders)
|
16
16
|
* API route.
|
17
17
|
*
|
18
18
|
* @param query - Filters and pagination configurations.
|
@@ -55,7 +55,7 @@ export declare class FulfillmentProvider {
|
|
55
55
|
* })
|
56
56
|
* ```
|
57
57
|
*
|
58
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
58
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
59
59
|
*/
|
60
60
|
list(query?: HttpTypes.AdminFulfillmentProviderListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentProviderListResponse>;
|
61
61
|
}
|
@@ -10,7 +10,7 @@ class FulfillmentProvider {
|
|
10
10
|
}
|
11
11
|
/**
|
12
12
|
* This method retrieves a paginated list of fulfillment providers. It sends a request to the
|
13
|
-
* [List Fulfillment Providers](https://docs.medusajs.com/
|
13
|
+
* [List Fulfillment Providers](https://docs.medusajs.com/api/admin#fulfillment-providers_getfulfillmentproviders)
|
14
14
|
* API route.
|
15
15
|
*
|
16
16
|
* @param query - Filters and pagination configurations.
|
@@ -53,7 +53,7 @@ class FulfillmentProvider {
|
|
53
53
|
* })
|
54
54
|
* ```
|
55
55
|
*
|
56
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
56
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
57
57
|
*/
|
58
58
|
async list(query, headers) {
|
59
59
|
return await this.client.fetch(`/admin/fulfillment-providers`, {
|
@@ -12,7 +12,7 @@ export declare class FulfillmentSet {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This method deletes a fulfillment set. It sends a request to the
|
15
|
-
* [Delete Fulfillment Set](https://docs.medusajs.com/
|
15
|
+
* [Delete Fulfillment Set](https://docs.medusajs.com/api/admin#fulfillment-sets_deletefulfillmentsetsid)
|
16
16
|
* API route.
|
17
17
|
*
|
18
18
|
* @param id - The fulfillment set's ID.
|
@@ -28,7 +28,7 @@ export declare class FulfillmentSet {
|
|
28
28
|
delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentSetDeleteResponse>;
|
29
29
|
/**
|
30
30
|
* This method adds a service zone to a fulfillment set. It uses the
|
31
|
-
* [Add Service Zone](https://docs.medusajs.com/
|
31
|
+
* [Add Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezones)
|
32
32
|
* API route.
|
33
33
|
*
|
34
34
|
* @param id - The fulfillment set's ID.
|
@@ -52,7 +52,7 @@ export declare class FulfillmentSet {
|
|
52
52
|
createServiceZone(id: string, body: HttpTypes.AdminCreateFulfillmentSetServiceZone, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentSetResponse>;
|
53
53
|
/**
|
54
54
|
* This method retrieves a fulfillment set's service zone's details. It sends a request to the
|
55
|
-
* [Get Service Zone](https://docs.medusajs.com/
|
55
|
+
* [Get Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_getfulfillmentsetsidservicezoneszone_id)
|
56
56
|
* API route.
|
57
57
|
*
|
58
58
|
* @param fulfillmentSetId - The fulfillment set's ID.
|
@@ -89,12 +89,12 @@ export declare class FulfillmentSet {
|
|
89
89
|
* })
|
90
90
|
* ```
|
91
91
|
*
|
92
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
92
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
93
93
|
*/
|
94
94
|
retrieveServiceZone(fulfillmentSetId: string, serviceZoneId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminServiceZoneResponse>;
|
95
95
|
/**
|
96
96
|
* This method updates a service zone in a fulfillment set. It sends a request to the
|
97
|
-
* [Update Service Zone](https://docs.medusajs.com/
|
97
|
+
* [Update Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezoneszone_id)
|
98
98
|
* API route.
|
99
99
|
*
|
100
100
|
* @param fulfillmentSetId - The fulfillment set's ID.
|
@@ -119,7 +119,7 @@ export declare class FulfillmentSet {
|
|
119
119
|
updateServiceZone(fulfillmentSetId: string, serviceZoneId: string, body: HttpTypes.AdminUpdateFulfillmentSetServiceZone, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentSetResponse>;
|
120
120
|
/**
|
121
121
|
* This method deletes a service zone in a fulfillment set. It sends a request to the
|
122
|
-
* [Remove Service Zone](https://docs.medusajs.com/
|
122
|
+
* [Remove Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_deletefulfillmentsetsidservicezoneszone_id)
|
123
123
|
* API route.
|
124
124
|
*
|
125
125
|
* @param fulfillmentSetId - The fulfullment set's ID.
|
@@ -10,7 +10,7 @@ class FulfillmentSet {
|
|
10
10
|
}
|
11
11
|
/**
|
12
12
|
* This method deletes a fulfillment set. It sends a request to the
|
13
|
-
* [Delete Fulfillment Set](https://docs.medusajs.com/
|
13
|
+
* [Delete Fulfillment Set](https://docs.medusajs.com/api/admin#fulfillment-sets_deletefulfillmentsetsid)
|
14
14
|
* API route.
|
15
15
|
*
|
16
16
|
* @param id - The fulfillment set's ID.
|
@@ -31,7 +31,7 @@ class FulfillmentSet {
|
|
31
31
|
}
|
32
32
|
/**
|
33
33
|
* This method adds a service zone to a fulfillment set. It uses the
|
34
|
-
* [Add Service Zone](https://docs.medusajs.com/
|
34
|
+
* [Add Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezones)
|
35
35
|
* API route.
|
36
36
|
*
|
37
37
|
* @param id - The fulfillment set's ID.
|
@@ -62,7 +62,7 @@ class FulfillmentSet {
|
|
62
62
|
}
|
63
63
|
/**
|
64
64
|
* This method retrieves a fulfillment set's service zone's details. It sends a request to the
|
65
|
-
* [Get Service Zone](https://docs.medusajs.com/
|
65
|
+
* [Get Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_getfulfillmentsetsidservicezoneszone_id)
|
66
66
|
* API route.
|
67
67
|
*
|
68
68
|
* @param fulfillmentSetId - The fulfillment set's ID.
|
@@ -99,7 +99,7 @@ class FulfillmentSet {
|
|
99
99
|
* })
|
100
100
|
* ```
|
101
101
|
*
|
102
|
-
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/
|
102
|
+
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
|
103
103
|
*/
|
104
104
|
async retrieveServiceZone(fulfillmentSetId, serviceZoneId, query, headers) {
|
105
105
|
return await this.client.fetch(`/admin/fulfillment-sets/${fulfillmentSetId}/service-zones/${serviceZoneId}`, {
|
@@ -110,7 +110,7 @@ class FulfillmentSet {
|
|
110
110
|
}
|
111
111
|
/**
|
112
112
|
* This method updates a service zone in a fulfillment set. It sends a request to the
|
113
|
-
* [Update Service Zone](https://docs.medusajs.com/
|
113
|
+
* [Update Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_postfulfillmentsetsidservicezoneszone_id)
|
114
114
|
* API route.
|
115
115
|
*
|
116
116
|
* @param fulfillmentSetId - The fulfillment set's ID.
|
@@ -142,7 +142,7 @@ class FulfillmentSet {
|
|
142
142
|
}
|
143
143
|
/**
|
144
144
|
* This method deletes a service zone in a fulfillment set. It sends a request to the
|
145
|
-
* [Remove Service Zone](https://docs.medusajs.com/
|
145
|
+
* [Remove Service Zone](https://docs.medusajs.com/api/admin#fulfillment-sets_deletefulfillmentsetsidservicezoneszone_id)
|
146
146
|
* API route.
|
147
147
|
*
|
148
148
|
* @param fulfillmentSetId - The fulfullment set's ID.
|
@@ -12,7 +12,7 @@ export declare class Fulfillment {
|
|
12
12
|
constructor(client: Client);
|
13
13
|
/**
|
14
14
|
* This method creates a fulfillment. It sends a request to the
|
15
|
-
* [Create Fulfillment](https://docs.medusajs.com/
|
15
|
+
* [Create Fulfillment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillments)
|
16
16
|
* API route.
|
17
17
|
*
|
18
18
|
* @param body - The fulfillment's details.
|
@@ -46,7 +46,7 @@ export declare class Fulfillment {
|
|
46
46
|
create(body: HttpTypes.AdminCreateFulfillment, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentResponse>;
|
47
47
|
/**
|
48
48
|
* This method cancels a fulfillment. It sends a request to the
|
49
|
-
* [Cancel Fulfillment](https://docs.medusajs.com/
|
49
|
+
* [Cancel Fulfillment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillmentsidcancel)
|
50
50
|
* API route.
|
51
51
|
*
|
52
52
|
* @param id - The fulfillment's ID.
|
@@ -63,7 +63,7 @@ export declare class Fulfillment {
|
|
63
63
|
cancel(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFulfillmentResponse>;
|
64
64
|
/**
|
65
65
|
* This method creates a shipment for a fulfillment. It sends a request to the
|
66
|
-
* [Create Shipment](https://docs.medusajs.com/
|
66
|
+
* [Create Shipment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillmentsidshipment)
|
67
67
|
* API route.
|
68
68
|
*
|
69
69
|
* @param id - The fulfillment's ID.
|
@@ -10,7 +10,7 @@ class Fulfillment {
|
|
10
10
|
}
|
11
11
|
/**
|
12
12
|
* This method creates a fulfillment. It sends a request to the
|
13
|
-
* [Create Fulfillment](https://docs.medusajs.com/
|
13
|
+
* [Create Fulfillment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillments)
|
14
14
|
* API route.
|
15
15
|
*
|
16
16
|
* @param body - The fulfillment's details.
|
@@ -51,7 +51,7 @@ class Fulfillment {
|
|
51
51
|
}
|
52
52
|
/**
|
53
53
|
* This method cancels a fulfillment. It sends a request to the
|
54
|
-
* [Cancel Fulfillment](https://docs.medusajs.com/
|
54
|
+
* [Cancel Fulfillment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillmentsidcancel)
|
55
55
|
* API route.
|
56
56
|
*
|
57
57
|
* @param id - The fulfillment's ID.
|
@@ -75,7 +75,7 @@ class Fulfillment {
|
|
75
75
|
}
|
76
76
|
/**
|
77
77
|
* This method creates a shipment for a fulfillment. It sends a request to the
|
78
|
-
* [Create Shipment](https://docs.medusajs.com/
|
78
|
+
* [Create Shipment](https://docs.medusajs.com/api/admin#fulfillments_postfulfillmentsidshipment)
|
79
79
|
* API route.
|
80
80
|
*
|
81
81
|
* @param id - The fulfillment's ID.
|