@acmekit/js-sdk 2.13.2 → 2.13.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/admin/index.d.ts +2 -177
- package/dist/admin/index.d.ts.map +1 -1
- package/dist/admin/index.js +3 -76
- package/dist/admin/index.js.map +1 -1
- package/dist/esm/admin/index.d.ts +2 -177
- package/dist/esm/admin/index.d.ts.map +1 -1
- package/dist/esm/admin/index.js +3 -73
- package/dist/esm/admin/index.js.map +1 -1
- package/dist/esm/store/index.d.ts +5 -1193
- package/dist/esm/store/index.d.ts.map +1 -1
- package/dist/esm/store/index.js +6 -1418
- package/dist/esm/store/index.js.map +1 -1
- package/dist/store/index.d.ts +5 -1193
- package/dist/store/index.d.ts.map +1 -1
- package/dist/store/index.js +6 -1408
- package/dist/store/index.js.map +1 -1
- package/package.json +2 -2
- package/dist/admin/campaign.d.ts +0 -164
- package/dist/admin/campaign.d.ts.map +0 -1
- package/dist/admin/campaign.js +0 -196
- package/dist/admin/campaign.js.map +0 -1
- package/dist/admin/claim.d.ts +0 -558
- package/dist/admin/claim.d.ts.map +0 -1
- package/dist/admin/claim.js +0 -693
- package/dist/admin/claim.js.map +0 -1
- package/dist/admin/currency.d.ts +0 -95
- package/dist/admin/currency.d.ts.map +0 -1
- package/dist/admin/currency.js +0 -104
- package/dist/admin/currency.js.map +0 -1
- package/dist/admin/draft-order.d.ts +0 -430
- package/dist/admin/draft-order.d.ts.map +0 -1
- package/dist/admin/draft-order.js +0 -547
- package/dist/admin/draft-order.js.map +0 -1
- package/dist/admin/exchange.d.ts +0 -487
- package/dist/admin/exchange.d.ts.map +0 -1
- package/dist/admin/exchange.js +0 -602
- package/dist/admin/exchange.js.map +0 -1
- package/dist/admin/fulfillment-provider.d.ts +0 -78
- package/dist/admin/fulfillment-provider.d.ts.map +0 -1
- package/dist/admin/fulfillment-provider.js +0 -88
- package/dist/admin/fulfillment-provider.js.map +0 -1
- package/dist/admin/fulfillment-set.d.ts +0 -141
- package/dist/admin/fulfillment-set.d.ts.map +0 -1
- package/dist/admin/fulfillment-set.js +0 -170
- package/dist/admin/fulfillment-set.js.map +0 -1
- package/dist/admin/fulfillment.d.ts +0 -91
- package/dist/admin/fulfillment.d.ts.map +0 -1
- package/dist/admin/fulfillment.js +0 -111
- package/dist/admin/fulfillment.js.map +0 -1
- package/dist/admin/inventory-item.d.ts +0 -320
- package/dist/admin/inventory-item.d.ts.map +0 -1
- package/dist/admin/inventory-item.js +0 -384
- package/dist/admin/inventory-item.js.map +0 -1
- package/dist/admin/order-edit.d.ts +0 -189
- package/dist/admin/order-edit.d.ts.map +0 -1
- package/dist/admin/order-edit.js +0 -240
- package/dist/admin/order-edit.js.map +0 -1
- package/dist/admin/order.d.ts +0 -452
- package/dist/admin/order.d.ts.map +0 -1
- package/dist/admin/order.js +0 -560
- package/dist/admin/order.js.map +0 -1
- package/dist/admin/payment-collection.d.ts +0 -72
- package/dist/admin/payment-collection.d.ts.map +0 -1
- package/dist/admin/payment-collection.js +0 -90
- package/dist/admin/payment-collection.js.map +0 -1
- package/dist/admin/payment.d.ts +0 -180
- package/dist/admin/payment.d.ts.map +0 -1
- package/dist/admin/payment.js +0 -208
- package/dist/admin/payment.js.map +0 -1
- package/dist/admin/price-list.d.ts +0 -234
- package/dist/admin/price-list.d.ts.map +0 -1
- package/dist/admin/price-list.js +0 -284
- package/dist/admin/price-list.js.map +0 -1
- package/dist/admin/price-preference.d.ts +0 -152
- package/dist/admin/price-preference.d.ts.map +0 -1
- package/dist/admin/price-preference.js +0 -182
- package/dist/admin/price-preference.js.map +0 -1
- package/dist/admin/product-category.d.ts +0 -170
- package/dist/admin/product-category.d.ts.map +0 -1
- package/dist/admin/product-category.js +0 -205
- package/dist/admin/product-category.js.map +0 -1
- package/dist/admin/product-collection.d.ts +0 -169
- package/dist/admin/product-collection.d.ts.map +0 -1
- package/dist/admin/product-collection.js +0 -203
- package/dist/admin/product-collection.js.map +0 -1
- package/dist/admin/product-tag.d.ts +0 -149
- package/dist/admin/product-tag.d.ts.map +0 -1
- package/dist/admin/product-tag.js +0 -177
- package/dist/admin/product-tag.js.map +0 -1
- package/dist/admin/product-type.d.ts +0 -150
- package/dist/admin/product-type.d.ts.map +0 -1
- package/dist/admin/product-type.js +0 -178
- package/dist/admin/product-type.js.map +0 -1
- package/dist/admin/product-variant.d.ts +0 -62
- package/dist/admin/product-variant.d.ts.map +0 -1
- package/dist/admin/product-variant.js +0 -66
- package/dist/admin/product-variant.js.map +0 -1
- package/dist/admin/product.d.ts +0 -740
- package/dist/admin/product.d.ts.map +0 -1
- package/dist/admin/product.js +0 -948
- package/dist/admin/product.js.map +0 -1
- package/dist/admin/promotion.d.ts +0 -310
- package/dist/admin/promotion.d.ts.map +0 -1
- package/dist/admin/promotion.js +0 -374
- package/dist/admin/promotion.js.map +0 -1
- package/dist/admin/refund-reasons.d.ts +0 -163
- package/dist/admin/refund-reasons.d.ts.map +0 -1
- package/dist/admin/refund-reasons.js +0 -192
- package/dist/admin/refund-reasons.js.map +0 -1
- package/dist/admin/region.d.ts +0 -152
- package/dist/admin/region.d.ts.map +0 -1
- package/dist/admin/region.js +0 -180
- package/dist/admin/region.js.map +0 -1
- package/dist/admin/reservation.d.ts +0 -154
- package/dist/admin/reservation.d.ts.map +0 -1
- package/dist/admin/reservation.js +0 -182
- package/dist/admin/reservation.js.map +0 -1
- package/dist/admin/return-reason.d.ts +0 -154
- package/dist/admin/return-reason.d.ts.map +0 -1
- package/dist/admin/return-reason.js +0 -183
- package/dist/admin/return-reason.js.map +0 -1
- package/dist/admin/return.d.ts +0 -558
- package/dist/admin/return.d.ts.map +0 -1
- package/dist/admin/return.js +0 -700
- package/dist/admin/return.js.map +0 -1
- package/dist/admin/sales-channel.d.ts +0 -196
- package/dist/admin/sales-channel.d.ts.map +0 -1
- package/dist/admin/sales-channel.js +0 -238
- package/dist/admin/sales-channel.js.map +0 -1
- package/dist/admin/shipping-option-type.d.ts +0 -152
- package/dist/admin/shipping-option-type.d.ts.map +0 -1
- package/dist/admin/shipping-option-type.js +0 -180
- package/dist/admin/shipping-option-type.js.map +0 -1
- package/dist/admin/shipping-option.d.ts +0 -171
- package/dist/admin/shipping-option.d.ts.map +0 -1
- package/dist/admin/shipping-option.js +0 -207
- package/dist/admin/shipping-option.js.map +0 -1
- package/dist/admin/shipping-profile.d.ts +0 -151
- package/dist/admin/shipping-profile.d.ts.map +0 -1
- package/dist/admin/shipping-profile.js +0 -181
- package/dist/admin/shipping-profile.js.map +0 -1
- package/dist/admin/stock-location.d.ts +0 -212
- package/dist/admin/stock-location.d.ts.map +0 -1
- package/dist/admin/stock-location.js +0 -260
- package/dist/admin/stock-location.js.map +0 -1
- package/dist/admin/tax-provider.d.ts +0 -64
- package/dist/admin/tax-provider.d.ts.map +0 -1
- package/dist/admin/tax-provider.js +0 -70
- package/dist/admin/tax-provider.js.map +0 -1
- package/dist/admin/tax-rate.d.ts +0 -155
- package/dist/admin/tax-rate.d.ts.map +0 -1
- package/dist/admin/tax-rate.js +0 -186
- package/dist/admin/tax-rate.js.map +0 -1
- package/dist/admin/tax-region.d.ts +0 -165
- package/dist/admin/tax-region.d.ts.map +0 -1
- package/dist/admin/tax-region.js +0 -196
- package/dist/admin/tax-region.js.map +0 -1
- package/dist/esm/admin/campaign.d.ts +0 -164
- package/dist/esm/admin/campaign.d.ts.map +0 -1
- package/dist/esm/admin/campaign.js +0 -213
- package/dist/esm/admin/campaign.js.map +0 -1
- package/dist/esm/admin/claim.d.ts +0 -558
- package/dist/esm/admin/claim.d.ts.map +0 -1
- package/dist/esm/admin/claim.js +0 -740
- package/dist/esm/admin/claim.js.map +0 -1
- package/dist/esm/admin/currency.d.ts +0 -95
- package/dist/esm/admin/currency.d.ts.map +0 -1
- package/dist/esm/admin/currency.js +0 -113
- package/dist/esm/admin/currency.js.map +0 -1
- package/dist/esm/admin/draft-order.d.ts +0 -430
- package/dist/esm/admin/draft-order.d.ts.map +0 -1
- package/dist/esm/admin/draft-order.js +0 -594
- package/dist/esm/admin/draft-order.js.map +0 -1
- package/dist/esm/admin/exchange.d.ts +0 -487
- package/dist/esm/admin/exchange.d.ts.map +0 -1
- package/dist/esm/admin/exchange.js +0 -643
- package/dist/esm/admin/exchange.js.map +0 -1
- package/dist/esm/admin/fulfillment-provider.d.ts +0 -78
- package/dist/esm/admin/fulfillment-provider.d.ts.map +0 -1
- package/dist/esm/admin/fulfillment-provider.js +0 -97
- package/dist/esm/admin/fulfillment-provider.js.map +0 -1
- package/dist/esm/admin/fulfillment-set.d.ts +0 -141
- package/dist/esm/admin/fulfillment-set.d.ts.map +0 -1
- package/dist/esm/admin/fulfillment-set.js +0 -185
- package/dist/esm/admin/fulfillment-set.js.map +0 -1
- package/dist/esm/admin/fulfillment.d.ts +0 -91
- package/dist/esm/admin/fulfillment.d.ts.map +0 -1
- package/dist/esm/admin/fulfillment.js +0 -122
- package/dist/esm/admin/fulfillment.js.map +0 -1
- package/dist/esm/admin/inventory-item.d.ts +0 -320
- package/dist/esm/admin/inventory-item.d.ts.map +0 -1
- package/dist/esm/admin/inventory-item.js +0 -411
- package/dist/esm/admin/inventory-item.js.map +0 -1
- package/dist/esm/admin/order-edit.d.ts +0 -189
- package/dist/esm/admin/order-edit.d.ts.map +0 -1
- package/dist/esm/admin/order-edit.js +0 -261
- package/dist/esm/admin/order-edit.js.map +0 -1
- package/dist/esm/admin/order.d.ts +0 -452
- package/dist/esm/admin/order.d.ts.map +0 -1
- package/dist/esm/admin/order.js +0 -603
- package/dist/esm/admin/order.js.map +0 -1
- package/dist/esm/admin/payment-collection.d.ts +0 -72
- package/dist/esm/admin/payment-collection.d.ts.map +0 -1
- package/dist/esm/admin/payment-collection.js +0 -101
- package/dist/esm/admin/payment-collection.js.map +0 -1
- package/dist/esm/admin/payment.d.ts +0 -180
- package/dist/esm/admin/payment.d.ts.map +0 -1
- package/dist/esm/admin/payment.js +0 -223
- package/dist/esm/admin/payment.js.map +0 -1
- package/dist/esm/admin/price-list.d.ts +0 -234
- package/dist/esm/admin/price-list.d.ts.map +0 -1
- package/dist/esm/admin/price-list.js +0 -305
- package/dist/esm/admin/price-list.js.map +0 -1
- package/dist/esm/admin/price-preference.d.ts +0 -152
- package/dist/esm/admin/price-preference.d.ts.map +0 -1
- package/dist/esm/admin/price-preference.js +0 -197
- package/dist/esm/admin/price-preference.js.map +0 -1
- package/dist/esm/admin/product-category.d.ts +0 -170
- package/dist/esm/admin/product-category.d.ts.map +0 -1
- package/dist/esm/admin/product-category.js +0 -222
- package/dist/esm/admin/product-category.js.map +0 -1
- package/dist/esm/admin/product-collection.d.ts +0 -169
- package/dist/esm/admin/product-collection.d.ts.map +0 -1
- package/dist/esm/admin/product-collection.js +0 -220
- package/dist/esm/admin/product-collection.js.map +0 -1
- package/dist/esm/admin/product-tag.d.ts +0 -149
- package/dist/esm/admin/product-tag.d.ts.map +0 -1
- package/dist/esm/admin/product-tag.js +0 -192
- package/dist/esm/admin/product-tag.js.map +0 -1
- package/dist/esm/admin/product-type.d.ts +0 -150
- package/dist/esm/admin/product-type.d.ts.map +0 -1
- package/dist/esm/admin/product-type.js +0 -193
- package/dist/esm/admin/product-type.js.map +0 -1
- package/dist/esm/admin/product-variant.d.ts +0 -62
- package/dist/esm/admin/product-variant.d.ts.map +0 -1
- package/dist/esm/admin/product-variant.js +0 -73
- package/dist/esm/admin/product-variant.js.map +0 -1
- package/dist/esm/admin/product.d.ts +0 -740
- package/dist/esm/admin/product.d.ts.map +0 -1
- package/dist/esm/admin/product.js +0 -995
- package/dist/esm/admin/product.js.map +0 -1
- package/dist/esm/admin/promotion.d.ts +0 -310
- package/dist/esm/admin/promotion.d.ts.map +0 -1
- package/dist/esm/admin/promotion.js +0 -401
- package/dist/esm/admin/promotion.js.map +0 -1
- package/dist/esm/admin/refund-reasons.d.ts +0 -163
- package/dist/esm/admin/refund-reasons.d.ts.map +0 -1
- package/dist/esm/admin/refund-reasons.js +0 -207
- package/dist/esm/admin/refund-reasons.js.map +0 -1
- package/dist/esm/admin/region.d.ts +0 -152
- package/dist/esm/admin/region.d.ts.map +0 -1
- package/dist/esm/admin/region.js +0 -195
- package/dist/esm/admin/region.js.map +0 -1
- package/dist/esm/admin/reservation.d.ts +0 -154
- package/dist/esm/admin/reservation.d.ts.map +0 -1
- package/dist/esm/admin/reservation.js +0 -199
- package/dist/esm/admin/reservation.js.map +0 -1
- package/dist/esm/admin/return-reason.d.ts +0 -154
- package/dist/esm/admin/return-reason.d.ts.map +0 -1
- package/dist/esm/admin/return-reason.js +0 -198
- package/dist/esm/admin/return-reason.js.map +0 -1
- package/dist/esm/admin/return.d.ts +0 -558
- package/dist/esm/admin/return.d.ts.map +0 -1
- package/dist/esm/admin/return.js +0 -749
- package/dist/esm/admin/return.js.map +0 -1
- package/dist/esm/admin/sales-channel.d.ts +0 -196
- package/dist/esm/admin/sales-channel.d.ts.map +0 -1
- package/dist/esm/admin/sales-channel.js +0 -257
- package/dist/esm/admin/sales-channel.js.map +0 -1
- package/dist/esm/admin/shipping-option-type.d.ts +0 -152
- package/dist/esm/admin/shipping-option-type.d.ts.map +0 -1
- package/dist/esm/admin/shipping-option-type.js +0 -195
- package/dist/esm/admin/shipping-option-type.js.map +0 -1
- package/dist/esm/admin/shipping-option.d.ts +0 -171
- package/dist/esm/admin/shipping-option.d.ts.map +0 -1
- package/dist/esm/admin/shipping-option.js +0 -224
- package/dist/esm/admin/shipping-option.js.map +0 -1
- package/dist/esm/admin/shipping-profile.d.ts +0 -151
- package/dist/esm/admin/shipping-profile.d.ts.map +0 -1
- package/dist/esm/admin/shipping-profile.js +0 -196
- package/dist/esm/admin/shipping-profile.js.map +0 -1
- package/dist/esm/admin/stock-location.d.ts +0 -212
- package/dist/esm/admin/stock-location.d.ts.map +0 -1
- package/dist/esm/admin/stock-location.js +0 -281
- package/dist/esm/admin/stock-location.js.map +0 -1
- package/dist/esm/admin/tax-provider.d.ts +0 -64
- package/dist/esm/admin/tax-provider.d.ts.map +0 -1
- package/dist/esm/admin/tax-provider.js +0 -77
- package/dist/esm/admin/tax-provider.js.map +0 -1
- package/dist/esm/admin/tax-rate.d.ts +0 -155
- package/dist/esm/admin/tax-rate.d.ts.map +0 -1
- package/dist/esm/admin/tax-rate.js +0 -201
- package/dist/esm/admin/tax-rate.js.map +0 -1
- package/dist/esm/admin/tax-region.d.ts +0 -165
- package/dist/esm/admin/tax-region.d.ts.map +0 -1
- package/dist/esm/admin/tax-region.js +0 -211
- package/dist/esm/admin/tax-region.js.map +0 -1
|
@@ -1,384 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.InventoryItem = void 0;
|
|
4
|
-
class InventoryItem {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
constructor(client) {
|
|
9
|
-
this.client = client;
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* This method creates an inventory item. It sends a request to the
|
|
13
|
-
* [Create Inventory Item](https://docs.acmekit.com/api/admin#inventory-items_postinventoryitems)
|
|
14
|
-
* API route.
|
|
15
|
-
*
|
|
16
|
-
* @param body - The inventory item's details.
|
|
17
|
-
* @param query - Configure the fields to retrieve in the inventory item.
|
|
18
|
-
* @param headers - Headers to pass in the request.
|
|
19
|
-
* @returns The inventory item's details.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* sdk.admin.inventoryItem.create({
|
|
23
|
-
* sku: "SHIRT"
|
|
24
|
-
* })
|
|
25
|
-
* .then(({ inventory_item }) => {
|
|
26
|
-
* console.log(inventory_item)
|
|
27
|
-
* })
|
|
28
|
-
*/
|
|
29
|
-
async create(body, query, headers) {
|
|
30
|
-
return await this.client.fetch(`/admin/inventory-items`, {
|
|
31
|
-
method: "POST",
|
|
32
|
-
headers,
|
|
33
|
-
body,
|
|
34
|
-
query,
|
|
35
|
-
});
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* This method updates an inventory level. It sends a request to the
|
|
39
|
-
* [Update Inventory Item](https://docs.acmekit.com/api/admin#inventory-items_postinventoryitemsid)
|
|
40
|
-
* API route.
|
|
41
|
-
*
|
|
42
|
-
* @param id - The inventory item's ID.
|
|
43
|
-
* @param body - The data to update.
|
|
44
|
-
* @param query - Configure the fields to retrieve in the inventory item.
|
|
45
|
-
* @param headers - Headers to pass in the request.
|
|
46
|
-
* @returns The inventory item's details.
|
|
47
|
-
*
|
|
48
|
-
* @example
|
|
49
|
-
* sdk.admin.inventoryItem.update("iitem_123", {
|
|
50
|
-
* sku: "SHIRT"
|
|
51
|
-
* })
|
|
52
|
-
* .then(({ inventory_item }) => {
|
|
53
|
-
* console.log(inventory_item)
|
|
54
|
-
* })
|
|
55
|
-
*/
|
|
56
|
-
async update(id, body, query, headers) {
|
|
57
|
-
return await this.client.fetch(`/admin/inventory-items/${id}`, {
|
|
58
|
-
method: "POST",
|
|
59
|
-
headers,
|
|
60
|
-
body,
|
|
61
|
-
query,
|
|
62
|
-
});
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* This method retrieves a paginated list of inventory items. It sends a request to the
|
|
66
|
-
* [List Inventory Items](https://docs.acmekit.com/api/admin#inventory-items_getinventoryitems)
|
|
67
|
-
* API route.
|
|
68
|
-
*
|
|
69
|
-
* @param query - Filters and pagination configurations.
|
|
70
|
-
* @param headers - Headers to pass in the request.
|
|
71
|
-
* @returns The paginated list of inventory items.
|
|
72
|
-
*
|
|
73
|
-
* @example
|
|
74
|
-
* To retrieve the list of inventory items:
|
|
75
|
-
*
|
|
76
|
-
* ```ts
|
|
77
|
-
* sdk.admin.inventoryItem.list()
|
|
78
|
-
* .then(({ inventory_items, count, limit, offset }) => {
|
|
79
|
-
* console.log(inventory_items)
|
|
80
|
-
* })
|
|
81
|
-
* ```
|
|
82
|
-
*
|
|
83
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
84
|
-
*
|
|
85
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
86
|
-
*
|
|
87
|
-
* ```ts
|
|
88
|
-
* sdk.admin.inventoryItem.list({
|
|
89
|
-
* limit: 10,
|
|
90
|
-
* offset: 10
|
|
91
|
-
* })
|
|
92
|
-
* .then(({ inventory_items, count, limit, offset }) => {
|
|
93
|
-
* console.log(inventory_items)
|
|
94
|
-
* })
|
|
95
|
-
* ```
|
|
96
|
-
*
|
|
97
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
98
|
-
* in each inventory item:
|
|
99
|
-
*
|
|
100
|
-
* ```ts
|
|
101
|
-
* sdk.admin.inventoryItem.list({
|
|
102
|
-
* fields: "id,*location_levels"
|
|
103
|
-
* })
|
|
104
|
-
* .then(({ inventory_items, count, limit, offset }) => {
|
|
105
|
-
* console.log(inventory_items)
|
|
106
|
-
* })
|
|
107
|
-
* ```
|
|
108
|
-
*
|
|
109
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
110
|
-
*/
|
|
111
|
-
async list(query, headers) {
|
|
112
|
-
return await this.client.fetch(`/admin/inventory-items`, {
|
|
113
|
-
query,
|
|
114
|
-
headers,
|
|
115
|
-
});
|
|
116
|
-
}
|
|
117
|
-
/**
|
|
118
|
-
* This method retrieves an inventory item by its ID. It sends a request to the
|
|
119
|
-
* [Get Inventory Item](https://docs.acmekit.com/api/admin#inventory-items_getinventoryitemsid) API route.
|
|
120
|
-
*
|
|
121
|
-
* @param id - The inventory item's ID.
|
|
122
|
-
* @param query - Configure the fields to retrieve in the inventory item.
|
|
123
|
-
* @param headers - Headers to pass in the request
|
|
124
|
-
* @returns The inventory item's details.
|
|
125
|
-
*
|
|
126
|
-
* @example
|
|
127
|
-
* To retrieve an inventory item by its ID:
|
|
128
|
-
*
|
|
129
|
-
* ```ts
|
|
130
|
-
* sdk.admin.inventoryItem.retrieve("iitem_123")
|
|
131
|
-
* .then(({ inventory_item }) => {
|
|
132
|
-
* console.log(inventory_item)
|
|
133
|
-
* })
|
|
134
|
-
* ```
|
|
135
|
-
*
|
|
136
|
-
* To specify the fields and relations to retrieve:
|
|
137
|
-
*
|
|
138
|
-
* ```ts
|
|
139
|
-
* sdk.admin.inventoryItem.retrieve("iitem_123", {
|
|
140
|
-
* fields: "id,*location_levels"
|
|
141
|
-
* })
|
|
142
|
-
* .then(({ inventory_item }) => {
|
|
143
|
-
* console.log(inventory_item)
|
|
144
|
-
* })
|
|
145
|
-
* ```
|
|
146
|
-
*
|
|
147
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
148
|
-
*/
|
|
149
|
-
async retrieve(id, query, headers) {
|
|
150
|
-
return await this.client.fetch(`/admin/inventory-items/${id}`, {
|
|
151
|
-
query,
|
|
152
|
-
headers,
|
|
153
|
-
});
|
|
154
|
-
}
|
|
155
|
-
/**
|
|
156
|
-
* This method deletes an inventory item. This sends a request to the
|
|
157
|
-
* [Delete Inventory Item](https://docs.acmekit.com/api/admin#inventory-items_deleteinventoryitemsid)
|
|
158
|
-
* API route.
|
|
159
|
-
*
|
|
160
|
-
* @param id - The inventory item's ID.
|
|
161
|
-
* @param headers - Headers to pass in the request
|
|
162
|
-
* @returns The deletion's details.
|
|
163
|
-
*
|
|
164
|
-
* @example
|
|
165
|
-
* sdk.admin.inventoryItem.delete("iitem_123")
|
|
166
|
-
* .then(({ deleted }) => {
|
|
167
|
-
* console.log(deleted)
|
|
168
|
-
* })
|
|
169
|
-
*/
|
|
170
|
-
async delete(id, headers) {
|
|
171
|
-
return await this.client.fetch(`/admin/inventory-items/${id}`, {
|
|
172
|
-
method: "DELETE",
|
|
173
|
-
headers,
|
|
174
|
-
});
|
|
175
|
-
}
|
|
176
|
-
/**
|
|
177
|
-
* This method retrieves a paginated list of inventory levels that belong to an inventory item.
|
|
178
|
-
* It sends a request to the [List Inventory Items](https://docs.acmekit.com/api/admin#inventory-items_getinventoryitems)
|
|
179
|
-
* API route.
|
|
180
|
-
*
|
|
181
|
-
* @param id - The inventory item's ID.
|
|
182
|
-
* @param query - Filters and pagination configurations.
|
|
183
|
-
* @param headers - Headers to pass in the request.
|
|
184
|
-
* @returns The paginated list of inventory levels.
|
|
185
|
-
*
|
|
186
|
-
* @example
|
|
187
|
-
* To retrieve the list of inventory levels:
|
|
188
|
-
*
|
|
189
|
-
* ```ts
|
|
190
|
-
* sdk.admin.inventoryItem.listLevels("iitem_123")
|
|
191
|
-
* .then(({ inventory_levels, count, limit, offset }) => {
|
|
192
|
-
* console.log(inventory_levels)
|
|
193
|
-
* })
|
|
194
|
-
* ```
|
|
195
|
-
*
|
|
196
|
-
* To configure the pagination, pass the `limit` and `offset` query parameters.
|
|
197
|
-
*
|
|
198
|
-
* For example, to retrieve only 10 items and skip 10 items:
|
|
199
|
-
*
|
|
200
|
-
* ```ts
|
|
201
|
-
* sdk.admin.inventoryItem.listLevels("iitem_123", {
|
|
202
|
-
* limit: 10,
|
|
203
|
-
* offset: 10
|
|
204
|
-
* })
|
|
205
|
-
* .then(({ inventory_levels, count, limit, offset }) => {
|
|
206
|
-
* console.log(inventory_levels)
|
|
207
|
-
* })
|
|
208
|
-
* ```
|
|
209
|
-
*
|
|
210
|
-
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
|
|
211
|
-
* in each inventory level:
|
|
212
|
-
*
|
|
213
|
-
* ```ts
|
|
214
|
-
* sdk.admin.inventoryItem.listLevels("iitem_123", {
|
|
215
|
-
* fields: "id,*inventory_item"
|
|
216
|
-
* })
|
|
217
|
-
* .then(({ inventory_levels, count, limit, offset }) => {
|
|
218
|
-
* console.log(inventory_levels)
|
|
219
|
-
* })
|
|
220
|
-
* ```
|
|
221
|
-
*
|
|
222
|
-
* Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
|
|
223
|
-
*/
|
|
224
|
-
async listLevels(id, query, headers) {
|
|
225
|
-
return await this.client.fetch(`/admin/inventory-items/${id}/location-levels`, {
|
|
226
|
-
query,
|
|
227
|
-
headers,
|
|
228
|
-
});
|
|
229
|
-
}
|
|
230
|
-
/**
|
|
231
|
-
* This method updates the inventory level of the specified inventory item and
|
|
232
|
-
* stock location.
|
|
233
|
-
*
|
|
234
|
-
* This method sends a request to the
|
|
235
|
-
* [Update Inventory Level](https://docs.acmekit.com/api/admin#inventory-items_postinventoryitemsidlocationlevelslocation_id)
|
|
236
|
-
* API route.
|
|
237
|
-
*
|
|
238
|
-
* @param id - The inventory item's ID.
|
|
239
|
-
* @param locationId - The stock location's ID.
|
|
240
|
-
* @param body - The details to update.
|
|
241
|
-
* @param query - Configure the fields to retrieve in the inventory item.
|
|
242
|
-
* @param headers - Headers to pass in the request
|
|
243
|
-
* @returns The inventory item's details.
|
|
244
|
-
*
|
|
245
|
-
* @example
|
|
246
|
-
* sdk.admin.inventoryItem.updateLevel(
|
|
247
|
-
* "iitem_123",
|
|
248
|
-
* "sloc_123",
|
|
249
|
-
* {
|
|
250
|
-
* stocked_quantity: 10
|
|
251
|
-
* }
|
|
252
|
-
* )
|
|
253
|
-
* .then(({ inventory_item }) => {
|
|
254
|
-
* console.log(inventory_item)
|
|
255
|
-
* })
|
|
256
|
-
*/
|
|
257
|
-
async updateLevel(id, locationId, body, query, headers) {
|
|
258
|
-
return await this.client.fetch(`/admin/inventory-items/${id}/location-levels/${locationId}`, {
|
|
259
|
-
method: "POST",
|
|
260
|
-
headers,
|
|
261
|
-
body,
|
|
262
|
-
query,
|
|
263
|
-
});
|
|
264
|
-
}
|
|
265
|
-
/**
|
|
266
|
-
* This method deletes an inventory level associated with an inventory item
|
|
267
|
-
* and a stock location.
|
|
268
|
-
*
|
|
269
|
-
* This method sends a request to the
|
|
270
|
-
* [Remove Inventory Level](https://docs.acmekit.com/api/admin#inventory-items_deleteinventoryitemsidlocationlevelslocation_id)
|
|
271
|
-
* API route.
|
|
272
|
-
*
|
|
273
|
-
* @param id - The inventory item's ID.
|
|
274
|
-
* @param locationId - The stock location's ID.
|
|
275
|
-
* @param headers - Headers to pass in the request
|
|
276
|
-
* @returns The deletion's details.
|
|
277
|
-
*
|
|
278
|
-
* @example
|
|
279
|
-
* sdk.admin.inventoryItem.deleteLevel(
|
|
280
|
-
* "iitem_123",
|
|
281
|
-
* "sloc_123",
|
|
282
|
-
* )
|
|
283
|
-
* .then(({ deleted, parent: inventoryItem }) => {
|
|
284
|
-
* console.log(deleted, inventoryItem)
|
|
285
|
-
* })
|
|
286
|
-
*/
|
|
287
|
-
async deleteLevel(id, locationId, headers) {
|
|
288
|
-
return await this.client.fetch(`/admin/inventory-items/${id}/location-levels/${locationId}`, {
|
|
289
|
-
method: "DELETE",
|
|
290
|
-
headers,
|
|
291
|
-
});
|
|
292
|
-
}
|
|
293
|
-
/**
|
|
294
|
-
* This method manages the inventory levels of an inventory item. It sends a request to the
|
|
295
|
-
* [Manage Inventory Levels](https://docs.acmekit.com/api/admin#inventory-items_postinventoryitemsidlocationlevelsbatch)
|
|
296
|
-
* API route.
|
|
297
|
-
*
|
|
298
|
-
* @deprecated Use `batchInventoryItemLocationLevels` instead.
|
|
299
|
-
*
|
|
300
|
-
* @param id - The inventory item's ID.
|
|
301
|
-
* @param body - The inventory levels to create or delete.
|
|
302
|
-
* @param query - Configure the fields to retrieve in the inventory item.
|
|
303
|
-
* @param headers - Headers to pass in the request
|
|
304
|
-
* @returns The inventory item's details.
|
|
305
|
-
*
|
|
306
|
-
* @example
|
|
307
|
-
* sdk.admin.inventoryItem.batchUpdateLevels("iitem_123", {
|
|
308
|
-
* create: [{
|
|
309
|
-
* location_id: "sloc_123",
|
|
310
|
-
* stocked_quantity: 10
|
|
311
|
-
* }],
|
|
312
|
-
* delete: ["ilvl_123"]
|
|
313
|
-
* })
|
|
314
|
-
* .then(({ created, updated, deleted }) => {
|
|
315
|
-
* console.log(created, updated, deleted)
|
|
316
|
-
* })
|
|
317
|
-
*/
|
|
318
|
-
async batchUpdateLevels(id, body, query, headers) {
|
|
319
|
-
return await this.client.fetch(`/admin/inventory-items/${id}/location-levels/batch`, {
|
|
320
|
-
method: "POST",
|
|
321
|
-
headers,
|
|
322
|
-
body,
|
|
323
|
-
query,
|
|
324
|
-
});
|
|
325
|
-
}
|
|
326
|
-
/**
|
|
327
|
-
* This method manages the inventory levels of an inventory item. It sends a request to the
|
|
328
|
-
* [Manage Inventory Levels](https://docs.acmekit.com/api/admin#inventory-items_postinventoryitemsidlocationlevelsbatch)
|
|
329
|
-
* API route.
|
|
330
|
-
*
|
|
331
|
-
* @param id - The inventory item's ID.
|
|
332
|
-
* @param body - The inventory levels to create, update or delete, and an optional `force` flag.
|
|
333
|
-
* @param headers - Headers to pass in the request
|
|
334
|
-
* @returns The inventory item's details.
|
|
335
|
-
*
|
|
336
|
-
* @example
|
|
337
|
-
* sdk.admin.inventoryItem.batchInventoryItemLocationLevels("iitem_123", {
|
|
338
|
-
* create: [{
|
|
339
|
-
* location_id: "sloc_123",
|
|
340
|
-
* stocked_quantity: 10
|
|
341
|
-
* }],
|
|
342
|
-
* delete: ["ilvl_123"]
|
|
343
|
-
* })
|
|
344
|
-
* .then(({ created, updated, deleted }) => {
|
|
345
|
-
* console.log(created, updated, deleted)
|
|
346
|
-
* })
|
|
347
|
-
*/
|
|
348
|
-
async batchInventoryItemLocationLevels(id, body, headers) {
|
|
349
|
-
return await this.client.fetch(`/admin/inventory-items/${id}/location-levels/batch`, {
|
|
350
|
-
method: "POST",
|
|
351
|
-
headers,
|
|
352
|
-
body,
|
|
353
|
-
});
|
|
354
|
-
}
|
|
355
|
-
/**
|
|
356
|
-
* This method manages the inventory levels of multiple inventory items.
|
|
357
|
-
*
|
|
358
|
-
* @param body - The inventory levels to create, update or delete, and an optional `force` flag.
|
|
359
|
-
* @param headers - Headers to pass in the request
|
|
360
|
-
* @returns The inventory item's details.
|
|
361
|
-
*
|
|
362
|
-
* @example
|
|
363
|
-
* sdk.admin.inventoryItem.batchInventoryItemsLocationLevels({
|
|
364
|
-
* create: [{
|
|
365
|
-
* inventory_item_id: "iitem_123",
|
|
366
|
-
* location_id: "sloc_123",
|
|
367
|
-
* stocked_quantity: 10
|
|
368
|
-
* }],
|
|
369
|
-
* delete: ["ilvl_123"]
|
|
370
|
-
* })
|
|
371
|
-
* .then(({ created, updated, deleted }) => {
|
|
372
|
-
* console.log(created, updated, deleted)
|
|
373
|
-
* })
|
|
374
|
-
*/
|
|
375
|
-
async batchInventoryItemsLocationLevels(body, headers) {
|
|
376
|
-
return await this.client.fetch(`/admin/inventory-items/location-levels/batch`, {
|
|
377
|
-
method: "POST",
|
|
378
|
-
headers,
|
|
379
|
-
body,
|
|
380
|
-
});
|
|
381
|
-
}
|
|
382
|
-
}
|
|
383
|
-
exports.InventoryItem = InventoryItem;
|
|
384
|
-
//# sourceMappingURL=inventory-item.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"inventory-item.js","sourceRoot":"","sources":["../../src/admin/inventory-item.ts"],"names":[],"mappings":";;;AAIA,MAAa,aAAa;IAKxB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAwC,EACxC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA2C,EAC3C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EACxB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,EAAE,EAC9B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,KAAK,CAAC,UAAU,CACd,EAAU,EACV,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,kBAAkB,EAC9C;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,WAAW,CACf,EAAU,EACV,UAAkB,EAClB,IAAyC,EACzC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,oBAAoB,UAAU,EAAE,EAC5D;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,WAAW,CAAC,EAAU,EAAE,UAAkB,EAAE,OAAuB;QACvE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,oBAAoB,UAAU,EAAE,EAC5D;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,iBAAiB,CACrB,EAAU,EACV,IAAqD,EACrD,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,wBAAwB,EACpD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,gCAAgC,CACpC,EAAU,EACV,IAAqD,EACrD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAAE,wBAAwB,EACpD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,iCAAiC,CACrC,IAAsD,EACtD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8CAA8C,EAC9C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AA5cD,sCA4cC"}
|
|
@@ -1,189 +0,0 @@
|
|
|
1
|
-
import { HttpTypes } from "@acmekit/types";
|
|
2
|
-
import { Client } from "../client";
|
|
3
|
-
import { ClientHeaders } from "../types";
|
|
4
|
-
export declare class OrderEdit {
|
|
5
|
-
/**
|
|
6
|
-
* @ignore
|
|
7
|
-
*/
|
|
8
|
-
private client;
|
|
9
|
-
/**
|
|
10
|
-
* @ignore
|
|
11
|
-
*/
|
|
12
|
-
constructor(client: Client);
|
|
13
|
-
/**
|
|
14
|
-
* This method creates an order edit request. It sends a HTTP request to the
|
|
15
|
-
* [Create Order Edit](https://docs.acmekit.com/api/admin#order-edits_postorderedits)
|
|
16
|
-
* API route.
|
|
17
|
-
*
|
|
18
|
-
* @param body - The order edit's details.
|
|
19
|
-
* @param query - Configure the fields to retrieve in the order edit.
|
|
20
|
-
* @param headers - Headers to pass in the request.
|
|
21
|
-
* @returns The order edit's details.
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* sdk.admin.orderEdit.initiateRequest({
|
|
25
|
-
* order_id: "order_123"
|
|
26
|
-
* })
|
|
27
|
-
* .then(({ order_change }) => {
|
|
28
|
-
* console.log(order_change)
|
|
29
|
-
* })
|
|
30
|
-
*/
|
|
31
|
-
initiateRequest(body: HttpTypes.AdminInitiateOrderEditRequest, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditResponse>;
|
|
32
|
-
/**
|
|
33
|
-
* This method changes an order edit to requested. It sends a request to the
|
|
34
|
-
* [Request Order Edit](https://docs.acmekit.com/api/admin#order-edits_postordereditsidrequest)
|
|
35
|
-
* API route.
|
|
36
|
-
*
|
|
37
|
-
* @param id - The ID of the order that is being edited.
|
|
38
|
-
* @param query - Configure the fields to retrieve in the order preview.
|
|
39
|
-
* @param headers - Headers to pass in the request.
|
|
40
|
-
* @returns The order preview's details.
|
|
41
|
-
*
|
|
42
|
-
* @example
|
|
43
|
-
* sdk.admin.orderEdit.request("order_123")
|
|
44
|
-
* .then(({ order_preview }) => {
|
|
45
|
-
* console.log(order_preview)
|
|
46
|
-
* })
|
|
47
|
-
*/
|
|
48
|
-
request(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
|
|
49
|
-
/**
|
|
50
|
-
* This method confirms an order edit and applies it on the order. It sends a request
|
|
51
|
-
* to the [Confirm Order Edit](https://docs.acmekit.com/api/admin#order-edits_postordereditsidconfirm)
|
|
52
|
-
* API route.
|
|
53
|
-
*
|
|
54
|
-
* @param id - The ID of the order that is being edited.
|
|
55
|
-
* @param query - Configure the fields to retrieve in the order preview.
|
|
56
|
-
* @param headers - Headers to pass in the request.
|
|
57
|
-
* @returns The order preview's details.
|
|
58
|
-
*
|
|
59
|
-
* @example
|
|
60
|
-
* sdk.admin.orderEdit.confirm("order_123")
|
|
61
|
-
* .then(({ order_preview }) => {
|
|
62
|
-
* console.log(order_preview)
|
|
63
|
-
* })
|
|
64
|
-
*/
|
|
65
|
-
confirm(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
|
|
66
|
-
/**
|
|
67
|
-
* This method cancels a requested order edit. It sends a request to the
|
|
68
|
-
* [Cancel Order Edit](https://docs.acmekit.com/api/admin#order-edits_deleteordereditsid)
|
|
69
|
-
* API route.
|
|
70
|
-
*
|
|
71
|
-
* @param id - The ID of the order that is being edited.
|
|
72
|
-
* @param query - Query parameters
|
|
73
|
-
* @param headers - Headers to pass in the request.
|
|
74
|
-
* @returns The deletion's details.
|
|
75
|
-
*
|
|
76
|
-
* @example
|
|
77
|
-
* sdk.admin.orderEdit.cancelRequest("order_123")
|
|
78
|
-
* .then(({ deleted }) => {
|
|
79
|
-
* console.log(deleted)
|
|
80
|
-
* })
|
|
81
|
-
*/
|
|
82
|
-
cancelRequest(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditDeleteResponse>;
|
|
83
|
-
/**
|
|
84
|
-
* This method adds items to an order edit. These items will have the action `ITEM_ADD`.
|
|
85
|
-
*
|
|
86
|
-
* The method sends a request to the [Add Items](https://docs.acmekit.com/api/admin#order-edits_postordereditsiditems)
|
|
87
|
-
* API route.
|
|
88
|
-
*
|
|
89
|
-
* @param id - The ID of the order that is being edited.
|
|
90
|
-
* @param body - The items to add.
|
|
91
|
-
* @param query - Configure the fields to retrieve in the order preview.
|
|
92
|
-
* @param headers - Headers to pass in the request.
|
|
93
|
-
* @returns The order preview's details.
|
|
94
|
-
*
|
|
95
|
-
* @example
|
|
96
|
-
* sdk.admin.orderEdit.addItems("order_123", {
|
|
97
|
-
* items: [
|
|
98
|
-
* {
|
|
99
|
-
* variant_id: "variant_123",
|
|
100
|
-
* quantity: 1
|
|
101
|
-
* }
|
|
102
|
-
* ]
|
|
103
|
-
* })
|
|
104
|
-
* .then(({ order_preview }) => {
|
|
105
|
-
* console.log(order_preview)
|
|
106
|
-
* })
|
|
107
|
-
*/
|
|
108
|
-
addItems(id: string, body: HttpTypes.AdminAddOrderEditItems, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
|
|
109
|
-
/**
|
|
110
|
-
* This method updates the quantity and other details of an item in an order. It sends a request to the
|
|
111
|
-
* [Update Item Quantity](https://docs.acmekit.com/api/admin#order-edits_postordereditsiditemsitemitem_id)
|
|
112
|
-
* API route.
|
|
113
|
-
*
|
|
114
|
-
* You can also use this method to remove an item from an order by setting the `quantity` to `0`.
|
|
115
|
-
*
|
|
116
|
-
* @param id - The ID of the order that is being edited.
|
|
117
|
-
* @param itemId - The item's ID in the order.
|
|
118
|
-
* @param body - The data to edit in the item.
|
|
119
|
-
* @param query - Configure the fields to retrieve in the order preview.
|
|
120
|
-
* @param headers - Headers to pass in the request.
|
|
121
|
-
* @returns The order preview's details.
|
|
122
|
-
*
|
|
123
|
-
* @example
|
|
124
|
-
* sdk.admin.orderEdit.updateOriginalItem(
|
|
125
|
-
* "order_123",
|
|
126
|
-
* "orli_123",
|
|
127
|
-
* {
|
|
128
|
-
* quantity: 1
|
|
129
|
-
* }
|
|
130
|
-
* )
|
|
131
|
-
* .then(({ order_preview }) => {
|
|
132
|
-
* console.log(order_preview)
|
|
133
|
-
* })
|
|
134
|
-
*/
|
|
135
|
-
updateOriginalItem(id: string, itemId: string, body: HttpTypes.AdminUpdateOrderEditItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
|
|
136
|
-
/**
|
|
137
|
-
* This method updates an added item in the order edit by the ID of the item's `ITEM_ADD` action.
|
|
138
|
-
*
|
|
139
|
-
* Every item has an `actions` property, whose value is an array of actions.
|
|
140
|
-
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
|
141
|
-
*
|
|
142
|
-
* It sends a request
|
|
143
|
-
* to the [Update Item](https://docs.acmekit.com/api/admin#order-edits_postordereditsiditemsaction_id)
|
|
144
|
-
* API route.
|
|
145
|
-
*
|
|
146
|
-
* @param id - The ID of the order that is being edited.
|
|
147
|
-
* @param actionId - The id of the new item's `ITEM_ADD` action.
|
|
148
|
-
* @param body - The data to update.
|
|
149
|
-
* @param query - Configure the fields to retrieve in the order preview.
|
|
150
|
-
* @param headers - Headers to pass in the request.
|
|
151
|
-
* @returns The order preview's details.
|
|
152
|
-
*
|
|
153
|
-
* @example
|
|
154
|
-
* sdk.admin.orderEdit.updateAddedItem(
|
|
155
|
-
* "order_123",
|
|
156
|
-
* "orli_123",
|
|
157
|
-
* {
|
|
158
|
-
* quantity: 1
|
|
159
|
-
* }
|
|
160
|
-
* )
|
|
161
|
-
* .then(({ order_preview }) => {
|
|
162
|
-
* console.log(order_preview)
|
|
163
|
-
* })
|
|
164
|
-
*/
|
|
165
|
-
updateAddedItem(id: string, actionId: string, body: HttpTypes.AdminUpdateOrderEditItem, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
|
|
166
|
-
/**
|
|
167
|
-
* This method removes an added item in the order edit by the ID of the item's `ITEM_ADD` action.
|
|
168
|
-
*
|
|
169
|
-
* Every item has an `actions` property, whose value is an array of actions.
|
|
170
|
-
* You can check the action's name using its `action` property, and use the value of the `id` property.
|
|
171
|
-
*
|
|
172
|
-
* @param id - The ID of the order that is being edited.
|
|
173
|
-
* @param actionId - The id of the new item's `ITEM_ADD` action.
|
|
174
|
-
* @param query - Configure the fields to retrieve in the order preview.
|
|
175
|
-
* @param headers - Headers to pass in the request.
|
|
176
|
-
* @returns The order preview's details.
|
|
177
|
-
*
|
|
178
|
-
* @example
|
|
179
|
-
* sdk.admin.orderEdit.removeAddedItem(
|
|
180
|
-
* "order_123",
|
|
181
|
-
* "orli_123",
|
|
182
|
-
* )
|
|
183
|
-
* .then(({ order_preview }) => {
|
|
184
|
-
* console.log(order_preview)
|
|
185
|
-
* })
|
|
186
|
-
*/
|
|
187
|
-
removeAddedItem(id: string, actionId: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderEditPreviewResponse>;
|
|
188
|
-
}
|
|
189
|
-
//# sourceMappingURL=order-edit.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"order-edit.d.ts","sourceRoot":"","sources":["../../src/admin/order-edit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,eAAe,CACnB,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,eAAe,CACnB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
|