ultracart_rest_api_v2_typescript 3.10.9 → 3.10.12
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 -2
- package/api.ts +160 -116
- package/dist/api.d.ts +83 -65
- package/dist/api.js +105 -91
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.10.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.10.12
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). 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 ultracart_rest_api_v2_typescript@3.10.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.10.12 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.10.12 | 06/16/2022 | Customer profile search method to look up tags |
|
|
58
|
+
| 3.10.11 | 06/10/2022 | esp segment 3rd party sync add/remove tag fields |
|
|
59
|
+
| 3.10.10 | 06/06/2022 | storefront communication options for syncing to third party provider list |
|
|
57
60
|
| 3.10.9 | 06/01/2022 | bug fixes for customer profile store credit |
|
|
58
61
|
| 3.10.8 | 05/27/2022 | customer store credit |
|
|
59
62
|
| 3.10.7 | 05/23/2022 | add internal gift cert to order summary, addl provider info for storefront comm |
|
package/api.ts
CHANGED
|
@@ -14599,6 +14599,42 @@ export interface EmailSegment {
|
|
|
14599
14599
|
* @memberof EmailSegment
|
|
14600
14600
|
*/
|
|
14601
14601
|
storefront_oid?: number;
|
|
14602
|
+
/**
|
|
14603
|
+
* Third party provider tags to add when a customer joins the segment.
|
|
14604
|
+
* @type {Array<string>}
|
|
14605
|
+
* @memberof EmailSegment
|
|
14606
|
+
*/
|
|
14607
|
+
thirdparty_join_add_tags?: Array<string>;
|
|
14608
|
+
/**
|
|
14609
|
+
* Third party provider tags to remove when a customer joins the segment.
|
|
14610
|
+
* @type {Array<string>}
|
|
14611
|
+
* @memberof EmailSegment
|
|
14612
|
+
*/
|
|
14613
|
+
thirdparty_join_remove_tags?: Array<string>;
|
|
14614
|
+
/**
|
|
14615
|
+
* Third party provider tags to add when a customer leaves the segment.
|
|
14616
|
+
* @type {Array<string>}
|
|
14617
|
+
* @memberof EmailSegment
|
|
14618
|
+
*/
|
|
14619
|
+
thirdparty_leave_add_tags?: Array<string>;
|
|
14620
|
+
/**
|
|
14621
|
+
* Third party provider tags to remove when a customer leaves the segment.
|
|
14622
|
+
* @type {Array<string>}
|
|
14623
|
+
* @memberof EmailSegment
|
|
14624
|
+
*/
|
|
14625
|
+
thirdparty_leave_remove_tags?: Array<string>;
|
|
14626
|
+
/**
|
|
14627
|
+
* List id of third party provider to sync with.
|
|
14628
|
+
* @type {string}
|
|
14629
|
+
* @memberof EmailSegment
|
|
14630
|
+
*/
|
|
14631
|
+
thirdparty_list_id?: string;
|
|
14632
|
+
/**
|
|
14633
|
+
* Name of third party provider to sync segment to a list with.
|
|
14634
|
+
* @type {string}
|
|
14635
|
+
* @memberof EmailSegment
|
|
14636
|
+
*/
|
|
14637
|
+
thirdparty_provider_name?: string;
|
|
14602
14638
|
/**
|
|
14603
14639
|
* Details on the flows or campaigns that use this list.
|
|
14604
14640
|
* @type {Array<EmailListSegmentUsedBy>}
|
|
@@ -45497,6 +45533,69 @@ export const CustomerApiFetchParamCreator = function (configuration?: Configurat
|
|
|
45497
45533
|
options: localVarRequestOptions,
|
|
45498
45534
|
};
|
|
45499
45535
|
},
|
|
45536
|
+
/**
|
|
45537
|
+
*
|
|
45538
|
+
* @summary Searches for all matching values (using POST)
|
|
45539
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
45540
|
+
* @param {*} [options] Override http request option.
|
|
45541
|
+
* @throws {RequiredError}
|
|
45542
|
+
*/
|
|
45543
|
+
search(lookup_request: LookupRequest, options: any = {}): FetchArgs {
|
|
45544
|
+
// verify required parameter 'lookup_request' is not null or undefined
|
|
45545
|
+
if (lookup_request === null || lookup_request === undefined) {
|
|
45546
|
+
throw new RequiredError('lookup_request','Required parameter lookup_request was null or undefined when calling search.');
|
|
45547
|
+
}
|
|
45548
|
+
const localVarPath = `/customer/search`;
|
|
45549
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
45550
|
+
const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
|
|
45551
|
+
const localVarHeaderParameter = {} as any;
|
|
45552
|
+
const localVarQueryParameter = {} as any;
|
|
45553
|
+
|
|
45554
|
+
if(configuration && configuration.apiVersion) {
|
|
45555
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
45556
|
+
}
|
|
45557
|
+
|
|
45558
|
+
|
|
45559
|
+
|
|
45560
|
+
// authentication ultraCartBrowserApiKey required
|
|
45561
|
+
if (configuration && configuration.apiKey) {
|
|
45562
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
45563
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
45564
|
+
: configuration.apiKey;
|
|
45565
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
45566
|
+
}
|
|
45567
|
+
|
|
45568
|
+
// authentication ultraCartOauth required
|
|
45569
|
+
// oauth required
|
|
45570
|
+
if (configuration && configuration.accessToken) {
|
|
45571
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
45572
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_read"])
|
|
45573
|
+
: configuration.accessToken;
|
|
45574
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
45575
|
+
}
|
|
45576
|
+
|
|
45577
|
+
// authentication ultraCartSimpleApiKey required
|
|
45578
|
+
if (configuration && configuration.apiKey) {
|
|
45579
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
45580
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
45581
|
+
: configuration.apiKey;
|
|
45582
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
45583
|
+
}
|
|
45584
|
+
|
|
45585
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
45586
|
+
|
|
45587
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
45588
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
45589
|
+
delete localVarUrlObj.search;
|
|
45590
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
45591
|
+
const needsSerialization = (<any>"LookupRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
45592
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(lookup_request || {}) : (lookup_request || "");
|
|
45593
|
+
|
|
45594
|
+
return {
|
|
45595
|
+
url: url.format(localVarUrlObj),
|
|
45596
|
+
options: localVarRequestOptions,
|
|
45597
|
+
};
|
|
45598
|
+
},
|
|
45500
45599
|
/**
|
|
45501
45600
|
* Update a customer on the UltraCart account.
|
|
45502
45601
|
* @summary Update a customer
|
|
@@ -46000,6 +46099,27 @@ export const CustomerApiFp = function(configuration?: Configuration) {
|
|
|
46000
46099
|
});
|
|
46001
46100
|
};
|
|
46002
46101
|
},
|
|
46102
|
+
/**
|
|
46103
|
+
*
|
|
46104
|
+
* @summary Searches for all matching values (using POST)
|
|
46105
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
46106
|
+
* @param {*} [options] Override http request option.
|
|
46107
|
+
* @throws {RequiredError}
|
|
46108
|
+
*/
|
|
46109
|
+
search(lookup_request: LookupRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<LookupResponse> {
|
|
46110
|
+
const localVarFetchArgs = CustomerApiFetchParamCreator(configuration).search(lookup_request, options);
|
|
46111
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
46112
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
46113
|
+
|
|
46114
|
+
if (response.status >= 200 && response.status < 300) {
|
|
46115
|
+
return response.json();
|
|
46116
|
+
|
|
46117
|
+
} else {
|
|
46118
|
+
throw response;
|
|
46119
|
+
}
|
|
46120
|
+
});
|
|
46121
|
+
};
|
|
46122
|
+
},
|
|
46003
46123
|
/**
|
|
46004
46124
|
* Update a customer on the UltraCart account.
|
|
46005
46125
|
* @summary Update a customer
|
|
@@ -46244,6 +46364,16 @@ export const CustomerApiFactory = function (configuration?: Configuration, fetch
|
|
|
46244
46364
|
insertCustomer(customer: Customer, _expand?: string, options?: any) {
|
|
46245
46365
|
return CustomerApiFp(configuration).insertCustomer(customer, _expand, options)(fetch, basePath);
|
|
46246
46366
|
},
|
|
46367
|
+
/**
|
|
46368
|
+
*
|
|
46369
|
+
* @summary Searches for all matching values (using POST)
|
|
46370
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
46371
|
+
* @param {*} [options] Override http request option.
|
|
46372
|
+
* @throws {RequiredError}
|
|
46373
|
+
*/
|
|
46374
|
+
search(lookup_request: LookupRequest, options?: any) {
|
|
46375
|
+
return CustomerApiFp(configuration).search(lookup_request, options)(fetch, basePath);
|
|
46376
|
+
},
|
|
46247
46377
|
/**
|
|
46248
46378
|
* Update a customer on the UltraCart account.
|
|
46249
46379
|
* @summary Update a customer
|
|
@@ -46455,6 +46585,16 @@ export interface CustomerApiInterface {
|
|
|
46455
46585
|
*/
|
|
46456
46586
|
insertCustomer(customer: Customer, _expand?: string, options?: any): Promise<CustomerResponse>;
|
|
46457
46587
|
|
|
46588
|
+
/**
|
|
46589
|
+
*
|
|
46590
|
+
* @summary Searches for all matching values (using POST)
|
|
46591
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
46592
|
+
* @param {*} [options] Override http request option.
|
|
46593
|
+
* @throws {RequiredError}
|
|
46594
|
+
* @memberof CustomerApiInterface
|
|
46595
|
+
*/
|
|
46596
|
+
search(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
|
|
46597
|
+
|
|
46458
46598
|
/**
|
|
46459
46599
|
* Update a customer on the UltraCart account.
|
|
46460
46600
|
* @summary Update a customer
|
|
@@ -46692,6 +46832,18 @@ export class CustomerApi extends BaseAPI implements CustomerApiInterface {
|
|
|
46692
46832
|
return CustomerApiFp(this.configuration).insertCustomer(customer, _expand, options)(this.fetch, this.basePath);
|
|
46693
46833
|
}
|
|
46694
46834
|
|
|
46835
|
+
/**
|
|
46836
|
+
*
|
|
46837
|
+
* @summary Searches for all matching values (using POST)
|
|
46838
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
46839
|
+
* @param {*} [options] Override http request option.
|
|
46840
|
+
* @throws {RequiredError}
|
|
46841
|
+
* @memberof CustomerApi
|
|
46842
|
+
*/
|
|
46843
|
+
public search(lookup_request: LookupRequest, options?: any) {
|
|
46844
|
+
return CustomerApiFp(this.configuration).search(lookup_request, options)(this.fetch, this.basePath);
|
|
46845
|
+
}
|
|
46846
|
+
|
|
46695
46847
|
/**
|
|
46696
46848
|
* Update a customer on the UltraCart account.
|
|
46697
46849
|
* @summary Update a customer
|
|
@@ -51268,18 +51420,6 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
51268
51420
|
* @param {string} [current_stage] Current Stage
|
|
51269
51421
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
51270
51422
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
51271
|
-
* @param {number} [customer_profile_oid]
|
|
51272
|
-
* @param {string} [Refund_Date_Begin]
|
|
51273
|
-
* @param {string} [Refund_Date_End]
|
|
51274
|
-
* @param {string} [Custom_Field_1]
|
|
51275
|
-
* @param {string} [Custom_Field_2]
|
|
51276
|
-
* @param {string} [Custom_Field_3]
|
|
51277
|
-
* @param {string} [Custom_Field_4]
|
|
51278
|
-
* @param {string} [Custom_Field_5]
|
|
51279
|
-
* @param {string} [Custom_Field_6]
|
|
51280
|
-
* @param {string} [Custom_Field_7]
|
|
51281
|
-
* @param {string} [ship_on_date_begin]
|
|
51282
|
-
* @param {string} [ship_on_date_end]
|
|
51283
51423
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
51284
51424
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
51285
51425
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -51287,7 +51427,7 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
51287
51427
|
* @param {*} [options] Override http request option.
|
|
51288
51428
|
* @throws {RequiredError}
|
|
51289
51429
|
*/
|
|
51290
|
-
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
51430
|
+
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options: any = {}): FetchArgs {
|
|
51291
51431
|
const localVarPath = `/order/orders`;
|
|
51292
51432
|
const localVarUrlObj = url.parse(localVarPath, true);
|
|
51293
51433
|
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
@@ -51425,54 +51565,6 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
51425
51565
|
localVarQueryParameter['channel_partner_order_id'] = channel_partner_order_id;
|
|
51426
51566
|
}
|
|
51427
51567
|
|
|
51428
|
-
if (customer_profile_oid !== undefined) {
|
|
51429
|
-
localVarQueryParameter['customer_profile_oid'] = customer_profile_oid;
|
|
51430
|
-
}
|
|
51431
|
-
|
|
51432
|
-
if (Refund_Date_Begin !== undefined) {
|
|
51433
|
-
localVarQueryParameter['Refund Date Begin'] = Refund_Date_Begin;
|
|
51434
|
-
}
|
|
51435
|
-
|
|
51436
|
-
if (Refund_Date_End !== undefined) {
|
|
51437
|
-
localVarQueryParameter['Refund Date End'] = Refund_Date_End;
|
|
51438
|
-
}
|
|
51439
|
-
|
|
51440
|
-
if (Custom_Field_1 !== undefined) {
|
|
51441
|
-
localVarQueryParameter['Custom Field 1'] = Custom_Field_1;
|
|
51442
|
-
}
|
|
51443
|
-
|
|
51444
|
-
if (Custom_Field_2 !== undefined) {
|
|
51445
|
-
localVarQueryParameter['Custom Field 2'] = Custom_Field_2;
|
|
51446
|
-
}
|
|
51447
|
-
|
|
51448
|
-
if (Custom_Field_3 !== undefined) {
|
|
51449
|
-
localVarQueryParameter['Custom Field 3'] = Custom_Field_3;
|
|
51450
|
-
}
|
|
51451
|
-
|
|
51452
|
-
if (Custom_Field_4 !== undefined) {
|
|
51453
|
-
localVarQueryParameter['Custom Field 4'] = Custom_Field_4;
|
|
51454
|
-
}
|
|
51455
|
-
|
|
51456
|
-
if (Custom_Field_5 !== undefined) {
|
|
51457
|
-
localVarQueryParameter['Custom Field 5'] = Custom_Field_5;
|
|
51458
|
-
}
|
|
51459
|
-
|
|
51460
|
-
if (Custom_Field_6 !== undefined) {
|
|
51461
|
-
localVarQueryParameter['Custom Field 6'] = Custom_Field_6;
|
|
51462
|
-
}
|
|
51463
|
-
|
|
51464
|
-
if (Custom_Field_7 !== undefined) {
|
|
51465
|
-
localVarQueryParameter['Custom Field 7'] = Custom_Field_7;
|
|
51466
|
-
}
|
|
51467
|
-
|
|
51468
|
-
if (ship_on_date_begin !== undefined) {
|
|
51469
|
-
localVarQueryParameter['ship_on_date_begin'] = ship_on_date_begin;
|
|
51470
|
-
}
|
|
51471
|
-
|
|
51472
|
-
if (ship_on_date_end !== undefined) {
|
|
51473
|
-
localVarQueryParameter['ship_on_date_end'] = ship_on_date_end;
|
|
51474
|
-
}
|
|
51475
|
-
|
|
51476
51568
|
if (_limit !== undefined) {
|
|
51477
51569
|
localVarQueryParameter['_limit'] = _limit;
|
|
51478
51570
|
}
|
|
@@ -52429,18 +52521,6 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
52429
52521
|
* @param {string} [current_stage] Current Stage
|
|
52430
52522
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
52431
52523
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
52432
|
-
* @param {number} [customer_profile_oid]
|
|
52433
|
-
* @param {string} [Refund_Date_Begin]
|
|
52434
|
-
* @param {string} [Refund_Date_End]
|
|
52435
|
-
* @param {string} [Custom_Field_1]
|
|
52436
|
-
* @param {string} [Custom_Field_2]
|
|
52437
|
-
* @param {string} [Custom_Field_3]
|
|
52438
|
-
* @param {string} [Custom_Field_4]
|
|
52439
|
-
* @param {string} [Custom_Field_5]
|
|
52440
|
-
* @param {string} [Custom_Field_6]
|
|
52441
|
-
* @param {string} [Custom_Field_7]
|
|
52442
|
-
* @param {string} [ship_on_date_begin]
|
|
52443
|
-
* @param {string} [ship_on_date_end]
|
|
52444
52524
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
52445
52525
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
52446
52526
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -52448,8 +52528,8 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
52448
52528
|
* @param {*} [options] Override http request option.
|
|
52449
52529
|
* @throws {RequiredError}
|
|
52450
52530
|
*/
|
|
52451
|
-
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
52452
|
-
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
52531
|
+
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrdersResponse> {
|
|
52532
|
+
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options);
|
|
52453
52533
|
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
52454
52534
|
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
52455
52535
|
|
|
@@ -52854,18 +52934,6 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
52854
52934
|
* @param {string} [current_stage] Current Stage
|
|
52855
52935
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
52856
52936
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
52857
|
-
* @param {number} [customer_profile_oid]
|
|
52858
|
-
* @param {string} [Refund_Date_Begin]
|
|
52859
|
-
* @param {string} [Refund_Date_End]
|
|
52860
|
-
* @param {string} [Custom_Field_1]
|
|
52861
|
-
* @param {string} [Custom_Field_2]
|
|
52862
|
-
* @param {string} [Custom_Field_3]
|
|
52863
|
-
* @param {string} [Custom_Field_4]
|
|
52864
|
-
* @param {string} [Custom_Field_5]
|
|
52865
|
-
* @param {string} [Custom_Field_6]
|
|
52866
|
-
* @param {string} [Custom_Field_7]
|
|
52867
|
-
* @param {string} [ship_on_date_begin]
|
|
52868
|
-
* @param {string} [ship_on_date_end]
|
|
52869
52937
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
52870
52938
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
52871
52939
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -52873,8 +52941,8 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
52873
52941
|
* @param {*} [options] Override http request option.
|
|
52874
52942
|
* @throws {RequiredError}
|
|
52875
52943
|
*/
|
|
52876
|
-
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
52877
|
-
return OrderApiFp(configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
52944
|
+
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any) {
|
|
52945
|
+
return OrderApiFp(configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options)(fetch, basePath);
|
|
52878
52946
|
},
|
|
52879
52947
|
/**
|
|
52880
52948
|
* Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
|
|
@@ -53158,18 +53226,6 @@ export interface OrderApiInterface {
|
|
|
53158
53226
|
* @param {string} [current_stage] Current Stage
|
|
53159
53227
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
53160
53228
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
53161
|
-
* @param {number} [customer_profile_oid]
|
|
53162
|
-
* @param {string} [Refund_Date_Begin]
|
|
53163
|
-
* @param {string} [Refund_Date_End]
|
|
53164
|
-
* @param {string} [Custom_Field_1]
|
|
53165
|
-
* @param {string} [Custom_Field_2]
|
|
53166
|
-
* @param {string} [Custom_Field_3]
|
|
53167
|
-
* @param {string} [Custom_Field_4]
|
|
53168
|
-
* @param {string} [Custom_Field_5]
|
|
53169
|
-
* @param {string} [Custom_Field_6]
|
|
53170
|
-
* @param {string} [Custom_Field_7]
|
|
53171
|
-
* @param {string} [ship_on_date_begin]
|
|
53172
|
-
* @param {string} [ship_on_date_end]
|
|
53173
53229
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
53174
53230
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
53175
53231
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -53178,7 +53234,7 @@ export interface OrderApiInterface {
|
|
|
53178
53234
|
* @throws {RequiredError}
|
|
53179
53235
|
* @memberof OrderApiInterface
|
|
53180
53236
|
*/
|
|
53181
|
-
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
53237
|
+
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): Promise<OrdersResponse>;
|
|
53182
53238
|
|
|
53183
53239
|
/**
|
|
53184
53240
|
* Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
|
|
@@ -53486,18 +53542,6 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
53486
53542
|
* @param {string} [current_stage] Current Stage
|
|
53487
53543
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
53488
53544
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
53489
|
-
* @param {number} [customer_profile_oid]
|
|
53490
|
-
* @param {string} [Refund_Date_Begin]
|
|
53491
|
-
* @param {string} [Refund_Date_End]
|
|
53492
|
-
* @param {string} [Custom_Field_1]
|
|
53493
|
-
* @param {string} [Custom_Field_2]
|
|
53494
|
-
* @param {string} [Custom_Field_3]
|
|
53495
|
-
* @param {string} [Custom_Field_4]
|
|
53496
|
-
* @param {string} [Custom_Field_5]
|
|
53497
|
-
* @param {string} [Custom_Field_6]
|
|
53498
|
-
* @param {string} [Custom_Field_7]
|
|
53499
|
-
* @param {string} [ship_on_date_begin]
|
|
53500
|
-
* @param {string} [ship_on_date_end]
|
|
53501
53545
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
53502
53546
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
53503
53547
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -53506,8 +53550,8 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
53506
53550
|
* @throws {RequiredError}
|
|
53507
53551
|
* @memberof OrderApi
|
|
53508
53552
|
*/
|
|
53509
|
-
public getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
53510
|
-
return OrderApiFp(this.configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
53553
|
+
public getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any) {
|
|
53554
|
+
return OrderApiFp(this.configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options)(this.fetch, this.basePath);
|
|
53511
53555
|
}
|
|
53512
53556
|
|
|
53513
53557
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -14276,6 +14276,42 @@ export interface EmailSegment {
|
|
|
14276
14276
|
* @memberof EmailSegment
|
|
14277
14277
|
*/
|
|
14278
14278
|
storefront_oid?: number;
|
|
14279
|
+
/**
|
|
14280
|
+
* Third party provider tags to add when a customer joins the segment.
|
|
14281
|
+
* @type {Array<string>}
|
|
14282
|
+
* @memberof EmailSegment
|
|
14283
|
+
*/
|
|
14284
|
+
thirdparty_join_add_tags?: Array<string>;
|
|
14285
|
+
/**
|
|
14286
|
+
* Third party provider tags to remove when a customer joins the segment.
|
|
14287
|
+
* @type {Array<string>}
|
|
14288
|
+
* @memberof EmailSegment
|
|
14289
|
+
*/
|
|
14290
|
+
thirdparty_join_remove_tags?: Array<string>;
|
|
14291
|
+
/**
|
|
14292
|
+
* Third party provider tags to add when a customer leaves the segment.
|
|
14293
|
+
* @type {Array<string>}
|
|
14294
|
+
* @memberof EmailSegment
|
|
14295
|
+
*/
|
|
14296
|
+
thirdparty_leave_add_tags?: Array<string>;
|
|
14297
|
+
/**
|
|
14298
|
+
* Third party provider tags to remove when a customer leaves the segment.
|
|
14299
|
+
* @type {Array<string>}
|
|
14300
|
+
* @memberof EmailSegment
|
|
14301
|
+
*/
|
|
14302
|
+
thirdparty_leave_remove_tags?: Array<string>;
|
|
14303
|
+
/**
|
|
14304
|
+
* List id of third party provider to sync with.
|
|
14305
|
+
* @type {string}
|
|
14306
|
+
* @memberof EmailSegment
|
|
14307
|
+
*/
|
|
14308
|
+
thirdparty_list_id?: string;
|
|
14309
|
+
/**
|
|
14310
|
+
* Name of third party provider to sync segment to a list with.
|
|
14311
|
+
* @type {string}
|
|
14312
|
+
* @memberof EmailSegment
|
|
14313
|
+
*/
|
|
14314
|
+
thirdparty_provider_name?: string;
|
|
14279
14315
|
/**
|
|
14280
14316
|
* Details on the flows or campaigns that use this list.
|
|
14281
14317
|
* @type {Array<EmailListSegmentUsedBy>}
|
|
@@ -38784,6 +38820,14 @@ export declare const CustomerApiFetchParamCreator: (configuration?: Configuratio
|
|
|
38784
38820
|
* @throws {RequiredError}
|
|
38785
38821
|
*/
|
|
38786
38822
|
insertCustomer(customer: Customer, _expand?: string, options?: any): FetchArgs;
|
|
38823
|
+
/**
|
|
38824
|
+
*
|
|
38825
|
+
* @summary Searches for all matching values (using POST)
|
|
38826
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
38827
|
+
* @param {*} [options] Override http request option.
|
|
38828
|
+
* @throws {RequiredError}
|
|
38829
|
+
*/
|
|
38830
|
+
search(lookup_request: LookupRequest, options?: any): FetchArgs;
|
|
38787
38831
|
/**
|
|
38788
38832
|
* Update a customer on the UltraCart account.
|
|
38789
38833
|
* @summary Update a customer
|
|
@@ -38960,6 +39004,14 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
|
|
|
38960
39004
|
* @throws {RequiredError}
|
|
38961
39005
|
*/
|
|
38962
39006
|
insertCustomer(customer: Customer, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomerResponse>;
|
|
39007
|
+
/**
|
|
39008
|
+
*
|
|
39009
|
+
* @summary Searches for all matching values (using POST)
|
|
39010
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
39011
|
+
* @param {*} [options] Override http request option.
|
|
39012
|
+
* @throws {RequiredError}
|
|
39013
|
+
*/
|
|
39014
|
+
search(lookup_request: LookupRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<LookupResponse>;
|
|
38963
39015
|
/**
|
|
38964
39016
|
* Update a customer on the UltraCart account.
|
|
38965
39017
|
* @summary Update a customer
|
|
@@ -39136,6 +39188,14 @@ export declare const CustomerApiFactory: (configuration?: Configuration, fetch?:
|
|
|
39136
39188
|
* @throws {RequiredError}
|
|
39137
39189
|
*/
|
|
39138
39190
|
insertCustomer(customer: Customer, _expand?: string, options?: any): Promise<CustomerResponse>;
|
|
39191
|
+
/**
|
|
39192
|
+
*
|
|
39193
|
+
* @summary Searches for all matching values (using POST)
|
|
39194
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
39195
|
+
* @param {*} [options] Override http request option.
|
|
39196
|
+
* @throws {RequiredError}
|
|
39197
|
+
*/
|
|
39198
|
+
search(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
|
|
39139
39199
|
/**
|
|
39140
39200
|
* Update a customer on the UltraCart account.
|
|
39141
39201
|
* @summary Update a customer
|
|
@@ -39326,6 +39386,15 @@ export interface CustomerApiInterface {
|
|
|
39326
39386
|
* @memberof CustomerApiInterface
|
|
39327
39387
|
*/
|
|
39328
39388
|
insertCustomer(customer: Customer, _expand?: string, options?: any): Promise<CustomerResponse>;
|
|
39389
|
+
/**
|
|
39390
|
+
*
|
|
39391
|
+
* @summary Searches for all matching values (using POST)
|
|
39392
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
39393
|
+
* @param {*} [options] Override http request option.
|
|
39394
|
+
* @throws {RequiredError}
|
|
39395
|
+
* @memberof CustomerApiInterface
|
|
39396
|
+
*/
|
|
39397
|
+
search(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
|
|
39329
39398
|
/**
|
|
39330
39399
|
* Update a customer on the UltraCart account.
|
|
39331
39400
|
* @summary Update a customer
|
|
@@ -39520,6 +39589,15 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
|
|
|
39520
39589
|
* @memberof CustomerApi
|
|
39521
39590
|
*/
|
|
39522
39591
|
insertCustomer(customer: Customer, _expand?: string, options?: any): Promise<CustomerResponse>;
|
|
39592
|
+
/**
|
|
39593
|
+
*
|
|
39594
|
+
* @summary Searches for all matching values (using POST)
|
|
39595
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
39596
|
+
* @param {*} [options] Override http request option.
|
|
39597
|
+
* @throws {RequiredError}
|
|
39598
|
+
* @memberof CustomerApi
|
|
39599
|
+
*/
|
|
39600
|
+
search(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
|
|
39523
39601
|
/**
|
|
39524
39602
|
* Update a customer on the UltraCart account.
|
|
39525
39603
|
* @summary Update a customer
|
|
@@ -41323,18 +41401,6 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
|
|
|
41323
41401
|
* @param {string} [current_stage] Current Stage
|
|
41324
41402
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
41325
41403
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
41326
|
-
* @param {number} [customer_profile_oid]
|
|
41327
|
-
* @param {string} [Refund_Date_Begin]
|
|
41328
|
-
* @param {string} [Refund_Date_End]
|
|
41329
|
-
* @param {string} [Custom_Field_1]
|
|
41330
|
-
* @param {string} [Custom_Field_2]
|
|
41331
|
-
* @param {string} [Custom_Field_3]
|
|
41332
|
-
* @param {string} [Custom_Field_4]
|
|
41333
|
-
* @param {string} [Custom_Field_5]
|
|
41334
|
-
* @param {string} [Custom_Field_6]
|
|
41335
|
-
* @param {string} [Custom_Field_7]
|
|
41336
|
-
* @param {string} [ship_on_date_begin]
|
|
41337
|
-
* @param {string} [ship_on_date_end]
|
|
41338
41404
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
41339
41405
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
41340
41406
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -41342,7 +41408,7 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
|
|
|
41342
41408
|
* @param {*} [options] Override http request option.
|
|
41343
41409
|
* @throws {RequiredError}
|
|
41344
41410
|
*/
|
|
41345
|
-
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
41411
|
+
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): FetchArgs;
|
|
41346
41412
|
/**
|
|
41347
41413
|
* Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
|
|
41348
41414
|
* @summary Retrieve order batch
|
|
@@ -41578,18 +41644,6 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
|
|
|
41578
41644
|
* @param {string} [current_stage] Current Stage
|
|
41579
41645
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
41580
41646
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
41581
|
-
* @param {number} [customer_profile_oid]
|
|
41582
|
-
* @param {string} [Refund_Date_Begin]
|
|
41583
|
-
* @param {string} [Refund_Date_End]
|
|
41584
|
-
* @param {string} [Custom_Field_1]
|
|
41585
|
-
* @param {string} [Custom_Field_2]
|
|
41586
|
-
* @param {string} [Custom_Field_3]
|
|
41587
|
-
* @param {string} [Custom_Field_4]
|
|
41588
|
-
* @param {string} [Custom_Field_5]
|
|
41589
|
-
* @param {string} [Custom_Field_6]
|
|
41590
|
-
* @param {string} [Custom_Field_7]
|
|
41591
|
-
* @param {string} [ship_on_date_begin]
|
|
41592
|
-
* @param {string} [ship_on_date_end]
|
|
41593
41647
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
41594
41648
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
41595
41649
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -41597,7 +41651,7 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
|
|
|
41597
41651
|
* @param {*} [options] Override http request option.
|
|
41598
41652
|
* @throws {RequiredError}
|
|
41599
41653
|
*/
|
|
41600
|
-
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
41654
|
+
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrdersResponse>;
|
|
41601
41655
|
/**
|
|
41602
41656
|
* Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
|
|
41603
41657
|
* @summary Retrieve order batch
|
|
@@ -41833,18 +41887,6 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
|
|
|
41833
41887
|
* @param {string} [current_stage] Current Stage
|
|
41834
41888
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
41835
41889
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
41836
|
-
* @param {number} [customer_profile_oid]
|
|
41837
|
-
* @param {string} [Refund_Date_Begin]
|
|
41838
|
-
* @param {string} [Refund_Date_End]
|
|
41839
|
-
* @param {string} [Custom_Field_1]
|
|
41840
|
-
* @param {string} [Custom_Field_2]
|
|
41841
|
-
* @param {string} [Custom_Field_3]
|
|
41842
|
-
* @param {string} [Custom_Field_4]
|
|
41843
|
-
* @param {string} [Custom_Field_5]
|
|
41844
|
-
* @param {string} [Custom_Field_6]
|
|
41845
|
-
* @param {string} [Custom_Field_7]
|
|
41846
|
-
* @param {string} [ship_on_date_begin]
|
|
41847
|
-
* @param {string} [ship_on_date_end]
|
|
41848
41890
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
41849
41891
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
41850
41892
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -41852,7 +41894,7 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
|
|
|
41852
41894
|
* @param {*} [options] Override http request option.
|
|
41853
41895
|
* @throws {RequiredError}
|
|
41854
41896
|
*/
|
|
41855
|
-
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
41897
|
+
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): Promise<OrdersResponse>;
|
|
41856
41898
|
/**
|
|
41857
41899
|
* Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
|
|
41858
41900
|
* @summary Retrieve order batch
|
|
@@ -42101,18 +42143,6 @@ export interface OrderApiInterface {
|
|
|
42101
42143
|
* @param {string} [current_stage] Current Stage
|
|
42102
42144
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
42103
42145
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
42104
|
-
* @param {number} [customer_profile_oid]
|
|
42105
|
-
* @param {string} [Refund_Date_Begin]
|
|
42106
|
-
* @param {string} [Refund_Date_End]
|
|
42107
|
-
* @param {string} [Custom_Field_1]
|
|
42108
|
-
* @param {string} [Custom_Field_2]
|
|
42109
|
-
* @param {string} [Custom_Field_3]
|
|
42110
|
-
* @param {string} [Custom_Field_4]
|
|
42111
|
-
* @param {string} [Custom_Field_5]
|
|
42112
|
-
* @param {string} [Custom_Field_6]
|
|
42113
|
-
* @param {string} [Custom_Field_7]
|
|
42114
|
-
* @param {string} [ship_on_date_begin]
|
|
42115
|
-
* @param {string} [ship_on_date_end]
|
|
42116
42146
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
42117
42147
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
42118
42148
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -42121,7 +42151,7 @@ export interface OrderApiInterface {
|
|
|
42121
42151
|
* @throws {RequiredError}
|
|
42122
42152
|
* @memberof OrderApiInterface
|
|
42123
42153
|
*/
|
|
42124
|
-
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
42154
|
+
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): Promise<OrdersResponse>;
|
|
42125
42155
|
/**
|
|
42126
42156
|
* Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
|
|
42127
42157
|
* @summary Retrieve order batch
|
|
@@ -42381,18 +42411,6 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
42381
42411
|
* @param {string} [current_stage] Current Stage
|
|
42382
42412
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
42383
42413
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
42384
|
-
* @param {number} [customer_profile_oid]
|
|
42385
|
-
* @param {string} [Refund_Date_Begin]
|
|
42386
|
-
* @param {string} [Refund_Date_End]
|
|
42387
|
-
* @param {string} [Custom_Field_1]
|
|
42388
|
-
* @param {string} [Custom_Field_2]
|
|
42389
|
-
* @param {string} [Custom_Field_3]
|
|
42390
|
-
* @param {string} [Custom_Field_4]
|
|
42391
|
-
* @param {string} [Custom_Field_5]
|
|
42392
|
-
* @param {string} [Custom_Field_6]
|
|
42393
|
-
* @param {string} [Custom_Field_7]
|
|
42394
|
-
* @param {string} [ship_on_date_begin]
|
|
42395
|
-
* @param {string} [ship_on_date_end]
|
|
42396
42414
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
42397
42415
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
42398
42416
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -42401,7 +42419,7 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
42401
42419
|
* @throws {RequiredError}
|
|
42402
42420
|
* @memberof OrderApi
|
|
42403
42421
|
*/
|
|
42404
|
-
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string,
|
|
42422
|
+
getOrders(order_id?: string, payment_method?: string, company?: string, first_name?: string, last_name?: string, city?: string, state_region?: string, postal_code?: string, country_code?: string, phone?: string, email?: string, cc_email?: string, total?: number, screen_branding_theme_code?: string, storefront_host_name?: string, creation_date_begin?: string, creation_date_end?: string, payment_date_begin?: string, payment_date_end?: string, shipment_date_begin?: string, shipment_date_end?: string, rma?: string, purchase_order_number?: string, item_id?: string, current_stage?: string, channel_partner_code?: string, channel_partner_order_id?: string, _limit?: number, _offset?: number, _sort?: string, _expand?: string, options?: any): Promise<OrdersResponse>;
|
|
42405
42423
|
/**
|
|
42406
42424
|
* Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
|
|
42407
42425
|
* @summary Retrieve order batch
|
package/dist/api.js
CHANGED
|
@@ -9580,6 +9580,61 @@ var CustomerApiFetchParamCreator = function (configuration) {
|
|
|
9580
9580
|
options: localVarRequestOptions,
|
|
9581
9581
|
};
|
|
9582
9582
|
},
|
|
9583
|
+
/**
|
|
9584
|
+
*
|
|
9585
|
+
* @summary Searches for all matching values (using POST)
|
|
9586
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
9587
|
+
* @param {*} [options] Override http request option.
|
|
9588
|
+
* @throws {RequiredError}
|
|
9589
|
+
*/
|
|
9590
|
+
search: function (lookup_request, options) {
|
|
9591
|
+
if (options === void 0) { options = {}; }
|
|
9592
|
+
// verify required parameter 'lookup_request' is not null or undefined
|
|
9593
|
+
if (lookup_request === null || lookup_request === undefined) {
|
|
9594
|
+
throw new RequiredError('lookup_request', 'Required parameter lookup_request was null or undefined when calling search.');
|
|
9595
|
+
}
|
|
9596
|
+
var localVarPath = "/customer/search";
|
|
9597
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
9598
|
+
var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
|
|
9599
|
+
var localVarHeaderParameter = {};
|
|
9600
|
+
var localVarQueryParameter = {};
|
|
9601
|
+
if (configuration && configuration.apiVersion) {
|
|
9602
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
9603
|
+
}
|
|
9604
|
+
// authentication ultraCartBrowserApiKey required
|
|
9605
|
+
if (configuration && configuration.apiKey) {
|
|
9606
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
9607
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
9608
|
+
: configuration.apiKey;
|
|
9609
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
9610
|
+
}
|
|
9611
|
+
// authentication ultraCartOauth required
|
|
9612
|
+
// oauth required
|
|
9613
|
+
if (configuration && configuration.accessToken) {
|
|
9614
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
9615
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_read"])
|
|
9616
|
+
: configuration.accessToken;
|
|
9617
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
9618
|
+
}
|
|
9619
|
+
// authentication ultraCartSimpleApiKey required
|
|
9620
|
+
if (configuration && configuration.apiKey) {
|
|
9621
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
9622
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
9623
|
+
: configuration.apiKey;
|
|
9624
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
9625
|
+
}
|
|
9626
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
9627
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
9628
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
9629
|
+
delete localVarUrlObj.search;
|
|
9630
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
9631
|
+
var needsSerialization = ("LookupRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
9632
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(lookup_request || {}) : (lookup_request || "");
|
|
9633
|
+
return {
|
|
9634
|
+
url: url.format(localVarUrlObj),
|
|
9635
|
+
options: localVarRequestOptions,
|
|
9636
|
+
};
|
|
9637
|
+
},
|
|
9583
9638
|
/**
|
|
9584
9639
|
* Update a customer on the UltraCart account.
|
|
9585
9640
|
* @summary Update a customer
|
|
@@ -10074,6 +10129,28 @@ var CustomerApiFp = function (configuration) {
|
|
|
10074
10129
|
});
|
|
10075
10130
|
};
|
|
10076
10131
|
},
|
|
10132
|
+
/**
|
|
10133
|
+
*
|
|
10134
|
+
* @summary Searches for all matching values (using POST)
|
|
10135
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
10136
|
+
* @param {*} [options] Override http request option.
|
|
10137
|
+
* @throws {RequiredError}
|
|
10138
|
+
*/
|
|
10139
|
+
search: function (lookup_request, options) {
|
|
10140
|
+
var localVarFetchArgs = (0, exports.CustomerApiFetchParamCreator)(configuration).search(lookup_request, options);
|
|
10141
|
+
return function (fetch, basePath) {
|
|
10142
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
10143
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
10144
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
10145
|
+
if (response.status >= 200 && response.status < 300) {
|
|
10146
|
+
return response.json();
|
|
10147
|
+
}
|
|
10148
|
+
else {
|
|
10149
|
+
throw response;
|
|
10150
|
+
}
|
|
10151
|
+
});
|
|
10152
|
+
};
|
|
10153
|
+
},
|
|
10077
10154
|
/**
|
|
10078
10155
|
* Update a customer on the UltraCart account.
|
|
10079
10156
|
* @summary Update a customer
|
|
@@ -10321,6 +10398,16 @@ var CustomerApiFactory = function (configuration, fetch, basePath) {
|
|
|
10321
10398
|
insertCustomer: function (customer, _expand, options) {
|
|
10322
10399
|
return (0, exports.CustomerApiFp)(configuration).insertCustomer(customer, _expand, options)(fetch, basePath);
|
|
10323
10400
|
},
|
|
10401
|
+
/**
|
|
10402
|
+
*
|
|
10403
|
+
* @summary Searches for all matching values (using POST)
|
|
10404
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
10405
|
+
* @param {*} [options] Override http request option.
|
|
10406
|
+
* @throws {RequiredError}
|
|
10407
|
+
*/
|
|
10408
|
+
search: function (lookup_request, options) {
|
|
10409
|
+
return (0, exports.CustomerApiFp)(configuration).search(lookup_request, options)(fetch, basePath);
|
|
10410
|
+
},
|
|
10324
10411
|
/**
|
|
10325
10412
|
* Update a customer on the UltraCart account.
|
|
10326
10413
|
* @summary Update a customer
|
|
@@ -10550,6 +10637,17 @@ var CustomerApi = /** @class */ (function (_super) {
|
|
|
10550
10637
|
CustomerApi.prototype.insertCustomer = function (customer, _expand, options) {
|
|
10551
10638
|
return (0, exports.CustomerApiFp)(this.configuration).insertCustomer(customer, _expand, options)(this.fetch, this.basePath);
|
|
10552
10639
|
};
|
|
10640
|
+
/**
|
|
10641
|
+
*
|
|
10642
|
+
* @summary Searches for all matching values (using POST)
|
|
10643
|
+
* @param {LookupRequest} lookup_request LookupRequest
|
|
10644
|
+
* @param {*} [options] Override http request option.
|
|
10645
|
+
* @throws {RequiredError}
|
|
10646
|
+
* @memberof CustomerApi
|
|
10647
|
+
*/
|
|
10648
|
+
CustomerApi.prototype.search = function (lookup_request, options) {
|
|
10649
|
+
return (0, exports.CustomerApiFp)(this.configuration).search(lookup_request, options)(this.fetch, this.basePath);
|
|
10650
|
+
};
|
|
10553
10651
|
/**
|
|
10554
10652
|
* Update a customer on the UltraCart account.
|
|
10555
10653
|
* @summary Update a customer
|
|
@@ -14455,18 +14553,6 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
14455
14553
|
* @param {string} [current_stage] Current Stage
|
|
14456
14554
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
14457
14555
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
14458
|
-
* @param {number} [customer_profile_oid]
|
|
14459
|
-
* @param {string} [Refund_Date_Begin]
|
|
14460
|
-
* @param {string} [Refund_Date_End]
|
|
14461
|
-
* @param {string} [Custom_Field_1]
|
|
14462
|
-
* @param {string} [Custom_Field_2]
|
|
14463
|
-
* @param {string} [Custom_Field_3]
|
|
14464
|
-
* @param {string} [Custom_Field_4]
|
|
14465
|
-
* @param {string} [Custom_Field_5]
|
|
14466
|
-
* @param {string} [Custom_Field_6]
|
|
14467
|
-
* @param {string} [Custom_Field_7]
|
|
14468
|
-
* @param {string} [ship_on_date_begin]
|
|
14469
|
-
* @param {string} [ship_on_date_end]
|
|
14470
14556
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
14471
14557
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
14472
14558
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -14474,7 +14560,7 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
14474
14560
|
* @param {*} [options] Override http request option.
|
|
14475
14561
|
* @throws {RequiredError}
|
|
14476
14562
|
*/
|
|
14477
|
-
getOrders: function (order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
14563
|
+
getOrders: function (order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options) {
|
|
14478
14564
|
if (options === void 0) { options = {}; }
|
|
14479
14565
|
var localVarPath = "/order/orders";
|
|
14480
14566
|
var localVarUrlObj = url.parse(localVarPath, true);
|
|
@@ -14580,42 +14666,6 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
14580
14666
|
if (channel_partner_order_id !== undefined) {
|
|
14581
14667
|
localVarQueryParameter['channel_partner_order_id'] = channel_partner_order_id;
|
|
14582
14668
|
}
|
|
14583
|
-
if (customer_profile_oid !== undefined) {
|
|
14584
|
-
localVarQueryParameter['customer_profile_oid'] = customer_profile_oid;
|
|
14585
|
-
}
|
|
14586
|
-
if (Refund_Date_Begin !== undefined) {
|
|
14587
|
-
localVarQueryParameter['Refund Date Begin'] = Refund_Date_Begin;
|
|
14588
|
-
}
|
|
14589
|
-
if (Refund_Date_End !== undefined) {
|
|
14590
|
-
localVarQueryParameter['Refund Date End'] = Refund_Date_End;
|
|
14591
|
-
}
|
|
14592
|
-
if (Custom_Field_1 !== undefined) {
|
|
14593
|
-
localVarQueryParameter['Custom Field 1'] = Custom_Field_1;
|
|
14594
|
-
}
|
|
14595
|
-
if (Custom_Field_2 !== undefined) {
|
|
14596
|
-
localVarQueryParameter['Custom Field 2'] = Custom_Field_2;
|
|
14597
|
-
}
|
|
14598
|
-
if (Custom_Field_3 !== undefined) {
|
|
14599
|
-
localVarQueryParameter['Custom Field 3'] = Custom_Field_3;
|
|
14600
|
-
}
|
|
14601
|
-
if (Custom_Field_4 !== undefined) {
|
|
14602
|
-
localVarQueryParameter['Custom Field 4'] = Custom_Field_4;
|
|
14603
|
-
}
|
|
14604
|
-
if (Custom_Field_5 !== undefined) {
|
|
14605
|
-
localVarQueryParameter['Custom Field 5'] = Custom_Field_5;
|
|
14606
|
-
}
|
|
14607
|
-
if (Custom_Field_6 !== undefined) {
|
|
14608
|
-
localVarQueryParameter['Custom Field 6'] = Custom_Field_6;
|
|
14609
|
-
}
|
|
14610
|
-
if (Custom_Field_7 !== undefined) {
|
|
14611
|
-
localVarQueryParameter['Custom Field 7'] = Custom_Field_7;
|
|
14612
|
-
}
|
|
14613
|
-
if (ship_on_date_begin !== undefined) {
|
|
14614
|
-
localVarQueryParameter['ship_on_date_begin'] = ship_on_date_begin;
|
|
14615
|
-
}
|
|
14616
|
-
if (ship_on_date_end !== undefined) {
|
|
14617
|
-
localVarQueryParameter['ship_on_date_end'] = ship_on_date_end;
|
|
14618
|
-
}
|
|
14619
14669
|
if (_limit !== undefined) {
|
|
14620
14670
|
localVarQueryParameter['_limit'] = _limit;
|
|
14621
14671
|
}
|
|
@@ -15498,18 +15548,6 @@ var OrderApiFp = function (configuration) {
|
|
|
15498
15548
|
* @param {string} [current_stage] Current Stage
|
|
15499
15549
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
15500
15550
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
15501
|
-
* @param {number} [customer_profile_oid]
|
|
15502
|
-
* @param {string} [Refund_Date_Begin]
|
|
15503
|
-
* @param {string} [Refund_Date_End]
|
|
15504
|
-
* @param {string} [Custom_Field_1]
|
|
15505
|
-
* @param {string} [Custom_Field_2]
|
|
15506
|
-
* @param {string} [Custom_Field_3]
|
|
15507
|
-
* @param {string} [Custom_Field_4]
|
|
15508
|
-
* @param {string} [Custom_Field_5]
|
|
15509
|
-
* @param {string} [Custom_Field_6]
|
|
15510
|
-
* @param {string} [Custom_Field_7]
|
|
15511
|
-
* @param {string} [ship_on_date_begin]
|
|
15512
|
-
* @param {string} [ship_on_date_end]
|
|
15513
15551
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
15514
15552
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
15515
15553
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -15517,8 +15555,8 @@ var OrderApiFp = function (configuration) {
|
|
|
15517
15555
|
* @param {*} [options] Override http request option.
|
|
15518
15556
|
* @throws {RequiredError}
|
|
15519
15557
|
*/
|
|
15520
|
-
getOrders: function (order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
15521
|
-
var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
15558
|
+
getOrders: function (order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options) {
|
|
15559
|
+
var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options);
|
|
15522
15560
|
return function (fetch, basePath) {
|
|
15523
15561
|
if (fetch === void 0) { fetch = portableFetch; }
|
|
15524
15562
|
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
@@ -15934,18 +15972,6 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
|
|
|
15934
15972
|
* @param {string} [current_stage] Current Stage
|
|
15935
15973
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
15936
15974
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
15937
|
-
* @param {number} [customer_profile_oid]
|
|
15938
|
-
* @param {string} [Refund_Date_Begin]
|
|
15939
|
-
* @param {string} [Refund_Date_End]
|
|
15940
|
-
* @param {string} [Custom_Field_1]
|
|
15941
|
-
* @param {string} [Custom_Field_2]
|
|
15942
|
-
* @param {string} [Custom_Field_3]
|
|
15943
|
-
* @param {string} [Custom_Field_4]
|
|
15944
|
-
* @param {string} [Custom_Field_5]
|
|
15945
|
-
* @param {string} [Custom_Field_6]
|
|
15946
|
-
* @param {string} [Custom_Field_7]
|
|
15947
|
-
* @param {string} [ship_on_date_begin]
|
|
15948
|
-
* @param {string} [ship_on_date_end]
|
|
15949
15975
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
15950
15976
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
15951
15977
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -15953,8 +15979,8 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
|
|
|
15953
15979
|
* @param {*} [options] Override http request option.
|
|
15954
15980
|
* @throws {RequiredError}
|
|
15955
15981
|
*/
|
|
15956
|
-
getOrders: function (order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
15957
|
-
return (0, exports.OrderApiFp)(configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
15982
|
+
getOrders: function (order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options) {
|
|
15983
|
+
return (0, exports.OrderApiFp)(configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options)(fetch, basePath);
|
|
15958
15984
|
},
|
|
15959
15985
|
/**
|
|
15960
15986
|
* Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
|
|
@@ -16255,18 +16281,6 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
16255
16281
|
* @param {string} [current_stage] Current Stage
|
|
16256
16282
|
* @param {string} [channel_partner_code] Channel Partner Code
|
|
16257
16283
|
* @param {string} [channel_partner_order_id] Channel Partner Order ID
|
|
16258
|
-
* @param {number} [customer_profile_oid]
|
|
16259
|
-
* @param {string} [Refund_Date_Begin]
|
|
16260
|
-
* @param {string} [Refund_Date_End]
|
|
16261
|
-
* @param {string} [Custom_Field_1]
|
|
16262
|
-
* @param {string} [Custom_Field_2]
|
|
16263
|
-
* @param {string} [Custom_Field_3]
|
|
16264
|
-
* @param {string} [Custom_Field_4]
|
|
16265
|
-
* @param {string} [Custom_Field_5]
|
|
16266
|
-
* @param {string} [Custom_Field_6]
|
|
16267
|
-
* @param {string} [Custom_Field_7]
|
|
16268
|
-
* @param {string} [ship_on_date_begin]
|
|
16269
|
-
* @param {string} [ship_on_date_end]
|
|
16270
16284
|
* @param {number} [_limit] The maximum number of records to return on this one API call. (Maximum 200)
|
|
16271
16285
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
16272
16286
|
* @param {string} [_sort] The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
@@ -16275,8 +16289,8 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
16275
16289
|
* @throws {RequiredError}
|
|
16276
16290
|
* @memberof OrderApi
|
|
16277
16291
|
*/
|
|
16278
|
-
OrderApi.prototype.getOrders = function (order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
16279
|
-
return (0, exports.OrderApiFp)(this.configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id,
|
|
16292
|
+
OrderApi.prototype.getOrders = function (order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options) {
|
|
16293
|
+
return (0, exports.OrderApiFp)(this.configuration).getOrders(order_id, payment_method, company, first_name, last_name, city, state_region, postal_code, country_code, phone, email, cc_email, total, screen_branding_theme_code, storefront_host_name, creation_date_begin, creation_date_end, payment_date_begin, payment_date_end, shipment_date_begin, shipment_date_end, rma, purchase_order_number, item_id, current_stage, channel_partner_code, channel_partner_order_id, _limit, _offset, _sort, _expand, options)(this.fetch, this.basePath);
|
|
16280
16294
|
};
|
|
16281
16295
|
/**
|
|
16282
16296
|
* Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.
|