@teemill/orders 1.21.0 → 1.22.0
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/README.md +5 -3
- package/api.ts +16 -708
- package/base.ts +1 -25
- package/common.ts +1 -2
- package/configuration.ts +1 -18
- package/dist/api.d.ts +23 -716
- package/dist/api.js +1 -23
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -18
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +23 -716
- package/dist/esm/api.js +1 -23
- package/dist/esm/base.d.ts +1 -25
- package/dist/esm/base.js +1 -20
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -18
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ConfirmOrderFulfillment.md +2 -2
- package/docs/ConfirmOrderFulfillmentWithShipment.md +22 -0
- package/docs/ConfirmOrderFulfillmentWithShipmentShipment.md +21 -0
- package/docs/ConfirmOrderFulfillmentWithShippingMethod.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders API
|
|
3
3
|
* Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.22.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -15,146 +15,74 @@ import type { RequestArgs } from './base';
|
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
16
|
/**
|
|
17
17
|
* A person\'s address.
|
|
18
|
-
* @export
|
|
19
|
-
* @interface Address
|
|
20
18
|
*/
|
|
21
19
|
export interface Address {
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @type {string}
|
|
25
|
-
* @memberof Address
|
|
26
|
-
*/
|
|
27
20
|
'contactName'?: string;
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
* @type {string}
|
|
31
|
-
* @memberof Address
|
|
32
|
-
*/
|
|
33
21
|
'company'?: string;
|
|
34
22
|
/**
|
|
35
23
|
* First line of the address.
|
|
36
|
-
* @type {string}
|
|
37
|
-
* @memberof Address
|
|
38
24
|
*/
|
|
39
25
|
'line1'?: string;
|
|
40
26
|
/**
|
|
41
27
|
* Second line of the address.
|
|
42
|
-
* @type {string}
|
|
43
|
-
* @memberof Address
|
|
44
28
|
*/
|
|
45
29
|
'line2'?: string;
|
|
46
30
|
/**
|
|
47
31
|
* City of the address.
|
|
48
|
-
* @type {string}
|
|
49
|
-
* @memberof Address
|
|
50
32
|
*/
|
|
51
33
|
'city'?: string;
|
|
52
34
|
/**
|
|
53
35
|
* Postal code of the address.
|
|
54
|
-
* @type {string}
|
|
55
|
-
* @memberof Address
|
|
56
36
|
*/
|
|
57
37
|
'postalCode'?: string;
|
|
58
38
|
/**
|
|
59
39
|
* Country of the address (ISO 3166-1 alpha-2).
|
|
60
|
-
* @type {string}
|
|
61
|
-
* @memberof Address
|
|
62
40
|
*/
|
|
63
41
|
'country': string;
|
|
64
42
|
/**
|
|
65
43
|
* State of the address. If the country is Canada, Australia, or the United States, this field is required.
|
|
66
|
-
* @type {string}
|
|
67
|
-
* @memberof Address
|
|
68
44
|
*/
|
|
69
45
|
'state'?: string;
|
|
70
46
|
}
|
|
71
|
-
/**
|
|
72
|
-
*
|
|
73
|
-
* @export
|
|
74
|
-
* @interface ApiError
|
|
75
|
-
*/
|
|
76
47
|
export interface ApiError {
|
|
77
|
-
/**
|
|
78
|
-
*
|
|
79
|
-
* @type {string}
|
|
80
|
-
* @memberof ApiError
|
|
81
|
-
*/
|
|
82
48
|
'code'?: string;
|
|
83
|
-
/**
|
|
84
|
-
*
|
|
85
|
-
* @type {string}
|
|
86
|
-
* @memberof ApiError
|
|
87
|
-
*/
|
|
88
49
|
'message': string;
|
|
89
50
|
}
|
|
90
51
|
/**
|
|
91
|
-
*
|
|
92
|
-
* @export
|
|
93
|
-
* @interface ConfirmOrderFulfillment
|
|
52
|
+
* @type ConfirmOrderFulfillment
|
|
94
53
|
*/
|
|
95
|
-
export
|
|
54
|
+
export type ConfirmOrderFulfillment = ConfirmOrderFulfillmentWithShipment | ConfirmOrderFulfillmentWithShippingMethod;
|
|
55
|
+
export interface ConfirmOrderFulfillmentWithShipment {
|
|
96
56
|
/**
|
|
97
57
|
* Unique object identifier
|
|
98
|
-
* @type {string}
|
|
99
|
-
* @memberof ConfirmOrderFulfillment
|
|
100
58
|
*/
|
|
101
59
|
'fulfillmentId': string;
|
|
102
|
-
|
|
103
|
-
* Unique object identifier
|
|
104
|
-
* @type {string}
|
|
105
|
-
* @memberof ConfirmOrderFulfillment
|
|
106
|
-
*/
|
|
107
|
-
'shippingMethodId'?: string;
|
|
108
|
-
/**
|
|
109
|
-
*
|
|
110
|
-
* @type {ConfirmOrderFulfillmentShipment}
|
|
111
|
-
* @memberof ConfirmOrderFulfillment
|
|
112
|
-
*/
|
|
113
|
-
'shipment'?: ConfirmOrderFulfillmentShipment;
|
|
60
|
+
'shipment': ConfirmOrderFulfillmentWithShipmentShipment;
|
|
114
61
|
}
|
|
115
62
|
/**
|
|
116
63
|
* This field is only required if you are using your own shipping label.
|
|
117
|
-
* @export
|
|
118
|
-
* @interface ConfirmOrderFulfillmentShipment
|
|
119
64
|
*/
|
|
120
|
-
export interface
|
|
65
|
+
export interface ConfirmOrderFulfillmentWithShipmentShipment {
|
|
121
66
|
/**
|
|
122
67
|
* Only required if you are generating shipping labels outside of PodOS
|
|
123
|
-
* @type {string}
|
|
124
|
-
* @memberof ConfirmOrderFulfillmentShipment
|
|
125
68
|
*/
|
|
126
69
|
'image': string;
|
|
127
70
|
}
|
|
128
|
-
|
|
129
|
-
*
|
|
130
|
-
* @export
|
|
131
|
-
* @interface ConfirmOrderRequest
|
|
132
|
-
*/
|
|
133
|
-
export interface ConfirmOrderRequest {
|
|
71
|
+
export interface ConfirmOrderFulfillmentWithShippingMethod {
|
|
134
72
|
/**
|
|
135
|
-
*
|
|
136
|
-
* @type {Array<ConfirmOrderFulfillment>}
|
|
137
|
-
* @memberof ConfirmOrderRequest
|
|
73
|
+
* Unique object identifier
|
|
138
74
|
*/
|
|
75
|
+
'fulfillmentId': string;
|
|
76
|
+
/**
|
|
77
|
+
* Unique object identifier
|
|
78
|
+
*/
|
|
79
|
+
'shippingMethodId': string;
|
|
80
|
+
}
|
|
81
|
+
export interface ConfirmOrderRequest {
|
|
139
82
|
'fulfillments': Array<ConfirmOrderFulfillment>;
|
|
140
83
|
}
|
|
141
|
-
/**
|
|
142
|
-
*
|
|
143
|
-
* @export
|
|
144
|
-
* @interface ConfirmOrderValidationError
|
|
145
|
-
*/
|
|
146
84
|
export interface ConfirmOrderValidationError {
|
|
147
|
-
/**
|
|
148
|
-
*
|
|
149
|
-
* @type {string}
|
|
150
|
-
* @memberof ConfirmOrderValidationError
|
|
151
|
-
*/
|
|
152
85
|
'code': ConfirmOrderValidationErrorCodeEnum;
|
|
153
|
-
/**
|
|
154
|
-
*
|
|
155
|
-
* @type {string}
|
|
156
|
-
* @memberof ConfirmOrderValidationError
|
|
157
|
-
*/
|
|
158
86
|
'message': string;
|
|
159
87
|
}
|
|
160
88
|
export declare const ConfirmOrderValidationErrorCodeEnum: {
|
|
@@ -166,138 +94,67 @@ export declare const ConfirmOrderValidationErrorCodeEnum: {
|
|
|
166
94
|
export type ConfirmOrderValidationErrorCodeEnum = typeof ConfirmOrderValidationErrorCodeEnum[keyof typeof ConfirmOrderValidationErrorCodeEnum];
|
|
167
95
|
/**
|
|
168
96
|
* Order recipient contact information, used only for courier tracking/updates.
|
|
169
|
-
* @export
|
|
170
|
-
* @interface ContactInformation
|
|
171
97
|
*/
|
|
172
98
|
export interface ContactInformation {
|
|
173
|
-
/**
|
|
174
|
-
*
|
|
175
|
-
* @type {string}
|
|
176
|
-
* @memberof ContactInformation
|
|
177
|
-
*/
|
|
178
99
|
'email': string;
|
|
179
|
-
/**
|
|
180
|
-
*
|
|
181
|
-
* @type {string}
|
|
182
|
-
* @memberof ContactInformation
|
|
183
|
-
*/
|
|
184
100
|
'phone'?: string | null;
|
|
185
101
|
}
|
|
186
102
|
/**
|
|
187
103
|
* Coupon applied to the order.
|
|
188
|
-
* @export
|
|
189
|
-
* @interface Coupon
|
|
190
104
|
*/
|
|
191
105
|
export interface Coupon {
|
|
192
106
|
/**
|
|
193
107
|
* Unique object identifier
|
|
194
|
-
* @type {string}
|
|
195
|
-
* @memberof Coupon
|
|
196
108
|
*/
|
|
197
109
|
'id': string;
|
|
198
|
-
/**
|
|
199
|
-
*
|
|
200
|
-
* @type {string}
|
|
201
|
-
* @memberof Coupon
|
|
202
|
-
*/
|
|
203
110
|
'code': string;
|
|
204
111
|
/**
|
|
205
112
|
* Reference to the discount. **Note:** Requires the discounts integration to see the reference.
|
|
206
|
-
* @type {string}
|
|
207
|
-
* @memberof Coupon
|
|
208
113
|
*/
|
|
209
114
|
'ref'?: string | null;
|
|
210
115
|
}
|
|
211
116
|
/**
|
|
212
117
|
* Create an order
|
|
213
|
-
* @export
|
|
214
|
-
* @interface CreateOrder
|
|
215
118
|
*/
|
|
216
119
|
export interface CreateOrder {
|
|
217
120
|
/**
|
|
218
121
|
* A custom reference to the merchant\'s order.
|
|
219
|
-
* @type {string}
|
|
220
|
-
* @memberof CreateOrder
|
|
221
122
|
*/
|
|
222
123
|
'merchantReference'?: string | null;
|
|
223
|
-
/**
|
|
224
|
-
*
|
|
225
|
-
* @type {CreateOrderContactInformation}
|
|
226
|
-
* @memberof CreateOrder
|
|
227
|
-
*/
|
|
228
124
|
'contactInformation': CreateOrderContactInformation;
|
|
229
|
-
/**
|
|
230
|
-
*
|
|
231
|
-
* @type {Address}
|
|
232
|
-
* @memberof CreateOrder
|
|
233
|
-
*/
|
|
234
125
|
'shippingAddress': Address;
|
|
235
|
-
/**
|
|
236
|
-
*
|
|
237
|
-
* @type {CustomsInformation}
|
|
238
|
-
* @memberof CreateOrder
|
|
239
|
-
*/
|
|
240
126
|
'customsInformation'?: CustomsInformation;
|
|
241
127
|
/**
|
|
242
128
|
* Items to be ordered
|
|
243
|
-
* @type {Array<OrderItem1>}
|
|
244
|
-
* @memberof CreateOrder
|
|
245
129
|
*/
|
|
246
130
|
'items': Array<OrderItem1>;
|
|
247
|
-
/**
|
|
248
|
-
*
|
|
249
|
-
* @type {Array<string>}
|
|
250
|
-
* @memberof CreateOrder
|
|
251
|
-
*/
|
|
252
131
|
'preferredFulfillers'?: Array<string>;
|
|
253
132
|
}
|
|
254
133
|
/**
|
|
255
134
|
* Contact information for the order
|
|
256
|
-
* @export
|
|
257
|
-
* @interface CreateOrderContactInformation
|
|
258
135
|
*/
|
|
259
136
|
export interface CreateOrderContactInformation {
|
|
260
|
-
/**
|
|
261
|
-
*
|
|
262
|
-
* @type {string}
|
|
263
|
-
* @memberof CreateOrderContactInformation
|
|
264
|
-
*/
|
|
265
137
|
'email': string;
|
|
266
|
-
/**
|
|
267
|
-
*
|
|
268
|
-
* @type {string}
|
|
269
|
-
* @memberof CreateOrderContactInformation
|
|
270
|
-
*/
|
|
271
138
|
'phone'?: string | null;
|
|
272
139
|
}
|
|
273
140
|
/**
|
|
274
141
|
* Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
|
|
275
|
-
* @export
|
|
276
|
-
* @interface CustomsInformation
|
|
277
142
|
*/
|
|
278
143
|
export interface CustomsInformation {
|
|
279
144
|
/**
|
|
280
145
|
* Pre-registration type
|
|
281
|
-
* @type {string}
|
|
282
|
-
* @memberof CustomsInformation
|
|
283
146
|
*/
|
|
284
147
|
'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
|
|
285
148
|
/**
|
|
286
149
|
* Pre-registration number
|
|
287
|
-
* @type {string}
|
|
288
|
-
* @memberof CustomsInformation
|
|
289
150
|
*/
|
|
290
151
|
'preRegistrationNumber'?: string;
|
|
291
152
|
/**
|
|
292
153
|
* VAT number
|
|
293
|
-
* @type {string}
|
|
294
|
-
* @memberof CustomsInformation
|
|
295
154
|
*/
|
|
296
155
|
'vatNumber'?: string;
|
|
297
156
|
/**
|
|
298
157
|
* EORI number
|
|
299
|
-
* @type {string}
|
|
300
|
-
* @memberof CustomsInformation
|
|
301
158
|
*/
|
|
302
159
|
'eoriNumber'?: string;
|
|
303
160
|
}
|
|
@@ -305,596 +162,218 @@ export declare const CustomsInformationPreRegistrationTypeEnum: {
|
|
|
305
162
|
readonly Ioss: "IOSS";
|
|
306
163
|
};
|
|
307
164
|
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
308
|
-
/**
|
|
309
|
-
*
|
|
310
|
-
* @export
|
|
311
|
-
* @interface CustomsInformation1
|
|
312
|
-
*/
|
|
313
165
|
export interface CustomsInformation1 {
|
|
314
|
-
/**
|
|
315
|
-
*
|
|
316
|
-
* @type {string}
|
|
317
|
-
* @memberof CustomsInformation1
|
|
318
|
-
*/
|
|
319
166
|
'preRegistrationType'?: string;
|
|
320
|
-
/**
|
|
321
|
-
*
|
|
322
|
-
* @type {string}
|
|
323
|
-
* @memberof CustomsInformation1
|
|
324
|
-
*/
|
|
325
167
|
'preRegistrationNumber'?: string;
|
|
326
|
-
/**
|
|
327
|
-
*
|
|
328
|
-
* @type {string}
|
|
329
|
-
* @memberof CustomsInformation1
|
|
330
|
-
*/
|
|
331
168
|
'vatNumber'?: string;
|
|
332
|
-
/**
|
|
333
|
-
*
|
|
334
|
-
* @type {string}
|
|
335
|
-
* @memberof CustomsInformation1
|
|
336
|
-
*/
|
|
337
169
|
'eoriNumber'?: string;
|
|
338
170
|
}
|
|
339
|
-
/**
|
|
340
|
-
*
|
|
341
|
-
* @export
|
|
342
|
-
* @interface DeliveryEstimates
|
|
343
|
-
*/
|
|
344
171
|
export interface DeliveryEstimates {
|
|
345
172
|
/**
|
|
346
173
|
* Whether this is a priority shipping method. Fulfillments with priority methods aim for same day dispatch when ordered before 1pm, and typically offer faster delivery times.
|
|
347
|
-
* @type {boolean}
|
|
348
|
-
* @memberof DeliveryEstimates
|
|
349
174
|
*/
|
|
350
175
|
'isPriority'?: boolean;
|
|
351
176
|
/**
|
|
352
177
|
* ISO 8601 Timestamp
|
|
353
|
-
* @type {string}
|
|
354
|
-
* @memberof DeliveryEstimates
|
|
355
178
|
*/
|
|
356
179
|
'min'?: string;
|
|
357
180
|
/**
|
|
358
181
|
* ISO 8601 Timestamp
|
|
359
|
-
* @type {string}
|
|
360
|
-
* @memberof DeliveryEstimates
|
|
361
182
|
*/
|
|
362
183
|
'max'?: string;
|
|
363
184
|
}
|
|
364
|
-
/**
|
|
365
|
-
*
|
|
366
|
-
* @export
|
|
367
|
-
* @interface ExportOrders202Response
|
|
368
|
-
*/
|
|
369
185
|
export interface ExportOrders202Response {
|
|
370
186
|
/**
|
|
371
187
|
* A message describing the export status
|
|
372
|
-
* @type {string}
|
|
373
|
-
* @memberof ExportOrders202Response
|
|
374
188
|
*/
|
|
375
189
|
'message'?: string;
|
|
376
190
|
}
|
|
377
|
-
/**
|
|
378
|
-
*
|
|
379
|
-
* @export
|
|
380
|
-
* @interface Fulfillment
|
|
381
|
-
*/
|
|
382
191
|
export interface Fulfillment {
|
|
383
192
|
/**
|
|
384
193
|
* Unique fulfillment id
|
|
385
|
-
* @type {string}
|
|
386
|
-
* @memberof Fulfillment
|
|
387
194
|
*/
|
|
388
195
|
'id'?: string;
|
|
389
|
-
/**
|
|
390
|
-
*
|
|
391
|
-
* @type {Status}
|
|
392
|
-
* @memberof Fulfillment
|
|
393
|
-
*/
|
|
394
196
|
'status'?: Status;
|
|
395
|
-
/**
|
|
396
|
-
*
|
|
397
|
-
* @type {FulfillmentFulfiller}
|
|
398
|
-
* @memberof Fulfillment
|
|
399
|
-
*/
|
|
400
197
|
'fulfiller'?: FulfillmentFulfiller;
|
|
401
|
-
/**
|
|
402
|
-
*
|
|
403
|
-
* @type {Array<FulfillmentItem>}
|
|
404
|
-
* @memberof Fulfillment
|
|
405
|
-
*/
|
|
406
198
|
'items'?: Array<FulfillmentItem>;
|
|
407
|
-
/**
|
|
408
|
-
*
|
|
409
|
-
* @type {OrderTracking}
|
|
410
|
-
* @memberof Fulfillment
|
|
411
|
-
*/
|
|
412
199
|
'tracking'?: OrderTracking | null;
|
|
413
200
|
/**
|
|
414
201
|
* Shipping method currently set
|
|
415
|
-
* @type {ShippingMethod}
|
|
416
|
-
* @memberof Fulfillment
|
|
417
202
|
*/
|
|
418
203
|
'shippingMethod'?: ShippingMethod;
|
|
419
204
|
/**
|
|
420
205
|
* Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment.
|
|
421
|
-
* @type {Array<ShippingMethod>}
|
|
422
|
-
* @memberof Fulfillment
|
|
423
206
|
*/
|
|
424
207
|
'availableShippingMethods'?: Array<ShippingMethod>;
|
|
425
208
|
/**
|
|
426
209
|
* Weight of the package being shipped in grams
|
|
427
|
-
* @type {number}
|
|
428
|
-
* @memberof Fulfillment
|
|
429
210
|
*/
|
|
430
211
|
'packageWeight'?: number;
|
|
431
212
|
}
|
|
432
213
|
/**
|
|
433
214
|
* The fulfiller that will be processing this order.
|
|
434
|
-
* @export
|
|
435
|
-
* @interface FulfillmentFulfiller
|
|
436
215
|
*/
|
|
437
216
|
export interface FulfillmentFulfiller {
|
|
438
217
|
/**
|
|
439
218
|
* Unique object identifier
|
|
440
|
-
* @type {string}
|
|
441
|
-
* @memberof FulfillmentFulfiller
|
|
442
219
|
*/
|
|
443
220
|
'id'?: string;
|
|
444
|
-
/**
|
|
445
|
-
*
|
|
446
|
-
* @type {FulfillmentFulfillerLocation}
|
|
447
|
-
* @memberof FulfillmentFulfiller
|
|
448
|
-
*/
|
|
449
221
|
'location'?: FulfillmentFulfillerLocation;
|
|
450
222
|
}
|
|
451
|
-
/**
|
|
452
|
-
*
|
|
453
|
-
* @export
|
|
454
|
-
* @interface FulfillmentFulfillerLocation
|
|
455
|
-
*/
|
|
456
223
|
export interface FulfillmentFulfillerLocation {
|
|
457
|
-
/**
|
|
458
|
-
*
|
|
459
|
-
* @type {string}
|
|
460
|
-
* @memberof FulfillmentFulfillerLocation
|
|
461
|
-
*/
|
|
462
224
|
'city'?: string | null;
|
|
463
|
-
/**
|
|
464
|
-
*
|
|
465
|
-
* @type {string}
|
|
466
|
-
* @memberof FulfillmentFulfillerLocation
|
|
467
|
-
*/
|
|
468
225
|
'country'?: string | null;
|
|
469
226
|
}
|
|
470
|
-
/**
|
|
471
|
-
*
|
|
472
|
-
* @export
|
|
473
|
-
* @interface FulfillmentItem
|
|
474
|
-
*/
|
|
475
227
|
export interface FulfillmentItem {
|
|
476
228
|
/**
|
|
477
229
|
* Unique fulfillment item id
|
|
478
|
-
* @type {string}
|
|
479
|
-
* @memberof FulfillmentItem
|
|
480
230
|
*/
|
|
481
231
|
'id'?: string;
|
|
482
232
|
/**
|
|
483
233
|
* Id of the order item being fulfilled
|
|
484
|
-
* @type {string}
|
|
485
|
-
* @memberof FulfillmentItem
|
|
486
234
|
*/
|
|
487
235
|
'itemId'?: string;
|
|
488
236
|
/**
|
|
489
237
|
* Number of this item being fulfilled
|
|
490
|
-
* @type {number}
|
|
491
|
-
* @memberof FulfillmentItem
|
|
492
238
|
*/
|
|
493
239
|
'quantity'?: number;
|
|
494
240
|
}
|
|
495
241
|
/**
|
|
496
242
|
* Image description
|
|
497
|
-
* @export
|
|
498
|
-
* @interface Image
|
|
499
243
|
*/
|
|
500
244
|
export interface Image {
|
|
501
245
|
/**
|
|
502
246
|
* Unique object identifier
|
|
503
|
-
* @type {string}
|
|
504
|
-
* @memberof Image
|
|
505
247
|
*/
|
|
506
248
|
'id'?: string;
|
|
507
|
-
/**
|
|
508
|
-
*
|
|
509
|
-
* @type {string}
|
|
510
|
-
* @memberof Image
|
|
511
|
-
*/
|
|
512
249
|
'src'?: string;
|
|
513
|
-
/**
|
|
514
|
-
*
|
|
515
|
-
* @type {string}
|
|
516
|
-
* @memberof Image
|
|
517
|
-
*/
|
|
518
250
|
'alt'?: string;
|
|
519
|
-
/**
|
|
520
|
-
*
|
|
521
|
-
* @type {number}
|
|
522
|
-
* @memberof Image
|
|
523
|
-
*/
|
|
524
251
|
'sortOrder'?: number;
|
|
525
252
|
}
|
|
526
|
-
/**
|
|
527
|
-
*
|
|
528
|
-
* @export
|
|
529
|
-
* @interface Option
|
|
530
|
-
*/
|
|
531
253
|
export interface Option {
|
|
532
254
|
/**
|
|
533
255
|
* Option name
|
|
534
|
-
* @type {string}
|
|
535
|
-
* @memberof Option
|
|
536
256
|
*/
|
|
537
257
|
'name': string;
|
|
538
258
|
/**
|
|
539
259
|
* Option value
|
|
540
|
-
* @type {string}
|
|
541
|
-
* @memberof Option
|
|
542
260
|
*/
|
|
543
261
|
'value': string;
|
|
544
262
|
}
|
|
545
|
-
/**
|
|
546
|
-
*
|
|
547
|
-
* @export
|
|
548
|
-
* @interface Order
|
|
549
|
-
*/
|
|
550
263
|
export interface Order {
|
|
551
264
|
/**
|
|
552
265
|
* Unique object identifier
|
|
553
|
-
* @type {string}
|
|
554
|
-
* @memberof Order
|
|
555
266
|
*/
|
|
556
267
|
'id'?: string;
|
|
557
268
|
/**
|
|
558
269
|
* A reference to the resource location
|
|
559
|
-
* @type {string}
|
|
560
|
-
* @memberof Order
|
|
561
270
|
*/
|
|
562
271
|
'ref'?: string;
|
|
563
|
-
/**
|
|
564
|
-
*
|
|
565
|
-
* @type {Status}
|
|
566
|
-
* @memberof Order
|
|
567
|
-
*/
|
|
568
272
|
'status'?: Status;
|
|
569
|
-
/**
|
|
570
|
-
*
|
|
571
|
-
* @type {ContactInformation}
|
|
572
|
-
* @memberof Order
|
|
573
|
-
*/
|
|
574
273
|
'contactInformation': ContactInformation;
|
|
575
|
-
/**
|
|
576
|
-
*
|
|
577
|
-
* @type {PaymentMethod}
|
|
578
|
-
* @memberof Order
|
|
579
|
-
*/
|
|
580
274
|
'paymentMethod'?: PaymentMethod;
|
|
581
|
-
/**
|
|
582
|
-
*
|
|
583
|
-
* @type {Address}
|
|
584
|
-
* @memberof Order
|
|
585
|
-
*/
|
|
586
275
|
'shippingAddress': Address;
|
|
587
|
-
/**
|
|
588
|
-
*
|
|
589
|
-
* @type {CustomsInformation1}
|
|
590
|
-
* @memberof Order
|
|
591
|
-
*/
|
|
592
276
|
'customsInformation'?: CustomsInformation1;
|
|
593
277
|
/**
|
|
594
278
|
* ISO 8601 Timestamp
|
|
595
|
-
* @type {string}
|
|
596
|
-
* @memberof Order
|
|
597
279
|
*/
|
|
598
280
|
'createdAt'?: string;
|
|
599
281
|
/**
|
|
600
282
|
* ISO 8601 Timestamp
|
|
601
|
-
* @type {string}
|
|
602
|
-
* @memberof Order
|
|
603
283
|
*/
|
|
604
284
|
'updatedAt'?: string;
|
|
605
285
|
/**
|
|
606
286
|
* ISO 8601 Timestamp
|
|
607
|
-
* @type {string}
|
|
608
|
-
* @memberof Order
|
|
609
287
|
*/
|
|
610
288
|
'statusChangedAt'?: string;
|
|
611
289
|
/**
|
|
612
290
|
* A custom reference to the merchant\'s order.
|
|
613
|
-
* @type {string}
|
|
614
|
-
* @memberof Order
|
|
615
291
|
*/
|
|
616
292
|
'merchantReference'?: string | null;
|
|
617
|
-
/**
|
|
618
|
-
*
|
|
619
|
-
* @type {Array<Fulfillment>}
|
|
620
|
-
* @memberof Order
|
|
621
|
-
*/
|
|
622
293
|
'fulfillments'?: Array<Fulfillment>;
|
|
623
|
-
/**
|
|
624
|
-
*
|
|
625
|
-
* @type {Array<OrderItem>}
|
|
626
|
-
* @memberof Order
|
|
627
|
-
*/
|
|
628
294
|
'items': Array<OrderItem>;
|
|
629
|
-
/**
|
|
630
|
-
*
|
|
631
|
-
* @type {Price}
|
|
632
|
-
* @memberof Order
|
|
633
|
-
*/
|
|
634
295
|
'totalPrice'?: Price;
|
|
635
|
-
/**
|
|
636
|
-
*
|
|
637
|
-
* @type {Price}
|
|
638
|
-
* @memberof Order
|
|
639
|
-
*/
|
|
640
296
|
'taxPrice'?: Price;
|
|
641
|
-
/**
|
|
642
|
-
*
|
|
643
|
-
* @type {Price}
|
|
644
|
-
* @memberof Order
|
|
645
|
-
*/
|
|
646
297
|
'subtotalPrice'?: Price;
|
|
647
|
-
/**
|
|
648
|
-
*
|
|
649
|
-
* @type {Price}
|
|
650
|
-
* @memberof Order
|
|
651
|
-
*/
|
|
652
298
|
'discountPrice'?: Price;
|
|
653
|
-
/**
|
|
654
|
-
*
|
|
655
|
-
* @type {Coupon}
|
|
656
|
-
* @memberof Order
|
|
657
|
-
*/
|
|
658
299
|
'coupon'?: Coupon | null;
|
|
659
|
-
/**
|
|
660
|
-
*
|
|
661
|
-
* @type {Price}
|
|
662
|
-
* @memberof Order
|
|
663
|
-
*/
|
|
664
300
|
'shippingPrice'?: Price;
|
|
665
|
-
/**
|
|
666
|
-
*
|
|
667
|
-
* @type {Origin}
|
|
668
|
-
* @memberof Order
|
|
669
|
-
*/
|
|
670
301
|
'origin'?: Origin;
|
|
671
|
-
/**
|
|
672
|
-
*
|
|
673
|
-
* @type {Array<StatusHistoryItem>}
|
|
674
|
-
* @memberof Order
|
|
675
|
-
*/
|
|
676
302
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
677
|
-
/**
|
|
678
|
-
*
|
|
679
|
-
* @type {Array<PaymentAttempt>}
|
|
680
|
-
* @memberof Order
|
|
681
|
-
*/
|
|
682
303
|
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
683
304
|
}
|
|
684
|
-
/**
|
|
685
|
-
*
|
|
686
|
-
* @export
|
|
687
|
-
* @interface OrderItem
|
|
688
|
-
*/
|
|
689
305
|
export interface OrderItem {
|
|
690
306
|
/**
|
|
691
307
|
* Unique object identifier
|
|
692
|
-
* @type {string}
|
|
693
|
-
* @memberof OrderItem
|
|
694
308
|
*/
|
|
695
309
|
'id'?: string;
|
|
696
310
|
/**
|
|
697
311
|
* A reference to the variant being ordered
|
|
698
|
-
* @type {string}
|
|
699
|
-
* @memberof OrderItem
|
|
700
312
|
*/
|
|
701
313
|
'variantRef': string;
|
|
702
314
|
/**
|
|
703
315
|
* Options associated to an order item\'s variant, such as color and size.
|
|
704
|
-
* @type {Array<Option>}
|
|
705
|
-
* @memberof OrderItem
|
|
706
316
|
*/
|
|
707
317
|
'options'?: Array<Option>;
|
|
708
|
-
/**
|
|
709
|
-
*
|
|
710
|
-
* @type {number}
|
|
711
|
-
* @memberof OrderItem
|
|
712
|
-
*/
|
|
713
318
|
'quantity': number;
|
|
714
319
|
/**
|
|
715
320
|
* The name of the product
|
|
716
|
-
* @type {string}
|
|
717
|
-
* @memberof OrderItem
|
|
718
321
|
*/
|
|
719
322
|
'name'?: string;
|
|
720
323
|
/**
|
|
721
324
|
* Images
|
|
722
|
-
* @type {Array<Image>}
|
|
723
|
-
* @memberof OrderItem
|
|
724
325
|
*/
|
|
725
326
|
'images'?: Array<Image>;
|
|
726
|
-
/**
|
|
727
|
-
*
|
|
728
|
-
* @type {Price}
|
|
729
|
-
* @memberof OrderItem
|
|
730
|
-
*/
|
|
731
327
|
'totalPrice'?: Price;
|
|
732
328
|
/**
|
|
733
329
|
* This is an estimate until the order has been confirmed
|
|
734
|
-
* @type {Price}
|
|
735
|
-
* @memberof OrderItem
|
|
736
330
|
*/
|
|
737
331
|
'taxPrice'?: Price;
|
|
738
|
-
/**
|
|
739
|
-
*
|
|
740
|
-
* @type {Price}
|
|
741
|
-
* @memberof OrderItem
|
|
742
|
-
*/
|
|
743
332
|
'subtotalPrice'?: Price;
|
|
744
|
-
/**
|
|
745
|
-
*
|
|
746
|
-
* @type {Price}
|
|
747
|
-
* @memberof OrderItem
|
|
748
|
-
*/
|
|
749
333
|
'discountPrice'?: Price;
|
|
750
334
|
/**
|
|
751
335
|
* The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues.
|
|
752
|
-
* @type {Price}
|
|
753
|
-
* @memberof OrderItem
|
|
754
336
|
*/
|
|
755
337
|
'recipientCost'?: Price;
|
|
756
338
|
}
|
|
757
|
-
/**
|
|
758
|
-
*
|
|
759
|
-
* @export
|
|
760
|
-
* @interface OrderItem1
|
|
761
|
-
*/
|
|
762
339
|
export interface OrderItem1 {
|
|
763
340
|
/**
|
|
764
341
|
* A reference to the variant being ordered
|
|
765
|
-
* @type {string}
|
|
766
|
-
* @memberof OrderItem1
|
|
767
342
|
*/
|
|
768
343
|
'variantRef': string;
|
|
769
|
-
/**
|
|
770
|
-
*
|
|
771
|
-
* @type {number}
|
|
772
|
-
* @memberof OrderItem1
|
|
773
|
-
*/
|
|
774
344
|
'quantity': number;
|
|
775
|
-
/**
|
|
776
|
-
*
|
|
777
|
-
* @type {OrderItem1RecipientCost}
|
|
778
|
-
* @memberof OrderItem1
|
|
779
|
-
*/
|
|
780
345
|
'recipientCost'?: OrderItem1RecipientCost;
|
|
781
346
|
}
|
|
782
|
-
/**
|
|
783
|
-
*
|
|
784
|
-
* @export
|
|
785
|
-
* @interface OrderItem1RecipientCost
|
|
786
|
-
*/
|
|
787
347
|
export interface OrderItem1RecipientCost {
|
|
788
|
-
/**
|
|
789
|
-
*
|
|
790
|
-
* @type {string}
|
|
791
|
-
* @memberof OrderItem1RecipientCost
|
|
792
|
-
*/
|
|
793
348
|
'amount': string;
|
|
794
|
-
/**
|
|
795
|
-
*
|
|
796
|
-
* @type {string}
|
|
797
|
-
* @memberof OrderItem1RecipientCost
|
|
798
|
-
*/
|
|
799
349
|
'currencyCode': string;
|
|
800
350
|
}
|
|
801
|
-
/**
|
|
802
|
-
*
|
|
803
|
-
* @export
|
|
804
|
-
* @interface OrderTracking
|
|
805
|
-
*/
|
|
806
351
|
export interface OrderTracking {
|
|
807
|
-
/**
|
|
808
|
-
*
|
|
809
|
-
* @type {string}
|
|
810
|
-
* @memberof OrderTracking
|
|
811
|
-
*/
|
|
812
352
|
'courier'?: string;
|
|
813
|
-
/**
|
|
814
|
-
*
|
|
815
|
-
* @type {string}
|
|
816
|
-
* @memberof OrderTracking
|
|
817
|
-
*/
|
|
818
353
|
'code'?: string;
|
|
819
|
-
/**
|
|
820
|
-
*
|
|
821
|
-
* @type {string}
|
|
822
|
-
* @memberof OrderTracking
|
|
823
|
-
*/
|
|
824
354
|
'url'?: string;
|
|
825
355
|
}
|
|
826
|
-
/**
|
|
827
|
-
*
|
|
828
|
-
* @export
|
|
829
|
-
* @interface OrdersResponse
|
|
830
|
-
*/
|
|
831
356
|
export interface OrdersResponse {
|
|
832
|
-
/**
|
|
833
|
-
*
|
|
834
|
-
* @type {Array<Order>}
|
|
835
|
-
* @memberof OrdersResponse
|
|
836
|
-
*/
|
|
837
357
|
'orders'?: Array<Order>;
|
|
838
358
|
/**
|
|
839
359
|
* The token referencing the next page number
|
|
840
|
-
* @type {number}
|
|
841
|
-
* @memberof OrdersResponse
|
|
842
360
|
*/
|
|
843
361
|
'nextPageToken'?: number | null;
|
|
844
362
|
}
|
|
845
|
-
/**
|
|
846
|
-
*
|
|
847
|
-
* @export
|
|
848
|
-
* @interface Origin
|
|
849
|
-
*/
|
|
850
363
|
export interface Origin {
|
|
851
|
-
/**
|
|
852
|
-
*
|
|
853
|
-
* @type {string}
|
|
854
|
-
* @memberof Origin
|
|
855
|
-
*/
|
|
856
364
|
'code'?: string;
|
|
857
|
-
/**
|
|
858
|
-
*
|
|
859
|
-
* @type {boolean}
|
|
860
|
-
* @memberof Origin
|
|
861
|
-
*/
|
|
862
365
|
'isPaid'?: boolean;
|
|
863
366
|
}
|
|
864
367
|
/**
|
|
865
368
|
* List of payment attempts for this order
|
|
866
|
-
* @export
|
|
867
|
-
* @interface PaymentAttempt
|
|
868
369
|
*/
|
|
869
370
|
export interface PaymentAttempt {
|
|
870
|
-
/**
|
|
871
|
-
*
|
|
872
|
-
* @type {string}
|
|
873
|
-
* @memberof PaymentAttempt
|
|
874
|
-
*/
|
|
875
371
|
'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
|
|
876
|
-
/**
|
|
877
|
-
*
|
|
878
|
-
* @type {string}
|
|
879
|
-
* @memberof PaymentAttempt
|
|
880
|
-
*/
|
|
881
372
|
'status'?: PaymentAttemptStatusEnum;
|
|
882
|
-
/**
|
|
883
|
-
*
|
|
884
|
-
* @type {string}
|
|
885
|
-
* @memberof PaymentAttempt
|
|
886
|
-
*/
|
|
887
373
|
'transactionId'?: string | null;
|
|
888
|
-
/**
|
|
889
|
-
*
|
|
890
|
-
* @type {string}
|
|
891
|
-
* @memberof PaymentAttempt
|
|
892
|
-
*/
|
|
893
374
|
'message'?: string;
|
|
894
375
|
/**
|
|
895
376
|
* ISO 8601 Timestamp
|
|
896
|
-
* @type {string}
|
|
897
|
-
* @memberof PaymentAttempt
|
|
898
377
|
*/
|
|
899
378
|
'createdAt'?: string;
|
|
900
379
|
}
|
|
@@ -911,98 +390,35 @@ export declare const PaymentAttemptStatusEnum: {
|
|
|
911
390
|
readonly Cancelled: "cancelled";
|
|
912
391
|
};
|
|
913
392
|
export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
|
|
914
|
-
/**
|
|
915
|
-
*
|
|
916
|
-
* @export
|
|
917
|
-
* @interface PaymentMethod
|
|
918
|
-
*/
|
|
919
393
|
export interface PaymentMethod {
|
|
920
|
-
/**
|
|
921
|
-
*
|
|
922
|
-
* @type {string}
|
|
923
|
-
* @memberof PaymentMethod
|
|
924
|
-
*/
|
|
925
394
|
'type'?: string;
|
|
926
395
|
}
|
|
927
396
|
/**
|
|
928
397
|
* Standard price definition that defines the amount and currency.
|
|
929
|
-
* @export
|
|
930
|
-
* @interface Price
|
|
931
398
|
*/
|
|
932
399
|
export interface Price {
|
|
933
400
|
/**
|
|
934
401
|
* Price including tax in the specified currency.
|
|
935
|
-
* @type {string}
|
|
936
|
-
* @memberof Price
|
|
937
402
|
*/
|
|
938
403
|
'amount'?: string;
|
|
939
404
|
/**
|
|
940
405
|
* Currency code for the currency the price is valued in.
|
|
941
|
-
* @type {string}
|
|
942
|
-
* @memberof Price
|
|
943
406
|
*/
|
|
944
407
|
'currencyCode'?: string;
|
|
945
408
|
}
|
|
946
|
-
/**
|
|
947
|
-
*
|
|
948
|
-
* @export
|
|
949
|
-
* @interface ShippingMethod
|
|
950
|
-
*/
|
|
951
409
|
export interface ShippingMethod {
|
|
952
410
|
/**
|
|
953
411
|
* Unique object identifier
|
|
954
|
-
* @type {string}
|
|
955
|
-
* @memberof ShippingMethod
|
|
956
412
|
*/
|
|
957
413
|
'id'?: string;
|
|
958
|
-
/**
|
|
959
|
-
*
|
|
960
|
-
* @type {string}
|
|
961
|
-
* @memberof ShippingMethod
|
|
962
|
-
*/
|
|
963
414
|
'name'?: string;
|
|
964
|
-
/**
|
|
965
|
-
*
|
|
966
|
-
* @type {string}
|
|
967
|
-
* @memberof ShippingMethod
|
|
968
|
-
*/
|
|
969
415
|
'description'?: string;
|
|
970
|
-
/**
|
|
971
|
-
*
|
|
972
|
-
* @type {DeliveryEstimates}
|
|
973
|
-
* @memberof ShippingMethod
|
|
974
|
-
*/
|
|
975
416
|
'deliveryEstimates'?: DeliveryEstimates;
|
|
976
|
-
/**
|
|
977
|
-
*
|
|
978
|
-
* @type {Price}
|
|
979
|
-
* @memberof ShippingMethod
|
|
980
|
-
*/
|
|
981
417
|
'totalPrice'?: Price;
|
|
982
|
-
/**
|
|
983
|
-
*
|
|
984
|
-
* @type {Price}
|
|
985
|
-
* @memberof ShippingMethod
|
|
986
|
-
*/
|
|
987
418
|
'taxPrice'?: Price;
|
|
988
|
-
/**
|
|
989
|
-
*
|
|
990
|
-
* @type {Price}
|
|
991
|
-
* @memberof ShippingMethod
|
|
992
|
-
*/
|
|
993
419
|
'subtotalPrice'?: Price;
|
|
994
|
-
/**
|
|
995
|
-
*
|
|
996
|
-
* @type {Price}
|
|
997
|
-
* @memberof ShippingMethod
|
|
998
|
-
*/
|
|
999
420
|
'discountPrice'?: Price;
|
|
1000
421
|
}
|
|
1001
|
-
/**
|
|
1002
|
-
*
|
|
1003
|
-
* @export
|
|
1004
|
-
* @enum {string}
|
|
1005
|
-
*/
|
|
1006
422
|
export declare const Status: {
|
|
1007
423
|
readonly New: "new";
|
|
1008
424
|
readonly Paid: "paid";
|
|
@@ -1012,28 +428,15 @@ export declare const Status: {
|
|
|
1012
428
|
readonly Quote: "quote";
|
|
1013
429
|
};
|
|
1014
430
|
export type Status = typeof Status[keyof typeof Status];
|
|
1015
|
-
/**
|
|
1016
|
-
*
|
|
1017
|
-
* @export
|
|
1018
|
-
* @interface StatusHistoryItem
|
|
1019
|
-
*/
|
|
1020
431
|
export interface StatusHistoryItem {
|
|
1021
|
-
/**
|
|
1022
|
-
*
|
|
1023
|
-
* @type {Status}
|
|
1024
|
-
* @memberof StatusHistoryItem
|
|
1025
|
-
*/
|
|
1026
432
|
'status'?: Status;
|
|
1027
433
|
/**
|
|
1028
434
|
* ISO 8601 Timestamp
|
|
1029
|
-
* @type {string}
|
|
1030
|
-
* @memberof StatusHistoryItem
|
|
1031
435
|
*/
|
|
1032
436
|
'createdAt'?: string;
|
|
1033
437
|
}
|
|
1034
438
|
/**
|
|
1035
439
|
* OrdersApi - axios parameter creator
|
|
1036
|
-
* @export
|
|
1037
440
|
*/
|
|
1038
441
|
export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1039
442
|
/**
|
|
@@ -1127,7 +530,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1127
530
|
};
|
|
1128
531
|
/**
|
|
1129
532
|
* OrdersApi - functional programming interface
|
|
1130
|
-
* @export
|
|
1131
533
|
*/
|
|
1132
534
|
export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
1133
535
|
/**
|
|
@@ -1221,7 +623,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1221
623
|
};
|
|
1222
624
|
/**
|
|
1223
625
|
* OrdersApi - factory interface
|
|
1224
|
-
* @export
|
|
1225
626
|
*/
|
|
1226
627
|
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1227
628
|
/**
|
|
@@ -1291,257 +692,174 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
1291
692
|
};
|
|
1292
693
|
/**
|
|
1293
694
|
* Request parameters for cancelOrder operation in OrdersApi.
|
|
1294
|
-
* @export
|
|
1295
|
-
* @interface OrdersApiCancelOrderRequest
|
|
1296
695
|
*/
|
|
1297
696
|
export interface OrdersApiCancelOrderRequest {
|
|
1298
697
|
/**
|
|
1299
698
|
* What project it is
|
|
1300
|
-
* @type {string}
|
|
1301
|
-
* @memberof OrdersApiCancelOrder
|
|
1302
699
|
*/
|
|
1303
700
|
readonly project: string;
|
|
1304
701
|
/**
|
|
1305
702
|
* Unique identifier of an order
|
|
1306
|
-
* @type {string}
|
|
1307
|
-
* @memberof OrdersApiCancelOrder
|
|
1308
703
|
*/
|
|
1309
704
|
readonly orderId: string;
|
|
1310
705
|
/**
|
|
1311
706
|
* Specifies which fields to return, separated by commas
|
|
1312
|
-
* @type {string}
|
|
1313
|
-
* @memberof OrdersApiCancelOrder
|
|
1314
707
|
*/
|
|
1315
708
|
readonly fields?: string;
|
|
1316
709
|
}
|
|
1317
710
|
/**
|
|
1318
711
|
* Request parameters for confirmOrder operation in OrdersApi.
|
|
1319
|
-
* @export
|
|
1320
|
-
* @interface OrdersApiConfirmOrderRequest
|
|
1321
712
|
*/
|
|
1322
713
|
export interface OrdersApiConfirmOrderRequest {
|
|
1323
714
|
/**
|
|
1324
715
|
* What project it is
|
|
1325
|
-
* @type {string}
|
|
1326
|
-
* @memberof OrdersApiConfirmOrder
|
|
1327
716
|
*/
|
|
1328
717
|
readonly project: string;
|
|
1329
718
|
/**
|
|
1330
719
|
* Unique identifier of an order
|
|
1331
|
-
* @type {string}
|
|
1332
|
-
* @memberof OrdersApiConfirmOrder
|
|
1333
720
|
*/
|
|
1334
721
|
readonly orderId: string;
|
|
1335
722
|
/**
|
|
1336
723
|
* ConfirmFulfillment schema
|
|
1337
|
-
* @type {ConfirmOrderRequest}
|
|
1338
|
-
* @memberof OrdersApiConfirmOrder
|
|
1339
724
|
*/
|
|
1340
725
|
readonly confirmOrderRequest: ConfirmOrderRequest;
|
|
1341
726
|
/**
|
|
1342
727
|
* Specifies which fields to return, separated by commas
|
|
1343
|
-
* @type {string}
|
|
1344
|
-
* @memberof OrdersApiConfirmOrder
|
|
1345
728
|
*/
|
|
1346
729
|
readonly fields?: string;
|
|
1347
730
|
}
|
|
1348
731
|
/**
|
|
1349
732
|
* Request parameters for createOrder operation in OrdersApi.
|
|
1350
|
-
* @export
|
|
1351
|
-
* @interface OrdersApiCreateOrderRequest
|
|
1352
733
|
*/
|
|
1353
734
|
export interface OrdersApiCreateOrderRequest {
|
|
1354
735
|
/**
|
|
1355
736
|
* What project it is
|
|
1356
|
-
* @type {string}
|
|
1357
|
-
* @memberof OrdersApiCreateOrder
|
|
1358
737
|
*/
|
|
1359
738
|
readonly project: string;
|
|
1360
739
|
/**
|
|
1361
740
|
* Create Order schema
|
|
1362
|
-
* @type {CreateOrder}
|
|
1363
|
-
* @memberof OrdersApiCreateOrder
|
|
1364
741
|
*/
|
|
1365
742
|
readonly createOrder: CreateOrder;
|
|
1366
743
|
/**
|
|
1367
744
|
* Specifies which fields to return, separated by commas
|
|
1368
|
-
* @type {string}
|
|
1369
|
-
* @memberof OrdersApiCreateOrder
|
|
1370
745
|
*/
|
|
1371
746
|
readonly fields?: string;
|
|
1372
747
|
}
|
|
1373
748
|
/**
|
|
1374
749
|
* Request parameters for downloadInvoice operation in OrdersApi.
|
|
1375
|
-
* @export
|
|
1376
|
-
* @interface OrdersApiDownloadInvoiceRequest
|
|
1377
750
|
*/
|
|
1378
751
|
export interface OrdersApiDownloadInvoiceRequest {
|
|
1379
752
|
/**
|
|
1380
753
|
* What project it is
|
|
1381
|
-
* @type {string}
|
|
1382
|
-
* @memberof OrdersApiDownloadInvoice
|
|
1383
754
|
*/
|
|
1384
755
|
readonly project: string;
|
|
1385
756
|
/**
|
|
1386
757
|
* Unique identifier of an order
|
|
1387
|
-
* @type {string}
|
|
1388
|
-
* @memberof OrdersApiDownloadInvoice
|
|
1389
758
|
*/
|
|
1390
759
|
readonly orderId: string;
|
|
1391
760
|
}
|
|
1392
761
|
/**
|
|
1393
762
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
1394
|
-
* @export
|
|
1395
|
-
* @interface OrdersApiExportOrdersRequest
|
|
1396
763
|
*/
|
|
1397
764
|
export interface OrdersApiExportOrdersRequest {
|
|
1398
765
|
/**
|
|
1399
766
|
* What project it is
|
|
1400
|
-
* @type {string}
|
|
1401
|
-
* @memberof OrdersApiExportOrders
|
|
1402
767
|
*/
|
|
1403
768
|
readonly project: string;
|
|
1404
769
|
/**
|
|
1405
770
|
* Start of date range to filter by when orders were placed
|
|
1406
|
-
* @type {string}
|
|
1407
|
-
* @memberof OrdersApiExportOrders
|
|
1408
771
|
*/
|
|
1409
772
|
readonly start: string;
|
|
1410
773
|
/**
|
|
1411
774
|
* End of date range
|
|
1412
|
-
* @type {string}
|
|
1413
|
-
* @memberof OrdersApiExportOrders
|
|
1414
775
|
*/
|
|
1415
776
|
readonly end?: string;
|
|
1416
777
|
/**
|
|
1417
778
|
* Search term to filter based on order reference, customer name and email
|
|
1418
|
-
* @type {string}
|
|
1419
|
-
* @memberof OrdersApiExportOrders
|
|
1420
779
|
*/
|
|
1421
780
|
readonly search?: string;
|
|
1422
781
|
}
|
|
1423
782
|
/**
|
|
1424
783
|
* Request parameters for getOrder operation in OrdersApi.
|
|
1425
|
-
* @export
|
|
1426
|
-
* @interface OrdersApiGetOrderRequest
|
|
1427
784
|
*/
|
|
1428
785
|
export interface OrdersApiGetOrderRequest {
|
|
1429
786
|
/**
|
|
1430
787
|
* What project it is
|
|
1431
|
-
* @type {string}
|
|
1432
|
-
* @memberof OrdersApiGetOrder
|
|
1433
788
|
*/
|
|
1434
789
|
readonly project: string;
|
|
1435
790
|
/**
|
|
1436
791
|
* Unique identifier of an order
|
|
1437
|
-
* @type {string}
|
|
1438
|
-
* @memberof OrdersApiGetOrder
|
|
1439
792
|
*/
|
|
1440
793
|
readonly orderId: string;
|
|
1441
794
|
/**
|
|
1442
795
|
* Specifies which fields to return, separated by commas
|
|
1443
|
-
* @type {string}
|
|
1444
|
-
* @memberof OrdersApiGetOrder
|
|
1445
796
|
*/
|
|
1446
797
|
readonly fields?: string;
|
|
1447
798
|
}
|
|
1448
799
|
/**
|
|
1449
800
|
* Request parameters for getOrders operation in OrdersApi.
|
|
1450
|
-
* @export
|
|
1451
|
-
* @interface OrdersApiGetOrdersRequest
|
|
1452
801
|
*/
|
|
1453
802
|
export interface OrdersApiGetOrdersRequest {
|
|
1454
803
|
/**
|
|
1455
804
|
* What project it is
|
|
1456
|
-
* @type {string}
|
|
1457
|
-
* @memberof OrdersApiGetOrders
|
|
1458
805
|
*/
|
|
1459
806
|
readonly project: string;
|
|
1460
807
|
/**
|
|
1461
808
|
* Specifies which fields to return, separated by commas
|
|
1462
|
-
* @type {string}
|
|
1463
|
-
* @memberof OrdersApiGetOrders
|
|
1464
809
|
*/
|
|
1465
810
|
readonly fields?: string;
|
|
1466
811
|
/**
|
|
1467
812
|
* Page reference token
|
|
1468
|
-
* @type {number}
|
|
1469
|
-
* @memberof OrdersApiGetOrders
|
|
1470
813
|
*/
|
|
1471
814
|
readonly pageToken?: number;
|
|
1472
815
|
/**
|
|
1473
816
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1474
|
-
* @type {number}
|
|
1475
|
-
* @memberof OrdersApiGetOrders
|
|
1476
817
|
*/
|
|
1477
818
|
readonly pageSize?: number;
|
|
1478
819
|
/**
|
|
1479
820
|
* Search term to filter based on order reference, customer name and email
|
|
1480
|
-
* @type {string}
|
|
1481
|
-
* @memberof OrdersApiGetOrders
|
|
1482
821
|
*/
|
|
1483
822
|
readonly search?: string;
|
|
1484
823
|
/**
|
|
1485
824
|
* Specify fulfillment IDs to list
|
|
1486
|
-
* @type {Array<string>}
|
|
1487
|
-
* @memberof OrdersApiGetOrders
|
|
1488
825
|
*/
|
|
1489
826
|
readonly ids?: Array<string>;
|
|
1490
827
|
/**
|
|
1491
828
|
* Filter by fulfillment status
|
|
1492
|
-
* @type {Array<Status>}
|
|
1493
|
-
* @memberof OrdersApiGetOrders
|
|
1494
829
|
*/
|
|
1495
830
|
readonly statuses?: Array<Status>;
|
|
1496
831
|
/**
|
|
1497
832
|
* Start of date range
|
|
1498
|
-
* @type {string}
|
|
1499
|
-
* @memberof OrdersApiGetOrders
|
|
1500
833
|
*/
|
|
1501
834
|
readonly start?: string;
|
|
1502
835
|
/**
|
|
1503
836
|
* End of date range
|
|
1504
|
-
* @type {string}
|
|
1505
|
-
* @memberof OrdersApiGetOrders
|
|
1506
837
|
*/
|
|
1507
838
|
readonly end?: string;
|
|
1508
839
|
/**
|
|
1509
840
|
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1510
|
-
* @type {'createdAt' | 'updatedAt' | 'statusChangedAt'}
|
|
1511
|
-
* @memberof OrdersApiGetOrders
|
|
1512
841
|
*/
|
|
1513
842
|
readonly dateFilterType?: GetOrdersDateFilterTypeEnum;
|
|
1514
843
|
}
|
|
1515
844
|
/**
|
|
1516
845
|
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
1517
|
-
* @export
|
|
1518
|
-
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
1519
846
|
*/
|
|
1520
847
|
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
1521
848
|
/**
|
|
1522
849
|
* What project it is
|
|
1523
|
-
* @type {string}
|
|
1524
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
1525
850
|
*/
|
|
1526
851
|
readonly project: string;
|
|
1527
852
|
/**
|
|
1528
853
|
* Unique identifier of an order
|
|
1529
|
-
* @type {string}
|
|
1530
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
1531
854
|
*/
|
|
1532
855
|
readonly orderId: string;
|
|
1533
856
|
/**
|
|
1534
857
|
* Specifies which fields to return, separated by commas
|
|
1535
|
-
* @type {string}
|
|
1536
|
-
* @memberof OrdersApiRetryPlatformPayment
|
|
1537
858
|
*/
|
|
1538
859
|
readonly fields?: string;
|
|
1539
860
|
}
|
|
1540
861
|
/**
|
|
1541
862
|
* OrdersApi - object-oriented interface
|
|
1542
|
-
* @export
|
|
1543
|
-
* @class OrdersApi
|
|
1544
|
-
* @extends {BaseAPI}
|
|
1545
863
|
*/
|
|
1546
864
|
export declare class OrdersApi extends BaseAPI {
|
|
1547
865
|
/**
|
|
@@ -1550,76 +868,65 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
1550
868
|
* @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
|
|
1551
869
|
* @param {*} [options] Override http request option.
|
|
1552
870
|
* @throws {RequiredError}
|
|
1553
|
-
* @memberof OrdersApi
|
|
1554
871
|
*/
|
|
1555
|
-
cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
872
|
+
cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1556
873
|
/**
|
|
1557
874
|
* Confirms an order, and submits it as ready to take payment and begin processing.
|
|
1558
875
|
* @summary Confirm order
|
|
1559
876
|
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
1560
877
|
* @param {*} [options] Override http request option.
|
|
1561
878
|
* @throws {RequiredError}
|
|
1562
|
-
* @memberof OrdersApi
|
|
1563
879
|
*/
|
|
1564
|
-
confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
880
|
+
confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
|
|
1565
881
|
/**
|
|
1566
882
|
* Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
|
|
1567
883
|
* @summary Create order
|
|
1568
884
|
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
1569
885
|
* @param {*} [options] Override http request option.
|
|
1570
886
|
* @throws {RequiredError}
|
|
1571
|
-
* @memberof OrdersApi
|
|
1572
887
|
*/
|
|
1573
|
-
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
888
|
+
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
|
|
1574
889
|
/**
|
|
1575
890
|
* Download an order invoice.
|
|
1576
891
|
* @summary Download order invoice
|
|
1577
892
|
* @param {OrdersApiDownloadInvoiceRequest} requestParameters Request parameters.
|
|
1578
893
|
* @param {*} [options] Override http request option.
|
|
1579
894
|
* @throws {RequiredError}
|
|
1580
|
-
* @memberof OrdersApi
|
|
1581
895
|
*/
|
|
1582
|
-
downloadInvoice(requestParameters: OrdersApiDownloadInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
896
|
+
downloadInvoice(requestParameters: OrdersApiDownloadInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
1583
897
|
/**
|
|
1584
898
|
* Export orders as a CSV file
|
|
1585
899
|
* @summary Export orders
|
|
1586
900
|
* @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
|
|
1587
901
|
* @param {*} [options] Override http request option.
|
|
1588
902
|
* @throws {RequiredError}
|
|
1589
|
-
* @memberof OrdersApi
|
|
1590
903
|
*/
|
|
1591
|
-
exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
904
|
+
exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
1592
905
|
/**
|
|
1593
906
|
* Get an order by a given ID.
|
|
1594
907
|
* @summary Get order
|
|
1595
908
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
1596
909
|
* @param {*} [options] Override http request option.
|
|
1597
910
|
* @throws {RequiredError}
|
|
1598
|
-
* @memberof OrdersApi
|
|
1599
911
|
*/
|
|
1600
|
-
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
912
|
+
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
|
|
1601
913
|
/**
|
|
1602
914
|
* Lists all orders placed on this project, paginated into configurable chunks.
|
|
1603
915
|
* @summary List orders
|
|
1604
916
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
1605
917
|
* @param {*} [options] Override http request option.
|
|
1606
918
|
* @throws {RequiredError}
|
|
1607
|
-
* @memberof OrdersApi
|
|
1608
919
|
*/
|
|
1609
|
-
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
920
|
+
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any, {}>>;
|
|
1610
921
|
/**
|
|
1611
922
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1612
923
|
* @summary Retry
|
|
1613
924
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1614
925
|
* @param {*} [options] Override http request option.
|
|
1615
926
|
* @throws {RequiredError}
|
|
1616
|
-
* @memberof OrdersApi
|
|
1617
927
|
*/
|
|
1618
|
-
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
928
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
|
|
1619
929
|
}
|
|
1620
|
-
/**
|
|
1621
|
-
* @export
|
|
1622
|
-
*/
|
|
1623
930
|
export declare const GetOrdersDateFilterTypeEnum: {
|
|
1624
931
|
readonly CreatedAt: "createdAt";
|
|
1625
932
|
readonly UpdatedAt: "updatedAt";
|