yellowgrid-api-ts 3.2.80-dev.0 → 3.2.82-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/api.ts +62 -76
- package/dist/api.d.ts +37 -45
- package/dist/api.js +64 -78
- package/docs/OrdersApi.md +30 -36
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -164,8 +164,8 @@ Class | Method | HTTP request | Description
|
|
|
164
164
|
*OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
|
|
165
165
|
*OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
|
|
166
166
|
*OrdersApi* | [**postCreateShipment**](docs/OrdersApi.md#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)
|
|
167
|
+
*OrdersApi* | [**postGetItemSerialInfo**](docs/OrdersApi.md#postgetitemserialinfo) | **POST** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)
|
|
167
168
|
*OrdersApi* | [**postGetOrders**](docs/OrdersApi.md#postgetorders) | **POST** /orders | Create An Order (Beta)
|
|
168
|
-
*OrdersApi* | [**postGetShipmentItemSerialInfo**](docs/OrdersApi.md#postgetshipmentitemserialinfo) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info | Get Shipment Item Serial Info (Admin)
|
|
169
169
|
*OrdersApi* | [**postIssueCredit**](docs/OrdersApi.md#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)
|
|
170
170
|
*OrdersApi* | [**postPrintShippingLabel**](docs/OrdersApi.md#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label
|
|
171
171
|
*OrdersApi* | [**postSendOrderEmail**](docs/OrdersApi.md#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email
|
package/api.ts
CHANGED
|
@@ -20299,15 +20299,21 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20299
20299
|
};
|
|
20300
20300
|
},
|
|
20301
20301
|
/**
|
|
20302
|
-
*
|
|
20303
|
-
* @summary
|
|
20304
|
-
* @param {
|
|
20305
|
-
* @param {
|
|
20302
|
+
* Get Item Serial Info (Admin)
|
|
20303
|
+
* @summary Get Item Serial Info (Admin)
|
|
20304
|
+
* @param {number} id Order ID
|
|
20305
|
+
* @param {number} itemId Shipment Item ID
|
|
20306
20306
|
* @param {*} [options] Override http request option.
|
|
20307
20307
|
* @throws {RequiredError}
|
|
20308
20308
|
*/
|
|
20309
|
-
|
|
20310
|
-
|
|
20309
|
+
postGetItemSerialInfo: async (id: number, itemId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20310
|
+
// verify required parameter 'id' is not null or undefined
|
|
20311
|
+
assertParamExists('postGetItemSerialInfo', 'id', id)
|
|
20312
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
20313
|
+
assertParamExists('postGetItemSerialInfo', 'itemId', itemId)
|
|
20314
|
+
const localVarPath = `/admin/orders/{id}/items/{item_id}/info`
|
|
20315
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
20316
|
+
.replace(`{${"item_id"}}`, encodeURIComponent(String(itemId)));
|
|
20311
20317
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20312
20318
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20313
20319
|
let baseOptions;
|
|
@@ -20319,18 +20325,11 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20319
20325
|
const localVarHeaderParameter = {} as any;
|
|
20320
20326
|
const localVarQueryParameter = {} as any;
|
|
20321
20327
|
|
|
20322
|
-
if (readonly !== undefined) {
|
|
20323
|
-
localVarQueryParameter['readonly'] = readonly;
|
|
20324
|
-
}
|
|
20325
|
-
|
|
20326
20328
|
|
|
20327
20329
|
|
|
20328
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
20329
|
-
|
|
20330
20330
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20331
20331
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20332
20332
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20333
|
-
localVarRequestOptions.data = serializeDataIfNeeded(customerOrderRequestDTO, localVarRequestOptions, configuration)
|
|
20334
20333
|
|
|
20335
20334
|
return {
|
|
20336
20335
|
url: toPathString(localVarUrlObj),
|
|
@@ -20338,29 +20337,15 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20338
20337
|
};
|
|
20339
20338
|
},
|
|
20340
20339
|
/**
|
|
20341
|
-
*
|
|
20342
|
-
* @summary
|
|
20343
|
-
* @param {
|
|
20344
|
-
* @param {
|
|
20345
|
-
* @param {number} shipmentId Shipment ID
|
|
20346
|
-
* @param {number} itemId Shipment Item ID
|
|
20340
|
+
* Create An Order (Beta)
|
|
20341
|
+
* @summary Create An Order (Beta)
|
|
20342
|
+
* @param {boolean} [readonly] Readonly Order
|
|
20343
|
+
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
20347
20344
|
* @param {*} [options] Override http request option.
|
|
20348
20345
|
* @throws {RequiredError}
|
|
20349
20346
|
*/
|
|
20350
|
-
|
|
20351
|
-
|
|
20352
|
-
assertParamExists('postGetShipmentItemSerialInfo', 'id', id)
|
|
20353
|
-
// verify required parameter 'batchId' is not null or undefined
|
|
20354
|
-
assertParamExists('postGetShipmentItemSerialInfo', 'batchId', batchId)
|
|
20355
|
-
// verify required parameter 'shipmentId' is not null or undefined
|
|
20356
|
-
assertParamExists('postGetShipmentItemSerialInfo', 'shipmentId', shipmentId)
|
|
20357
|
-
// verify required parameter 'itemId' is not null or undefined
|
|
20358
|
-
assertParamExists('postGetShipmentItemSerialInfo', 'itemId', itemId)
|
|
20359
|
-
const localVarPath = `/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info`
|
|
20360
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
20361
|
-
.replace(`{${"batch_id"}}`, encodeURIComponent(String(batchId)))
|
|
20362
|
-
.replace(`{${"shipment_id"}}`, encodeURIComponent(String(shipmentId)))
|
|
20363
|
-
.replace(`{${"item_id"}}`, encodeURIComponent(String(itemId)));
|
|
20347
|
+
postGetOrders: async (readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20348
|
+
const localVarPath = `/orders`;
|
|
20364
20349
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20365
20350
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20366
20351
|
let baseOptions;
|
|
@@ -20372,11 +20357,18 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20372
20357
|
const localVarHeaderParameter = {} as any;
|
|
20373
20358
|
const localVarQueryParameter = {} as any;
|
|
20374
20359
|
|
|
20360
|
+
if (readonly !== undefined) {
|
|
20361
|
+
localVarQueryParameter['readonly'] = readonly;
|
|
20362
|
+
}
|
|
20363
|
+
|
|
20375
20364
|
|
|
20376
20365
|
|
|
20366
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
20367
|
+
|
|
20377
20368
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20378
20369
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20379
20370
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20371
|
+
localVarRequestOptions.data = serializeDataIfNeeded(customerOrderRequestDTO, localVarRequestOptions, configuration)
|
|
20380
20372
|
|
|
20381
20373
|
return {
|
|
20382
20374
|
url: toPathString(localVarUrlObj),
|
|
@@ -20990,33 +20982,31 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
20990
20982
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20991
20983
|
},
|
|
20992
20984
|
/**
|
|
20993
|
-
*
|
|
20994
|
-
* @summary
|
|
20995
|
-
* @param {
|
|
20996
|
-
* @param {
|
|
20985
|
+
* Get Item Serial Info (Admin)
|
|
20986
|
+
* @summary Get Item Serial Info (Admin)
|
|
20987
|
+
* @param {number} id Order ID
|
|
20988
|
+
* @param {number} itemId Shipment Item ID
|
|
20997
20989
|
* @param {*} [options] Override http request option.
|
|
20998
20990
|
* @throws {RequiredError}
|
|
20999
20991
|
*/
|
|
21000
|
-
async
|
|
21001
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
20992
|
+
async postGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>> {
|
|
20993
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postGetItemSerialInfo(id, itemId, options);
|
|
21002
20994
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21003
|
-
const localVarOperationServerBasePath = operationServerMap['OrdersApi.
|
|
20995
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.postGetItemSerialInfo']?.[localVarOperationServerIndex]?.url;
|
|
21004
20996
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21005
20997
|
},
|
|
21006
20998
|
/**
|
|
21007
|
-
*
|
|
21008
|
-
* @summary
|
|
21009
|
-
* @param {
|
|
21010
|
-
* @param {
|
|
21011
|
-
* @param {number} shipmentId Shipment ID
|
|
21012
|
-
* @param {number} itemId Shipment Item ID
|
|
20999
|
+
* Create An Order (Beta)
|
|
21000
|
+
* @summary Create An Order (Beta)
|
|
21001
|
+
* @param {boolean} [readonly] Readonly Order
|
|
21002
|
+
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
21013
21003
|
* @param {*} [options] Override http request option.
|
|
21014
21004
|
* @throws {RequiredError}
|
|
21015
21005
|
*/
|
|
21016
|
-
async
|
|
21017
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
21006
|
+
async postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>> {
|
|
21007
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postGetOrders(readonly, customerOrderRequestDTO, options);
|
|
21018
21008
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21019
|
-
const localVarOperationServerBasePath = operationServerMap['OrdersApi.
|
|
21009
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.postGetOrders']?.[localVarOperationServerIndex]?.url;
|
|
21020
21010
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21021
21011
|
},
|
|
21022
21012
|
/**
|
|
@@ -21311,6 +21301,17 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
21311
21301
|
postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentDTO> {
|
|
21312
21302
|
return localVarFp.postCreateShipment(id, batchId, shipmentRequestDTO, options).then((request) => request(axios, basePath));
|
|
21313
21303
|
},
|
|
21304
|
+
/**
|
|
21305
|
+
* Get Item Serial Info (Admin)
|
|
21306
|
+
* @summary Get Item Serial Info (Admin)
|
|
21307
|
+
* @param {number} id Order ID
|
|
21308
|
+
* @param {number} itemId Shipment Item ID
|
|
21309
|
+
* @param {*} [options] Override http request option.
|
|
21310
|
+
* @throws {RequiredError}
|
|
21311
|
+
*/
|
|
21312
|
+
postGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel> {
|
|
21313
|
+
return localVarFp.postGetItemSerialInfo(id, itemId, options).then((request) => request(axios, basePath));
|
|
21314
|
+
},
|
|
21314
21315
|
/**
|
|
21315
21316
|
* Create An Order (Beta)
|
|
21316
21317
|
* @summary Create An Order (Beta)
|
|
@@ -21322,19 +21323,6 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
21322
21323
|
postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>> {
|
|
21323
21324
|
return localVarFp.postGetOrders(readonly, customerOrderRequestDTO, options).then((request) => request(axios, basePath));
|
|
21324
21325
|
},
|
|
21325
|
-
/**
|
|
21326
|
-
* Get Shipment Item Serial Info (Admin)
|
|
21327
|
-
* @summary Get Shipment Item Serial Info (Admin)
|
|
21328
|
-
* @param {number} id Order ID
|
|
21329
|
-
* @param {number} batchId Batch ID
|
|
21330
|
-
* @param {number} shipmentId Shipment ID
|
|
21331
|
-
* @param {number} itemId Shipment Item ID
|
|
21332
|
-
* @param {*} [options] Override http request option.
|
|
21333
|
-
* @throws {RequiredError}
|
|
21334
|
-
*/
|
|
21335
|
-
postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel> {
|
|
21336
|
-
return localVarFp.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then((request) => request(axios, basePath));
|
|
21337
|
-
},
|
|
21338
21326
|
/**
|
|
21339
21327
|
* Issue Credit (Admin)
|
|
21340
21328
|
* @summary Issue Credit (Admin)
|
|
@@ -21622,31 +21610,29 @@ export class OrdersApi extends BaseAPI {
|
|
|
21622
21610
|
}
|
|
21623
21611
|
|
|
21624
21612
|
/**
|
|
21625
|
-
*
|
|
21626
|
-
* @summary
|
|
21627
|
-
* @param {
|
|
21628
|
-
* @param {
|
|
21613
|
+
* Get Item Serial Info (Admin)
|
|
21614
|
+
* @summary Get Item Serial Info (Admin)
|
|
21615
|
+
* @param {number} id Order ID
|
|
21616
|
+
* @param {number} itemId Shipment Item ID
|
|
21629
21617
|
* @param {*} [options] Override http request option.
|
|
21630
21618
|
* @throws {RequiredError}
|
|
21631
21619
|
* @memberof OrdersApi
|
|
21632
21620
|
*/
|
|
21633
|
-
public
|
|
21634
|
-
return OrdersApiFp(this.configuration).
|
|
21621
|
+
public postGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig) {
|
|
21622
|
+
return OrdersApiFp(this.configuration).postGetItemSerialInfo(id, itemId, options).then((request) => request(this.axios, this.basePath));
|
|
21635
21623
|
}
|
|
21636
21624
|
|
|
21637
21625
|
/**
|
|
21638
|
-
*
|
|
21639
|
-
* @summary
|
|
21640
|
-
* @param {
|
|
21641
|
-
* @param {
|
|
21642
|
-
* @param {number} shipmentId Shipment ID
|
|
21643
|
-
* @param {number} itemId Shipment Item ID
|
|
21626
|
+
* Create An Order (Beta)
|
|
21627
|
+
* @summary Create An Order (Beta)
|
|
21628
|
+
* @param {boolean} [readonly] Readonly Order
|
|
21629
|
+
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
21644
21630
|
* @param {*} [options] Override http request option.
|
|
21645
21631
|
* @throws {RequiredError}
|
|
21646
21632
|
* @memberof OrdersApi
|
|
21647
21633
|
*/
|
|
21648
|
-
public
|
|
21649
|
-
return OrdersApiFp(this.configuration).
|
|
21634
|
+
public postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig) {
|
|
21635
|
+
return OrdersApiFp(this.configuration).postGetOrders(readonly, customerOrderRequestDTO, options).then((request) => request(this.axios, this.basePath));
|
|
21650
21636
|
}
|
|
21651
21637
|
|
|
21652
21638
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -15605,6 +15605,15 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15605
15605
|
* @throws {RequiredError}
|
|
15606
15606
|
*/
|
|
15607
15607
|
postCreateShipment: (id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15608
|
+
/**
|
|
15609
|
+
* Get Item Serial Info (Admin)
|
|
15610
|
+
* @summary Get Item Serial Info (Admin)
|
|
15611
|
+
* @param {number} id Order ID
|
|
15612
|
+
* @param {number} itemId Shipment Item ID
|
|
15613
|
+
* @param {*} [options] Override http request option.
|
|
15614
|
+
* @throws {RequiredError}
|
|
15615
|
+
*/
|
|
15616
|
+
postGetItemSerialInfo: (id: number, itemId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15608
15617
|
/**
|
|
15609
15618
|
* Create An Order (Beta)
|
|
15610
15619
|
* @summary Create An Order (Beta)
|
|
@@ -15614,17 +15623,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15614
15623
|
* @throws {RequiredError}
|
|
15615
15624
|
*/
|
|
15616
15625
|
postGetOrders: (readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15617
|
-
/**
|
|
15618
|
-
* Get Shipment Item Serial Info (Admin)
|
|
15619
|
-
* @summary Get Shipment Item Serial Info (Admin)
|
|
15620
|
-
* @param {number} id Order ID
|
|
15621
|
-
* @param {number} batchId Batch ID
|
|
15622
|
-
* @param {number} shipmentId Shipment ID
|
|
15623
|
-
* @param {number} itemId Shipment Item ID
|
|
15624
|
-
* @param {*} [options] Override http request option.
|
|
15625
|
-
* @throws {RequiredError}
|
|
15626
|
-
*/
|
|
15627
|
-
postGetShipmentItemSerialInfo: (id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15628
15626
|
/**
|
|
15629
15627
|
* Issue Credit (Admin)
|
|
15630
15628
|
* @summary Issue Credit (Admin)
|
|
@@ -15839,6 +15837,15 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
15839
15837
|
* @throws {RequiredError}
|
|
15840
15838
|
*/
|
|
15841
15839
|
postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentDTO>>;
|
|
15840
|
+
/**
|
|
15841
|
+
* Get Item Serial Info (Admin)
|
|
15842
|
+
* @summary Get Item Serial Info (Admin)
|
|
15843
|
+
* @param {number} id Order ID
|
|
15844
|
+
* @param {number} itemId Shipment Item ID
|
|
15845
|
+
* @param {*} [options] Override http request option.
|
|
15846
|
+
* @throws {RequiredError}
|
|
15847
|
+
*/
|
|
15848
|
+
postGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>>;
|
|
15842
15849
|
/**
|
|
15843
15850
|
* Create An Order (Beta)
|
|
15844
15851
|
* @summary Create An Order (Beta)
|
|
@@ -15848,17 +15855,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
15848
15855
|
* @throws {RequiredError}
|
|
15849
15856
|
*/
|
|
15850
15857
|
postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
|
|
15851
|
-
/**
|
|
15852
|
-
* Get Shipment Item Serial Info (Admin)
|
|
15853
|
-
* @summary Get Shipment Item Serial Info (Admin)
|
|
15854
|
-
* @param {number} id Order ID
|
|
15855
|
-
* @param {number} batchId Batch ID
|
|
15856
|
-
* @param {number} shipmentId Shipment ID
|
|
15857
|
-
* @param {number} itemId Shipment Item ID
|
|
15858
|
-
* @param {*} [options] Override http request option.
|
|
15859
|
-
* @throws {RequiredError}
|
|
15860
|
-
*/
|
|
15861
|
-
postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>>;
|
|
15862
15858
|
/**
|
|
15863
15859
|
* Issue Credit (Admin)
|
|
15864
15860
|
* @summary Issue Credit (Admin)
|
|
@@ -16073,6 +16069,15 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
16073
16069
|
* @throws {RequiredError}
|
|
16074
16070
|
*/
|
|
16075
16071
|
postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentDTO>;
|
|
16072
|
+
/**
|
|
16073
|
+
* Get Item Serial Info (Admin)
|
|
16074
|
+
* @summary Get Item Serial Info (Admin)
|
|
16075
|
+
* @param {number} id Order ID
|
|
16076
|
+
* @param {number} itemId Shipment Item ID
|
|
16077
|
+
* @param {*} [options] Override http request option.
|
|
16078
|
+
* @throws {RequiredError}
|
|
16079
|
+
*/
|
|
16080
|
+
postGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel>;
|
|
16076
16081
|
/**
|
|
16077
16082
|
* Create An Order (Beta)
|
|
16078
16083
|
* @summary Create An Order (Beta)
|
|
@@ -16082,17 +16087,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
16082
16087
|
* @throws {RequiredError}
|
|
16083
16088
|
*/
|
|
16084
16089
|
postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
|
|
16085
|
-
/**
|
|
16086
|
-
* Get Shipment Item Serial Info (Admin)
|
|
16087
|
-
* @summary Get Shipment Item Serial Info (Admin)
|
|
16088
|
-
* @param {number} id Order ID
|
|
16089
|
-
* @param {number} batchId Batch ID
|
|
16090
|
-
* @param {number} shipmentId Shipment ID
|
|
16091
|
-
* @param {number} itemId Shipment Item ID
|
|
16092
|
-
* @param {*} [options] Override http request option.
|
|
16093
|
-
* @throws {RequiredError}
|
|
16094
|
-
*/
|
|
16095
|
-
postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel>;
|
|
16096
16090
|
/**
|
|
16097
16091
|
* Issue Credit (Admin)
|
|
16098
16092
|
* @summary Issue Credit (Admin)
|
|
@@ -16322,27 +16316,25 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
16322
16316
|
*/
|
|
16323
16317
|
postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentDTO, any, {}>>;
|
|
16324
16318
|
/**
|
|
16325
|
-
*
|
|
16326
|
-
* @summary
|
|
16327
|
-
* @param {
|
|
16328
|
-
* @param {
|
|
16319
|
+
* Get Item Serial Info (Admin)
|
|
16320
|
+
* @summary Get Item Serial Info (Admin)
|
|
16321
|
+
* @param {number} id Order ID
|
|
16322
|
+
* @param {number} itemId Shipment Item ID
|
|
16329
16323
|
* @param {*} [options] Override http request option.
|
|
16330
16324
|
* @throws {RequiredError}
|
|
16331
16325
|
* @memberof OrdersApi
|
|
16332
16326
|
*/
|
|
16333
|
-
|
|
16327
|
+
postGetItemSerialInfo(id: number, itemId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSerialInfoModel, any, {}>>;
|
|
16334
16328
|
/**
|
|
16335
|
-
*
|
|
16336
|
-
* @summary
|
|
16337
|
-
* @param {
|
|
16338
|
-
* @param {
|
|
16339
|
-
* @param {number} shipmentId Shipment ID
|
|
16340
|
-
* @param {number} itemId Shipment Item ID
|
|
16329
|
+
* Create An Order (Beta)
|
|
16330
|
+
* @summary Create An Order (Beta)
|
|
16331
|
+
* @param {boolean} [readonly] Readonly Order
|
|
16332
|
+
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
16341
16333
|
* @param {*} [options] Override http request option.
|
|
16342
16334
|
* @throws {RequiredError}
|
|
16343
16335
|
* @memberof OrdersApi
|
|
16344
16336
|
*/
|
|
16345
|
-
|
|
16337
|
+
postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
|
|
16346
16338
|
/**
|
|
16347
16339
|
* Issue Credit (Admin)
|
|
16348
16340
|
* @summary Issue Credit (Admin)
|
package/dist/api.js
CHANGED
|
@@ -10350,23 +10350,29 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
10350
10350
|
});
|
|
10351
10351
|
},
|
|
10352
10352
|
/**
|
|
10353
|
-
*
|
|
10354
|
-
* @summary
|
|
10355
|
-
* @param {
|
|
10356
|
-
* @param {
|
|
10353
|
+
* Get Item Serial Info (Admin)
|
|
10354
|
+
* @summary Get Item Serial Info (Admin)
|
|
10355
|
+
* @param {number} id Order ID
|
|
10356
|
+
* @param {number} itemId Shipment Item ID
|
|
10357
10357
|
* @param {*} [options] Override http request option.
|
|
10358
10358
|
* @throws {RequiredError}
|
|
10359
10359
|
*/
|
|
10360
|
-
|
|
10360
|
+
postGetItemSerialInfo: function (id_1, itemId_1) {
|
|
10361
10361
|
var args_1 = [];
|
|
10362
10362
|
for (var _i = 2; _i < arguments.length; _i++) {
|
|
10363
10363
|
args_1[_i - 2] = arguments[_i];
|
|
10364
10364
|
}
|
|
10365
|
-
return __awaiter(_this, __spreadArray([
|
|
10365
|
+
return __awaiter(_this, __spreadArray([id_1, itemId_1], args_1, true), void 0, function (id, itemId, options) {
|
|
10366
10366
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
10367
10367
|
if (options === void 0) { options = {}; }
|
|
10368
10368
|
return __generator(this, function (_a) {
|
|
10369
|
-
|
|
10369
|
+
// verify required parameter 'id' is not null or undefined
|
|
10370
|
+
(0, common_1.assertParamExists)('postGetItemSerialInfo', 'id', id);
|
|
10371
|
+
// verify required parameter 'itemId' is not null or undefined
|
|
10372
|
+
(0, common_1.assertParamExists)('postGetItemSerialInfo', 'itemId', itemId);
|
|
10373
|
+
localVarPath = "/admin/orders/{id}/items/{item_id}/info"
|
|
10374
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)))
|
|
10375
|
+
.replace("{".concat("item_id", "}"), encodeURIComponent(String(itemId)));
|
|
10370
10376
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10371
10377
|
if (configuration) {
|
|
10372
10378
|
baseOptions = configuration.baseOptions;
|
|
@@ -10374,14 +10380,9 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
10374
10380
|
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
10375
10381
|
localVarHeaderParameter = {};
|
|
10376
10382
|
localVarQueryParameter = {};
|
|
10377
|
-
if (readonly !== undefined) {
|
|
10378
|
-
localVarQueryParameter['readonly'] = readonly;
|
|
10379
|
-
}
|
|
10380
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10381
10383
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10382
10384
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10383
10385
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10384
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(customerOrderRequestDTO, localVarRequestOptions, configuration);
|
|
10385
10386
|
return [2 /*return*/, {
|
|
10386
10387
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10387
10388
|
options: localVarRequestOptions,
|
|
@@ -10390,37 +10391,23 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
10390
10391
|
});
|
|
10391
10392
|
},
|
|
10392
10393
|
/**
|
|
10393
|
-
*
|
|
10394
|
-
* @summary
|
|
10395
|
-
* @param {
|
|
10396
|
-
* @param {
|
|
10397
|
-
* @param {number} shipmentId Shipment ID
|
|
10398
|
-
* @param {number} itemId Shipment Item ID
|
|
10394
|
+
* Create An Order (Beta)
|
|
10395
|
+
* @summary Create An Order (Beta)
|
|
10396
|
+
* @param {boolean} [readonly] Readonly Order
|
|
10397
|
+
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
10399
10398
|
* @param {*} [options] Override http request option.
|
|
10400
10399
|
* @throws {RequiredError}
|
|
10401
10400
|
*/
|
|
10402
|
-
|
|
10401
|
+
postGetOrders: function (readonly_1, customerOrderRequestDTO_1) {
|
|
10403
10402
|
var args_1 = [];
|
|
10404
|
-
for (var _i =
|
|
10405
|
-
args_1[_i -
|
|
10403
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
10404
|
+
args_1[_i - 2] = arguments[_i];
|
|
10406
10405
|
}
|
|
10407
|
-
return __awaiter(_this, __spreadArray([
|
|
10406
|
+
return __awaiter(_this, __spreadArray([readonly_1, customerOrderRequestDTO_1], args_1, true), void 0, function (readonly, customerOrderRequestDTO, options) {
|
|
10408
10407
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
10409
10408
|
if (options === void 0) { options = {}; }
|
|
10410
10409
|
return __generator(this, function (_a) {
|
|
10411
|
-
|
|
10412
|
-
(0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'id', id);
|
|
10413
|
-
// verify required parameter 'batchId' is not null or undefined
|
|
10414
|
-
(0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'batchId', batchId);
|
|
10415
|
-
// verify required parameter 'shipmentId' is not null or undefined
|
|
10416
|
-
(0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'shipmentId', shipmentId);
|
|
10417
|
-
// verify required parameter 'itemId' is not null or undefined
|
|
10418
|
-
(0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'itemId', itemId);
|
|
10419
|
-
localVarPath = "/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info"
|
|
10420
|
-
.replace("{".concat("id", "}"), encodeURIComponent(String(id)))
|
|
10421
|
-
.replace("{".concat("batch_id", "}"), encodeURIComponent(String(batchId)))
|
|
10422
|
-
.replace("{".concat("shipment_id", "}"), encodeURIComponent(String(shipmentId)))
|
|
10423
|
-
.replace("{".concat("item_id", "}"), encodeURIComponent(String(itemId)));
|
|
10410
|
+
localVarPath = "/orders";
|
|
10424
10411
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10425
10412
|
if (configuration) {
|
|
10426
10413
|
baseOptions = configuration.baseOptions;
|
|
@@ -10428,9 +10415,14 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
10428
10415
|
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
10429
10416
|
localVarHeaderParameter = {};
|
|
10430
10417
|
localVarQueryParameter = {};
|
|
10418
|
+
if (readonly !== undefined) {
|
|
10419
|
+
localVarQueryParameter['readonly'] = readonly;
|
|
10420
|
+
}
|
|
10421
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10431
10422
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10432
10423
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10433
10424
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10425
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(customerOrderRequestDTO, localVarRequestOptions, configuration);
|
|
10434
10426
|
return [2 /*return*/, {
|
|
10435
10427
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10436
10428
|
options: localVarRequestOptions,
|
|
@@ -11183,50 +11175,48 @@ var OrdersApiFp = function (configuration) {
|
|
|
11183
11175
|
});
|
|
11184
11176
|
},
|
|
11185
11177
|
/**
|
|
11186
|
-
*
|
|
11187
|
-
* @summary
|
|
11188
|
-
* @param {
|
|
11189
|
-
* @param {
|
|
11178
|
+
* Get Item Serial Info (Admin)
|
|
11179
|
+
* @summary Get Item Serial Info (Admin)
|
|
11180
|
+
* @param {number} id Order ID
|
|
11181
|
+
* @param {number} itemId Shipment Item ID
|
|
11190
11182
|
* @param {*} [options] Override http request option.
|
|
11191
11183
|
* @throws {RequiredError}
|
|
11192
11184
|
*/
|
|
11193
|
-
|
|
11185
|
+
postGetItemSerialInfo: function (id, itemId, options) {
|
|
11194
11186
|
return __awaiter(this, void 0, void 0, function () {
|
|
11195
11187
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11196
11188
|
var _a, _b, _c;
|
|
11197
11189
|
return __generator(this, function (_d) {
|
|
11198
11190
|
switch (_d.label) {
|
|
11199
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
11191
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetItemSerialInfo(id, itemId, options)];
|
|
11200
11192
|
case 1:
|
|
11201
11193
|
localVarAxiosArgs = _d.sent();
|
|
11202
11194
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11203
|
-
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.
|
|
11195
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.postGetItemSerialInfo']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11204
11196
|
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11205
11197
|
}
|
|
11206
11198
|
});
|
|
11207
11199
|
});
|
|
11208
11200
|
},
|
|
11209
11201
|
/**
|
|
11210
|
-
*
|
|
11211
|
-
* @summary
|
|
11212
|
-
* @param {
|
|
11213
|
-
* @param {
|
|
11214
|
-
* @param {number} shipmentId Shipment ID
|
|
11215
|
-
* @param {number} itemId Shipment Item ID
|
|
11202
|
+
* Create An Order (Beta)
|
|
11203
|
+
* @summary Create An Order (Beta)
|
|
11204
|
+
* @param {boolean} [readonly] Readonly Order
|
|
11205
|
+
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
11216
11206
|
* @param {*} [options] Override http request option.
|
|
11217
11207
|
* @throws {RequiredError}
|
|
11218
11208
|
*/
|
|
11219
|
-
|
|
11209
|
+
postGetOrders: function (readonly, customerOrderRequestDTO, options) {
|
|
11220
11210
|
return __awaiter(this, void 0, void 0, function () {
|
|
11221
11211
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11222
11212
|
var _a, _b, _c;
|
|
11223
11213
|
return __generator(this, function (_d) {
|
|
11224
11214
|
switch (_d.label) {
|
|
11225
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
11215
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetOrders(readonly, customerOrderRequestDTO, options)];
|
|
11226
11216
|
case 1:
|
|
11227
11217
|
localVarAxiosArgs = _d.sent();
|
|
11228
11218
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11229
|
-
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.
|
|
11219
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.postGetOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11230
11220
|
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11231
11221
|
}
|
|
11232
11222
|
});
|
|
@@ -11624,6 +11614,17 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
11624
11614
|
postCreateShipment: function (id, batchId, shipmentRequestDTO, options) {
|
|
11625
11615
|
return localVarFp.postCreateShipment(id, batchId, shipmentRequestDTO, options).then(function (request) { return request(axios, basePath); });
|
|
11626
11616
|
},
|
|
11617
|
+
/**
|
|
11618
|
+
* Get Item Serial Info (Admin)
|
|
11619
|
+
* @summary Get Item Serial Info (Admin)
|
|
11620
|
+
* @param {number} id Order ID
|
|
11621
|
+
* @param {number} itemId Shipment Item ID
|
|
11622
|
+
* @param {*} [options] Override http request option.
|
|
11623
|
+
* @throws {RequiredError}
|
|
11624
|
+
*/
|
|
11625
|
+
postGetItemSerialInfo: function (id, itemId, options) {
|
|
11626
|
+
return localVarFp.postGetItemSerialInfo(id, itemId, options).then(function (request) { return request(axios, basePath); });
|
|
11627
|
+
},
|
|
11627
11628
|
/**
|
|
11628
11629
|
* Create An Order (Beta)
|
|
11629
11630
|
* @summary Create An Order (Beta)
|
|
@@ -11635,19 +11636,6 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
11635
11636
|
postGetOrders: function (readonly, customerOrderRequestDTO, options) {
|
|
11636
11637
|
return localVarFp.postGetOrders(readonly, customerOrderRequestDTO, options).then(function (request) { return request(axios, basePath); });
|
|
11637
11638
|
},
|
|
11638
|
-
/**
|
|
11639
|
-
* Get Shipment Item Serial Info (Admin)
|
|
11640
|
-
* @summary Get Shipment Item Serial Info (Admin)
|
|
11641
|
-
* @param {number} id Order ID
|
|
11642
|
-
* @param {number} batchId Batch ID
|
|
11643
|
-
* @param {number} shipmentId Shipment ID
|
|
11644
|
-
* @param {number} itemId Shipment Item ID
|
|
11645
|
-
* @param {*} [options] Override http request option.
|
|
11646
|
-
* @throws {RequiredError}
|
|
11647
|
-
*/
|
|
11648
|
-
postGetShipmentItemSerialInfo: function (id, batchId, shipmentId, itemId, options) {
|
|
11649
|
-
return localVarFp.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then(function (request) { return request(axios, basePath); });
|
|
11650
|
-
},
|
|
11651
11639
|
/**
|
|
11652
11640
|
* Issue Credit (Admin)
|
|
11653
11641
|
* @summary Issue Credit (Admin)
|
|
@@ -11939,32 +11927,30 @@ var OrdersApi = /** @class */ (function (_super) {
|
|
|
11939
11927
|
return (0, exports.OrdersApiFp)(this.configuration).postCreateShipment(id, batchId, shipmentRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11940
11928
|
};
|
|
11941
11929
|
/**
|
|
11942
|
-
*
|
|
11943
|
-
* @summary
|
|
11944
|
-
* @param {
|
|
11945
|
-
* @param {
|
|
11930
|
+
* Get Item Serial Info (Admin)
|
|
11931
|
+
* @summary Get Item Serial Info (Admin)
|
|
11932
|
+
* @param {number} id Order ID
|
|
11933
|
+
* @param {number} itemId Shipment Item ID
|
|
11946
11934
|
* @param {*} [options] Override http request option.
|
|
11947
11935
|
* @throws {RequiredError}
|
|
11948
11936
|
* @memberof OrdersApi
|
|
11949
11937
|
*/
|
|
11950
|
-
OrdersApi.prototype.
|
|
11938
|
+
OrdersApi.prototype.postGetItemSerialInfo = function (id, itemId, options) {
|
|
11951
11939
|
var _this = this;
|
|
11952
|
-
return (0, exports.OrdersApiFp)(this.configuration).
|
|
11940
|
+
return (0, exports.OrdersApiFp)(this.configuration).postGetItemSerialInfo(id, itemId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11953
11941
|
};
|
|
11954
11942
|
/**
|
|
11955
|
-
*
|
|
11956
|
-
* @summary
|
|
11957
|
-
* @param {
|
|
11958
|
-
* @param {
|
|
11959
|
-
* @param {number} shipmentId Shipment ID
|
|
11960
|
-
* @param {number} itemId Shipment Item ID
|
|
11943
|
+
* Create An Order (Beta)
|
|
11944
|
+
* @summary Create An Order (Beta)
|
|
11945
|
+
* @param {boolean} [readonly] Readonly Order
|
|
11946
|
+
* @param {CustomerOrderRequestDTO} [customerOrderRequestDTO] Order Request
|
|
11961
11947
|
* @param {*} [options] Override http request option.
|
|
11962
11948
|
* @throws {RequiredError}
|
|
11963
11949
|
* @memberof OrdersApi
|
|
11964
11950
|
*/
|
|
11965
|
-
OrdersApi.prototype.
|
|
11951
|
+
OrdersApi.prototype.postGetOrders = function (readonly, customerOrderRequestDTO, options) {
|
|
11966
11952
|
var _this = this;
|
|
11967
|
-
return (0, exports.OrdersApiFp)(this.configuration).
|
|
11953
|
+
return (0, exports.OrdersApiFp)(this.configuration).postGetOrders(readonly, customerOrderRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11968
11954
|
};
|
|
11969
11955
|
/**
|
|
11970
11956
|
* Issue Credit (Admin)
|
package/docs/OrdersApi.md
CHANGED
|
@@ -16,8 +16,8 @@ All URIs are relative to *https://api.yellowgrid.local*
|
|
|
16
16
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
17
17
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
18
18
|
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
19
|
+
|[**postGetItemSerialInfo**](#postgetitemserialinfo) | **POST** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
|
|
19
20
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
20
|
-
|[**postGetShipmentItemSerialInfo**](#postgetshipmentitemserialinfo) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info | Get Shipment Item Serial Info (Admin)|
|
|
21
21
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
22
22
|
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
23
23
|
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
@@ -726,29 +726,28 @@ No authorization required
|
|
|
726
726
|
|
|
727
727
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
728
728
|
|
|
729
|
-
# **
|
|
730
|
-
>
|
|
729
|
+
# **postGetItemSerialInfo**
|
|
730
|
+
> ProductSerialInfoModel postGetItemSerialInfo()
|
|
731
731
|
|
|
732
|
-
|
|
732
|
+
Get Item Serial Info (Admin)
|
|
733
733
|
|
|
734
734
|
### Example
|
|
735
735
|
|
|
736
736
|
```typescript
|
|
737
737
|
import {
|
|
738
738
|
OrdersApi,
|
|
739
|
-
Configuration
|
|
740
|
-
CustomerOrderRequestDTO
|
|
739
|
+
Configuration
|
|
741
740
|
} from 'yellowgrid-api-ts';
|
|
742
741
|
|
|
743
742
|
const configuration = new Configuration();
|
|
744
743
|
const apiInstance = new OrdersApi(configuration);
|
|
745
744
|
|
|
746
|
-
let
|
|
747
|
-
let
|
|
745
|
+
let id: number; //Order ID (default to undefined)
|
|
746
|
+
let itemId: number; //Shipment Item ID (default to undefined)
|
|
748
747
|
|
|
749
|
-
const { status, data } = await apiInstance.
|
|
750
|
-
|
|
751
|
-
|
|
748
|
+
const { status, data } = await apiInstance.postGetItemSerialInfo(
|
|
749
|
+
id,
|
|
750
|
+
itemId
|
|
752
751
|
);
|
|
753
752
|
```
|
|
754
753
|
|
|
@@ -756,13 +755,13 @@ const { status, data } = await apiInstance.postGetOrders(
|
|
|
756
755
|
|
|
757
756
|
|Name | Type | Description | Notes|
|
|
758
757
|
|------------- | ------------- | ------------- | -------------|
|
|
759
|
-
| **
|
|
760
|
-
| **
|
|
758
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
759
|
+
| **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
|
|
761
760
|
|
|
762
761
|
|
|
763
762
|
### Return type
|
|
764
763
|
|
|
765
|
-
**
|
|
764
|
+
**ProductSerialInfoModel**
|
|
766
765
|
|
|
767
766
|
### Authorization
|
|
768
767
|
|
|
@@ -770,46 +769,43 @@ No authorization required
|
|
|
770
769
|
|
|
771
770
|
### HTTP request headers
|
|
772
771
|
|
|
773
|
-
- **Content-Type**:
|
|
772
|
+
- **Content-Type**: Not defined
|
|
774
773
|
- **Accept**: application/json
|
|
775
774
|
|
|
776
775
|
|
|
777
776
|
### HTTP response details
|
|
778
777
|
| Status code | Description | Response headers |
|
|
779
778
|
|-------------|-------------|------------------|
|
|
780
|
-
|**200** |
|
|
779
|
+
|**200** | Serial Info | - |
|
|
781
780
|
|**400** | Bad Request | - |
|
|
782
781
|
|**401** | Unauthorised | - |
|
|
783
782
|
|**403** | Access Denied | - |
|
|
784
783
|
|
|
785
784
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
786
785
|
|
|
787
|
-
# **
|
|
788
|
-
>
|
|
786
|
+
# **postGetOrders**
|
|
787
|
+
> Array<OrderSummaryDTO> postGetOrders()
|
|
789
788
|
|
|
790
|
-
|
|
789
|
+
Create An Order (Beta)
|
|
791
790
|
|
|
792
791
|
### Example
|
|
793
792
|
|
|
794
793
|
```typescript
|
|
795
794
|
import {
|
|
796
795
|
OrdersApi,
|
|
797
|
-
Configuration
|
|
796
|
+
Configuration,
|
|
797
|
+
CustomerOrderRequestDTO
|
|
798
798
|
} from 'yellowgrid-api-ts';
|
|
799
799
|
|
|
800
800
|
const configuration = new Configuration();
|
|
801
801
|
const apiInstance = new OrdersApi(configuration);
|
|
802
802
|
|
|
803
|
-
let
|
|
804
|
-
let
|
|
805
|
-
let shipmentId: number; //Shipment ID (default to undefined)
|
|
806
|
-
let itemId: number; //Shipment Item ID (default to undefined)
|
|
803
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
804
|
+
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
807
805
|
|
|
808
|
-
const { status, data } = await apiInstance.
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
shipmentId,
|
|
812
|
-
itemId
|
|
806
|
+
const { status, data } = await apiInstance.postGetOrders(
|
|
807
|
+
readonly,
|
|
808
|
+
customerOrderRequestDTO
|
|
813
809
|
);
|
|
814
810
|
```
|
|
815
811
|
|
|
@@ -817,15 +813,13 @@ const { status, data } = await apiInstance.postGetShipmentItemSerialInfo(
|
|
|
817
813
|
|
|
818
814
|
|Name | Type | Description | Notes|
|
|
819
815
|
|------------- | ------------- | ------------- | -------------|
|
|
820
|
-
| **
|
|
821
|
-
| **
|
|
822
|
-
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
823
|
-
| **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
|
|
816
|
+
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
817
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
824
818
|
|
|
825
819
|
|
|
826
820
|
### Return type
|
|
827
821
|
|
|
828
|
-
**
|
|
822
|
+
**Array<OrderSummaryDTO>**
|
|
829
823
|
|
|
830
824
|
### Authorization
|
|
831
825
|
|
|
@@ -833,14 +827,14 @@ No authorization required
|
|
|
833
827
|
|
|
834
828
|
### HTTP request headers
|
|
835
829
|
|
|
836
|
-
- **Content-Type**:
|
|
830
|
+
- **Content-Type**: application/json
|
|
837
831
|
- **Accept**: application/json
|
|
838
832
|
|
|
839
833
|
|
|
840
834
|
### HTTP response details
|
|
841
835
|
| Status code | Description | Response headers |
|
|
842
836
|
|-------------|-------------|------------------|
|
|
843
|
-
|**200** |
|
|
837
|
+
|**200** | Order Summaries | - |
|
|
844
838
|
|**400** | Bad Request | - |
|
|
845
839
|
|**401** | Unauthorised | - |
|
|
846
840
|
|**403** | Access Denied | - |
|