-
Notifications
You must be signed in to change notification settings - Fork 0
/
inventory.ts
337 lines (335 loc) · 8.86 KB
/
inventory.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
/**
* Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
* Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
*/
import { ChannelReference, ChannelResourceIdentifier } from './channel.js'
import { BaseResource, CreatedBy, LastModifiedBy } from './common.js'
import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js'
export interface InventoryEntry extends BaseResource {
/**
* Unique identifier of the InventoryEntry.
*
*
*/
readonly id: string
/**
* Current version of the InventoryEntry.
*
*
*/
readonly version: number
/**
* Date and time (UTC) the InventoryEntry was initially created.
*
*
*/
readonly createdAt: string
/**
* Date and time (UTC) the InventoryEntry was last updated.
*
*/
readonly lastModifiedAt: string
/**
* Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
*
*
*/
readonly lastModifiedBy?: LastModifiedBy
/**
* Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
*
*
*/
readonly createdBy?: CreatedBy
/**
* User-defined unique identifier of the InventoryEntry.
*
*
*/
readonly key?: string
/**
* [ProductVariant](ctp:api:type:ProductVariant) `sku` of the InventoryEntry.
*
*
*/
readonly sku: string
/**
* [Channel](ctp:api:type:Channel) that supplies this InventoryEntry.
*
*
*/
readonly supplyChannel?: ChannelReference
/**
* Overall amount of stock (`availableQuantity` + reserved).
*
*/
readonly quantityOnStock: number
/**
* Available amount of stock (`quantityOnStock` - reserved).
*
*
*/
readonly availableQuantity: number
/**
* How often the InventoryEntry is restocked (in days).
*
*/
readonly restockableInDays?: number
/**
* Date and time of the next restock.
*
*
*/
readonly expectedDelivery?: string
/**
* Custom Fields of the InventoryEntry.
*
*
*/
readonly custom?: CustomFields
}
export interface InventoryEntryDraft {
/**
* [ProductVariant](ctp:api:type:ProductVariant) `sku` of the InventoryEntry.
*
*
*/
readonly sku: string
/**
* User-defined unique identifier for the InventoryEntry.
*
*
*/
readonly key?: string
/**
* [Channel](ctp:api:type:Channel) that supplies this InventoryEntry.
*
*
*/
readonly supplyChannel?: ChannelResourceIdentifier
/**
* Overall amount of stock.
*
*
*/
readonly quantityOnStock: number
/**
* How often the InventoryEntry is restocked (in days).
*
*
*/
readonly restockableInDays?: number
/**
* Date and time of the next restock.
*
*
*/
readonly expectedDelivery?: string
/**
* Custom Fields of the InventoryEntry.
*
*
*/
readonly custom?: CustomFieldsDraft
}
/**
* [Reference](ctp:api:type:Reference) to an [InventoryEntry](ctp:api:type:InventoryEntry).
*
*/
export interface InventoryEntryReference {
readonly typeId: 'inventory-entry'
/**
* Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry).
*
*
*/
readonly id: string
/**
* Contains the representation of the expanded InventoryEntry. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for InventoryEntries.
*
*
*/
readonly obj?: InventoryEntry
}
/**
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [InventoryEntry](ctp:api:type:InventoryEntry).
*
*/
export interface InventoryEntryResourceIdentifier {
readonly typeId: 'inventory-entry'
/**
* Unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required.
*
*
*/
readonly id?: string
/**
* User-defined unique identifier of the referenced [InventoryEntry](ctp:api:type:InventoryEntry). Either `id` or `key` is required.
*
*
*/
readonly key?: string
}
export interface InventoryEntryUpdate {
/**
* Expected version of the InventoryEntry on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned.
*
*
*/
readonly version: number
/**
* Update actions to be performed on the InventoryEntry.
*
*
*/
readonly actions: InventoryEntryUpdateAction[]
}
export type InventoryEntryUpdateAction =
| InventoryEntryAddQuantityAction
| InventoryEntryChangeQuantityAction
| InventoryEntryRemoveQuantityAction
| InventoryEntrySetCustomFieldAction
| InventoryEntrySetCustomTypeAction
| InventoryEntrySetExpectedDeliveryAction
| InventoryEntrySetKeyAction
| InventoryEntrySetRestockableInDaysAction
| InventoryEntrySetSupplyChannelAction
export interface InventoryPagedQueryResponse {
/**
* Number of [results requested](/../api/general-concepts#limit).
*
*
*/
readonly limit: number
/**
* Number of [elements skipped](/../api/general-concepts#offset).
*
*
*/
readonly offset: number
/**
* Actual number of results returned.
*
*
*/
readonly count: number
/**
* Total number of results matching the query.
* This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
* This field is returned by default.
* For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
* When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
*
*
*/
readonly total?: number
/**
* [Inventory entries](ctp:api:type:InventoryEntry) matching the query.
*
*
*/
readonly results: InventoryEntry[]
}
/**
* Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
*/
export interface InventoryEntryAddQuantityAction {
readonly action: 'addQuantity'
/**
* Value to add to `quantityOnStock`.
*
*/
readonly quantity: number
}
/**
* Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
*/
export interface InventoryEntryChangeQuantityAction {
readonly action: 'changeQuantity'
/**
* Value to set for `quantityOnStock`.
*
*/
readonly quantity: number
}
/**
* Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
*/
export interface InventoryEntryRemoveQuantityAction {
readonly action: 'removeQuantity'
/**
* Value to remove from `quantityOnStock`.
*
*/
readonly quantity: number
}
export interface InventoryEntrySetCustomFieldAction {
readonly action: 'setCustomField'
/**
* Name of the [Custom Field](/../api/projects/custom-fields).
*
*
*/
readonly name: string
/**
* If `value` is absent or `null`, this field will be removed if it exists.
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
* If `value` is provided, it is set for the field defined by `name`.
*
*
*/
readonly value?: any
}
export interface InventoryEntrySetCustomTypeAction {
readonly action: 'setCustomType'
/**
* Defines the [Type](ctp:api:type:Type) that extends the InventoryEntry with [Custom Fields](/../api/projects/custom-fields).
* If absent, any existing Type and Custom Fields are removed from the InventoryEntry.
*
*
*/
readonly type?: TypeResourceIdentifier
/**
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the InventoryEntry.
*
*
*/
readonly fields?: FieldContainer
}
export interface InventoryEntrySetExpectedDeliveryAction {
readonly action: 'setExpectedDelivery'
/**
* Value to set. If empty, any existing value will be removed.
*
*/
readonly expectedDelivery?: string
}
export interface InventoryEntrySetKeyAction {
readonly action: 'setKey'
/**
* Value to set. If empty, any existing value will be removed.
*
*
*/
readonly key?: string
}
export interface InventoryEntrySetRestockableInDaysAction {
readonly action: 'setRestockableInDays'
/**
* Value to set. If empty, any existing value will be removed.
*
*/
readonly restockableInDays?: number
}
/**
* If an entry with the same `sku` and `supplyChannel` already exists, an [DuplicateField](ctp:api:type:DuplicateFieldError) error is returned.
*/
export interface InventoryEntrySetSupplyChannelAction {
readonly action: 'setSupplyChannel'
/**
* Value to set. If empty, any existing value will be removed.
*
*/
readonly supplyChannel?: ChannelResourceIdentifier
}