yellowgrid-api-ts 3.2.95-dev.0 → 3.2.96-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 +2 -0
- package/api.ts +148 -0
- package/dist/api.d.ts +70 -0
- package/dist/api.js +173 -0
- package/docs/OrdersApi.md +55 -0
- package/docs/ProductsApi.md +58 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -163,6 +163,7 @@ Class | Method | HTTP request | Description
|
|
|
163
163
|
*OrdersApi* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF
|
|
164
164
|
*OrdersApi* | [**getGetOrderSummary**](docs/OrdersApi.md#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)
|
|
165
165
|
*OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders (Beta)
|
|
166
|
+
*OrdersApi* | [**patchCompleteOrder**](docs/OrdersApi.md#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)
|
|
166
167
|
*OrdersApi* | [**postAddOrderNote**](docs/OrdersApi.md#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note
|
|
167
168
|
*OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
|
|
168
169
|
*OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
|
|
@@ -188,6 +189,7 @@ Class | Method | HTTP request | Description
|
|
|
188
189
|
*ProductsApi* | [**getGetStockList**](docs/ProductsApi.md#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing
|
|
189
190
|
*ProductsApi* | [**getGetTcxTemplates**](docs/ProductsApi.md#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates
|
|
190
191
|
*ProductsApi* | [**getSearchProducts**](docs/ProductsApi.md#getsearchproducts) | **GET** /products/search | Search Products
|
|
192
|
+
*ProductsApi* | [**patchAddQuantityToStock**](docs/ProductsApi.md#patchaddquantitytostock) | **PATCH** /products/{sku}/stock/add | Add Item Quantity To Stock
|
|
191
193
|
*ProductsApi* | [**postGetProduct**](docs/ProductsApi.md#postgetproduct) | **POST** /products/{sku} | Get Product
|
|
192
194
|
*ProductsApi* | [**postGetProductForCustomer**](docs/ProductsApi.md#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer
|
|
193
195
|
*ProvisioningApi* | [**deleteAddFanvilMac**](docs/ProvisioningApi.md#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group
|
package/api.ts
CHANGED
|
@@ -20458,6 +20458,40 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20458
20458
|
|
|
20459
20459
|
|
|
20460
20460
|
|
|
20461
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20462
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20463
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20464
|
+
|
|
20465
|
+
return {
|
|
20466
|
+
url: toPathString(localVarUrlObj),
|
|
20467
|
+
options: localVarRequestOptions,
|
|
20468
|
+
};
|
|
20469
|
+
},
|
|
20470
|
+
/**
|
|
20471
|
+
* Mark Order As Complete (Admin)
|
|
20472
|
+
* @summary Mark Order As Complete (Admin)
|
|
20473
|
+
* @param {number} id Order ID
|
|
20474
|
+
* @param {*} [options] Override http request option.
|
|
20475
|
+
* @throws {RequiredError}
|
|
20476
|
+
*/
|
|
20477
|
+
patchCompleteOrder: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20478
|
+
// verify required parameter 'id' is not null or undefined
|
|
20479
|
+
assertParamExists('patchCompleteOrder', 'id', id)
|
|
20480
|
+
const localVarPath = `/admin/orders/{id}/complete`
|
|
20481
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
20482
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20483
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20484
|
+
let baseOptions;
|
|
20485
|
+
if (configuration) {
|
|
20486
|
+
baseOptions = configuration.baseOptions;
|
|
20487
|
+
}
|
|
20488
|
+
|
|
20489
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
20490
|
+
const localVarHeaderParameter = {} as any;
|
|
20491
|
+
const localVarQueryParameter = {} as any;
|
|
20492
|
+
|
|
20493
|
+
|
|
20494
|
+
|
|
20461
20495
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20462
20496
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20463
20497
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -21283,6 +21317,19 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
21283
21317
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetOrders']?.[localVarOperationServerIndex]?.url;
|
|
21284
21318
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21285
21319
|
},
|
|
21320
|
+
/**
|
|
21321
|
+
* Mark Order As Complete (Admin)
|
|
21322
|
+
* @summary Mark Order As Complete (Admin)
|
|
21323
|
+
* @param {number} id Order ID
|
|
21324
|
+
* @param {*} [options] Override http request option.
|
|
21325
|
+
* @throws {RequiredError}
|
|
21326
|
+
*/
|
|
21327
|
+
async patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>> {
|
|
21328
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchCompleteOrder(id, options);
|
|
21329
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21330
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.patchCompleteOrder']?.[localVarOperationServerIndex]?.url;
|
|
21331
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21332
|
+
},
|
|
21286
21333
|
/**
|
|
21287
21334
|
* Add Order Note
|
|
21288
21335
|
* @summary Add Order Note
|
|
@@ -21636,6 +21683,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
21636
21683
|
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel> {
|
|
21637
21684
|
return localVarFp.getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then((request) => request(axios, basePath));
|
|
21638
21685
|
},
|
|
21686
|
+
/**
|
|
21687
|
+
* Mark Order As Complete (Admin)
|
|
21688
|
+
* @summary Mark Order As Complete (Admin)
|
|
21689
|
+
* @param {number} id Order ID
|
|
21690
|
+
* @param {*} [options] Override http request option.
|
|
21691
|
+
* @throws {RequiredError}
|
|
21692
|
+
*/
|
|
21693
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO> {
|
|
21694
|
+
return localVarFp.patchCompleteOrder(id, options).then((request) => request(axios, basePath));
|
|
21695
|
+
},
|
|
21639
21696
|
/**
|
|
21640
21697
|
* Add Order Note
|
|
21641
21698
|
* @summary Add Order Note
|
|
@@ -21961,6 +22018,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
21961
22018
|
return OrdersApiFp(this.configuration).getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then((request) => request(this.axios, this.basePath));
|
|
21962
22019
|
}
|
|
21963
22020
|
|
|
22021
|
+
/**
|
|
22022
|
+
* Mark Order As Complete (Admin)
|
|
22023
|
+
* @summary Mark Order As Complete (Admin)
|
|
22024
|
+
* @param {number} id Order ID
|
|
22025
|
+
* @param {*} [options] Override http request option.
|
|
22026
|
+
* @throws {RequiredError}
|
|
22027
|
+
* @memberof OrdersApi
|
|
22028
|
+
*/
|
|
22029
|
+
public patchCompleteOrder(id: number, options?: RawAxiosRequestConfig) {
|
|
22030
|
+
return OrdersApiFp(this.configuration).patchCompleteOrder(id, options).then((request) => request(this.axios, this.basePath));
|
|
22031
|
+
}
|
|
22032
|
+
|
|
21964
22033
|
/**
|
|
21965
22034
|
* Add Order Note
|
|
21966
22035
|
* @summary Add Order Note
|
|
@@ -22792,6 +22861,47 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
22792
22861
|
|
|
22793
22862
|
|
|
22794
22863
|
|
|
22864
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22865
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22866
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
22867
|
+
|
|
22868
|
+
return {
|
|
22869
|
+
url: toPathString(localVarUrlObj),
|
|
22870
|
+
options: localVarRequestOptions,
|
|
22871
|
+
};
|
|
22872
|
+
},
|
|
22873
|
+
/**
|
|
22874
|
+
* Add Item Quantity To Stock
|
|
22875
|
+
* @summary Add Item Quantity To Stock
|
|
22876
|
+
* @param {string} sku Product SKU
|
|
22877
|
+
* @param {number} quantity Quantity
|
|
22878
|
+
* @param {*} [options] Override http request option.
|
|
22879
|
+
* @throws {RequiredError}
|
|
22880
|
+
*/
|
|
22881
|
+
patchAddQuantityToStock: async (sku: string, quantity: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
22882
|
+
// verify required parameter 'sku' is not null or undefined
|
|
22883
|
+
assertParamExists('patchAddQuantityToStock', 'sku', sku)
|
|
22884
|
+
// verify required parameter 'quantity' is not null or undefined
|
|
22885
|
+
assertParamExists('patchAddQuantityToStock', 'quantity', quantity)
|
|
22886
|
+
const localVarPath = `/products/{sku}/stock/add`
|
|
22887
|
+
.replace(`{${"sku"}}`, encodeURIComponent(String(sku)));
|
|
22888
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22889
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22890
|
+
let baseOptions;
|
|
22891
|
+
if (configuration) {
|
|
22892
|
+
baseOptions = configuration.baseOptions;
|
|
22893
|
+
}
|
|
22894
|
+
|
|
22895
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
22896
|
+
const localVarHeaderParameter = {} as any;
|
|
22897
|
+
const localVarQueryParameter = {} as any;
|
|
22898
|
+
|
|
22899
|
+
if (quantity !== undefined) {
|
|
22900
|
+
localVarQueryParameter['quantity'] = quantity;
|
|
22901
|
+
}
|
|
22902
|
+
|
|
22903
|
+
|
|
22904
|
+
|
|
22795
22905
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22796
22906
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22797
22907
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -22987,6 +23097,20 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
22987
23097
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.getSearchProducts']?.[localVarOperationServerIndex]?.url;
|
|
22988
23098
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22989
23099
|
},
|
|
23100
|
+
/**
|
|
23101
|
+
* Add Item Quantity To Stock
|
|
23102
|
+
* @summary Add Item Quantity To Stock
|
|
23103
|
+
* @param {string} sku Product SKU
|
|
23104
|
+
* @param {number} quantity Quantity
|
|
23105
|
+
* @param {*} [options] Override http request option.
|
|
23106
|
+
* @throws {RequiredError}
|
|
23107
|
+
*/
|
|
23108
|
+
async patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
23109
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchAddQuantityToStock(sku, quantity, options);
|
|
23110
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
23111
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.patchAddQuantityToStock']?.[localVarOperationServerIndex]?.url;
|
|
23112
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23113
|
+
},
|
|
22990
23114
|
/**
|
|
22991
23115
|
* Get Product
|
|
22992
23116
|
* @summary Get Product
|
|
@@ -23094,6 +23218,17 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
23094
23218
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProductSearchResultsModel> {
|
|
23095
23219
|
return localVarFp.getSearchProducts(pageSize, page, search, options).then((request) => request(axios, basePath));
|
|
23096
23220
|
},
|
|
23221
|
+
/**
|
|
23222
|
+
* Add Item Quantity To Stock
|
|
23223
|
+
* @summary Add Item Quantity To Stock
|
|
23224
|
+
* @param {string} sku Product SKU
|
|
23225
|
+
* @param {number} quantity Quantity
|
|
23226
|
+
* @param {*} [options] Override http request option.
|
|
23227
|
+
* @throws {RequiredError}
|
|
23228
|
+
*/
|
|
23229
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
23230
|
+
return localVarFp.patchAddQuantityToStock(sku, quantity, options).then((request) => request(axios, basePath));
|
|
23231
|
+
},
|
|
23097
23232
|
/**
|
|
23098
23233
|
* Get Product
|
|
23099
23234
|
* @summary Get Product
|
|
@@ -23209,6 +23344,19 @@ export class ProductsApi extends BaseAPI {
|
|
|
23209
23344
|
return ProductsApiFp(this.configuration).getSearchProducts(pageSize, page, search, options).then((request) => request(this.axios, this.basePath));
|
|
23210
23345
|
}
|
|
23211
23346
|
|
|
23347
|
+
/**
|
|
23348
|
+
* Add Item Quantity To Stock
|
|
23349
|
+
* @summary Add Item Quantity To Stock
|
|
23350
|
+
* @param {string} sku Product SKU
|
|
23351
|
+
* @param {number} quantity Quantity
|
|
23352
|
+
* @param {*} [options] Override http request option.
|
|
23353
|
+
* @throws {RequiredError}
|
|
23354
|
+
* @memberof ProductsApi
|
|
23355
|
+
*/
|
|
23356
|
+
public patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig) {
|
|
23357
|
+
return ProductsApiFp(this.configuration).patchAddQuantityToStock(sku, quantity, options).then((request) => request(this.axios, this.basePath));
|
|
23358
|
+
}
|
|
23359
|
+
|
|
23212
23360
|
/**
|
|
23213
23361
|
* Get Product
|
|
23214
23362
|
* @summary Get Product
|
package/dist/api.d.ts
CHANGED
|
@@ -15801,6 +15801,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15801
15801
|
* @throws {RequiredError}
|
|
15802
15802
|
*/
|
|
15803
15803
|
getGetOrders: (pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15804
|
+
/**
|
|
15805
|
+
* Mark Order As Complete (Admin)
|
|
15806
|
+
* @summary Mark Order As Complete (Admin)
|
|
15807
|
+
* @param {number} id Order ID
|
|
15808
|
+
* @param {*} [options] Override http request option.
|
|
15809
|
+
* @throws {RequiredError}
|
|
15810
|
+
*/
|
|
15811
|
+
patchCompleteOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15804
15812
|
/**
|
|
15805
15813
|
* Add Order Note
|
|
15806
15814
|
* @summary Add Order Note
|
|
@@ -16050,6 +16058,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
16050
16058
|
* @throws {RequiredError}
|
|
16051
16059
|
*/
|
|
16052
16060
|
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummariesModel>>;
|
|
16061
|
+
/**
|
|
16062
|
+
* Mark Order As Complete (Admin)
|
|
16063
|
+
* @summary Mark Order As Complete (Admin)
|
|
16064
|
+
* @param {number} id Order ID
|
|
16065
|
+
* @param {*} [options] Override http request option.
|
|
16066
|
+
* @throws {RequiredError}
|
|
16067
|
+
*/
|
|
16068
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
|
|
16053
16069
|
/**
|
|
16054
16070
|
* Add Order Note
|
|
16055
16071
|
* @summary Add Order Note
|
|
@@ -16299,6 +16315,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
16299
16315
|
* @throws {RequiredError}
|
|
16300
16316
|
*/
|
|
16301
16317
|
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel>;
|
|
16318
|
+
/**
|
|
16319
|
+
* Mark Order As Complete (Admin)
|
|
16320
|
+
* @summary Mark Order As Complete (Admin)
|
|
16321
|
+
* @param {number} id Order ID
|
|
16322
|
+
* @param {*} [options] Override http request option.
|
|
16323
|
+
* @throws {RequiredError}
|
|
16324
|
+
*/
|
|
16325
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
|
|
16302
16326
|
/**
|
|
16303
16327
|
* Add Order Note
|
|
16304
16328
|
* @summary Add Order Note
|
|
@@ -16560,6 +16584,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
16560
16584
|
* @memberof OrdersApi
|
|
16561
16585
|
*/
|
|
16562
16586
|
getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummariesModel, any, {}>>;
|
|
16587
|
+
/**
|
|
16588
|
+
* Mark Order As Complete (Admin)
|
|
16589
|
+
* @summary Mark Order As Complete (Admin)
|
|
16590
|
+
* @param {number} id Order ID
|
|
16591
|
+
* @param {*} [options] Override http request option.
|
|
16592
|
+
* @throws {RequiredError}
|
|
16593
|
+
* @memberof OrdersApi
|
|
16594
|
+
*/
|
|
16595
|
+
patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
|
|
16563
16596
|
/**
|
|
16564
16597
|
* Add Order Note
|
|
16565
16598
|
* @summary Add Order Note
|
|
@@ -17043,6 +17076,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
17043
17076
|
* @throws {RequiredError}
|
|
17044
17077
|
*/
|
|
17045
17078
|
getSearchProducts: (pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17079
|
+
/**
|
|
17080
|
+
* Add Item Quantity To Stock
|
|
17081
|
+
* @summary Add Item Quantity To Stock
|
|
17082
|
+
* @param {string} sku Product SKU
|
|
17083
|
+
* @param {number} quantity Quantity
|
|
17084
|
+
* @param {*} [options] Override http request option.
|
|
17085
|
+
* @throws {RequiredError}
|
|
17086
|
+
*/
|
|
17087
|
+
patchAddQuantityToStock: (sku: string, quantity: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17046
17088
|
/**
|
|
17047
17089
|
* Get Product
|
|
17048
17090
|
* @summary Get Product
|
|
@@ -17122,6 +17164,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
17122
17164
|
* @throws {RequiredError}
|
|
17123
17165
|
*/
|
|
17124
17166
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSearchResultsModel>>;
|
|
17167
|
+
/**
|
|
17168
|
+
* Add Item Quantity To Stock
|
|
17169
|
+
* @summary Add Item Quantity To Stock
|
|
17170
|
+
* @param {string} sku Product SKU
|
|
17171
|
+
* @param {number} quantity Quantity
|
|
17172
|
+
* @param {*} [options] Override http request option.
|
|
17173
|
+
* @throws {RequiredError}
|
|
17174
|
+
*/
|
|
17175
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
17125
17176
|
/**
|
|
17126
17177
|
* Get Product
|
|
17127
17178
|
* @summary Get Product
|
|
@@ -17201,6 +17252,15 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
17201
17252
|
* @throws {RequiredError}
|
|
17202
17253
|
*/
|
|
17203
17254
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProductSearchResultsModel>;
|
|
17255
|
+
/**
|
|
17256
|
+
* Add Item Quantity To Stock
|
|
17257
|
+
* @summary Add Item Quantity To Stock
|
|
17258
|
+
* @param {string} sku Product SKU
|
|
17259
|
+
* @param {number} quantity Quantity
|
|
17260
|
+
* @param {*} [options] Override http request option.
|
|
17261
|
+
* @throws {RequiredError}
|
|
17262
|
+
*/
|
|
17263
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
17204
17264
|
/**
|
|
17205
17265
|
* Get Product
|
|
17206
17266
|
* @summary Get Product
|
|
@@ -17289,6 +17349,16 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
17289
17349
|
* @memberof ProductsApi
|
|
17290
17350
|
*/
|
|
17291
17351
|
getSearchProducts(pageSize?: number, page?: number, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSearchResultsModel, any, {}>>;
|
|
17352
|
+
/**
|
|
17353
|
+
* Add Item Quantity To Stock
|
|
17354
|
+
* @summary Add Item Quantity To Stock
|
|
17355
|
+
* @param {string} sku Product SKU
|
|
17356
|
+
* @param {number} quantity Quantity
|
|
17357
|
+
* @param {*} [options] Override http request option.
|
|
17358
|
+
* @throws {RequiredError}
|
|
17359
|
+
* @memberof ProductsApi
|
|
17360
|
+
*/
|
|
17361
|
+
patchAddQuantityToStock(sku: string, quantity: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
17292
17362
|
/**
|
|
17293
17363
|
* Get Product
|
|
17294
17364
|
* @summary Get Product
|
package/dist/api.js
CHANGED
|
@@ -10356,6 +10356,43 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
10356
10356
|
});
|
|
10357
10357
|
});
|
|
10358
10358
|
},
|
|
10359
|
+
/**
|
|
10360
|
+
* Mark Order As Complete (Admin)
|
|
10361
|
+
* @summary Mark Order As Complete (Admin)
|
|
10362
|
+
* @param {number} id Order ID
|
|
10363
|
+
* @param {*} [options] Override http request option.
|
|
10364
|
+
* @throws {RequiredError}
|
|
10365
|
+
*/
|
|
10366
|
+
patchCompleteOrder: function (id_1) {
|
|
10367
|
+
var args_1 = [];
|
|
10368
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
10369
|
+
args_1[_i - 1] = arguments[_i];
|
|
10370
|
+
}
|
|
10371
|
+
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
10372
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
10373
|
+
if (options === void 0) { options = {}; }
|
|
10374
|
+
return __generator(this, function (_a) {
|
|
10375
|
+
// verify required parameter 'id' is not null or undefined
|
|
10376
|
+
(0, common_1.assertParamExists)('patchCompleteOrder', 'id', id);
|
|
10377
|
+
localVarPath = "/admin/orders/{id}/complete"
|
|
10378
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
10379
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10380
|
+
if (configuration) {
|
|
10381
|
+
baseOptions = configuration.baseOptions;
|
|
10382
|
+
}
|
|
10383
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
10384
|
+
localVarHeaderParameter = {};
|
|
10385
|
+
localVarQueryParameter = {};
|
|
10386
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10387
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10388
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10389
|
+
return [2 /*return*/, {
|
|
10390
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10391
|
+
options: localVarRequestOptions,
|
|
10392
|
+
}];
|
|
10393
|
+
});
|
|
10394
|
+
});
|
|
10395
|
+
},
|
|
10359
10396
|
/**
|
|
10360
10397
|
* Add Order Note
|
|
10361
10398
|
* @summary Add Order Note
|
|
@@ -11300,6 +11337,29 @@ var OrdersApiFp = function (configuration) {
|
|
|
11300
11337
|
});
|
|
11301
11338
|
});
|
|
11302
11339
|
},
|
|
11340
|
+
/**
|
|
11341
|
+
* Mark Order As Complete (Admin)
|
|
11342
|
+
* @summary Mark Order As Complete (Admin)
|
|
11343
|
+
* @param {number} id Order ID
|
|
11344
|
+
* @param {*} [options] Override http request option.
|
|
11345
|
+
* @throws {RequiredError}
|
|
11346
|
+
*/
|
|
11347
|
+
patchCompleteOrder: function (id, options) {
|
|
11348
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11349
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11350
|
+
var _a, _b, _c;
|
|
11351
|
+
return __generator(this, function (_d) {
|
|
11352
|
+
switch (_d.label) {
|
|
11353
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchCompleteOrder(id, options)];
|
|
11354
|
+
case 1:
|
|
11355
|
+
localVarAxiosArgs = _d.sent();
|
|
11356
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11357
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.patchCompleteOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11358
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11359
|
+
}
|
|
11360
|
+
});
|
|
11361
|
+
});
|
|
11362
|
+
},
|
|
11303
11363
|
/**
|
|
11304
11364
|
* Add Order Note
|
|
11305
11365
|
* @summary Add Order Note
|
|
@@ -11813,6 +11873,16 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
11813
11873
|
getGetOrders: function (pageSize, page, search, fulfillable, status, filter, customerId, options) {
|
|
11814
11874
|
return localVarFp.getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then(function (request) { return request(axios, basePath); });
|
|
11815
11875
|
},
|
|
11876
|
+
/**
|
|
11877
|
+
* Mark Order As Complete (Admin)
|
|
11878
|
+
* @summary Mark Order As Complete (Admin)
|
|
11879
|
+
* @param {number} id Order ID
|
|
11880
|
+
* @param {*} [options] Override http request option.
|
|
11881
|
+
* @throws {RequiredError}
|
|
11882
|
+
*/
|
|
11883
|
+
patchCompleteOrder: function (id, options) {
|
|
11884
|
+
return localVarFp.patchCompleteOrder(id, options).then(function (request) { return request(axios, basePath); });
|
|
11885
|
+
},
|
|
11816
11886
|
/**
|
|
11817
11887
|
* Add Order Note
|
|
11818
11888
|
* @summary Add Order Note
|
|
@@ -12142,6 +12212,18 @@ var OrdersApi = /** @class */ (function (_super) {
|
|
|
12142
12212
|
var _this = this;
|
|
12143
12213
|
return (0, exports.OrdersApiFp)(this.configuration).getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12144
12214
|
};
|
|
12215
|
+
/**
|
|
12216
|
+
* Mark Order As Complete (Admin)
|
|
12217
|
+
* @summary Mark Order As Complete (Admin)
|
|
12218
|
+
* @param {number} id Order ID
|
|
12219
|
+
* @param {*} [options] Override http request option.
|
|
12220
|
+
* @throws {RequiredError}
|
|
12221
|
+
* @memberof OrdersApi
|
|
12222
|
+
*/
|
|
12223
|
+
OrdersApi.prototype.patchCompleteOrder = function (id, options) {
|
|
12224
|
+
var _this = this;
|
|
12225
|
+
return (0, exports.OrdersApiFp)(this.configuration).patchCompleteOrder(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
12226
|
+
};
|
|
12145
12227
|
/**
|
|
12146
12228
|
* Add Order Note
|
|
12147
12229
|
* @summary Add Order Note
|
|
@@ -13013,6 +13095,49 @@ var ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
13013
13095
|
});
|
|
13014
13096
|
});
|
|
13015
13097
|
},
|
|
13098
|
+
/**
|
|
13099
|
+
* Add Item Quantity To Stock
|
|
13100
|
+
* @summary Add Item Quantity To Stock
|
|
13101
|
+
* @param {string} sku Product SKU
|
|
13102
|
+
* @param {number} quantity Quantity
|
|
13103
|
+
* @param {*} [options] Override http request option.
|
|
13104
|
+
* @throws {RequiredError}
|
|
13105
|
+
*/
|
|
13106
|
+
patchAddQuantityToStock: function (sku_1, quantity_1) {
|
|
13107
|
+
var args_1 = [];
|
|
13108
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
13109
|
+
args_1[_i - 2] = arguments[_i];
|
|
13110
|
+
}
|
|
13111
|
+
return __awaiter(_this, __spreadArray([sku_1, quantity_1], args_1, true), void 0, function (sku, quantity, options) {
|
|
13112
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
13113
|
+
if (options === void 0) { options = {}; }
|
|
13114
|
+
return __generator(this, function (_a) {
|
|
13115
|
+
// verify required parameter 'sku' is not null or undefined
|
|
13116
|
+
(0, common_1.assertParamExists)('patchAddQuantityToStock', 'sku', sku);
|
|
13117
|
+
// verify required parameter 'quantity' is not null or undefined
|
|
13118
|
+
(0, common_1.assertParamExists)('patchAddQuantityToStock', 'quantity', quantity);
|
|
13119
|
+
localVarPath = "/products/{sku}/stock/add"
|
|
13120
|
+
.replace("{".concat("sku", "}"), encodeURIComponent(String(sku)));
|
|
13121
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
13122
|
+
if (configuration) {
|
|
13123
|
+
baseOptions = configuration.baseOptions;
|
|
13124
|
+
}
|
|
13125
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
13126
|
+
localVarHeaderParameter = {};
|
|
13127
|
+
localVarQueryParameter = {};
|
|
13128
|
+
if (quantity !== undefined) {
|
|
13129
|
+
localVarQueryParameter['quantity'] = quantity;
|
|
13130
|
+
}
|
|
13131
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
13132
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13133
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
13134
|
+
return [2 /*return*/, {
|
|
13135
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
13136
|
+
options: localVarRequestOptions,
|
|
13137
|
+
}];
|
|
13138
|
+
});
|
|
13139
|
+
});
|
|
13140
|
+
},
|
|
13016
13141
|
/**
|
|
13017
13142
|
* Get Product
|
|
13018
13143
|
* @summary Get Product
|
|
@@ -13272,6 +13397,30 @@ var ProductsApiFp = function (configuration) {
|
|
|
13272
13397
|
});
|
|
13273
13398
|
});
|
|
13274
13399
|
},
|
|
13400
|
+
/**
|
|
13401
|
+
* Add Item Quantity To Stock
|
|
13402
|
+
* @summary Add Item Quantity To Stock
|
|
13403
|
+
* @param {string} sku Product SKU
|
|
13404
|
+
* @param {number} quantity Quantity
|
|
13405
|
+
* @param {*} [options] Override http request option.
|
|
13406
|
+
* @throws {RequiredError}
|
|
13407
|
+
*/
|
|
13408
|
+
patchAddQuantityToStock: function (sku, quantity, options) {
|
|
13409
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
13410
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
13411
|
+
var _a, _b, _c;
|
|
13412
|
+
return __generator(this, function (_d) {
|
|
13413
|
+
switch (_d.label) {
|
|
13414
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchAddQuantityToStock(sku, quantity, options)];
|
|
13415
|
+
case 1:
|
|
13416
|
+
localVarAxiosArgs = _d.sent();
|
|
13417
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
13418
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.patchAddQuantityToStock']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
13419
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
13420
|
+
}
|
|
13421
|
+
});
|
|
13422
|
+
});
|
|
13423
|
+
},
|
|
13275
13424
|
/**
|
|
13276
13425
|
* Get Product
|
|
13277
13426
|
* @summary Get Product
|
|
@@ -13399,6 +13548,17 @@ var ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
13399
13548
|
getSearchProducts: function (pageSize, page, search, options) {
|
|
13400
13549
|
return localVarFp.getSearchProducts(pageSize, page, search, options).then(function (request) { return request(axios, basePath); });
|
|
13401
13550
|
},
|
|
13551
|
+
/**
|
|
13552
|
+
* Add Item Quantity To Stock
|
|
13553
|
+
* @summary Add Item Quantity To Stock
|
|
13554
|
+
* @param {string} sku Product SKU
|
|
13555
|
+
* @param {number} quantity Quantity
|
|
13556
|
+
* @param {*} [options] Override http request option.
|
|
13557
|
+
* @throws {RequiredError}
|
|
13558
|
+
*/
|
|
13559
|
+
patchAddQuantityToStock: function (sku, quantity, options) {
|
|
13560
|
+
return localVarFp.patchAddQuantityToStock(sku, quantity, options).then(function (request) { return request(axios, basePath); });
|
|
13561
|
+
},
|
|
13402
13562
|
/**
|
|
13403
13563
|
* Get Product
|
|
13404
13564
|
* @summary Get Product
|
|
@@ -13518,6 +13678,19 @@ var ProductsApi = /** @class */ (function (_super) {
|
|
|
13518
13678
|
var _this = this;
|
|
13519
13679
|
return (0, exports.ProductsApiFp)(this.configuration).getSearchProducts(pageSize, page, search, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
13520
13680
|
};
|
|
13681
|
+
/**
|
|
13682
|
+
* Add Item Quantity To Stock
|
|
13683
|
+
* @summary Add Item Quantity To Stock
|
|
13684
|
+
* @param {string} sku Product SKU
|
|
13685
|
+
* @param {number} quantity Quantity
|
|
13686
|
+
* @param {*} [options] Override http request option.
|
|
13687
|
+
* @throws {RequiredError}
|
|
13688
|
+
* @memberof ProductsApi
|
|
13689
|
+
*/
|
|
13690
|
+
ProductsApi.prototype.patchAddQuantityToStock = function (sku, quantity, options) {
|
|
13691
|
+
var _this = this;
|
|
13692
|
+
return (0, exports.ProductsApiFp)(this.configuration).patchAddQuantityToStock(sku, quantity, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
13693
|
+
};
|
|
13521
13694
|
/**
|
|
13522
13695
|
* Get Product
|
|
13523
13696
|
* @summary Get Product
|
package/docs/OrdersApi.md
CHANGED
|
@@ -14,6 +14,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
14
14
|
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
15
15
|
|[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
|
|
16
16
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
17
|
+
|[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
|
|
17
18
|
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
18
19
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
19
20
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
@@ -601,6 +602,60 @@ No authorization required
|
|
|
601
602
|
|
|
602
603
|
[[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)
|
|
603
604
|
|
|
605
|
+
# **patchCompleteOrder**
|
|
606
|
+
> OrderDetailsDTO patchCompleteOrder()
|
|
607
|
+
|
|
608
|
+
Mark Order As Complete (Admin)
|
|
609
|
+
|
|
610
|
+
### Example
|
|
611
|
+
|
|
612
|
+
```typescript
|
|
613
|
+
import {
|
|
614
|
+
OrdersApi,
|
|
615
|
+
Configuration
|
|
616
|
+
} from 'yellowgrid-api-ts';
|
|
617
|
+
|
|
618
|
+
const configuration = new Configuration();
|
|
619
|
+
const apiInstance = new OrdersApi(configuration);
|
|
620
|
+
|
|
621
|
+
let id: number; //Order ID (default to undefined)
|
|
622
|
+
|
|
623
|
+
const { status, data } = await apiInstance.patchCompleteOrder(
|
|
624
|
+
id
|
|
625
|
+
);
|
|
626
|
+
```
|
|
627
|
+
|
|
628
|
+
### Parameters
|
|
629
|
+
|
|
630
|
+
|Name | Type | Description | Notes|
|
|
631
|
+
|------------- | ------------- | ------------- | -------------|
|
|
632
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
### Return type
|
|
636
|
+
|
|
637
|
+
**OrderDetailsDTO**
|
|
638
|
+
|
|
639
|
+
### Authorization
|
|
640
|
+
|
|
641
|
+
No authorization required
|
|
642
|
+
|
|
643
|
+
### HTTP request headers
|
|
644
|
+
|
|
645
|
+
- **Content-Type**: Not defined
|
|
646
|
+
- **Accept**: application/json
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
### HTTP response details
|
|
650
|
+
| Status code | Description | Response headers |
|
|
651
|
+
|-------------|-------------|------------------|
|
|
652
|
+
|**200** | Order Details | - |
|
|
653
|
+
|**400** | Bad Request | - |
|
|
654
|
+
|**401** | Unauthorised | - |
|
|
655
|
+
|**403** | Access Denied | - |
|
|
656
|
+
|
|
657
|
+
[[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)
|
|
658
|
+
|
|
604
659
|
# **postAddOrderNote**
|
|
605
660
|
> AuditLogEntity postAddOrderNote()
|
|
606
661
|
|
package/docs/ProductsApi.md
CHANGED
|
@@ -11,6 +11,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
11
11
|
|[**getGetStockList**](#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing|
|
|
12
12
|
|[**getGetTcxTemplates**](#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates|
|
|
13
13
|
|[**getSearchProducts**](#getsearchproducts) | **GET** /products/search | Search Products|
|
|
14
|
+
|[**patchAddQuantityToStock**](#patchaddquantitytostock) | **PATCH** /products/{sku}/stock/add | Add Item Quantity To Stock|
|
|
14
15
|
|[**postGetProduct**](#postgetproduct) | **POST** /products/{sku} | Get Product|
|
|
15
16
|
|[**postGetProductForCustomer**](#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer|
|
|
16
17
|
|
|
@@ -363,6 +364,63 @@ No authorization required
|
|
|
363
364
|
|
|
364
365
|
[[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)
|
|
365
366
|
|
|
367
|
+
# **patchAddQuantityToStock**
|
|
368
|
+
> patchAddQuantityToStock()
|
|
369
|
+
|
|
370
|
+
Add Item Quantity To Stock
|
|
371
|
+
|
|
372
|
+
### Example
|
|
373
|
+
|
|
374
|
+
```typescript
|
|
375
|
+
import {
|
|
376
|
+
ProductsApi,
|
|
377
|
+
Configuration
|
|
378
|
+
} from 'yellowgrid-api-ts';
|
|
379
|
+
|
|
380
|
+
const configuration = new Configuration();
|
|
381
|
+
const apiInstance = new ProductsApi(configuration);
|
|
382
|
+
|
|
383
|
+
let sku: string; //Product SKU (default to undefined)
|
|
384
|
+
let quantity: number; //Quantity (default to undefined)
|
|
385
|
+
|
|
386
|
+
const { status, data } = await apiInstance.patchAddQuantityToStock(
|
|
387
|
+
sku,
|
|
388
|
+
quantity
|
|
389
|
+
);
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
### Parameters
|
|
393
|
+
|
|
394
|
+
|Name | Type | Description | Notes|
|
|
395
|
+
|------------- | ------------- | ------------- | -------------|
|
|
396
|
+
| **sku** | [**string**] | Product SKU | defaults to undefined|
|
|
397
|
+
| **quantity** | [**number**] | Quantity | defaults to undefined|
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
### Return type
|
|
401
|
+
|
|
402
|
+
void (empty response body)
|
|
403
|
+
|
|
404
|
+
### Authorization
|
|
405
|
+
|
|
406
|
+
No authorization required
|
|
407
|
+
|
|
408
|
+
### HTTP request headers
|
|
409
|
+
|
|
410
|
+
- **Content-Type**: Not defined
|
|
411
|
+
- **Accept**: Not defined
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
### HTTP response details
|
|
415
|
+
| Status code | Description | Response headers |
|
|
416
|
+
|-------------|-------------|------------------|
|
|
417
|
+
|**200** | No Response | - |
|
|
418
|
+
|**400** | Bad Request | - |
|
|
419
|
+
|**401** | Unauthorised | - |
|
|
420
|
+
|**403** | Access Denied | - |
|
|
421
|
+
|
|
422
|
+
[[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)
|
|
423
|
+
|
|
366
424
|
# **postGetProduct**
|
|
367
425
|
> ProductSummaryDTO postGetProduct(postGetProductRequest)
|
|
368
426
|
|