@teemill/orders 1.29.0 → 1.29.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/README.md +3 -3
- package/api.ts +83 -21
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +82 -21
- package/dist/api.js +17 -6
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +82 -21
- package/dist/esm/api.js +16 -5
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- 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/Coupon.md +3 -3
- package/docs/Fulfillment.md +1 -1
- package/docs/ImportOrders202Response.md +1 -1
- package/docs/Order.md +2 -2
- package/docs/OrderImport.md +7 -6
- package/docs/OrderImportCounts.md +1 -0
- package/docs/OrderImportError.md +2 -1
- package/docs/OrderImportGroup.md +6 -5
- package/docs/OrderItem.md +2 -2
- package/docs/OrdersApi.md +13 -13
- package/docs/ProductUnavailableError.md +3 -3
- package/docs/StockConflictError.md +4 -3
- package/docs/StockUnavailableError.md +3 -3
- package/index.ts +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/orders@1.29.
|
|
1
|
+
## @teemill/orders@1.29.3
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/orders@1.29.
|
|
39
|
+
npm install @teemill/orders@1.29.3 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -62,7 +62,7 @@ Class | Method | HTTP request | Description
|
|
|
62
62
|
*OrdersApi* | [**importOrders**](docs/OrdersApi.md#importorders) | **POST** /v1/orders/imports | Import orders
|
|
63
63
|
*OrdersApi* | [**listOrderImportGroups**](docs/OrdersApi.md#listorderimportgroups) | **GET** /v1/orders/imports/{importId}/groups | List order import groups
|
|
64
64
|
*OrdersApi* | [**listOrderImports**](docs/OrdersApi.md#listorderimports) | **GET** /v1/orders/imports | List order imports
|
|
65
|
-
*OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry
|
|
65
|
+
*OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry platform payment
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
### Documentation For Models
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.29.
|
|
7
|
+
* The version of the OpenAPI document: 1.29.3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -154,12 +154,15 @@ export interface ContactInformation1 {
|
|
|
154
154
|
*/
|
|
155
155
|
export interface Coupon {
|
|
156
156
|
/**
|
|
157
|
-
*
|
|
157
|
+
* The unique identifier of the coupon.
|
|
158
158
|
*/
|
|
159
159
|
'id': string;
|
|
160
|
+
/**
|
|
161
|
+
* The discount code entered by the customer.
|
|
162
|
+
*/
|
|
160
163
|
'code': string;
|
|
161
164
|
/**
|
|
162
|
-
*
|
|
165
|
+
* A URI reference to the discount resource. Requires the discounts integration.
|
|
163
166
|
*/
|
|
164
167
|
'ref'?: string | null;
|
|
165
168
|
}
|
|
@@ -338,11 +341,24 @@ export interface Fulfillment {
|
|
|
338
341
|
*/
|
|
339
342
|
'frozen'?: boolean;
|
|
340
343
|
/**
|
|
341
|
-
* List of reason codes why this fulfillment is frozen.
|
|
344
|
+
* List of reason codes why this fulfillment is frozen. - `moderation` - Held for content moderation review. - `internal_screen_print` - Awaiting internal screen print processing. - `manual` - Manually frozen by a user. - `client_credit_control` - The client is under credit control. - `factory_credit_control` - The factory fulfilling the order is under credit control. - `billing_failed` - Payment for this order failed. - `pickface_flagged` - Flagged on the pickface for review. - `flow_frozen` - Frozen by internal production flow handling. - `fraud` - Frozen due to fraud checks.
|
|
342
345
|
*/
|
|
343
|
-
'frozenReasons'?: Array<
|
|
346
|
+
'frozenReasons'?: Array<FulfillmentFrozenReasonsEnum>;
|
|
344
347
|
}
|
|
345
348
|
|
|
349
|
+
export const FulfillmentFrozenReasonsEnum = {
|
|
350
|
+
Moderation: 'moderation',
|
|
351
|
+
InternalScreenPrint: 'internal_screen_print',
|
|
352
|
+
Manual: 'manual',
|
|
353
|
+
ClientCreditControl: 'client_credit_control',
|
|
354
|
+
FactoryCreditControl: 'factory_credit_control',
|
|
355
|
+
BillingFailed: 'billing_failed',
|
|
356
|
+
PickfaceFlagged: 'pickface_flagged',
|
|
357
|
+
FlowFrozen: 'flow_frozen',
|
|
358
|
+
Fraud: 'fraud',
|
|
359
|
+
} as const;
|
|
360
|
+
|
|
361
|
+
export type FulfillmentFrozenReasonsEnum = typeof FulfillmentFrozenReasonsEnum[keyof typeof FulfillmentFrozenReasonsEnum];
|
|
346
362
|
|
|
347
363
|
export interface FulfillmentItem {
|
|
348
364
|
/**
|
|
@@ -381,7 +397,7 @@ export interface Image {
|
|
|
381
397
|
}
|
|
382
398
|
export interface ImportOrders202Response {
|
|
383
399
|
/**
|
|
384
|
-
* Unique
|
|
400
|
+
* Unique identifier of the created import. Use this with the GET /v1/orders/imports/{importId} endpoint to track progress.
|
|
385
401
|
*/
|
|
386
402
|
'importId'?: string;
|
|
387
403
|
}
|
|
@@ -400,11 +416,11 @@ export interface Option {
|
|
|
400
416
|
*/
|
|
401
417
|
export interface Order {
|
|
402
418
|
/**
|
|
403
|
-
*
|
|
419
|
+
* The unique identifier of the order.
|
|
404
420
|
*/
|
|
405
421
|
'id'?: string;
|
|
406
422
|
/**
|
|
407
|
-
* A reference to
|
|
423
|
+
* A URI reference to this order resource.
|
|
408
424
|
*/
|
|
409
425
|
'ref'?: string;
|
|
410
426
|
/**
|
|
@@ -478,23 +494,41 @@ export interface Order {
|
|
|
478
494
|
}
|
|
479
495
|
|
|
480
496
|
|
|
497
|
+
/**
|
|
498
|
+
* Represents a bulk order import job, tracking the progress and outcome of importing orders from a CSV file.
|
|
499
|
+
*/
|
|
481
500
|
export interface OrderImport {
|
|
482
501
|
/**
|
|
483
|
-
*
|
|
502
|
+
* The unique identifier of this import job.
|
|
484
503
|
*/
|
|
485
504
|
'importId': string;
|
|
505
|
+
/**
|
|
506
|
+
* The current lifecycle status of this import.
|
|
507
|
+
*/
|
|
486
508
|
'status': OrderImportStatus;
|
|
487
509
|
'counts': OrderImportCounts;
|
|
488
510
|
/**
|
|
489
|
-
*
|
|
511
|
+
* The timestamp when the import was created.
|
|
490
512
|
*/
|
|
491
513
|
'createdAt': string;
|
|
514
|
+
/**
|
|
515
|
+
* The timestamp when the import was cancelled. Null if the import has not been cancelled.
|
|
516
|
+
*/
|
|
492
517
|
'cancelledAt'?: string | null;
|
|
518
|
+
/**
|
|
519
|
+
* The timestamp when the import started processing. Null if processing has not yet begun.
|
|
520
|
+
*/
|
|
493
521
|
'startedAt'?: string | null;
|
|
522
|
+
/**
|
|
523
|
+
* The timestamp when the import finished processing. Null if processing has not yet completed.
|
|
524
|
+
*/
|
|
494
525
|
'finishedAt'?: string | null;
|
|
495
526
|
}
|
|
496
527
|
|
|
497
528
|
|
|
529
|
+
/**
|
|
530
|
+
* Counts of import groups in each processing state.
|
|
531
|
+
*/
|
|
498
532
|
export interface OrderImportCounts {
|
|
499
533
|
'total': number;
|
|
500
534
|
'pending': number;
|
|
@@ -504,7 +538,13 @@ export interface OrderImportCounts {
|
|
|
504
538
|
'cancelled': number;
|
|
505
539
|
'completed': number;
|
|
506
540
|
}
|
|
541
|
+
/**
|
|
542
|
+
* An error encountered while processing an import group, including a machine-readable code and human-readable message.
|
|
543
|
+
*/
|
|
507
544
|
export interface OrderImportError {
|
|
545
|
+
/**
|
|
546
|
+
* A machine-readable error code identifying the type of import failure.
|
|
547
|
+
*/
|
|
508
548
|
'code': OrderImportErrorCode;
|
|
509
549
|
/**
|
|
510
550
|
* A human-readable description of the error.
|
|
@@ -544,11 +584,17 @@ export const OrderImportErrorCode = {
|
|
|
544
584
|
export type OrderImportErrorCode = typeof OrderImportErrorCode[keyof typeof OrderImportErrorCode];
|
|
545
585
|
|
|
546
586
|
|
|
587
|
+
/**
|
|
588
|
+
* A single group (order) within a bulk import, representing one merchant reference and its processing outcome.
|
|
589
|
+
*/
|
|
547
590
|
export interface OrderImportGroup {
|
|
548
591
|
/**
|
|
549
|
-
* Unique
|
|
592
|
+
* Unique identifier for this import group.
|
|
550
593
|
*/
|
|
551
594
|
'id': string;
|
|
595
|
+
/**
|
|
596
|
+
* The current lifecycle status of this import group.
|
|
597
|
+
*/
|
|
552
598
|
'status': OrderImportGroupStatus;
|
|
553
599
|
/**
|
|
554
600
|
* The merchant reference from the CSV rows belonging to this group.
|
|
@@ -574,8 +620,17 @@ export interface OrderImportGroup {
|
|
|
574
620
|
* Errors encountered while processing this group. Empty when the group succeeded.
|
|
575
621
|
*/
|
|
576
622
|
'errors': Array<OrderImportError>;
|
|
623
|
+
/**
|
|
624
|
+
* The timestamp when this group was created. Null if not yet set.
|
|
625
|
+
*/
|
|
577
626
|
'createdAt'?: string | null;
|
|
627
|
+
/**
|
|
628
|
+
* The timestamp when this group started processing. Null if processing has not yet begun.
|
|
629
|
+
*/
|
|
578
630
|
'startedAt'?: string | null;
|
|
631
|
+
/**
|
|
632
|
+
* The timestamp when this group finished processing. Null if processing has not yet completed.
|
|
633
|
+
*/
|
|
579
634
|
'finishedAt'?: string | null;
|
|
580
635
|
}
|
|
581
636
|
|
|
@@ -628,11 +683,11 @@ export interface OrderItem {
|
|
|
628
683
|
*/
|
|
629
684
|
'id'?: string;
|
|
630
685
|
/**
|
|
631
|
-
* A reference to the variant being ordered
|
|
686
|
+
* A reference to the product variant being ordered.
|
|
632
687
|
*/
|
|
633
688
|
'variantRef': string;
|
|
634
689
|
/**
|
|
635
|
-
*
|
|
690
|
+
* The variant attributes (e.g. Colour, Size) for this line item.
|
|
636
691
|
*/
|
|
637
692
|
'options'?: Array<Option>;
|
|
638
693
|
/**
|
|
@@ -770,6 +825,9 @@ export interface Price {
|
|
|
770
825
|
* The item cannot be fulfilled at all — either it is out of stock entirely, or the assigned fulfiller cannot produce it (e.g. missing machinery or variant not configured).
|
|
771
826
|
*/
|
|
772
827
|
export interface ProductUnavailableError {
|
|
828
|
+
/**
|
|
829
|
+
* The error code identifying this as a product unavailable error.
|
|
830
|
+
*/
|
|
773
831
|
'code': ProductUnavailableErrorCodeEnum;
|
|
774
832
|
/**
|
|
775
833
|
* Human-readable description including the product name.
|
|
@@ -780,11 +838,11 @@ export interface ProductUnavailableError {
|
|
|
780
838
|
*/
|
|
781
839
|
'productTitle': string;
|
|
782
840
|
/**
|
|
783
|
-
*
|
|
841
|
+
* The unique identifier of the unavailable variant.
|
|
784
842
|
*/
|
|
785
843
|
'variantId': string;
|
|
786
844
|
/**
|
|
787
|
-
* A reference to the variant
|
|
845
|
+
* A URI reference to the unavailable variant.
|
|
788
846
|
*/
|
|
789
847
|
'variantRef': string;
|
|
790
848
|
/**
|
|
@@ -896,6 +954,7 @@ export interface StatusHistoryItem {
|
|
|
896
954
|
|
|
897
955
|
/**
|
|
898
956
|
* @type StockConflictError
|
|
957
|
+
* An error indicating that one or more items in the order cannot be fulfilled due to stock or product availability issues. Use the \'code\' field to determine the specific error type.
|
|
899
958
|
*/
|
|
900
959
|
export type StockConflictError = { code: 'PRODUCT_UNAVAILABLE' } & ProductUnavailableError | { code: 'STOCK_UNAVAILABLE' } & StockUnavailableError;
|
|
901
960
|
|
|
@@ -903,6 +962,9 @@ export type StockConflictError = { code: 'PRODUCT_UNAVAILABLE' } & ProductUnavai
|
|
|
903
962
|
* The requested quantity exceeds available stock. The item can still be ordered in a smaller quantity.
|
|
904
963
|
*/
|
|
905
964
|
export interface StockUnavailableError {
|
|
965
|
+
/**
|
|
966
|
+
* The error code identifying this as a stock unavailable error.
|
|
967
|
+
*/
|
|
906
968
|
'code': StockUnavailableErrorCodeEnum;
|
|
907
969
|
/**
|
|
908
970
|
* Human-readable description including the product name and available quantity.
|
|
@@ -913,11 +975,11 @@ export interface StockUnavailableError {
|
|
|
913
975
|
*/
|
|
914
976
|
'productTitle': string;
|
|
915
977
|
/**
|
|
916
|
-
*
|
|
978
|
+
* The unique identifier of the variant with insufficient stock.
|
|
917
979
|
*/
|
|
918
980
|
'variantId': string;
|
|
919
981
|
/**
|
|
920
|
-
* A reference to the variant
|
|
982
|
+
* A URI reference to the variant with insufficient stock.
|
|
921
983
|
*/
|
|
922
984
|
'variantRef': string;
|
|
923
985
|
/**
|
|
@@ -1591,7 +1653,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1591
1653
|
},
|
|
1592
1654
|
/**
|
|
1593
1655
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1594
|
-
* @summary Retry
|
|
1656
|
+
* @summary Retry platform payment
|
|
1595
1657
|
* @param {string} project The project identifier to scope the request to.
|
|
1596
1658
|
* @param {string} orderId Unique identifier of an order
|
|
1597
1659
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
@@ -1826,7 +1888,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
1826
1888
|
},
|
|
1827
1889
|
/**
|
|
1828
1890
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1829
|
-
* @summary Retry
|
|
1891
|
+
* @summary Retry platform payment
|
|
1830
1892
|
* @param {string} project The project identifier to scope the request to.
|
|
1831
1893
|
* @param {string} orderId Unique identifier of an order
|
|
1832
1894
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
@@ -1960,7 +2022,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
1960
2022
|
},
|
|
1961
2023
|
/**
|
|
1962
2024
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1963
|
-
* @summary Retry
|
|
2025
|
+
* @summary Retry platform payment
|
|
1964
2026
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1965
2027
|
* @param {*} [options] Override http request option.
|
|
1966
2028
|
* @throws {RequiredError}
|
|
@@ -2378,7 +2440,7 @@ export class OrdersApi extends BaseAPI {
|
|
|
2378
2440
|
|
|
2379
2441
|
/**
|
|
2380
2442
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
2381
|
-
* @summary Retry
|
|
2443
|
+
* @summary Retry platform payment
|
|
2382
2444
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
2383
2445
|
* @param {*} [options] Override http request option.
|
|
2384
2446
|
* @throws {RequiredError}
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.29.
|
|
7
|
+
* The version of the OpenAPI document: 1.29.3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Orders
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.29.
|
|
7
|
+
* The version of the OpenAPI document: 1.29.3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Orders
|
|
4
4
|
* 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.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.29.
|
|
6
|
+
* The version of the OpenAPI document: 1.29.3
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
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.29.
|
|
5
|
+
* The version of the OpenAPI document: 1.29.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -140,12 +140,15 @@ export interface ContactInformation1 {
|
|
|
140
140
|
*/
|
|
141
141
|
export interface Coupon {
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
143
|
+
* The unique identifier of the coupon.
|
|
144
144
|
*/
|
|
145
145
|
'id': string;
|
|
146
|
+
/**
|
|
147
|
+
* The discount code entered by the customer.
|
|
148
|
+
*/
|
|
146
149
|
'code': string;
|
|
147
150
|
/**
|
|
148
|
-
*
|
|
151
|
+
* A URI reference to the discount resource. Requires the discounts integration.
|
|
149
152
|
*/
|
|
150
153
|
'ref'?: string | null;
|
|
151
154
|
}
|
|
@@ -321,10 +324,22 @@ export interface Fulfillment {
|
|
|
321
324
|
*/
|
|
322
325
|
'frozen'?: boolean;
|
|
323
326
|
/**
|
|
324
|
-
* List of reason codes why this fulfillment is frozen.
|
|
327
|
+
* List of reason codes why this fulfillment is frozen. - `moderation` - Held for content moderation review. - `internal_screen_print` - Awaiting internal screen print processing. - `manual` - Manually frozen by a user. - `client_credit_control` - The client is under credit control. - `factory_credit_control` - The factory fulfilling the order is under credit control. - `billing_failed` - Payment for this order failed. - `pickface_flagged` - Flagged on the pickface for review. - `flow_frozen` - Frozen by internal production flow handling. - `fraud` - Frozen due to fraud checks.
|
|
325
328
|
*/
|
|
326
|
-
'frozenReasons'?: Array<
|
|
329
|
+
'frozenReasons'?: Array<FulfillmentFrozenReasonsEnum>;
|
|
327
330
|
}
|
|
331
|
+
export declare const FulfillmentFrozenReasonsEnum: {
|
|
332
|
+
readonly Moderation: "moderation";
|
|
333
|
+
readonly InternalScreenPrint: "internal_screen_print";
|
|
334
|
+
readonly Manual: "manual";
|
|
335
|
+
readonly ClientCreditControl: "client_credit_control";
|
|
336
|
+
readonly FactoryCreditControl: "factory_credit_control";
|
|
337
|
+
readonly BillingFailed: "billing_failed";
|
|
338
|
+
readonly PickfaceFlagged: "pickface_flagged";
|
|
339
|
+
readonly FlowFrozen: "flow_frozen";
|
|
340
|
+
readonly Fraud: "fraud";
|
|
341
|
+
};
|
|
342
|
+
export type FulfillmentFrozenReasonsEnum = typeof FulfillmentFrozenReasonsEnum[keyof typeof FulfillmentFrozenReasonsEnum];
|
|
328
343
|
export interface FulfillmentItem {
|
|
329
344
|
/**
|
|
330
345
|
* Unique identifier for this fulfillment item.
|
|
@@ -362,7 +377,7 @@ export interface Image {
|
|
|
362
377
|
}
|
|
363
378
|
export interface ImportOrders202Response {
|
|
364
379
|
/**
|
|
365
|
-
* Unique
|
|
380
|
+
* Unique identifier of the created import. Use this with the GET /v1/orders/imports/{importId} endpoint to track progress.
|
|
366
381
|
*/
|
|
367
382
|
'importId'?: string;
|
|
368
383
|
}
|
|
@@ -381,11 +396,11 @@ export interface Option {
|
|
|
381
396
|
*/
|
|
382
397
|
export interface Order {
|
|
383
398
|
/**
|
|
384
|
-
*
|
|
399
|
+
* The unique identifier of the order.
|
|
385
400
|
*/
|
|
386
401
|
'id'?: string;
|
|
387
402
|
/**
|
|
388
|
-
* A reference to
|
|
403
|
+
* A URI reference to this order resource.
|
|
389
404
|
*/
|
|
390
405
|
'ref'?: string;
|
|
391
406
|
/**
|
|
@@ -457,21 +472,39 @@ export interface Order {
|
|
|
457
472
|
*/
|
|
458
473
|
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
459
474
|
}
|
|
475
|
+
/**
|
|
476
|
+
* Represents a bulk order import job, tracking the progress and outcome of importing orders from a CSV file.
|
|
477
|
+
*/
|
|
460
478
|
export interface OrderImport {
|
|
461
479
|
/**
|
|
462
|
-
*
|
|
480
|
+
* The unique identifier of this import job.
|
|
463
481
|
*/
|
|
464
482
|
'importId': string;
|
|
483
|
+
/**
|
|
484
|
+
* The current lifecycle status of this import.
|
|
485
|
+
*/
|
|
465
486
|
'status': OrderImportStatus;
|
|
466
487
|
'counts': OrderImportCounts;
|
|
467
488
|
/**
|
|
468
|
-
*
|
|
489
|
+
* The timestamp when the import was created.
|
|
469
490
|
*/
|
|
470
491
|
'createdAt': string;
|
|
492
|
+
/**
|
|
493
|
+
* The timestamp when the import was cancelled. Null if the import has not been cancelled.
|
|
494
|
+
*/
|
|
471
495
|
'cancelledAt'?: string | null;
|
|
496
|
+
/**
|
|
497
|
+
* The timestamp when the import started processing. Null if processing has not yet begun.
|
|
498
|
+
*/
|
|
472
499
|
'startedAt'?: string | null;
|
|
500
|
+
/**
|
|
501
|
+
* The timestamp when the import finished processing. Null if processing has not yet completed.
|
|
502
|
+
*/
|
|
473
503
|
'finishedAt'?: string | null;
|
|
474
504
|
}
|
|
505
|
+
/**
|
|
506
|
+
* Counts of import groups in each processing state.
|
|
507
|
+
*/
|
|
475
508
|
export interface OrderImportCounts {
|
|
476
509
|
'total': number;
|
|
477
510
|
'pending': number;
|
|
@@ -481,7 +514,13 @@ export interface OrderImportCounts {
|
|
|
481
514
|
'cancelled': number;
|
|
482
515
|
'completed': number;
|
|
483
516
|
}
|
|
517
|
+
/**
|
|
518
|
+
* An error encountered while processing an import group, including a machine-readable code and human-readable message.
|
|
519
|
+
*/
|
|
484
520
|
export interface OrderImportError {
|
|
521
|
+
/**
|
|
522
|
+
* A machine-readable error code identifying the type of import failure.
|
|
523
|
+
*/
|
|
485
524
|
'code': OrderImportErrorCode;
|
|
486
525
|
/**
|
|
487
526
|
* A human-readable description of the error.
|
|
@@ -515,11 +554,17 @@ export declare const OrderImportErrorCode: {
|
|
|
515
554
|
readonly ImportFailed: "IMPORT_FAILED";
|
|
516
555
|
};
|
|
517
556
|
export type OrderImportErrorCode = typeof OrderImportErrorCode[keyof typeof OrderImportErrorCode];
|
|
557
|
+
/**
|
|
558
|
+
* A single group (order) within a bulk import, representing one merchant reference and its processing outcome.
|
|
559
|
+
*/
|
|
518
560
|
export interface OrderImportGroup {
|
|
519
561
|
/**
|
|
520
|
-
* Unique
|
|
562
|
+
* Unique identifier for this import group.
|
|
521
563
|
*/
|
|
522
564
|
'id': string;
|
|
565
|
+
/**
|
|
566
|
+
* The current lifecycle status of this import group.
|
|
567
|
+
*/
|
|
523
568
|
'status': OrderImportGroupStatus;
|
|
524
569
|
/**
|
|
525
570
|
* The merchant reference from the CSV rows belonging to this group.
|
|
@@ -545,8 +590,17 @@ export interface OrderImportGroup {
|
|
|
545
590
|
* Errors encountered while processing this group. Empty when the group succeeded.
|
|
546
591
|
*/
|
|
547
592
|
'errors': Array<OrderImportError>;
|
|
593
|
+
/**
|
|
594
|
+
* The timestamp when this group was created. Null if not yet set.
|
|
595
|
+
*/
|
|
548
596
|
'createdAt'?: string | null;
|
|
597
|
+
/**
|
|
598
|
+
* The timestamp when this group started processing. Null if processing has not yet begun.
|
|
599
|
+
*/
|
|
549
600
|
'startedAt'?: string | null;
|
|
601
|
+
/**
|
|
602
|
+
* The timestamp when this group finished processing. Null if processing has not yet completed.
|
|
603
|
+
*/
|
|
550
604
|
'finishedAt'?: string | null;
|
|
551
605
|
}
|
|
552
606
|
/**
|
|
@@ -589,11 +643,11 @@ export interface OrderItem {
|
|
|
589
643
|
*/
|
|
590
644
|
'id'?: string;
|
|
591
645
|
/**
|
|
592
|
-
* A reference to the variant being ordered
|
|
646
|
+
* A reference to the product variant being ordered.
|
|
593
647
|
*/
|
|
594
648
|
'variantRef': string;
|
|
595
649
|
/**
|
|
596
|
-
*
|
|
650
|
+
* The variant attributes (e.g. Colour, Size) for this line item.
|
|
597
651
|
*/
|
|
598
652
|
'options'?: Array<Option>;
|
|
599
653
|
/**
|
|
@@ -727,6 +781,9 @@ export interface Price {
|
|
|
727
781
|
* The item cannot be fulfilled at all — either it is out of stock entirely, or the assigned fulfiller cannot produce it (e.g. missing machinery or variant not configured).
|
|
728
782
|
*/
|
|
729
783
|
export interface ProductUnavailableError {
|
|
784
|
+
/**
|
|
785
|
+
* The error code identifying this as a product unavailable error.
|
|
786
|
+
*/
|
|
730
787
|
'code': ProductUnavailableErrorCodeEnum;
|
|
731
788
|
/**
|
|
732
789
|
* Human-readable description including the product name.
|
|
@@ -737,11 +794,11 @@ export interface ProductUnavailableError {
|
|
|
737
794
|
*/
|
|
738
795
|
'productTitle': string;
|
|
739
796
|
/**
|
|
740
|
-
*
|
|
797
|
+
* The unique identifier of the unavailable variant.
|
|
741
798
|
*/
|
|
742
799
|
'variantId': string;
|
|
743
800
|
/**
|
|
744
|
-
* A reference to the variant
|
|
801
|
+
* A URI reference to the unavailable variant.
|
|
745
802
|
*/
|
|
746
803
|
'variantRef': string;
|
|
747
804
|
/**
|
|
@@ -843,6 +900,7 @@ export interface StatusHistoryItem {
|
|
|
843
900
|
}
|
|
844
901
|
/**
|
|
845
902
|
* @type StockConflictError
|
|
903
|
+
* An error indicating that one or more items in the order cannot be fulfilled due to stock or product availability issues. Use the \'code\' field to determine the specific error type.
|
|
846
904
|
*/
|
|
847
905
|
export type StockConflictError = {
|
|
848
906
|
code: 'PRODUCT_UNAVAILABLE';
|
|
@@ -853,6 +911,9 @@ export type StockConflictError = {
|
|
|
853
911
|
* The requested quantity exceeds available stock. The item can still be ordered in a smaller quantity.
|
|
854
912
|
*/
|
|
855
913
|
export interface StockUnavailableError {
|
|
914
|
+
/**
|
|
915
|
+
* The error code identifying this as a stock unavailable error.
|
|
916
|
+
*/
|
|
856
917
|
'code': StockUnavailableErrorCodeEnum;
|
|
857
918
|
/**
|
|
858
919
|
* Human-readable description including the product name and available quantity.
|
|
@@ -863,11 +924,11 @@ export interface StockUnavailableError {
|
|
|
863
924
|
*/
|
|
864
925
|
'productTitle': string;
|
|
865
926
|
/**
|
|
866
|
-
*
|
|
927
|
+
* The unique identifier of the variant with insufficient stock.
|
|
867
928
|
*/
|
|
868
929
|
'variantId': string;
|
|
869
930
|
/**
|
|
870
|
-
* A reference to the variant
|
|
931
|
+
* A URI reference to the variant with insufficient stock.
|
|
871
932
|
*/
|
|
872
933
|
'variantRef': string;
|
|
873
934
|
/**
|
|
@@ -1011,7 +1072,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1011
1072
|
listOrderImports: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1012
1073
|
/**
|
|
1013
1074
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1014
|
-
* @summary Retry
|
|
1075
|
+
* @summary Retry platform payment
|
|
1015
1076
|
* @param {string} project The project identifier to scope the request to.
|
|
1016
1077
|
* @param {string} orderId Unique identifier of an order
|
|
1017
1078
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
@@ -1144,7 +1205,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1144
1205
|
listOrderImports(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderImportsResponse>>;
|
|
1145
1206
|
/**
|
|
1146
1207
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1147
|
-
* @summary Retry
|
|
1208
|
+
* @summary Retry platform payment
|
|
1148
1209
|
* @param {string} project The project identifier to scope the request to.
|
|
1149
1210
|
* @param {string} orderId Unique identifier of an order
|
|
1150
1211
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
@@ -1247,7 +1308,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
1247
1308
|
listOrderImports(requestParameters: OrdersApiListOrderImportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrderImportsResponse>;
|
|
1248
1309
|
/**
|
|
1249
1310
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1250
|
-
* @summary Retry
|
|
1311
|
+
* @summary Retry platform payment
|
|
1251
1312
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1252
1313
|
* @param {*} [options] Override http request option.
|
|
1253
1314
|
* @throws {RequiredError}
|
|
@@ -1584,7 +1645,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
1584
1645
|
listOrderImports(requestParameters: OrdersApiListOrderImportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderImportsResponse, any, {}>>;
|
|
1585
1646
|
/**
|
|
1586
1647
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1587
|
-
* @summary Retry
|
|
1648
|
+
* @summary Retry platform payment
|
|
1588
1649
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1589
1650
|
* @param {*} [options] Override http request option.
|
|
1590
1651
|
* @throws {RequiredError}
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Orders
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.29.
|
|
8
|
+
* The version of the OpenAPI document: 1.29.3
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.GetOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.StockUnavailableErrorCodeEnum = exports.Status = exports.ProductUnavailableErrorAvailableQuantityEnum = exports.ProductUnavailableErrorCodeEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.OrderImportStatus = exports.OrderImportGroupStatus = exports.OrderImportErrorCode = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
|
|
25
|
+
exports.GetOrdersDateFilterTypeEnum = exports.ExportOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.StockUnavailableErrorCodeEnum = exports.Status = exports.ProductUnavailableErrorAvailableQuantityEnum = exports.ProductUnavailableErrorCodeEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.OrderImportStatus = exports.OrderImportGroupStatus = exports.OrderImportErrorCode = exports.FulfillmentFrozenReasonsEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.ConfirmOrderValidationErrorCodeEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -38,6 +38,17 @@ exports.ConfirmOrderValidationErrorCodeEnum = {
|
|
|
38
38
|
exports.CustomsInformationPreRegistrationTypeEnum = {
|
|
39
39
|
Ioss: 'IOSS',
|
|
40
40
|
};
|
|
41
|
+
exports.FulfillmentFrozenReasonsEnum = {
|
|
42
|
+
Moderation: 'moderation',
|
|
43
|
+
InternalScreenPrint: 'internal_screen_print',
|
|
44
|
+
Manual: 'manual',
|
|
45
|
+
ClientCreditControl: 'client_credit_control',
|
|
46
|
+
FactoryCreditControl: 'factory_credit_control',
|
|
47
|
+
BillingFailed: 'billing_failed',
|
|
48
|
+
PickfaceFlagged: 'pickface_flagged',
|
|
49
|
+
FlowFrozen: 'flow_frozen',
|
|
50
|
+
Fraud: 'fraud',
|
|
51
|
+
};
|
|
41
52
|
/**
|
|
42
53
|
* Machine-readable error code identifying the type of import failure: - `VARIANT_NOT_FOUND` — The SKU does not match any variant in the project\'s catalog - `MISSING_SKU` — A required SKU field was empty or missing - `SHIPPING_METHOD_UNAVAILABLE` — No shipping methods are available for the fulfillment - `TRANSIENT_SYSTEM_ERROR` — A temporary system issue occurred; the import may succeed on retry - `IMPORT_FAILED` — A general import failure that does not match a more specific code
|
|
43
54
|
*/
|
|
@@ -652,7 +663,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
652
663
|
}),
|
|
653
664
|
/**
|
|
654
665
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
655
|
-
* @summary Retry
|
|
666
|
+
* @summary Retry platform payment
|
|
656
667
|
* @param {string} project The project identifier to scope the request to.
|
|
657
668
|
* @param {string} orderId Unique identifier of an order
|
|
658
669
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
@@ -912,7 +923,7 @@ const OrdersApiFp = function (configuration) {
|
|
|
912
923
|
},
|
|
913
924
|
/**
|
|
914
925
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
915
|
-
* @summary Retry
|
|
926
|
+
* @summary Retry platform payment
|
|
916
927
|
* @param {string} project The project identifier to scope the request to.
|
|
917
928
|
* @param {string} orderId Unique identifier of an order
|
|
918
929
|
* @param {string} [fields] Specifies which fields to return, separated by commas
|
|
@@ -1049,7 +1060,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
1049
1060
|
},
|
|
1050
1061
|
/**
|
|
1051
1062
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1052
|
-
* @summary Retry
|
|
1063
|
+
* @summary Retry platform payment
|
|
1053
1064
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1054
1065
|
* @param {*} [options] Override http request option.
|
|
1055
1066
|
* @throws {RequiredError}
|
|
@@ -1176,7 +1187,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
1176
1187
|
}
|
|
1177
1188
|
/**
|
|
1178
1189
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
1179
|
-
* @summary Retry
|
|
1190
|
+
* @summary Retry platform payment
|
|
1180
1191
|
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
1181
1192
|
* @param {*} [options] Override http request option.
|
|
1182
1193
|
* @throws {RequiredError}
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Orders
|
|
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.29.
|
|
5
|
+
* The version of the OpenAPI document: 1.29.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|