ultracart_rest_api_v2_typescript 4.1.127 → 4.1.129
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 +4 -2
- package/dist/models/ChannelPartnerOrder.d.ts +18 -0
- package/dist/models/ChannelPartnerOrder.js +6 -0
- package/dist/models/OrderChannelPartner.d.ts +6 -0
- package/dist/models/OrderChannelPartner.js +2 -0
- package/package.json +1 -1
- package/src/models/ChannelPartnerOrder.ts +24 -0
- package/src/models/OrderChannelPartner.ts +8 -0
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.129
|
|
3
3
|
|
|
4
4
|
Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
|
|
5
5
|
|
|
6
6
|
Installation
|
|
7
7
|
|
|
8
8
|
```
|
|
9
|
-
npm install ultracart_rest_api_v2_typescript@4.1.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.129 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.129 | 08/13/2026 | ChannelPartnerOrder and OrderChannelPartner were missing a property |
|
|
89
|
+
| 4.1.128 | 08/13/2026 | channel partner - added arbitrary discount to ChannelPartnerOrder |
|
|
88
90
|
| 4.1.127 | 08/13/2026 | added arbitrary discounts to order creation for historical imports |
|
|
89
91
|
| 4.1.126 | 08/10/2026 | oauth - add /oauth/me method to assist application in indentifying the connected account |
|
|
90
92
|
| 4.1.125 | 08/06/2026 | order api - ability to query by bin and last 4 in unlimited scenarios for chargeback order association |
|
|
@@ -41,6 +41,12 @@ export interface ChannelPartnerOrder {
|
|
|
41
41
|
* @memberof ChannelPartnerOrder
|
|
42
42
|
*/
|
|
43
43
|
arbitrary_shipping_handling_total?: number;
|
|
44
|
+
/**
|
|
45
|
+
* Arbitrary subtotal discount for overriding the calculated subtotal discount. Send the gross price in the item arbitrary unit cost and the discount here.
|
|
46
|
+
* @type {number}
|
|
47
|
+
* @memberof ChannelPartnerOrder
|
|
48
|
+
*/
|
|
49
|
+
arbitrary_subtotal_discount?: number;
|
|
44
50
|
/**
|
|
45
51
|
* Arbitrary tax for overriding calculated taxes
|
|
46
52
|
* @type {number}
|
|
@@ -59,6 +65,12 @@ export interface ChannelPartnerOrder {
|
|
|
59
65
|
* @memberof ChannelPartnerOrder
|
|
60
66
|
*/
|
|
61
67
|
arbitrary_taxable_subtotal?: number;
|
|
68
|
+
/**
|
|
69
|
+
* Arbitrary taxable subtotal discount. If an arbitrary subtotal discount is supplied without this field, the arbitrary subtotal discount is used for both.
|
|
70
|
+
* @type {number}
|
|
71
|
+
* @memberof ChannelPartnerOrder
|
|
72
|
+
*/
|
|
73
|
+
arbitrary_taxable_subtotal_discount?: number;
|
|
62
74
|
/**
|
|
63
75
|
* If true any matching customer profile based on email is associated with this order
|
|
64
76
|
* @type {boolean}
|
|
@@ -521,6 +533,12 @@ export interface ChannelPartnerOrder {
|
|
|
521
533
|
* @memberof ChannelPartnerOrder
|
|
522
534
|
*/
|
|
523
535
|
shipto_title?: string;
|
|
536
|
+
/**
|
|
537
|
+
* If true the setup of the auto order record is skipped
|
|
538
|
+
* @type {boolean}
|
|
539
|
+
* @memberof ChannelPartnerOrder
|
|
540
|
+
*/
|
|
541
|
+
skip_auto_order_setup?: boolean;
|
|
524
542
|
/**
|
|
525
543
|
* If true the order is placed directly into the shipping department
|
|
526
544
|
* @type {boolean}
|
|
@@ -70,9 +70,11 @@ function ChannelPartnerOrderFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
70
70
|
'affiliate_id': !(0, runtime_1.exists)(json, 'affiliate_id') ? undefined : json['affiliate_id'],
|
|
71
71
|
'affiliate_sub_id': !(0, runtime_1.exists)(json, 'affiliate_sub_id') ? undefined : json['affiliate_sub_id'],
|
|
72
72
|
'arbitrary_shipping_handling_total': !(0, runtime_1.exists)(json, 'arbitrary_shipping_handling_total') ? undefined : json['arbitrary_shipping_handling_total'],
|
|
73
|
+
'arbitrary_subtotal_discount': !(0, runtime_1.exists)(json, 'arbitrary_subtotal_discount') ? undefined : json['arbitrary_subtotal_discount'],
|
|
73
74
|
'arbitrary_tax': !(0, runtime_1.exists)(json, 'arbitrary_tax') ? undefined : json['arbitrary_tax'],
|
|
74
75
|
'arbitrary_tax_rate': !(0, runtime_1.exists)(json, 'arbitrary_tax_rate') ? undefined : json['arbitrary_tax_rate'],
|
|
75
76
|
'arbitrary_taxable_subtotal': !(0, runtime_1.exists)(json, 'arbitrary_taxable_subtotal') ? undefined : json['arbitrary_taxable_subtotal'],
|
|
77
|
+
'arbitrary_taxable_subtotal_discount': !(0, runtime_1.exists)(json, 'arbitrary_taxable_subtotal_discount') ? undefined : json['arbitrary_taxable_subtotal_discount'],
|
|
76
78
|
'associate_with_customer_profile_if_present': !(0, runtime_1.exists)(json, 'associate_with_customer_profile_if_present') ? undefined : json['associate_with_customer_profile_if_present'],
|
|
77
79
|
'auto_approve_purchase_order': !(0, runtime_1.exists)(json, 'auto_approve_purchase_order') ? undefined : json['auto_approve_purchase_order'],
|
|
78
80
|
'billto_address1': !(0, runtime_1.exists)(json, 'billto_address1') ? undefined : json['billto_address1'],
|
|
@@ -150,6 +152,7 @@ function ChannelPartnerOrderFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
150
152
|
'shipto_postal_code': !(0, runtime_1.exists)(json, 'shipto_postal_code') ? undefined : json['shipto_postal_code'],
|
|
151
153
|
'shipto_state_region': !(0, runtime_1.exists)(json, 'shipto_state_region') ? undefined : json['shipto_state_region'],
|
|
152
154
|
'shipto_title': !(0, runtime_1.exists)(json, 'shipto_title') ? undefined : json['shipto_title'],
|
|
155
|
+
'skip_auto_order_setup': !(0, runtime_1.exists)(json, 'skip_auto_order_setup') ? undefined : json['skip_auto_order_setup'],
|
|
153
156
|
'skip_payment_processing': !(0, runtime_1.exists)(json, 'skip_payment_processing') ? undefined : json['skip_payment_processing'],
|
|
154
157
|
'special_instructions': !(0, runtime_1.exists)(json, 'special_instructions') ? undefined : json['special_instructions'],
|
|
155
158
|
'store_completed': !(0, runtime_1.exists)(json, 'store_completed') ? undefined : json['store_completed'],
|
|
@@ -175,9 +178,11 @@ function ChannelPartnerOrderToJSON(value) {
|
|
|
175
178
|
'affiliate_id': value.affiliate_id,
|
|
176
179
|
'affiliate_sub_id': value.affiliate_sub_id,
|
|
177
180
|
'arbitrary_shipping_handling_total': value.arbitrary_shipping_handling_total,
|
|
181
|
+
'arbitrary_subtotal_discount': value.arbitrary_subtotal_discount,
|
|
178
182
|
'arbitrary_tax': value.arbitrary_tax,
|
|
179
183
|
'arbitrary_tax_rate': value.arbitrary_tax_rate,
|
|
180
184
|
'arbitrary_taxable_subtotal': value.arbitrary_taxable_subtotal,
|
|
185
|
+
'arbitrary_taxable_subtotal_discount': value.arbitrary_taxable_subtotal_discount,
|
|
181
186
|
'associate_with_customer_profile_if_present': value.associate_with_customer_profile_if_present,
|
|
182
187
|
'auto_approve_purchase_order': value.auto_approve_purchase_order,
|
|
183
188
|
'billto_address1': value.billto_address1,
|
|
@@ -255,6 +260,7 @@ function ChannelPartnerOrderToJSON(value) {
|
|
|
255
260
|
'shipto_postal_code': value.shipto_postal_code,
|
|
256
261
|
'shipto_state_region': value.shipto_state_region,
|
|
257
262
|
'shipto_title': value.shipto_title,
|
|
263
|
+
'skip_auto_order_setup': value.skip_auto_order_setup,
|
|
258
264
|
'skip_payment_processing': value.skip_payment_processing,
|
|
259
265
|
'special_instructions': value.special_instructions,
|
|
260
266
|
'store_completed': value.store_completed,
|
|
@@ -57,6 +57,12 @@ export interface OrderChannelPartner {
|
|
|
57
57
|
* @memberof OrderChannelPartner
|
|
58
58
|
*/
|
|
59
59
|
no_realtime_payment_processing?: boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Instructs UltraCart to skip auto order setup. Only applicable on inserting orders.
|
|
62
|
+
* @type {boolean}
|
|
63
|
+
* @memberof OrderChannelPartner
|
|
64
|
+
*/
|
|
65
|
+
skip_auto_order_setup?: boolean;
|
|
60
66
|
/**
|
|
61
67
|
* Indicates this order was already paid for via a channel purchase and no payment collection should be attempted
|
|
62
68
|
* @type {boolean}
|
|
@@ -39,6 +39,7 @@ function OrderChannelPartnerFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
39
39
|
'channel_partner_order_id': !(0, runtime_1.exists)(json, 'channel_partner_order_id') ? undefined : json['channel_partner_order_id'],
|
|
40
40
|
'ignore_invalid_shipping_method': !(0, runtime_1.exists)(json, 'ignore_invalid_shipping_method') ? undefined : json['ignore_invalid_shipping_method'],
|
|
41
41
|
'no_realtime_payment_processing': !(0, runtime_1.exists)(json, 'no_realtime_payment_processing') ? undefined : json['no_realtime_payment_processing'],
|
|
42
|
+
'skip_auto_order_setup': !(0, runtime_1.exists)(json, 'skip_auto_order_setup') ? undefined : json['skip_auto_order_setup'],
|
|
42
43
|
'skip_payment_processing': !(0, runtime_1.exists)(json, 'skip_payment_processing') ? undefined : json['skip_payment_processing'],
|
|
43
44
|
'store_completed': !(0, runtime_1.exists)(json, 'store_completed') ? undefined : json['store_completed'],
|
|
44
45
|
'store_if_payment_declines': !(0, runtime_1.exists)(json, 'store_if_payment_declines') ? undefined : json['store_if_payment_declines'],
|
|
@@ -61,6 +62,7 @@ function OrderChannelPartnerToJSON(value) {
|
|
|
61
62
|
'channel_partner_order_id': value.channel_partner_order_id,
|
|
62
63
|
'ignore_invalid_shipping_method': value.ignore_invalid_shipping_method,
|
|
63
64
|
'no_realtime_payment_processing': value.no_realtime_payment_processing,
|
|
65
|
+
'skip_auto_order_setup': value.skip_auto_order_setup,
|
|
64
66
|
'skip_payment_processing': value.skip_payment_processing,
|
|
65
67
|
'store_completed': value.store_completed,
|
|
66
68
|
'store_if_payment_declines': value.store_if_payment_declines,
|
package/package.json
CHANGED
|
@@ -56,6 +56,12 @@ export interface ChannelPartnerOrder {
|
|
|
56
56
|
* @memberof ChannelPartnerOrder
|
|
57
57
|
*/
|
|
58
58
|
arbitrary_shipping_handling_total?: number;
|
|
59
|
+
/**
|
|
60
|
+
* Arbitrary subtotal discount for overriding the calculated subtotal discount. Send the gross price in the item arbitrary unit cost and the discount here.
|
|
61
|
+
* @type {number}
|
|
62
|
+
* @memberof ChannelPartnerOrder
|
|
63
|
+
*/
|
|
64
|
+
arbitrary_subtotal_discount?: number;
|
|
59
65
|
/**
|
|
60
66
|
* Arbitrary tax for overriding calculated taxes
|
|
61
67
|
* @type {number}
|
|
@@ -74,6 +80,12 @@ export interface ChannelPartnerOrder {
|
|
|
74
80
|
* @memberof ChannelPartnerOrder
|
|
75
81
|
*/
|
|
76
82
|
arbitrary_taxable_subtotal?: number;
|
|
83
|
+
/**
|
|
84
|
+
* Arbitrary taxable subtotal discount. If an arbitrary subtotal discount is supplied without this field, the arbitrary subtotal discount is used for both.
|
|
85
|
+
* @type {number}
|
|
86
|
+
* @memberof ChannelPartnerOrder
|
|
87
|
+
*/
|
|
88
|
+
arbitrary_taxable_subtotal_discount?: number;
|
|
77
89
|
/**
|
|
78
90
|
* If true any matching customer profile based on email is associated with this order
|
|
79
91
|
* @type {boolean}
|
|
@@ -536,6 +548,12 @@ export interface ChannelPartnerOrder {
|
|
|
536
548
|
* @memberof ChannelPartnerOrder
|
|
537
549
|
*/
|
|
538
550
|
shipto_title?: string;
|
|
551
|
+
/**
|
|
552
|
+
* If true the setup of the auto order record is skipped
|
|
553
|
+
* @type {boolean}
|
|
554
|
+
* @memberof ChannelPartnerOrder
|
|
555
|
+
*/
|
|
556
|
+
skip_auto_order_setup?: boolean;
|
|
539
557
|
/**
|
|
540
558
|
* If true the order is placed directly into the shipping department
|
|
541
559
|
* @type {boolean}
|
|
@@ -662,9 +680,11 @@ export function ChannelPartnerOrderFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
662
680
|
'affiliate_id': !exists(json, 'affiliate_id') ? undefined : json['affiliate_id'],
|
|
663
681
|
'affiliate_sub_id': !exists(json, 'affiliate_sub_id') ? undefined : json['affiliate_sub_id'],
|
|
664
682
|
'arbitrary_shipping_handling_total': !exists(json, 'arbitrary_shipping_handling_total') ? undefined : json['arbitrary_shipping_handling_total'],
|
|
683
|
+
'arbitrary_subtotal_discount': !exists(json, 'arbitrary_subtotal_discount') ? undefined : json['arbitrary_subtotal_discount'],
|
|
665
684
|
'arbitrary_tax': !exists(json, 'arbitrary_tax') ? undefined : json['arbitrary_tax'],
|
|
666
685
|
'arbitrary_tax_rate': !exists(json, 'arbitrary_tax_rate') ? undefined : json['arbitrary_tax_rate'],
|
|
667
686
|
'arbitrary_taxable_subtotal': !exists(json, 'arbitrary_taxable_subtotal') ? undefined : json['arbitrary_taxable_subtotal'],
|
|
687
|
+
'arbitrary_taxable_subtotal_discount': !exists(json, 'arbitrary_taxable_subtotal_discount') ? undefined : json['arbitrary_taxable_subtotal_discount'],
|
|
668
688
|
'associate_with_customer_profile_if_present': !exists(json, 'associate_with_customer_profile_if_present') ? undefined : json['associate_with_customer_profile_if_present'],
|
|
669
689
|
'auto_approve_purchase_order': !exists(json, 'auto_approve_purchase_order') ? undefined : json['auto_approve_purchase_order'],
|
|
670
690
|
'billto_address1': !exists(json, 'billto_address1') ? undefined : json['billto_address1'],
|
|
@@ -742,6 +762,7 @@ export function ChannelPartnerOrderFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
742
762
|
'shipto_postal_code': !exists(json, 'shipto_postal_code') ? undefined : json['shipto_postal_code'],
|
|
743
763
|
'shipto_state_region': !exists(json, 'shipto_state_region') ? undefined : json['shipto_state_region'],
|
|
744
764
|
'shipto_title': !exists(json, 'shipto_title') ? undefined : json['shipto_title'],
|
|
765
|
+
'skip_auto_order_setup': !exists(json, 'skip_auto_order_setup') ? undefined : json['skip_auto_order_setup'],
|
|
745
766
|
'skip_payment_processing': !exists(json, 'skip_payment_processing') ? undefined : json['skip_payment_processing'],
|
|
746
767
|
'special_instructions': !exists(json, 'special_instructions') ? undefined : json['special_instructions'],
|
|
747
768
|
'store_completed': !exists(json, 'store_completed') ? undefined : json['store_completed'],
|
|
@@ -768,9 +789,11 @@ export function ChannelPartnerOrderToJSON(value?: ChannelPartnerOrder | null): a
|
|
|
768
789
|
'affiliate_id': value.affiliate_id,
|
|
769
790
|
'affiliate_sub_id': value.affiliate_sub_id,
|
|
770
791
|
'arbitrary_shipping_handling_total': value.arbitrary_shipping_handling_total,
|
|
792
|
+
'arbitrary_subtotal_discount': value.arbitrary_subtotal_discount,
|
|
771
793
|
'arbitrary_tax': value.arbitrary_tax,
|
|
772
794
|
'arbitrary_tax_rate': value.arbitrary_tax_rate,
|
|
773
795
|
'arbitrary_taxable_subtotal': value.arbitrary_taxable_subtotal,
|
|
796
|
+
'arbitrary_taxable_subtotal_discount': value.arbitrary_taxable_subtotal_discount,
|
|
774
797
|
'associate_with_customer_profile_if_present': value.associate_with_customer_profile_if_present,
|
|
775
798
|
'auto_approve_purchase_order': value.auto_approve_purchase_order,
|
|
776
799
|
'billto_address1': value.billto_address1,
|
|
@@ -848,6 +871,7 @@ export function ChannelPartnerOrderToJSON(value?: ChannelPartnerOrder | null): a
|
|
|
848
871
|
'shipto_postal_code': value.shipto_postal_code,
|
|
849
872
|
'shipto_state_region': value.shipto_state_region,
|
|
850
873
|
'shipto_title': value.shipto_title,
|
|
874
|
+
'skip_auto_order_setup': value.skip_auto_order_setup,
|
|
851
875
|
'skip_payment_processing': value.skip_payment_processing,
|
|
852
876
|
'special_instructions': value.special_instructions,
|
|
853
877
|
'store_completed': value.store_completed,
|
|
@@ -61,6 +61,12 @@ export interface OrderChannelPartner {
|
|
|
61
61
|
* @memberof OrderChannelPartner
|
|
62
62
|
*/
|
|
63
63
|
no_realtime_payment_processing?: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* Instructs UltraCart to skip auto order setup. Only applicable on inserting orders.
|
|
66
|
+
* @type {boolean}
|
|
67
|
+
* @memberof OrderChannelPartner
|
|
68
|
+
*/
|
|
69
|
+
skip_auto_order_setup?: boolean;
|
|
64
70
|
/**
|
|
65
71
|
* Indicates this order was already paid for via a channel purchase and no payment collection should be attempted
|
|
66
72
|
* @type {boolean}
|
|
@@ -115,6 +121,7 @@ export function OrderChannelPartnerFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
115
121
|
'channel_partner_order_id': !exists(json, 'channel_partner_order_id') ? undefined : json['channel_partner_order_id'],
|
|
116
122
|
'ignore_invalid_shipping_method': !exists(json, 'ignore_invalid_shipping_method') ? undefined : json['ignore_invalid_shipping_method'],
|
|
117
123
|
'no_realtime_payment_processing': !exists(json, 'no_realtime_payment_processing') ? undefined : json['no_realtime_payment_processing'],
|
|
124
|
+
'skip_auto_order_setup': !exists(json, 'skip_auto_order_setup') ? undefined : json['skip_auto_order_setup'],
|
|
118
125
|
'skip_payment_processing': !exists(json, 'skip_payment_processing') ? undefined : json['skip_payment_processing'],
|
|
119
126
|
'store_completed': !exists(json, 'store_completed') ? undefined : json['store_completed'],
|
|
120
127
|
'store_if_payment_declines': !exists(json, 'store_if_payment_declines') ? undefined : json['store_if_payment_declines'],
|
|
@@ -138,6 +145,7 @@ export function OrderChannelPartnerToJSON(value?: OrderChannelPartner | null): a
|
|
|
138
145
|
'channel_partner_order_id': value.channel_partner_order_id,
|
|
139
146
|
'ignore_invalid_shipping_method': value.ignore_invalid_shipping_method,
|
|
140
147
|
'no_realtime_payment_processing': value.no_realtime_payment_processing,
|
|
148
|
+
'skip_auto_order_setup': value.skip_auto_order_setup,
|
|
141
149
|
'skip_payment_processing': value.skip_payment_processing,
|
|
142
150
|
'store_completed': value.store_completed,
|
|
143
151
|
'store_if_payment_declines': value.store_if_payment_declines,
|