yellowgrid-api-ts 3.2.78-dev.0 → 3.2.80-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 -0
- package/api.ts +96 -0
- package/dist/api.d.ts +51 -0
- package/dist/api.js +103 -0
- package/docs/OrdersApi.md +64 -0
- package/docs/ShipmentDTO.md +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -165,6 +165,7 @@ Class | Method | HTTP request | Description
|
|
|
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
167
|
*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)
|
|
168
169
|
*OrdersApi* | [**postIssueCredit**](docs/OrdersApi.md#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)
|
|
169
170
|
*OrdersApi* | [**postPrintShippingLabel**](docs/OrdersApi.md#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label
|
|
170
171
|
*OrdersApi* | [**postSendOrderEmail**](docs/OrdersApi.md#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email
|
package/api.ts
CHANGED
|
@@ -6888,6 +6888,12 @@ export interface ShipmentDTO {
|
|
|
6888
6888
|
* @memberof ShipmentDTO
|
|
6889
6889
|
*/
|
|
6890
6890
|
'address'?: AddressModel;
|
|
6891
|
+
/**
|
|
6892
|
+
* Boxes Shipped
|
|
6893
|
+
* @type {number}
|
|
6894
|
+
* @memberof ShipmentDTO
|
|
6895
|
+
*/
|
|
6896
|
+
'boxes'?: number | null;
|
|
6891
6897
|
}
|
|
6892
6898
|
|
|
6893
6899
|
export const ShipmentDTOCourierEnum = {
|
|
@@ -20331,6 +20337,52 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20331
20337
|
options: localVarRequestOptions,
|
|
20332
20338
|
};
|
|
20333
20339
|
},
|
|
20340
|
+
/**
|
|
20341
|
+
* Get Shipment Item Serial Info (Admin)
|
|
20342
|
+
* @summary Get Shipment Item Serial Info (Admin)
|
|
20343
|
+
* @param {number} id Order ID
|
|
20344
|
+
* @param {number} batchId Batch ID
|
|
20345
|
+
* @param {number} shipmentId Shipment ID
|
|
20346
|
+
* @param {number} itemId Shipment Item ID
|
|
20347
|
+
* @param {*} [options] Override http request option.
|
|
20348
|
+
* @throws {RequiredError}
|
|
20349
|
+
*/
|
|
20350
|
+
postGetShipmentItemSerialInfo: async (id: number, batchId: number, shipmentId: number, itemId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20351
|
+
// verify required parameter 'id' is not null or undefined
|
|
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)));
|
|
20364
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20365
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20366
|
+
let baseOptions;
|
|
20367
|
+
if (configuration) {
|
|
20368
|
+
baseOptions = configuration.baseOptions;
|
|
20369
|
+
}
|
|
20370
|
+
|
|
20371
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
20372
|
+
const localVarHeaderParameter = {} as any;
|
|
20373
|
+
const localVarQueryParameter = {} as any;
|
|
20374
|
+
|
|
20375
|
+
|
|
20376
|
+
|
|
20377
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20378
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20379
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20380
|
+
|
|
20381
|
+
return {
|
|
20382
|
+
url: toPathString(localVarUrlObj),
|
|
20383
|
+
options: localVarRequestOptions,
|
|
20384
|
+
};
|
|
20385
|
+
},
|
|
20334
20386
|
/**
|
|
20335
20387
|
* Issue Credit (Admin)
|
|
20336
20388
|
* @summary Issue Credit (Admin)
|
|
@@ -20951,6 +21003,22 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
20951
21003
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.postGetOrders']?.[localVarOperationServerIndex]?.url;
|
|
20952
21004
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20953
21005
|
},
|
|
21006
|
+
/**
|
|
21007
|
+
* Get Shipment Item Serial Info (Admin)
|
|
21008
|
+
* @summary Get Shipment Item Serial Info (Admin)
|
|
21009
|
+
* @param {number} id Order ID
|
|
21010
|
+
* @param {number} batchId Batch ID
|
|
21011
|
+
* @param {number} shipmentId Shipment ID
|
|
21012
|
+
* @param {number} itemId Shipment Item ID
|
|
21013
|
+
* @param {*} [options] Override http request option.
|
|
21014
|
+
* @throws {RequiredError}
|
|
21015
|
+
*/
|
|
21016
|
+
async postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>> {
|
|
21017
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options);
|
|
21018
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21019
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.postGetShipmentItemSerialInfo']?.[localVarOperationServerIndex]?.url;
|
|
21020
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21021
|
+
},
|
|
20954
21022
|
/**
|
|
20955
21023
|
* Issue Credit (Admin)
|
|
20956
21024
|
* @summary Issue Credit (Admin)
|
|
@@ -21254,6 +21322,19 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
21254
21322
|
postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>> {
|
|
21255
21323
|
return localVarFp.postGetOrders(readonly, customerOrderRequestDTO, options).then((request) => request(axios, basePath));
|
|
21256
21324
|
},
|
|
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
|
+
},
|
|
21257
21338
|
/**
|
|
21258
21339
|
* Issue Credit (Admin)
|
|
21259
21340
|
* @summary Issue Credit (Admin)
|
|
@@ -21553,6 +21634,21 @@ export class OrdersApi extends BaseAPI {
|
|
|
21553
21634
|
return OrdersApiFp(this.configuration).postGetOrders(readonly, customerOrderRequestDTO, options).then((request) => request(this.axios, this.basePath));
|
|
21554
21635
|
}
|
|
21555
21636
|
|
|
21637
|
+
/**
|
|
21638
|
+
* Get Shipment Item Serial Info (Admin)
|
|
21639
|
+
* @summary Get Shipment Item Serial Info (Admin)
|
|
21640
|
+
* @param {number} id Order ID
|
|
21641
|
+
* @param {number} batchId Batch ID
|
|
21642
|
+
* @param {number} shipmentId Shipment ID
|
|
21643
|
+
* @param {number} itemId Shipment Item ID
|
|
21644
|
+
* @param {*} [options] Override http request option.
|
|
21645
|
+
* @throws {RequiredError}
|
|
21646
|
+
* @memberof OrdersApi
|
|
21647
|
+
*/
|
|
21648
|
+
public postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig) {
|
|
21649
|
+
return OrdersApiFp(this.configuration).postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then((request) => request(this.axios, this.basePath));
|
|
21650
|
+
}
|
|
21651
|
+
|
|
21556
21652
|
/**
|
|
21557
21653
|
* Issue Credit (Admin)
|
|
21558
21654
|
* @summary Issue Credit (Admin)
|
package/dist/api.d.ts
CHANGED
|
@@ -6840,6 +6840,12 @@ export interface ShipmentDTO {
|
|
|
6840
6840
|
* @memberof ShipmentDTO
|
|
6841
6841
|
*/
|
|
6842
6842
|
'address'?: AddressModel;
|
|
6843
|
+
/**
|
|
6844
|
+
* Boxes Shipped
|
|
6845
|
+
* @type {number}
|
|
6846
|
+
* @memberof ShipmentDTO
|
|
6847
|
+
*/
|
|
6848
|
+
'boxes'?: number | null;
|
|
6843
6849
|
}
|
|
6844
6850
|
export declare const ShipmentDTOCourierEnum: {
|
|
6845
6851
|
readonly Dpd: "DPD";
|
|
@@ -15608,6 +15614,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15608
15614
|
* @throws {RequiredError}
|
|
15609
15615
|
*/
|
|
15610
15616
|
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>;
|
|
15611
15628
|
/**
|
|
15612
15629
|
* Issue Credit (Admin)
|
|
15613
15630
|
* @summary Issue Credit (Admin)
|
|
@@ -15831,6 +15848,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
15831
15848
|
* @throws {RequiredError}
|
|
15832
15849
|
*/
|
|
15833
15850
|
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>>;
|
|
15834
15862
|
/**
|
|
15835
15863
|
* Issue Credit (Admin)
|
|
15836
15864
|
* @summary Issue Credit (Admin)
|
|
@@ -16054,6 +16082,17 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
16054
16082
|
* @throws {RequiredError}
|
|
16055
16083
|
*/
|
|
16056
16084
|
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>;
|
|
16057
16096
|
/**
|
|
16058
16097
|
* Issue Credit (Admin)
|
|
16059
16098
|
* @summary Issue Credit (Admin)
|
|
@@ -16292,6 +16331,18 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
16292
16331
|
* @memberof OrdersApi
|
|
16293
16332
|
*/
|
|
16294
16333
|
postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
|
|
16334
|
+
/**
|
|
16335
|
+
* Get Shipment Item Serial Info (Admin)
|
|
16336
|
+
* @summary Get Shipment Item Serial Info (Admin)
|
|
16337
|
+
* @param {number} id Order ID
|
|
16338
|
+
* @param {number} batchId Batch ID
|
|
16339
|
+
* @param {number} shipmentId Shipment ID
|
|
16340
|
+
* @param {number} itemId Shipment Item ID
|
|
16341
|
+
* @param {*} [options] Override http request option.
|
|
16342
|
+
* @throws {RequiredError}
|
|
16343
|
+
* @memberof OrdersApi
|
|
16344
|
+
*/
|
|
16345
|
+
postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSerialInfoModel, any, {}>>;
|
|
16295
16346
|
/**
|
|
16296
16347
|
* Issue Credit (Admin)
|
|
16297
16348
|
* @summary Issue Credit (Admin)
|
package/dist/api.js
CHANGED
|
@@ -10389,6 +10389,55 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
10389
10389
|
});
|
|
10390
10390
|
});
|
|
10391
10391
|
},
|
|
10392
|
+
/**
|
|
10393
|
+
* Get Shipment Item Serial Info (Admin)
|
|
10394
|
+
* @summary Get Shipment Item Serial Info (Admin)
|
|
10395
|
+
* @param {number} id Order ID
|
|
10396
|
+
* @param {number} batchId Batch ID
|
|
10397
|
+
* @param {number} shipmentId Shipment ID
|
|
10398
|
+
* @param {number} itemId Shipment Item ID
|
|
10399
|
+
* @param {*} [options] Override http request option.
|
|
10400
|
+
* @throws {RequiredError}
|
|
10401
|
+
*/
|
|
10402
|
+
postGetShipmentItemSerialInfo: function (id_1, batchId_1, shipmentId_1, itemId_1) {
|
|
10403
|
+
var args_1 = [];
|
|
10404
|
+
for (var _i = 4; _i < arguments.length; _i++) {
|
|
10405
|
+
args_1[_i - 4] = arguments[_i];
|
|
10406
|
+
}
|
|
10407
|
+
return __awaiter(_this, __spreadArray([id_1, batchId_1, shipmentId_1, itemId_1], args_1, true), void 0, function (id, batchId, shipmentId, itemId, options) {
|
|
10408
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
10409
|
+
if (options === void 0) { options = {}; }
|
|
10410
|
+
return __generator(this, function (_a) {
|
|
10411
|
+
// verify required parameter 'id' is not null or undefined
|
|
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)));
|
|
10424
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10425
|
+
if (configuration) {
|
|
10426
|
+
baseOptions = configuration.baseOptions;
|
|
10427
|
+
}
|
|
10428
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
10429
|
+
localVarHeaderParameter = {};
|
|
10430
|
+
localVarQueryParameter = {};
|
|
10431
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10432
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10433
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10434
|
+
return [2 /*return*/, {
|
|
10435
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10436
|
+
options: localVarRequestOptions,
|
|
10437
|
+
}];
|
|
10438
|
+
});
|
|
10439
|
+
});
|
|
10440
|
+
},
|
|
10392
10441
|
/**
|
|
10393
10442
|
* Issue Credit (Admin)
|
|
10394
10443
|
* @summary Issue Credit (Admin)
|
|
@@ -11157,6 +11206,32 @@ var OrdersApiFp = function (configuration) {
|
|
|
11157
11206
|
});
|
|
11158
11207
|
});
|
|
11159
11208
|
},
|
|
11209
|
+
/**
|
|
11210
|
+
* Get Shipment Item Serial Info (Admin)
|
|
11211
|
+
* @summary Get Shipment Item Serial Info (Admin)
|
|
11212
|
+
* @param {number} id Order ID
|
|
11213
|
+
* @param {number} batchId Batch ID
|
|
11214
|
+
* @param {number} shipmentId Shipment ID
|
|
11215
|
+
* @param {number} itemId Shipment Item ID
|
|
11216
|
+
* @param {*} [options] Override http request option.
|
|
11217
|
+
* @throws {RequiredError}
|
|
11218
|
+
*/
|
|
11219
|
+
postGetShipmentItemSerialInfo: function (id, batchId, shipmentId, itemId, options) {
|
|
11220
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11221
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11222
|
+
var _a, _b, _c;
|
|
11223
|
+
return __generator(this, function (_d) {
|
|
11224
|
+
switch (_d.label) {
|
|
11225
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options)];
|
|
11226
|
+
case 1:
|
|
11227
|
+
localVarAxiosArgs = _d.sent();
|
|
11228
|
+
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.postGetShipmentItemSerialInfo']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11230
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11231
|
+
}
|
|
11232
|
+
});
|
|
11233
|
+
});
|
|
11234
|
+
},
|
|
11160
11235
|
/**
|
|
11161
11236
|
* Issue Credit (Admin)
|
|
11162
11237
|
* @summary Issue Credit (Admin)
|
|
@@ -11560,6 +11635,19 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
11560
11635
|
postGetOrders: function (readonly, customerOrderRequestDTO, options) {
|
|
11561
11636
|
return localVarFp.postGetOrders(readonly, customerOrderRequestDTO, options).then(function (request) { return request(axios, basePath); });
|
|
11562
11637
|
},
|
|
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
|
+
},
|
|
11563
11651
|
/**
|
|
11564
11652
|
* Issue Credit (Admin)
|
|
11565
11653
|
* @summary Issue Credit (Admin)
|
|
@@ -11863,6 +11951,21 @@ var OrdersApi = /** @class */ (function (_super) {
|
|
|
11863
11951
|
var _this = this;
|
|
11864
11952
|
return (0, exports.OrdersApiFp)(this.configuration).postGetOrders(readonly, customerOrderRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11865
11953
|
};
|
|
11954
|
+
/**
|
|
11955
|
+
* Get Shipment Item Serial Info (Admin)
|
|
11956
|
+
* @summary Get Shipment Item Serial Info (Admin)
|
|
11957
|
+
* @param {number} id Order ID
|
|
11958
|
+
* @param {number} batchId Batch ID
|
|
11959
|
+
* @param {number} shipmentId Shipment ID
|
|
11960
|
+
* @param {number} itemId Shipment Item ID
|
|
11961
|
+
* @param {*} [options] Override http request option.
|
|
11962
|
+
* @throws {RequiredError}
|
|
11963
|
+
* @memberof OrdersApi
|
|
11964
|
+
*/
|
|
11965
|
+
OrdersApi.prototype.postGetShipmentItemSerialInfo = function (id, batchId, shipmentId, itemId, options) {
|
|
11966
|
+
var _this = this;
|
|
11967
|
+
return (0, exports.OrdersApiFp)(this.configuration).postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11968
|
+
};
|
|
11866
11969
|
/**
|
|
11867
11970
|
* Issue Credit (Admin)
|
|
11868
11971
|
* @summary Issue Credit (Admin)
|
package/docs/OrdersApi.md
CHANGED
|
@@ -17,6 +17,7 @@ All URIs are relative to *https://api.yellowgrid.local*
|
|
|
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
19
|
|[**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)|
|
|
20
21
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
21
22
|
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
22
23
|
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
@@ -783,6 +784,69 @@ No authorization required
|
|
|
783
784
|
|
|
784
785
|
[[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)
|
|
785
786
|
|
|
787
|
+
# **postGetShipmentItemSerialInfo**
|
|
788
|
+
> ProductSerialInfoModel postGetShipmentItemSerialInfo()
|
|
789
|
+
|
|
790
|
+
Get Shipment Item Serial Info (Admin)
|
|
791
|
+
|
|
792
|
+
### Example
|
|
793
|
+
|
|
794
|
+
```typescript
|
|
795
|
+
import {
|
|
796
|
+
OrdersApi,
|
|
797
|
+
Configuration
|
|
798
|
+
} from 'yellowgrid-api-ts';
|
|
799
|
+
|
|
800
|
+
const configuration = new Configuration();
|
|
801
|
+
const apiInstance = new OrdersApi(configuration);
|
|
802
|
+
|
|
803
|
+
let id: number; //Order ID (default to undefined)
|
|
804
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
805
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
806
|
+
let itemId: number; //Shipment Item ID (default to undefined)
|
|
807
|
+
|
|
808
|
+
const { status, data } = await apiInstance.postGetShipmentItemSerialInfo(
|
|
809
|
+
id,
|
|
810
|
+
batchId,
|
|
811
|
+
shipmentId,
|
|
812
|
+
itemId
|
|
813
|
+
);
|
|
814
|
+
```
|
|
815
|
+
|
|
816
|
+
### Parameters
|
|
817
|
+
|
|
818
|
+
|Name | Type | Description | Notes|
|
|
819
|
+
|------------- | ------------- | ------------- | -------------|
|
|
820
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
821
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
822
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
823
|
+
| **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
### Return type
|
|
827
|
+
|
|
828
|
+
**ProductSerialInfoModel**
|
|
829
|
+
|
|
830
|
+
### Authorization
|
|
831
|
+
|
|
832
|
+
No authorization required
|
|
833
|
+
|
|
834
|
+
### HTTP request headers
|
|
835
|
+
|
|
836
|
+
- **Content-Type**: Not defined
|
|
837
|
+
- **Accept**: application/json
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
### HTTP response details
|
|
841
|
+
| Status code | Description | Response headers |
|
|
842
|
+
|-------------|-------------|------------------|
|
|
843
|
+
|**200** | Serial Info | - |
|
|
844
|
+
|**400** | Bad Request | - |
|
|
845
|
+
|**401** | Unauthorised | - |
|
|
846
|
+
|**403** | Access Denied | - |
|
|
847
|
+
|
|
848
|
+
[[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)
|
|
849
|
+
|
|
786
850
|
# **postIssueCredit**
|
|
787
851
|
> CreditNoteModel postIssueCredit()
|
|
788
852
|
|
package/docs/ShipmentDTO.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**scannedItems** | [**Array<ScannedItemModel>**](ScannedItemModel.md) | Scanned Items | [optional] [default to undefined]
|
|
17
17
|
**items** | [**Array<ShipmentItemModel>**](ShipmentItemModel.md) | Items | [optional] [default to undefined]
|
|
18
18
|
**address** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
19
|
+
**boxes** | **number** | Boxes Shipped | [optional] [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -33,6 +34,7 @@ const instance: ShipmentDTO = {
|
|
|
33
34
|
scannedItems,
|
|
34
35
|
items,
|
|
35
36
|
address,
|
|
37
|
+
boxes,
|
|
36
38
|
};
|
|
37
39
|
```
|
|
38
40
|
|