@commercengine/pos 0.4.1 → 0.4.3
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/dist/admin-types.d.mts +1 -1
- package/dist/index.d.mts +332 -238
- package/dist/index.mjs +71 -22
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -11,8 +11,8 @@ type $Read$1<T> = {
|
|
|
11
11
|
type $Write$1<T> = {
|
|
12
12
|
readonly $write: T;
|
|
13
13
|
};
|
|
14
|
-
type Readable
|
|
15
|
-
type Writable
|
|
14
|
+
type Readable<T> = T extends $Write$1<any> ? never : T extends $Read$1<infer U> ? Readable<U> : T extends (infer E)[] ? Readable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Write$1<any> ? never : K]: Readable<T[K]> } : T;
|
|
15
|
+
type Writable<T> = T extends $Read$1<any> ? never : T extends $Write$1<infer U> ? Writable<U> : T extends (infer E)[] ? Writable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Read$1<any> ? never : K]: Writable<T[K]> } & { [K in keyof T as NonNullable<T[K]> extends $Read$1<any> ? K : never]?: never } : T;
|
|
16
16
|
interface paths {
|
|
17
17
|
"/pos/auth/login/email": {
|
|
18
18
|
parameters: {
|
|
@@ -570,7 +570,7 @@ interface paths {
|
|
|
570
570
|
patch?: never;
|
|
571
571
|
trace?: never;
|
|
572
572
|
};
|
|
573
|
-
"/pos/catalog/products/{
|
|
573
|
+
"/pos/catalog/products/{product_id}": {
|
|
574
574
|
parameters: {
|
|
575
575
|
query?: never;
|
|
576
576
|
header?: never;
|
|
@@ -579,7 +579,7 @@ interface paths {
|
|
|
579
579
|
};
|
|
580
580
|
/**
|
|
581
581
|
* Retrieve a product detail
|
|
582
|
-
* @description Retrieves the details of an existing product.
|
|
582
|
+
* @description Retrieves the details of an existing product. Product slug is supported in place of product ID in the path. Commerce Engine returns the corresponding product information.
|
|
583
583
|
*/
|
|
584
584
|
get: operations["pos-get-product-detail"];
|
|
585
585
|
put?: never;
|
|
@@ -619,7 +619,7 @@ interface paths {
|
|
|
619
619
|
};
|
|
620
620
|
/**
|
|
621
621
|
* Retrieve product variants
|
|
622
|
-
* @description Retrieves the variants of an existing product.
|
|
622
|
+
* @description Retrieves the variants of an existing product. Product slug is supported in place of product ID in the path. Commerce Engine returns the corresponding product variants information.
|
|
623
623
|
*/
|
|
624
624
|
get: operations["pos-list-product-variants"];
|
|
625
625
|
put?: never;
|
|
@@ -639,7 +639,7 @@ interface paths {
|
|
|
639
639
|
};
|
|
640
640
|
/**
|
|
641
641
|
* Retrieve variant detail
|
|
642
|
-
* @description Retrieves the details of a particular variant.
|
|
642
|
+
* @description Retrieves the details of a particular variant. Product slug is supported in place of product ID, and variant slug in place of variant ID, in the path.
|
|
643
643
|
*/
|
|
644
644
|
get: operations["pos-get-variant-detail"];
|
|
645
645
|
put?: never;
|
|
@@ -1576,7 +1576,8 @@ interface components {
|
|
|
1576
1576
|
product_id: string;
|
|
1577
1577
|
variant_id: string | null;
|
|
1578
1578
|
sku: string;
|
|
1579
|
-
|
|
1579
|
+
product_slug: string;
|
|
1580
|
+
variant_slug: string;
|
|
1580
1581
|
product_name: string;
|
|
1581
1582
|
variant_name: string | null;
|
|
1582
1583
|
/**
|
|
@@ -1590,7 +1591,8 @@ interface components {
|
|
|
1590
1591
|
backorder?: boolean;
|
|
1591
1592
|
on_subscription: boolean;
|
|
1592
1593
|
on_promotion: boolean;
|
|
1593
|
-
category_ids: string[];
|
|
1594
|
+
category_ids: string[]; /** @description Expanded category objects. */
|
|
1595
|
+
categories?: components["schemas"]["Category"][];
|
|
1594
1596
|
tags: string[] | null;
|
|
1595
1597
|
reviews_count: number;
|
|
1596
1598
|
reviews_rating_sum: number | null;
|
|
@@ -2209,17 +2211,55 @@ interface components {
|
|
|
2209
2211
|
* @description Maximum number of records returned for a page.
|
|
2210
2212
|
* @default 25
|
|
2211
2213
|
*/
|
|
2212
|
-
limit: number;
|
|
2214
|
+
limit: number; /** @description provide list of attributes for specific facets or * for all facets. All attributes supported in the filter parameter are also supported here. */
|
|
2215
|
+
facets?: string[];
|
|
2213
2216
|
/**
|
|
2214
|
-
* @description
|
|
2215
|
-
*
|
|
2216
|
-
*
|
|
2217
|
-
*
|
|
2218
|
-
*
|
|
2219
|
-
*
|
|
2220
|
-
*
|
|
2217
|
+
* @description Filter expression(s) to narrow results. Omit for no filtering.
|
|
2218
|
+
*
|
|
2219
|
+
* **Syntax:** `attribute OPERATOR value`
|
|
2220
|
+
*
|
|
2221
|
+
* **Operators:**
|
|
2222
|
+
*
|
|
2223
|
+
* | Operator | Description | Example |
|
|
2224
|
+
* |---|---|---|
|
|
2225
|
+
* | `=` | Equal to | `product_type = physical` |
|
|
2226
|
+
* | `!=` | Not equal to | `product_type != bundle` |
|
|
2227
|
+
* | `>`, `>=`, `<`, `<=` | Comparison | `rating > 4` |
|
|
2228
|
+
* | `TO` | Inclusive range (`>=` AND `<=`) | `pricing.selling_price 100 TO 500` |
|
|
2229
|
+
* | `IN [...]` | Matches any value in the list | `product_type IN [physical,bundle]` |
|
|
2230
|
+
* | `NOT IN [...]` | Excludes all values in the list | `product_type NOT IN [physical,bundle]` |
|
|
2231
|
+
* | `EXISTS` | Attribute is present (even if `null` or empty) | `tags EXISTS` |
|
|
2232
|
+
* | `NOT EXISTS` | Attribute is absent | `tags NOT EXISTS` |
|
|
2233
|
+
* | `IS NULL` | Value is `null` | `variant_id IS NULL` |
|
|
2234
|
+
* | `IS NOT NULL` | Value is not `null` | `variant_id IS NOT NULL` |
|
|
2235
|
+
* | `IS EMPTY` | Value is `""`, `[]`, or `{}` | `tags IS EMPTY` |
|
|
2236
|
+
* | `IS NOT EMPTY` | Value is not empty | `tags IS NOT EMPTY` |
|
|
2237
|
+
* | `AND` | Both conditions must match | `rating > 4 AND product_type = physical` |
|
|
2238
|
+
* | `OR` | Either condition must match | `product_type = physical OR product_type = bundle` |
|
|
2239
|
+
* | `NOT` | Negates a condition | `NOT product_type = bundle` |
|
|
2240
|
+
*
|
|
2241
|
+
* **Important rules:**
|
|
2242
|
+
* - Operators are **case-sensitive** — must be uppercase (`AND`, not `and`).
|
|
2243
|
+
* - String value comparison is **case-insensitive** — `product_type = Physical` matches `physical`.
|
|
2244
|
+
* - Operator precedence: `NOT` > `AND` > `OR`. Use parentheses to override.
|
|
2245
|
+
* - String values containing whitespace must be wrapped in single quotes.
|
|
2246
|
+
* - `IN` takes comma-separated values in square brackets.
|
|
2247
|
+
* - Maximum array nesting depth is **2 levels**.
|
|
2248
|
+
*
|
|
2249
|
+
* **Supported attributes:** `product_type`, `categories.name`, `attributes.key`, `pricing.listing_price`, `pricing.selling_price`, `pricing.tax_rate`, `product_id`, `variant_id`, `product_name`, `variant_name`, `tags`, `sku`, `stock_available`, `rating`
|
|
2250
|
+
*
|
|
2251
|
+
* **Combining conditions:**
|
|
2252
|
+
* - **String:** Use `AND`/`OR` operators inline — `"rating > 4 AND product_type = physical"`
|
|
2253
|
+
* - **Array of strings:** Conditions are combined with AND — `["rating > 4", "product_type = physical"]`
|
|
2254
|
+
* - **Nested arrays:** Inner arrays express OR, outer array expresses AND — `["product_type = physical", ["product_type = bundle", "rating > 4"]]`
|
|
2221
2255
|
*/
|
|
2222
|
-
|
|
2256
|
+
filter?: string | (string | string[])[];
|
|
2257
|
+
/**
|
|
2258
|
+
* @description Sort results by attributes. Use `asc` for ascending order and `desc` for descending order.
|
|
2259
|
+
* @example product_type:desc
|
|
2260
|
+
* @example product_name:asc
|
|
2261
|
+
*/
|
|
2262
|
+
sort?: string[];
|
|
2223
2263
|
}; /** SellerInfo */
|
|
2224
2264
|
SellerInfo: {
|
|
2225
2265
|
id: string;
|
|
@@ -2229,7 +2269,6 @@ interface components {
|
|
|
2229
2269
|
tax_identification_number: string;
|
|
2230
2270
|
}; /** Seo */
|
|
2231
2271
|
Seo: {
|
|
2232
|
-
slug: string;
|
|
2233
2272
|
title: string | null;
|
|
2234
2273
|
description: string | null;
|
|
2235
2274
|
keywords: string[] | null;
|
|
@@ -3557,7 +3596,7 @@ interface operations {
|
|
|
3557
3596
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3558
3597
|
};
|
|
3559
3598
|
path: {
|
|
3560
|
-
/** @description
|
|
3599
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string;
|
|
3561
3600
|
};
|
|
3562
3601
|
cookie?: never;
|
|
3563
3602
|
};
|
|
@@ -3627,7 +3666,7 @@ interface operations {
|
|
|
3627
3666
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3628
3667
|
};
|
|
3629
3668
|
path: {
|
|
3630
|
-
/** @description ID
|
|
3669
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string;
|
|
3631
3670
|
};
|
|
3632
3671
|
cookie?: never;
|
|
3633
3672
|
};
|
|
@@ -3660,7 +3699,7 @@ interface operations {
|
|
|
3660
3699
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
3661
3700
|
};
|
|
3662
3701
|
path: {
|
|
3663
|
-
/** @description product
|
|
3702
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string; /** @description Variant ID or variant slug. Either is accepted in the path. */
|
|
3664
3703
|
variant_id: string;
|
|
3665
3704
|
};
|
|
3666
3705
|
cookie?: never;
|
|
@@ -4259,8 +4298,8 @@ type $Read<T> = {
|
|
|
4259
4298
|
type $Write<T> = {
|
|
4260
4299
|
readonly $write: T;
|
|
4261
4300
|
};
|
|
4262
|
-
type Readable<T> = T extends $Write<any> ? never : T extends $Read<infer U> ? Readable<U> : T extends (infer E)[] ? Readable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Write<any> ? never : K]: Readable<T[K]> } : T;
|
|
4263
|
-
type Writable<T> = T extends $Read<any> ? never : T extends $Write<infer U> ? Writable<U> : T extends (infer E)[] ? Writable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? never : K]: Writable<T[K]> } & { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? K : never]?: never } : T;
|
|
4301
|
+
type Readable$1<T> = T extends $Write<any> ? never : T extends $Read<infer U> ? Readable$1<U> : T extends (infer E)[] ? Readable$1<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Write<any> ? never : K]: Readable$1<T[K]> } : T;
|
|
4302
|
+
type Writable$1<T> = T extends $Read<any> ? never : T extends $Write<infer U> ? Writable$1<U> : T extends (infer E)[] ? Writable$1<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? never : K]: Writable$1<T[K]> } & { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? K : never]?: never } : T;
|
|
4264
4303
|
interface paths$1 {
|
|
4265
4304
|
"/pos/catalog/inventories": {
|
|
4266
4305
|
parameters: {
|
|
@@ -6490,323 +6529,329 @@ declare enum Environment {
|
|
|
6490
6529
|
}
|
|
6491
6530
|
//#endregion
|
|
6492
6531
|
//#region src/types/pos-api-types.d.ts
|
|
6493
|
-
type AcceleratedRewardCouponPromotion = Readable
|
|
6494
|
-
type AcceleratedRewardRule = Readable
|
|
6495
|
-
type AdditionalProductDetails = Readable
|
|
6496
|
-
type ApplicableCoupon = Readable
|
|
6497
|
-
type ApplicablePromotion = Readable
|
|
6498
|
-
type AppliedCoupon = Readable
|
|
6499
|
-
type AppliedPromotion = Readable
|
|
6500
|
-
type AssociatedOption = Readable
|
|
6501
|
-
type AutoScaleBasedOnAmount = Readable
|
|
6502
|
-
type AutoScaleBasedOnQuantity = Readable
|
|
6503
|
-
type BankTransfer = Readable
|
|
6504
|
-
type BooleanAttribute = Readable
|
|
6505
|
-
type BuyXGetYCouponPromotion = Readable
|
|
6506
|
-
type BuyXGetYRule = Readable
|
|
6507
|
-
type BuyXGetYRuleBasedOnAmount = Readable
|
|
6508
|
-
type BuyXGetYRuleBasedOnQuantity = Readable
|
|
6509
|
-
type CardPayment = Readable
|
|
6510
|
-
type Cart = Readable
|
|
6511
|
-
type
|
|
6512
|
-
type CartItem = Readable
|
|
6513
|
-
type CartShipment = Readable
|
|
6514
|
-
type Category = Readable
|
|
6515
|
-
type CollectInStore = Readable
|
|
6516
|
-
type CollectInStoreAddress = Readable
|
|
6517
|
-
type CollectInStoreFulfillment = Readable
|
|
6518
|
-
type
|
|
6519
|
-
type
|
|
6520
|
-
type
|
|
6521
|
-
type
|
|
6522
|
-
type
|
|
6523
|
-
type
|
|
6524
|
-
type
|
|
6525
|
-
type
|
|
6526
|
-
type
|
|
6527
|
-
type
|
|
6528
|
-
type
|
|
6529
|
-
type
|
|
6530
|
-
type
|
|
6531
|
-
type
|
|
6532
|
-
type
|
|
6533
|
-
type
|
|
6534
|
-
type
|
|
6535
|
-
type
|
|
6536
|
-
type
|
|
6537
|
-
type
|
|
6538
|
-
type
|
|
6539
|
-
type
|
|
6540
|
-
type
|
|
6541
|
-
type
|
|
6542
|
-
type
|
|
6543
|
-
type
|
|
6544
|
-
type
|
|
6545
|
-
type
|
|
6546
|
-
type
|
|
6547
|
-
type
|
|
6548
|
-
type
|
|
6549
|
-
type
|
|
6550
|
-
type
|
|
6551
|
-
type
|
|
6552
|
-
type
|
|
6553
|
-
type
|
|
6554
|
-
type
|
|
6555
|
-
type
|
|
6556
|
-
type
|
|
6557
|
-
type
|
|
6558
|
-
type
|
|
6559
|
-
type
|
|
6560
|
-
type
|
|
6561
|
-
type
|
|
6562
|
-
type
|
|
6563
|
-
type
|
|
6564
|
-
type
|
|
6565
|
-
type
|
|
6566
|
-
type
|
|
6567
|
-
type
|
|
6568
|
-
type
|
|
6569
|
-
type
|
|
6570
|
-
type
|
|
6571
|
-
type
|
|
6572
|
-
type
|
|
6573
|
-
type
|
|
6574
|
-
type
|
|
6575
|
-
type
|
|
6576
|
-
type
|
|
6577
|
-
type
|
|
6578
|
-
type
|
|
6579
|
-
type
|
|
6580
|
-
type
|
|
6581
|
-
type
|
|
6582
|
-
type
|
|
6583
|
-
type
|
|
6584
|
-
type
|
|
6585
|
-
type
|
|
6586
|
-
type
|
|
6587
|
-
type
|
|
6588
|
-
type
|
|
6589
|
-
type
|
|
6590
|
-
type
|
|
6591
|
-
type
|
|
6592
|
-
type
|
|
6593
|
-
type
|
|
6594
|
-
type
|
|
6595
|
-
type
|
|
6596
|
-
type
|
|
6597
|
-
type
|
|
6598
|
-
type
|
|
6599
|
-
type
|
|
6600
|
-
type
|
|
6601
|
-
type
|
|
6602
|
-
type
|
|
6603
|
-
type
|
|
6532
|
+
type AcceleratedRewardCouponPromotion = Readable<components['schemas']['AcceleratedRewardCouponPromotion']>;
|
|
6533
|
+
type AcceleratedRewardRule = Readable<components['schemas']['AcceleratedRewardRule']>;
|
|
6534
|
+
type AdditionalProductDetails = Readable<components['schemas']['AdditionalProductDetails']>;
|
|
6535
|
+
type ApplicableCoupon = Readable<components['schemas']['ApplicableCoupon']>;
|
|
6536
|
+
type ApplicablePromotion = Readable<components['schemas']['ApplicablePromotion']>;
|
|
6537
|
+
type AppliedCoupon = Readable<components['schemas']['AppliedCoupon']>;
|
|
6538
|
+
type AppliedPromotion = Readable<components['schemas']['AppliedPromotion']>;
|
|
6539
|
+
type AssociatedOption = Readable<components['schemas']['AssociatedOption']>;
|
|
6540
|
+
type AutoScaleBasedOnAmount = Readable<components['schemas']['AutoScaleBasedOnAmount']>;
|
|
6541
|
+
type AutoScaleBasedOnQuantity = Readable<components['schemas']['AutoScaleBasedOnQuantity']>;
|
|
6542
|
+
type BankTransfer = Readable<components['schemas']['BankTransfer']>;
|
|
6543
|
+
type BooleanAttribute = Readable<components['schemas']['BooleanAttribute']>;
|
|
6544
|
+
type BuyXGetYCouponPromotion = Readable<components['schemas']['BuyXGetYCouponPromotion']>;
|
|
6545
|
+
type BuyXGetYRule = Readable<components['schemas']['BuyXGetYRule']>;
|
|
6546
|
+
type BuyXGetYRuleBasedOnAmount = Readable<components['schemas']['BuyXGetYRuleBasedOnAmount']>;
|
|
6547
|
+
type BuyXGetYRuleBasedOnQuantity = Readable<components['schemas']['BuyXGetYRuleBasedOnQuantity']>;
|
|
6548
|
+
type CardPayment = Readable<components['schemas']['CardPayment']>;
|
|
6549
|
+
type Cart = Readable<components['schemas']['Cart']>;
|
|
6550
|
+
type CartBasedFulfillmentOptionInput = Writable<components['schemas']['CartBasedFulfillmentOption']>;
|
|
6551
|
+
type CartItem = Readable<components['schemas']['CartItem']>;
|
|
6552
|
+
type CartShipment = Readable<components['schemas']['CartShipment']>;
|
|
6553
|
+
type Category = Readable<components['schemas']['Category']>;
|
|
6554
|
+
type CollectInStore = Readable<components['schemas']['CollectInStore']>;
|
|
6555
|
+
type CollectInStoreAddress = Readable<components['schemas']['CollectInStoreAddress']>;
|
|
6556
|
+
type CollectInStoreFulfillment = Readable<components['schemas']['CollectInStoreFulfillment']>;
|
|
6557
|
+
type CollectInStoreFulfillmentInput = Writable<components['schemas']['CollectInStoreFulfillment']>;
|
|
6558
|
+
type ColorAttribute = Readable<components['schemas']['ColorAttribute']>;
|
|
6559
|
+
type ColorOption = Readable<components['schemas']['ColorOption']>;
|
|
6560
|
+
type Coupon = Readable<components['schemas']['Coupon']>;
|
|
6561
|
+
type CouponPromotionCommonDetail = Readable<components['schemas']['CouponPromotionCommonDetail']>;
|
|
6562
|
+
type CouponType = Readable<components['schemas']['CouponType']>;
|
|
6563
|
+
type Currency = Readable<components['schemas']['Currency']>;
|
|
6564
|
+
type CustomSlabsBasedOnAmount = Readable<components['schemas']['CustomSlabsBasedOnAmount']>;
|
|
6565
|
+
type CustomSlabsBasedOnQuantity = Readable<components['schemas']['CustomSlabsBasedOnQuantity']>;
|
|
6566
|
+
type CustomerAddress = Readable<components['schemas']['CustomerAddress']>;
|
|
6567
|
+
type CustomerAddressInput = Writable<components['schemas']['CustomerAddress']>;
|
|
6568
|
+
type DateAttribute = Readable<components['schemas']['DateAttribute']>;
|
|
6569
|
+
type DeliveryFulfillment = Readable<components['schemas']['DeliveryFulfillment']>;
|
|
6570
|
+
type DeliveryFulfillmentInput = Writable<components['schemas']['DeliveryFulfillment']>;
|
|
6571
|
+
type DeliveryOption = Readable<components['schemas']['DeliveryOption']>;
|
|
6572
|
+
type DiscountBasedPromotion = Readable<components['schemas']['DiscountBasedPromotion']>;
|
|
6573
|
+
type DiscountCouponPromotion = Readable<components['schemas']['DiscountCouponPromotion']>;
|
|
6574
|
+
type DiscountRule = Readable<components['schemas']['DiscountRule']>;
|
|
6575
|
+
type FixedAmountDiscountRule = Readable<components['schemas']['FixedAmountDiscountRule']>;
|
|
6576
|
+
type FixedPriceCouponPromotion = Readable<components['schemas']['FixedPriceCouponPromotion']>;
|
|
6577
|
+
type FixedPricePromotion = Readable<components['schemas']['FixedPricePromotion']>;
|
|
6578
|
+
type FixedPriceRule = Readable<components['schemas']['FixedPriceRule']>;
|
|
6579
|
+
type FixedPriceRuleBasedAmount = Readable<components['schemas']['FixedPriceRuleBasedAmount']>;
|
|
6580
|
+
type FixedPriceRuleBasedQuantity = Readable<components['schemas']['FixedPriceRuleBasedQuantity']>;
|
|
6581
|
+
type FreeGoodCouponPromotion = Readable<components['schemas']['FreeGoodCouponPromotion']>;
|
|
6582
|
+
type FreeGoodsPromotion = Readable<components['schemas']['FreeGoodsPromotion']>;
|
|
6583
|
+
type FreeGoodsRule = Readable<components['schemas']['FreeGoodsRule']>;
|
|
6584
|
+
type FreeShipingCouponPromotion = Readable<components['schemas']['FreeShipingCouponPromotion']>;
|
|
6585
|
+
type FulfillmentItem = Readable<components['schemas']['FulfillmentItem']>;
|
|
6586
|
+
type FulfillmentItemInput = Writable<components['schemas']['FulfillmentItem']>;
|
|
6587
|
+
type FulfillmentPreference = Readable<components['schemas']['FulfillmentPreference']>;
|
|
6588
|
+
type FulfillmentPreferenceInput = Writable<components['schemas']['FulfillmentPreference']>;
|
|
6589
|
+
type InapplicableCoupon = Readable<components['schemas']['InapplicableCoupon']>;
|
|
6590
|
+
type InapplicablePromotion = Readable<components['schemas']['InapplicablePromotion']>;
|
|
6591
|
+
type Item = Readable<components['schemas']['Item']>;
|
|
6592
|
+
type LotBatchDetail = Readable<components['schemas']['LotBatchDetail']>;
|
|
6593
|
+
type MultiSelectAttribute = Readable<components['schemas']['MultiSelectAttribute']>;
|
|
6594
|
+
type NetbankingPayment = Readable<components['schemas']['NetbankingPayment']>;
|
|
6595
|
+
type NumberAttribute = Readable<components['schemas']['NumberAttribute']>;
|
|
6596
|
+
type Order = Readable<components['schemas']['Order']>;
|
|
6597
|
+
type OrderDetail = Readable<components['schemas']['OrderDetail']>;
|
|
6598
|
+
type OrderItem = Readable<components['schemas']['OrderItem']>;
|
|
6599
|
+
type OrderPayment = Readable<components['schemas']['OrderPayment']>;
|
|
6600
|
+
type OrderRefund = Readable<components['schemas']['OrderRefund']>;
|
|
6601
|
+
type OrderShipment = Readable<components['schemas']['OrderShipment']>;
|
|
6602
|
+
type Pagination = Readable<components['schemas']['Pagination']>;
|
|
6603
|
+
type PartialCollectAndDelivery = Readable<components['schemas']['PartialCollectAndDelivery']>;
|
|
6604
|
+
type PartialCollectAndDeliveryInput = Writable<components['schemas']['PartialCollectAndDelivery']>;
|
|
6605
|
+
type PayWithCardInput = Writable<components['schemas']['PayWithCard']>;
|
|
6606
|
+
type PayWithCashInput = Writable<components['schemas']['PayWithCash']>;
|
|
6607
|
+
type PayWithUpiInput = Writable<components['schemas']['PayWithUpi']>;
|
|
6608
|
+
type PaymentInfo = Readable<components['schemas']['PaymentInfo']>;
|
|
6609
|
+
type PercentageDiscountRule = Readable<components['schemas']['PercentageDiscountRule']>;
|
|
6610
|
+
type PosDevice = Readable<components['schemas']['PosDevice']>;
|
|
6611
|
+
type PosDeviceClaimedUser = Readable<components['schemas']['PosDeviceClaimedUser']>;
|
|
6612
|
+
type PosLocation = Readable<components['schemas']['PosLocation']>;
|
|
6613
|
+
type PosUpdateCustomerWithEmailInput = Writable<components['schemas']['PosUpdateCustomerWithEmail']>;
|
|
6614
|
+
type PosUpdateCustomerWithIdInput = Writable<components['schemas']['PosUpdateCustomerWithId']>;
|
|
6615
|
+
type PosUpdateCustomerWithPhoneInput = Writable<components['schemas']['PosUpdateCustomerWithPhone']>;
|
|
6616
|
+
type PosUser = Readable<components['schemas']['PosUser']>;
|
|
6617
|
+
type Product = Readable<components['schemas']['Product']>;
|
|
6618
|
+
type ProductAttribute = Readable<components['schemas']['ProductAttribute']>;
|
|
6619
|
+
type ProductBundleItem = Readable<components['schemas']['ProductBundleItem']>;
|
|
6620
|
+
type ProductCategory = Readable<components['schemas']['ProductCategory']>;
|
|
6621
|
+
type ProductDetail = Readable<components['schemas']['ProductDetail']>;
|
|
6622
|
+
type ProductImage = Readable<components['schemas']['ProductImage']>;
|
|
6623
|
+
type ProductPricing = Readable<components['schemas']['ProductPricing']>;
|
|
6624
|
+
type ProductPromotion = Readable<components['schemas']['ProductPromotion']>;
|
|
6625
|
+
type ProductReview = Readable<components['schemas']['ProductReview']>;
|
|
6626
|
+
type ProductShipping = Readable<components['schemas']['ProductShipping']>;
|
|
6627
|
+
type ProductSubscription = Readable<components['schemas']['ProductSubscription']>;
|
|
6628
|
+
type ProductVideo = Readable<components['schemas']['ProductVideo']>;
|
|
6629
|
+
type Promotion = Readable<components['schemas']['Promotion']>;
|
|
6630
|
+
type PromotionType = Readable<components['schemas']['PromotionType']>;
|
|
6631
|
+
type SearchProductInput = Writable<components['schemas']['SearchProduct']>;
|
|
6632
|
+
type SellerInfo = Readable<components['schemas']['SellerInfo']>;
|
|
6633
|
+
type Seo = Readable<components['schemas']['Seo']>;
|
|
6634
|
+
type ShipmentItem = Readable<components['schemas']['ShipmentItem']>;
|
|
6635
|
+
type ShipmentStatus = Readable<components['schemas']['ShipmentStatus']>;
|
|
6636
|
+
type SingleSelectAttribute = Readable<components['schemas']['SingleSelectAttribute']>;
|
|
6637
|
+
type SingleSelectOption = Readable<components['schemas']['SingleSelectOption']>;
|
|
6638
|
+
type TextAttribute = Readable<components['schemas']['TextAttribute']>;
|
|
6639
|
+
type UpdateCartItemInput = Writable<components['schemas']['UpdateCartItem']>;
|
|
6640
|
+
type UpiPayment = Readable<components['schemas']['UpiPayment']>;
|
|
6641
|
+
type Variant = Readable<components['schemas']['Variant']>;
|
|
6642
|
+
type VariantDetail = Readable<components['schemas']['VariantDetail']>;
|
|
6643
|
+
type VariantOption = Readable<components['schemas']['VariantOption']>;
|
|
6644
|
+
type VolumeBasedCouponPromotion = Readable<components['schemas']['VolumeBasedCouponPromotion']>;
|
|
6645
|
+
type VolumeBasedPromotion = Readable<components['schemas']['VolumeBasedPromotion']>;
|
|
6646
|
+
type VolumeBasedRule = Readable<components['schemas']['VolumeBasedRule']>;
|
|
6647
|
+
type WalletPayment = Readable<components['schemas']['WalletPayment']>;
|
|
6648
|
+
type LoginPosDeviceWithEmailResponse = Readable<paths['/pos/auth/login/email']['post']['responses'][200]['content']['application/json']>;
|
|
6604
6649
|
type LoginPosDeviceWithEmailContent = LoginPosDeviceWithEmailResponse['content'];
|
|
6605
6650
|
type LoginPosDeviceWithEmailHeaderParams = paths['/pos/auth/login/email']['post']['parameters']['header'];
|
|
6606
|
-
type LoginPosDeviceWithEmailBody = Writable
|
|
6607
|
-
type LoginPosDeviceWithPhoneResponse = Readable
|
|
6651
|
+
type LoginPosDeviceWithEmailBody = Writable<NonNullable<paths['/pos/auth/login/email']['post']['requestBody']>['content']['application/json']>;
|
|
6652
|
+
type LoginPosDeviceWithPhoneResponse = Readable<paths['/pos/auth/login/phone']['post']['responses'][200]['content']['application/json']>;
|
|
6608
6653
|
type LoginPosDeviceWithPhoneContent = LoginPosDeviceWithPhoneResponse['content'];
|
|
6609
6654
|
type LoginPosDeviceWithPhoneHeaderParams = paths['/pos/auth/login/phone']['post']['parameters']['header'];
|
|
6610
|
-
type LoginPosDeviceWithPhoneBody = Writable
|
|
6611
|
-
type LoginPosDeviceWithWhatsappResponse = Readable
|
|
6655
|
+
type LoginPosDeviceWithPhoneBody = Writable<NonNullable<paths['/pos/auth/login/phone']['post']['requestBody']>['content']['application/json']>;
|
|
6656
|
+
type LoginPosDeviceWithWhatsappResponse = Readable<paths['/pos/auth/login/whatsapp']['post']['responses'][200]['content']['application/json']>;
|
|
6612
6657
|
type LoginPosDeviceWithWhatsappContent = LoginPosDeviceWithWhatsappResponse['content'];
|
|
6613
6658
|
type LoginPosDeviceWithWhatsappHeaderParams = paths['/pos/auth/login/whatsapp']['post']['parameters']['header'];
|
|
6614
|
-
type LoginPosDeviceWithWhatsappBody = Writable
|
|
6615
|
-
type LogoutFromPosDeviceResponse = Readable
|
|
6616
|
-
type PairPosDeviceResponse = Readable
|
|
6659
|
+
type LoginPosDeviceWithWhatsappBody = Writable<NonNullable<paths['/pos/auth/login/whatsapp']['post']['requestBody']>['content']['application/json']>;
|
|
6660
|
+
type LogoutFromPosDeviceResponse = Readable<paths['/pos/auth/logout']['post']['responses'][200]['content']['application/json']>;
|
|
6661
|
+
type PairPosDeviceResponse = Readable<paths['/pos/auth/pair-device']['post']['responses'][200]['content']['application/json']>;
|
|
6617
6662
|
type PairPosDeviceContent = PairPosDeviceResponse['content'];
|
|
6618
|
-
type PairPosDeviceBody = Writable
|
|
6619
|
-
type RefreshPosAccessTokenResponse = Readable
|
|
6663
|
+
type PairPosDeviceBody = Writable<NonNullable<paths['/pos/auth/pair-device']['post']['requestBody']>['content']['application/json']>;
|
|
6664
|
+
type RefreshPosAccessTokenResponse = Readable<paths['/pos/auth/refresh-token']['post']['responses'][200]['content']['application/json']>;
|
|
6620
6665
|
type RefreshPosAccessTokenContent = RefreshPosAccessTokenResponse['content'];
|
|
6621
|
-
type RefreshPosAccessTokenBody = Writable
|
|
6622
|
-
type VerifyPosLoginOtpResponse = Readable
|
|
6666
|
+
type RefreshPosAccessTokenBody = Writable<NonNullable<paths['/pos/auth/refresh-token']['post']['requestBody']>['content']['application/json']>;
|
|
6667
|
+
type VerifyPosLoginOtpResponse = Readable<paths['/pos/auth/verify-otp']['post']['responses'][200]['content']['application/json']>;
|
|
6623
6668
|
type VerifyPosLoginOtpContent = VerifyPosLoginOtpResponse['content'];
|
|
6624
|
-
type VerifyPosLoginOtpBody = Writable
|
|
6625
|
-
type PosCreateCartResponse = Readable
|
|
6669
|
+
type VerifyPosLoginOtpBody = Writable<NonNullable<paths['/pos/auth/verify-otp']['post']['requestBody']>['content']['application/json']>;
|
|
6670
|
+
type PosCreateCartResponse = Readable<paths['/pos/carts']['post']['responses'][200]['content']['application/json']>;
|
|
6626
6671
|
type PosCreateCartContent = PosCreateCartResponse['content'];
|
|
6627
|
-
type PosCreateCartBody = Writable
|
|
6628
|
-
type PosListCouponsResponse = Readable
|
|
6672
|
+
type PosCreateCartBody = Writable<NonNullable<paths['/pos/carts']['post']['requestBody']>['content']['application/json']>;
|
|
6673
|
+
type PosListCouponsResponse = Readable<paths['/pos/carts/available-coupons']['get']['responses'][200]['content']['application/json']>;
|
|
6629
6674
|
type PosListCouponsContent = PosListCouponsResponse['content'];
|
|
6630
6675
|
type PosListCouponsHeaderParams = paths['/pos/carts/available-coupons']['get']['parameters']['header'];
|
|
6631
|
-
type PosListPromotionsResponse = Readable
|
|
6676
|
+
type PosListPromotionsResponse = Readable<paths['/pos/carts/available-promotions']['get']['responses'][200]['content']['application/json']>;
|
|
6632
6677
|
type PosListPromotionsContent = PosListPromotionsResponse['content'];
|
|
6633
6678
|
type PosListPromotionsHeaderParams = paths['/pos/carts/available-promotions']['get']['parameters']['header'];
|
|
6634
|
-
type PosGetUserCartResponse = Readable
|
|
6679
|
+
type PosGetUserCartResponse = Readable<paths['/pos/carts/users/{user_id}']['get']['responses'][200]['content']['application/json']>;
|
|
6635
6680
|
type PosGetUserCartContent = PosGetUserCartResponse['content'];
|
|
6636
6681
|
type PosGetUserCartPathParams = paths['/pos/carts/users/{user_id}']['get']['parameters']['path'];
|
|
6637
|
-
type PosGetCartResponse = Readable
|
|
6682
|
+
type PosGetCartResponse = Readable<paths['/pos/carts/{id}']['get']['responses'][200]['content']['application/json']>;
|
|
6638
6683
|
type PosGetCartContent = PosGetCartResponse['content'];
|
|
6639
6684
|
type PosGetCartPathParams = paths['/pos/carts/{id}']['get']['parameters']['path'];
|
|
6640
|
-
type PosDeleteCartResponse = Readable
|
|
6685
|
+
type PosDeleteCartResponse = Readable<paths['/pos/carts/{id}']['delete']['responses'][200]['content']['application/json']>;
|
|
6641
6686
|
type PosDeleteCartPathParams = paths['/pos/carts/{id}']['delete']['parameters']['path'];
|
|
6642
|
-
type PosCreateCartAddressResponse = Readable
|
|
6687
|
+
type PosCreateCartAddressResponse = Readable<paths['/pos/carts/{id}/address']['post']['responses'][200]['content']['application/json']>;
|
|
6643
6688
|
type PosCreateCartAddressContent = PosCreateCartAddressResponse['content'];
|
|
6644
6689
|
type PosCreateCartAddressPathParams = paths['/pos/carts/{id}/address']['post']['parameters']['path'];
|
|
6645
|
-
type PosCreateCartAddressBody = Writable
|
|
6646
|
-
type PosApplyCouponResponse = Readable
|
|
6690
|
+
type PosCreateCartAddressBody = Writable<NonNullable<paths['/pos/carts/{id}/address']['post']['requestBody']>['content']['application/json']>;
|
|
6691
|
+
type PosApplyCouponResponse = Readable<paths['/pos/carts/{id}/coupon']['post']['responses'][200]['content']['application/json']>;
|
|
6647
6692
|
type PosApplyCouponContent = PosApplyCouponResponse['content'];
|
|
6648
6693
|
type PosApplyCouponPathParams = paths['/pos/carts/{id}/coupon']['post']['parameters']['path'];
|
|
6649
|
-
type PosApplyCouponBody = Writable
|
|
6650
|
-
type PosRemoveCouponResponse = Readable
|
|
6694
|
+
type PosApplyCouponBody = Writable<NonNullable<paths['/pos/carts/{id}/coupon']['post']['requestBody']>['content']['application/json']>;
|
|
6695
|
+
type PosRemoveCouponResponse = Readable<paths['/pos/carts/{id}/coupon']['delete']['responses'][200]['content']['application/json']>;
|
|
6651
6696
|
type PosRemoveCouponContent = PosRemoveCouponResponse['content'];
|
|
6652
6697
|
type PosRemoveCouponPathParams = paths['/pos/carts/{id}/coupon']['delete']['parameters']['path'];
|
|
6653
|
-
type PosRedeemCreditBalanceResponse = Readable
|
|
6698
|
+
type PosRedeemCreditBalanceResponse = Readable<paths['/pos/carts/{id}/credit-balance']['post']['responses'][200]['content']['application/json']>;
|
|
6654
6699
|
type PosRedeemCreditBalanceContent = PosRedeemCreditBalanceResponse['content'];
|
|
6655
6700
|
type PosRedeemCreditBalancePathParams = paths['/pos/carts/{id}/credit-balance']['post']['parameters']['path'];
|
|
6656
|
-
type PosRedeemCreditBalanceBody = Writable
|
|
6657
|
-
type PosRemoveCreditBalanceResponse = Readable
|
|
6701
|
+
type PosRedeemCreditBalanceBody = Writable<NonNullable<paths['/pos/carts/{id}/credit-balance']['post']['requestBody']>['content']['application/json']>;
|
|
6702
|
+
type PosRemoveCreditBalanceResponse = Readable<paths['/pos/carts/{id}/credit-balance']['delete']['responses'][200]['content']['application/json']>;
|
|
6658
6703
|
type PosRemoveCreditBalanceContent = PosRemoveCreditBalanceResponse['content'];
|
|
6659
6704
|
type PosRemoveCreditBalancePathParams = paths['/pos/carts/{id}/credit-balance']['delete']['parameters']['path'];
|
|
6660
|
-
type PosEvaluateCouponsResponse = Readable
|
|
6705
|
+
type PosEvaluateCouponsResponse = Readable<paths['/pos/carts/{id}/evaluate-coupons']['get']['responses'][200]['content']['application/json']>;
|
|
6661
6706
|
type PosEvaluateCouponsContent = PosEvaluateCouponsResponse['content'];
|
|
6662
6707
|
type PosEvaluateCouponsPathParams = paths['/pos/carts/{id}/evaluate-coupons']['get']['parameters']['path'];
|
|
6663
|
-
type PosEvaluatePromotionsResponse = Readable
|
|
6708
|
+
type PosEvaluatePromotionsResponse = Readable<paths['/pos/carts/{id}/evaluate-promotions']['get']['responses'][200]['content']['application/json']>;
|
|
6664
6709
|
type PosEvaluatePromotionsContent = PosEvaluatePromotionsResponse['content'];
|
|
6665
6710
|
type PosEvaluatePromotionsPathParams = paths['/pos/carts/{id}/evaluate-promotions']['get']['parameters']['path'];
|
|
6666
|
-
type PosUpdateFulfillmentPreferenceResponse = Readable
|
|
6711
|
+
type PosUpdateFulfillmentPreferenceResponse = Readable<paths['/pos/carts/{id}/fulfillment-preference']['post']['responses'][200]['content']['application/json']>;
|
|
6667
6712
|
type PosUpdateFulfillmentPreferenceContent = PosUpdateFulfillmentPreferenceResponse['content'];
|
|
6668
6713
|
type PosUpdateFulfillmentPreferencePathParams = paths['/pos/carts/{id}/fulfillment-preference']['post']['parameters']['path'];
|
|
6669
|
-
type PosUpdateFulfillmentPreferenceBody = Writable
|
|
6670
|
-
type PosUpdateCartResponse = Readable
|
|
6714
|
+
type PosUpdateFulfillmentPreferenceBody = Writable<NonNullable<paths['/pos/carts/{id}/fulfillment-preference']['post']['requestBody']>['content']['application/json']>;
|
|
6715
|
+
type PosUpdateCartResponse = Readable<paths['/pos/carts/{id}/items']['post']['responses'][200]['content']['application/json']>;
|
|
6671
6716
|
type PosUpdateCartContent = PosUpdateCartResponse['content'];
|
|
6672
6717
|
type PosUpdateCartPathParams = paths['/pos/carts/{id}/items']['post']['parameters']['path'];
|
|
6673
|
-
type PosUpdateCartBody = Writable
|
|
6674
|
-
type PosRedeemLoyaltyPointsResponse = Readable
|
|
6718
|
+
type PosUpdateCartBody = Writable<NonNullable<paths['/pos/carts/{id}/items']['post']['requestBody']>['content']['application/json']>;
|
|
6719
|
+
type PosRedeemLoyaltyPointsResponse = Readable<paths['/pos/carts/{id}/loyalty-points']['post']['responses'][200]['content']['application/json']>;
|
|
6675
6720
|
type PosRedeemLoyaltyPointsContent = PosRedeemLoyaltyPointsResponse['content'];
|
|
6676
6721
|
type PosRedeemLoyaltyPointsPathParams = paths['/pos/carts/{id}/loyalty-points']['post']['parameters']['path'];
|
|
6677
|
-
type PosRedeemLoyaltyPointsBody = Writable
|
|
6678
|
-
type PosRemoveLoyaltyPointsResponse = Readable
|
|
6722
|
+
type PosRedeemLoyaltyPointsBody = Writable<NonNullable<paths['/pos/carts/{id}/loyalty-points']['post']['requestBody']>['content']['application/json']>;
|
|
6723
|
+
type PosRemoveLoyaltyPointsResponse = Readable<paths['/pos/carts/{id}/loyalty-points']['delete']['responses'][200]['content']['application/json']>;
|
|
6679
6724
|
type PosRemoveLoyaltyPointsContent = PosRemoveLoyaltyPointsResponse['content'];
|
|
6680
6725
|
type PosRemoveLoyaltyPointsPathParams = paths['/pos/carts/{id}/loyalty-points']['delete']['parameters']['path'];
|
|
6681
|
-
type UpdatePosCartCustomerResponse = Readable
|
|
6726
|
+
type UpdatePosCartCustomerResponse = Readable<paths['/pos/carts/{id}/update-customer']['post']['responses'][200]['content']['application/json']>;
|
|
6682
6727
|
type UpdatePosCartCustomerContent = UpdatePosCartCustomerResponse['content'];
|
|
6683
6728
|
type UpdatePosCartCustomerPathParams = paths['/pos/carts/{id}/update-customer']['post']['parameters']['path'];
|
|
6684
|
-
type UpdatePosCartCustomerBody = Writable
|
|
6685
|
-
type PosListCategoriesResponse = Readable
|
|
6729
|
+
type UpdatePosCartCustomerBody = Writable<NonNullable<paths['/pos/carts/{id}/update-customer']['post']['requestBody']>['content']['application/json']>;
|
|
6730
|
+
type PosListCategoriesResponse = Readable<paths['/pos/catalog/categories']['get']['responses'][200]['content']['application/json']>;
|
|
6686
6731
|
type PosListCategoriesContent = PosListCategoriesResponse['content'];
|
|
6687
6732
|
type PosListCategoriesQuery = paths['/pos/catalog/categories']['get']['parameters']['query'];
|
|
6688
|
-
type PosListProductsResponse = Readable
|
|
6733
|
+
type PosListProductsResponse = Readable<paths['/pos/catalog/products']['get']['responses'][200]['content']['application/json']>;
|
|
6689
6734
|
type PosListProductsContent = PosListProductsResponse['content'];
|
|
6690
6735
|
type PosListProductsQuery = paths['/pos/catalog/products']['get']['parameters']['query'];
|
|
6691
6736
|
type PosListProductsHeaderParams = paths['/pos/catalog/products']['get']['parameters']['header'];
|
|
6692
|
-
type PosListCrosssellProductsResponse = Readable
|
|
6737
|
+
type PosListCrosssellProductsResponse = Readable<paths['/pos/catalog/products/cross-sell']['get']['responses'][200]['content']['application/json']>;
|
|
6693
6738
|
type PosListCrosssellProductsContent = PosListCrosssellProductsResponse['content'];
|
|
6694
6739
|
type PosListCrosssellProductsQuery = paths['/pos/catalog/products/cross-sell']['get']['parameters']['query'];
|
|
6695
6740
|
type PosListCrosssellProductsHeaderParams = paths['/pos/catalog/products/cross-sell']['get']['parameters']['header'];
|
|
6696
|
-
type PosSearchProductsResponse = Readable
|
|
6741
|
+
type PosSearchProductsResponse = Readable<paths['/pos/catalog/products/search']['post']['responses'][200]['content']['application/json']>;
|
|
6697
6742
|
type PosSearchProductsContent = PosSearchProductsResponse['content'];
|
|
6698
6743
|
type PosSearchProductsHeaderParams = paths['/pos/catalog/products/search']['post']['parameters']['header'];
|
|
6699
|
-
type PosSearchProductsBody = Writable
|
|
6700
|
-
type PosListSimilarProductsResponse = Readable
|
|
6744
|
+
type PosSearchProductsBody = Writable<NonNullable<paths['/pos/catalog/products/search']['post']['requestBody']>['content']['application/json']>;
|
|
6745
|
+
type PosListSimilarProductsResponse = Readable<paths['/pos/catalog/products/similar']['get']['responses'][200]['content']['application/json']>;
|
|
6701
6746
|
type PosListSimilarProductsContent = PosListSimilarProductsResponse['content'];
|
|
6702
6747
|
type PosListSimilarProductsQuery = paths['/pos/catalog/products/similar']['get']['parameters']['query'];
|
|
6703
6748
|
type PosListSimilarProductsHeaderParams = paths['/pos/catalog/products/similar']['get']['parameters']['header'];
|
|
6704
|
-
type PosListUpsellProductsResponse = Readable
|
|
6749
|
+
type PosListUpsellProductsResponse = Readable<paths['/pos/catalog/products/up-sell']['get']['responses'][200]['content']['application/json']>;
|
|
6705
6750
|
type PosListUpsellProductsContent = PosListUpsellProductsResponse['content'];
|
|
6706
6751
|
type PosListUpsellProductsQuery = paths['/pos/catalog/products/up-sell']['get']['parameters']['query'];
|
|
6707
6752
|
type PosListUpsellProductsHeaderParams = paths['/pos/catalog/products/up-sell']['get']['parameters']['header'];
|
|
6708
|
-
type PosGetProductDetailResponse = Readable
|
|
6753
|
+
type PosGetProductDetailResponse = Readable<paths['/pos/catalog/products/{product_id}']['get']['responses'][200]['content']['application/json']>;
|
|
6709
6754
|
type PosGetProductDetailContent = PosGetProductDetailResponse['content'];
|
|
6710
|
-
type PosGetProductDetailQuery = paths['/pos/catalog/products/{
|
|
6711
|
-
type PosGetProductDetailPathParams = paths['/pos/catalog/products/{
|
|
6712
|
-
type PosGetProductDetailHeaderParams = paths['/pos/catalog/products/{
|
|
6713
|
-
type PosListProductReviewsResponse = Readable
|
|
6755
|
+
type PosGetProductDetailQuery = paths['/pos/catalog/products/{product_id}']['get']['parameters']['query'];
|
|
6756
|
+
type PosGetProductDetailPathParams = paths['/pos/catalog/products/{product_id}']['get']['parameters']['path'];
|
|
6757
|
+
type PosGetProductDetailHeaderParams = paths['/pos/catalog/products/{product_id}']['get']['parameters']['header'];
|
|
6758
|
+
type PosListProductReviewsResponse = Readable<paths['/pos/catalog/products/{product_id}/reviews']['get']['responses'][200]['content']['application/json']>;
|
|
6714
6759
|
type PosListProductReviewsContent = PosListProductReviewsResponse['content'];
|
|
6715
6760
|
type PosListProductReviewsQuery = paths['/pos/catalog/products/{product_id}/reviews']['get']['parameters']['query'];
|
|
6716
6761
|
type PosListProductReviewsPathParams = paths['/pos/catalog/products/{product_id}/reviews']['get']['parameters']['path'];
|
|
6717
|
-
type PosListProductVariantsResponse = Readable
|
|
6762
|
+
type PosListProductVariantsResponse = Readable<paths['/pos/catalog/products/{product_id}/variants']['get']['responses'][200]['content']['application/json']>;
|
|
6718
6763
|
type PosListProductVariantsContent = PosListProductVariantsResponse['content'];
|
|
6719
6764
|
type PosListProductVariantsQuery = paths['/pos/catalog/products/{product_id}/variants']['get']['parameters']['query'];
|
|
6720
6765
|
type PosListProductVariantsPathParams = paths['/pos/catalog/products/{product_id}/variants']['get']['parameters']['path'];
|
|
6721
6766
|
type PosListProductVariantsHeaderParams = paths['/pos/catalog/products/{product_id}/variants']['get']['parameters']['header'];
|
|
6722
|
-
type PosGetVariantDetailResponse = Readable
|
|
6767
|
+
type PosGetVariantDetailResponse = Readable<paths['/pos/catalog/products/{product_id}/variants/{variant_id}']['get']['responses'][200]['content']['application/json']>;
|
|
6723
6768
|
type PosGetVariantDetailContent = PosGetVariantDetailResponse['content'];
|
|
6724
6769
|
type PosGetVariantDetailQuery = paths['/pos/catalog/products/{product_id}/variants/{variant_id}']['get']['parameters']['query'];
|
|
6725
6770
|
type PosGetVariantDetailPathParams = paths['/pos/catalog/products/{product_id}/variants/{variant_id}']['get']['parameters']['path'];
|
|
6726
6771
|
type PosGetVariantDetailHeaderParams = paths['/pos/catalog/products/{product_id}/variants/{variant_id}']['get']['parameters']['header'];
|
|
6727
|
-
type PosListSkusResponse = Readable
|
|
6772
|
+
type PosListSkusResponse = Readable<paths['/pos/catalog/skus']['get']['responses'][200]['content']['application/json']>;
|
|
6728
6773
|
type PosListSkusContent = PosListSkusResponse['content'];
|
|
6729
6774
|
type PosListSkusQuery = paths['/pos/catalog/skus']['get']['parameters']['query'];
|
|
6730
6775
|
type PosListSkusHeaderParams = paths['/pos/catalog/skus']['get']['parameters']['header'];
|
|
6731
|
-
type ListPosDevicesResponse = Readable
|
|
6776
|
+
type ListPosDevicesResponse = Readable<paths['/pos/devices']['get']['responses'][200]['content']['application/json']>;
|
|
6732
6777
|
type ListPosDevicesContent = ListPosDevicesResponse['content'];
|
|
6733
|
-
type ClaimPosDeviceResponse = Readable
|
|
6778
|
+
type ClaimPosDeviceResponse = Readable<paths['/pos/devices/{id}/claim']['post']['responses'][200]['content']['application/json']>;
|
|
6734
6779
|
type ClaimPosDeviceContent = ClaimPosDeviceResponse['content'];
|
|
6735
6780
|
type ClaimPosDevicePathParams = paths['/pos/devices/{id}/claim']['post']['parameters']['path'];
|
|
6736
|
-
type UnclaimPosDeviceResponse = Readable
|
|
6781
|
+
type UnclaimPosDeviceResponse = Readable<paths['/pos/devices/{id}/unclaim']['post']['responses'][200]['content']['application/json']>;
|
|
6737
6782
|
type UnclaimPosDeviceContent = UnclaimPosDeviceResponse['content'];
|
|
6738
6783
|
type UnclaimPosDevicePathParams = paths['/pos/devices/{id}/unclaim']['post']['parameters']['path'];
|
|
6739
|
-
type GetPosFulfillmentOptionsResponse = Readable
|
|
6784
|
+
type GetPosFulfillmentOptionsResponse = Readable<paths['/pos/fulfillment-options']['post']['responses'][200]['content']['application/json']>;
|
|
6740
6785
|
type GetPosFulfillmentOptionsContent = GetPosFulfillmentOptionsResponse['content'];
|
|
6741
|
-
type GetPosFulfillmentOptionsBody = Writable
|
|
6742
|
-
type ListPosLocationsResponse = Readable
|
|
6786
|
+
type GetPosFulfillmentOptionsBody = Writable<NonNullable<paths['/pos/fulfillment-options']['post']['requestBody']>['content']['application/json']>;
|
|
6787
|
+
type ListPosLocationsResponse = Readable<paths['/pos/locations']['get']['responses'][200]['content']['application/json']>;
|
|
6743
6788
|
type ListPosLocationsContent = ListPosLocationsResponse['content'];
|
|
6744
|
-
type CreatePosOrderResponse = Readable
|
|
6789
|
+
type CreatePosOrderResponse = Readable<paths['/pos/orders']['post']['responses'][200]['content']['application/json']>;
|
|
6745
6790
|
type CreatePosOrderContent = CreatePosOrderResponse['content'];
|
|
6746
|
-
type CreatePosOrderBody = Writable
|
|
6747
|
-
type PosGetPaymentStatusResponse = Readable
|
|
6791
|
+
type CreatePosOrderBody = Writable<NonNullable<paths['/pos/orders']['post']['requestBody']>['content']['application/json']>;
|
|
6792
|
+
type PosGetPaymentStatusResponse = Readable<paths['/pos/orders/{order_number}/payment-status']['get']['responses'][200]['content']['application/json']>;
|
|
6748
6793
|
type PosGetPaymentStatusContent = PosGetPaymentStatusResponse['content'];
|
|
6749
6794
|
type PosGetPaymentStatusPathParams = paths['/pos/orders/{order_number}/payment-status']['get']['parameters']['path'];
|
|
6750
|
-
type GetPosUserResponse = Readable
|
|
6795
|
+
type GetPosUserResponse = Readable<paths['/pos/users/{id}']['get']['responses'][200]['content']['application/json']>;
|
|
6751
6796
|
type GetPosUserContent = GetPosUserResponse['content'];
|
|
6752
6797
|
type GetPosUserPathParams = paths['/pos/users/{id}']['get']['parameters']['path'];
|
|
6753
6798
|
//#endregion
|
|
6754
6799
|
//#region src/types/admin-pos-api-types.d.ts
|
|
6755
|
-
type PosListInventoryResponse = Readable<paths$1['/pos/catalog/inventories']['get']['responses'][200]['content']['application/json']>;
|
|
6800
|
+
type PosListInventoryResponse = Readable$1<paths$1['/pos/catalog/inventories']['get']['responses'][200]['content']['application/json']>;
|
|
6756
6801
|
type PosListInventoryContent = PosListInventoryResponse['content'];
|
|
6757
6802
|
type PosListInventoryQuery = paths$1['/pos/catalog/inventories']['get']['parameters']['query'];
|
|
6758
|
-
type PosListInventoryActivityResponse = Readable<paths$1['/pos/catalog/inventories/activites']['get']['responses'][200]['content']['application/json']>;
|
|
6803
|
+
type PosListInventoryActivityResponse = Readable$1<paths$1['/pos/catalog/inventories/activites']['get']['responses'][200]['content']['application/json']>;
|
|
6759
6804
|
type PosListInventoryActivityContent = PosListInventoryActivityResponse['content'];
|
|
6760
6805
|
type PosListInventoryActivityQuery = paths$1['/pos/catalog/inventories/activites']['get']['parameters']['query'];
|
|
6761
|
-
type PosListInventoryDetailResponse = Readable<paths$1['/pos/catalog/inventories/detail']['get']['responses'][200]['content']['application/json']>;
|
|
6806
|
+
type PosListInventoryDetailResponse = Readable$1<paths$1['/pos/catalog/inventories/detail']['get']['responses'][200]['content']['application/json']>;
|
|
6762
6807
|
type PosListInventoryDetailContent = PosListInventoryDetailResponse['content'];
|
|
6763
6808
|
type PosListInventoryDetailQuery = paths$1['/pos/catalog/inventories/detail']['get']['parameters']['query'];
|
|
6764
|
-
type PosListCustomersResponse = Readable<paths$1['/pos/customers']['get']['responses'][200]['content']['application/json']>;
|
|
6809
|
+
type PosListCustomersResponse = Readable$1<paths$1['/pos/customers']['get']['responses'][200]['content']['application/json']>;
|
|
6765
6810
|
type PosListCustomersContent = PosListCustomersResponse['content'];
|
|
6766
6811
|
type PosListCustomersQuery = paths$1['/pos/customers']['get']['parameters']['query'];
|
|
6767
|
-
type PosGetCustomerDetailResponse = Readable<paths$1['/pos/customers/{id}']['get']['responses'][200]['content']['application/json']>;
|
|
6812
|
+
type PosGetCustomerDetailResponse = Readable$1<paths$1['/pos/customers/{id}']['get']['responses'][200]['content']['application/json']>;
|
|
6768
6813
|
type PosGetCustomerDetailContent = PosGetCustomerDetailResponse['content'];
|
|
6769
6814
|
type PosGetCustomerDetailPathParams = paths$1['/pos/customers/{id}']['get']['parameters']['path'];
|
|
6770
|
-
type PosListOrdersResponse = Readable<paths$1['/pos/orders']['get']['responses'][200]['content']['application/json']>;
|
|
6815
|
+
type PosListOrdersResponse = Readable$1<paths$1['/pos/orders']['get']['responses'][200]['content']['application/json']>;
|
|
6771
6816
|
type PosListOrdersContent = PosListOrdersResponse['content'];
|
|
6772
6817
|
type PosListOrdersQuery = paths$1['/pos/orders']['get']['parameters']['query'];
|
|
6773
|
-
type PosGetOrderDetailResponse = Readable<paths$1['/pos/orders/{order_number}']['get']['responses'][200]['content']['application/json']>;
|
|
6818
|
+
type PosGetOrderDetailResponse = Readable$1<paths$1['/pos/orders/{order_number}']['get']['responses'][200]['content']['application/json']>;
|
|
6774
6819
|
type PosGetOrderDetailContent = PosGetOrderDetailResponse['content'];
|
|
6775
6820
|
type PosGetOrderDetailPathParams = paths$1['/pos/orders/{order_number}']['get']['parameters']['path'];
|
|
6776
|
-
type PosListOrderActivityResponse = Readable<paths$1['/pos/orders/{order_number}/activity']['get']['responses'][200]['content']['application/json']>;
|
|
6821
|
+
type PosListOrderActivityResponse = Readable$1<paths$1['/pos/orders/{order_number}/activity']['get']['responses'][200]['content']['application/json']>;
|
|
6777
6822
|
type PosListOrderActivityContent = PosListOrderActivityResponse['content'];
|
|
6778
6823
|
type PosListOrderActivityPathParams = paths$1['/pos/orders/{order_number}/activity']['get']['parameters']['path'];
|
|
6779
|
-
type PosCheckOrderInventoryResponse = Readable<paths$1['/pos/orders/{order_number}/check-inventory']['get']['responses'][200]['content']['application/json']>;
|
|
6824
|
+
type PosCheckOrderInventoryResponse = Readable$1<paths$1['/pos/orders/{order_number}/check-inventory']['get']['responses'][200]['content']['application/json']>;
|
|
6780
6825
|
type PosCheckOrderInventoryContent = PosCheckOrderInventoryResponse['content'];
|
|
6781
6826
|
type PosCheckOrderInventoryPathParams = paths$1['/pos/orders/{order_number}/check-inventory']['get']['parameters']['path'];
|
|
6782
|
-
type PosGetOrderInvoiceResponse = Readable<paths$1['/pos/orders/{order_number}/invoice']['get']['responses'][200]['content']['application/json']>;
|
|
6827
|
+
type PosGetOrderInvoiceResponse = Readable$1<paths$1['/pos/orders/{order_number}/invoice']['get']['responses'][200]['content']['application/json']>;
|
|
6783
6828
|
type PosGetOrderInvoiceContent = PosGetOrderInvoiceResponse['content'];
|
|
6784
6829
|
type PosGetOrderInvoiceQuery = paths$1['/pos/orders/{order_number}/invoice']['get']['parameters']['query'];
|
|
6785
6830
|
type PosGetOrderInvoicePathParams = paths$1['/pos/orders/{order_number}/invoice']['get']['parameters']['path'];
|
|
6786
|
-
type PosGetOrderReceiptResponse = Readable<paths$1['/pos/orders/{order_number}/receipt']['get']['responses'][200]['content']['application/json']>;
|
|
6831
|
+
type PosGetOrderReceiptResponse = Readable$1<paths$1['/pos/orders/{order_number}/receipt']['get']['responses'][200]['content']['application/json']>;
|
|
6787
6832
|
type PosGetOrderReceiptContent = PosGetOrderReceiptResponse['content'];
|
|
6788
6833
|
type PosGetOrderReceiptQuery = paths$1['/pos/orders/{order_number}/receipt']['get']['parameters']['query'];
|
|
6789
6834
|
type PosGetOrderReceiptPathParams = paths$1['/pos/orders/{order_number}/receipt']['get']['parameters']['path'];
|
|
6790
|
-
type PosListOrderShipmentsResponse = Readable<paths$1['/pos/orders/{order_number}/shipments']['get']['responses'][200]['content']['application/json']>;
|
|
6835
|
+
type PosListOrderShipmentsResponse = Readable$1<paths$1['/pos/orders/{order_number}/shipments']['get']['responses'][200]['content']['application/json']>;
|
|
6791
6836
|
type PosListOrderShipmentsContent = PosListOrderShipmentsResponse['content'];
|
|
6792
6837
|
type PosListOrderShipmentsPathParams = paths$1['/pos/orders/{order_number}/shipments']['get']['parameters']['path'];
|
|
6793
|
-
type PosListShipmentsResponse = Readable<paths$1['/pos/shipping/shipments']['get']['responses'][200]['content']['application/json']>;
|
|
6838
|
+
type PosListShipmentsResponse = Readable$1<paths$1['/pos/shipping/shipments']['get']['responses'][200]['content']['application/json']>;
|
|
6794
6839
|
type PosListShipmentsContent = PosListShipmentsResponse['content'];
|
|
6795
6840
|
type PosListShipmentsQuery = paths$1['/pos/shipping/shipments']['get']['parameters']['query'];
|
|
6796
|
-
type PosRefundShortfallResponse = Readable<paths$1['/pos/shipping/shipments/{order_number}/refund-shortfall']['post']['responses'][200]['content']['application/json']>;
|
|
6841
|
+
type PosRefundShortfallResponse = Readable$1<paths$1['/pos/shipping/shipments/{order_number}/refund-shortfall']['post']['responses'][200]['content']['application/json']>;
|
|
6797
6842
|
type PosRefundShortfallPathParams = paths$1['/pos/shipping/shipments/{order_number}/refund-shortfall']['post']['parameters']['path'];
|
|
6798
|
-
type PosRefundShortfallBody = Writable<NonNullable<paths$1['/pos/shipping/shipments/{order_number}/refund-shortfall']['post']['requestBody']>['content']['application/json']>;
|
|
6799
|
-
type PosGetShipmentDetailResponse = Readable<paths$1['/pos/shipping/shipments/{reference_number}']['get']['responses'][200]['content']['application/json']>;
|
|
6843
|
+
type PosRefundShortfallBody = Writable$1<NonNullable<paths$1['/pos/shipping/shipments/{order_number}/refund-shortfall']['post']['requestBody']>['content']['application/json']>;
|
|
6844
|
+
type PosGetShipmentDetailResponse = Readable$1<paths$1['/pos/shipping/shipments/{reference_number}']['get']['responses'][200]['content']['application/json']>;
|
|
6800
6845
|
type PosGetShipmentDetailContent = PosGetShipmentDetailResponse['content'];
|
|
6801
6846
|
type PosGetShipmentDetailPathParams = paths$1['/pos/shipping/shipments/{reference_number}']['get']['parameters']['path'];
|
|
6802
|
-
type PosGetShipmentInvoiceResponse = Readable<paths$1['/pos/shipping/shipments/{reference_number}/invoice']['get']['responses'][200]['content']['application/json']>;
|
|
6847
|
+
type PosGetShipmentInvoiceResponse = Readable$1<paths$1['/pos/shipping/shipments/{reference_number}/invoice']['get']['responses'][200]['content']['application/json']>;
|
|
6803
6848
|
type PosGetShipmentInvoiceContent = PosGetShipmentInvoiceResponse['content'];
|
|
6804
6849
|
type PosGetShipmentInvoiceQuery = paths$1['/pos/shipping/shipments/{reference_number}/invoice']['get']['parameters']['query'];
|
|
6805
6850
|
type PosGetShipmentInvoicePathParams = paths$1['/pos/shipping/shipments/{reference_number}/invoice']['get']['parameters']['path'];
|
|
6806
|
-
type PosUpdateShipmentResponse = Readable<paths$1['/pos/shipping/shipments/{reference_number}/manual-update']['put']['responses'][200]['content']['application/json']>;
|
|
6851
|
+
type PosUpdateShipmentResponse = Readable$1<paths$1['/pos/shipping/shipments/{reference_number}/manual-update']['put']['responses'][200]['content']['application/json']>;
|
|
6807
6852
|
type PosUpdateShipmentContent = PosUpdateShipmentResponse['content'];
|
|
6808
6853
|
type PosUpdateShipmentPathParams = paths$1['/pos/shipping/shipments/{reference_number}/manual-update']['put']['parameters']['path'];
|
|
6809
|
-
type PosUpdateShipmentBody = Writable<NonNullable<paths$1['/pos/shipping/shipments/{reference_number}/manual-update']['put']['requestBody']>['content']['application/json']>;
|
|
6854
|
+
type PosUpdateShipmentBody = Writable$1<NonNullable<paths$1['/pos/shipping/shipments/{reference_number}/manual-update']['put']['requestBody']>['content']['application/json']>;
|
|
6810
6855
|
//#endregion
|
|
6811
6856
|
//#region src/lib/pos.d.ts
|
|
6812
6857
|
/**
|
|
@@ -7689,16 +7734,12 @@ declare class PosClient extends PosAPIClient {
|
|
|
7689
7734
|
* Search products
|
|
7690
7735
|
* @param body - Search criteria and parameters
|
|
7691
7736
|
* @param headers - Optional header parameters
|
|
7692
|
-
* @returns Promise with search results
|
|
7737
|
+
* @returns Promise with search results including SKUs, facet distribution, facet stats, and pagination
|
|
7693
7738
|
* @example
|
|
7694
7739
|
* ```typescript
|
|
7740
|
+
* // Basic search
|
|
7695
7741
|
* const { data, error } = await pos.searchProducts({
|
|
7696
7742
|
* query: "smartphone",
|
|
7697
|
-
* filters: {
|
|
7698
|
-
* category: ["electronics", "mobile"],
|
|
7699
|
-
* price_range: { min: 100, max: 1000 },
|
|
7700
|
-
* brand: ["Apple", "Samsung"] // facet names depend on product configuration
|
|
7701
|
-
* },
|
|
7702
7743
|
* page: 1,
|
|
7703
7744
|
* limit: 20
|
|
7704
7745
|
* });
|
|
@@ -7708,17 +7749,52 @@ declare class PosClient extends PosAPIClient {
|
|
|
7708
7749
|
* } else {
|
|
7709
7750
|
* console.log("Search results:", data.skus?.length || 0, "products found");
|
|
7710
7751
|
* console.log("Facet distribution:", data.facet_distribution);
|
|
7711
|
-
* console.log("
|
|
7752
|
+
* console.log("Facet stats:", data.facet_stats);
|
|
7753
|
+
* console.log("Pagination:", data.pagination);
|
|
7754
|
+
*
|
|
7712
7755
|
* data.skus?.forEach(sku => {
|
|
7713
|
-
* console.log(`Found: ${sku.
|
|
7756
|
+
* console.log(`Found: ${sku.product_name} - ${sku.pricing?.selling_price}`);
|
|
7714
7757
|
* });
|
|
7715
7758
|
* }
|
|
7716
7759
|
*
|
|
7760
|
+
* // With filter (string expression — Meilisearch syntax)
|
|
7761
|
+
* const { data: filtered, error: filteredError } = await pos.searchProducts({
|
|
7762
|
+
* query: "laptop",
|
|
7763
|
+
* filter: "pricing.selling_price 500 TO 2000 AND product_type = physical",
|
|
7764
|
+
* sort: ["pricing.selling_price:asc"],
|
|
7765
|
+
* facets: ["product_type", "categories.name", "tags"],
|
|
7766
|
+
* page: 1,
|
|
7767
|
+
* limit: 10
|
|
7768
|
+
* });
|
|
7769
|
+
*
|
|
7770
|
+
* // With filter (array of conditions — combined with AND)
|
|
7771
|
+
* const { data: arrayFiltered, error: arrayError } = await pos.searchProducts({
|
|
7772
|
+
* query: "shoes",
|
|
7773
|
+
* filter: ["product_type = physical", "rating >= 4", "stock_available > 0"],
|
|
7774
|
+
* sort: ["rating:desc"],
|
|
7775
|
+
* facets: ["*"],
|
|
7776
|
+
* page: 1,
|
|
7777
|
+
* limit: 25
|
|
7778
|
+
* });
|
|
7779
|
+
*
|
|
7780
|
+
* // With filter (nested arrays — inner arrays use OR, outer uses AND)
|
|
7781
|
+
* const { data: nestedFiltered, error: nestedError } = await pos.searchProducts({
|
|
7782
|
+
* query: "headphones",
|
|
7783
|
+
* filter: [
|
|
7784
|
+
* "pricing.selling_price 50 TO 300",
|
|
7785
|
+
* ["product_type = physical", "product_type = bundle"]
|
|
7786
|
+
* ],
|
|
7787
|
+
* page: 1,
|
|
7788
|
+
* limit: 25
|
|
7789
|
+
* });
|
|
7790
|
+
*
|
|
7717
7791
|
* // Override customer group ID for this specific request
|
|
7718
7792
|
* const { data: overrideData, error: overrideError } = await pos.searchProducts(
|
|
7719
7793
|
* {
|
|
7720
7794
|
* query: "laptop",
|
|
7721
|
-
*
|
|
7795
|
+
* filter: "categories.name = computers",
|
|
7796
|
+
* page: 1,
|
|
7797
|
+
* limit: 20
|
|
7722
7798
|
* },
|
|
7723
7799
|
* {
|
|
7724
7800
|
* "x-customer-group-id": "01H9XYZ12345USERID" // Override default SDK config
|
|
@@ -7817,32 +7893,33 @@ declare class PosClient extends PosAPIClient {
|
|
|
7817
7893
|
listUpsellProducts(query: PosListUpsellProductsQuery, headers?: PosListUpsellProductsHeaderParams): Promise<ApiResult<PosListUpsellProductsContent>>;
|
|
7818
7894
|
/**
|
|
7819
7895
|
* Get product details
|
|
7820
|
-
* @param pathParams -
|
|
7896
|
+
* @param pathParams - The path parameters. Accepts product ID or product slug.
|
|
7821
7897
|
* @param headers - Optional header parameters
|
|
7822
7898
|
* @returns Promise with product details
|
|
7823
7899
|
* @example
|
|
7824
7900
|
* ```typescript
|
|
7825
7901
|
* // Get product by ID
|
|
7826
7902
|
* const { data, error } = await pos.getProductDetail(
|
|
7827
|
-
* {
|
|
7903
|
+
* { product_id: "prod_123" }
|
|
7828
7904
|
* );
|
|
7829
7905
|
*
|
|
7830
7906
|
* if (error) {
|
|
7831
7907
|
* console.error("Failed to get product details:", error.message);
|
|
7832
7908
|
* } else {
|
|
7833
7909
|
* console.log("Product:", data.product.name);
|
|
7834
|
-
* console.log("Price:", data.product.
|
|
7835
|
-
* console.log("Description:", data.product.
|
|
7910
|
+
* console.log("Price:", data.product.pricing?.selling_price);
|
|
7911
|
+
* console.log("Description:", data.product.short_description);
|
|
7836
7912
|
* }
|
|
7837
7913
|
*
|
|
7838
|
-
* // Get product by slug
|
|
7914
|
+
* // Get product by slug (also accepted in place of product_id)
|
|
7839
7915
|
* const { data: slugData, error: slugError } = await pos.getProductDetail({
|
|
7840
|
-
*
|
|
7916
|
+
* product_id: "detox-candy"
|
|
7841
7917
|
* });
|
|
7842
7918
|
*
|
|
7843
7919
|
* // Override customer group ID for this specific request
|
|
7844
7920
|
* const { data: overrideData, error: overrideError } = await pos.getProductDetail(
|
|
7845
|
-
* {
|
|
7921
|
+
* { product_id: "detox-candy" },
|
|
7922
|
+
* undefined,
|
|
7846
7923
|
* {
|
|
7847
7924
|
* "x-customer-group-id": "premium_customers" // Override default SDK config
|
|
7848
7925
|
* }
|
|
@@ -7884,11 +7961,12 @@ declare class PosClient extends PosAPIClient {
|
|
|
7884
7961
|
listProductReviews(pathParams: PosListProductReviewsPathParams, query?: PosListProductReviewsQuery): Promise<ApiResult<PosListProductReviewsContent>>;
|
|
7885
7962
|
/**
|
|
7886
7963
|
* List product variants
|
|
7887
|
-
* @param pathParams -
|
|
7964
|
+
* @param pathParams - The path parameters. Accepts product ID or product slug.
|
|
7888
7965
|
* @param headers - Optional header parameters
|
|
7889
7966
|
* @returns Promise with product variants
|
|
7890
7967
|
* @example
|
|
7891
7968
|
* ```typescript
|
|
7969
|
+
* // By product ID
|
|
7892
7970
|
* const { data, error } = await pos.listProductVariants(
|
|
7893
7971
|
* { product_id: "prod_123" }
|
|
7894
7972
|
* );
|
|
@@ -7898,13 +7976,19 @@ declare class PosClient extends PosAPIClient {
|
|
|
7898
7976
|
* } else {
|
|
7899
7977
|
* console.log("Variants found:", data.variants?.length || 0);
|
|
7900
7978
|
* data.variants?.forEach(variant => {
|
|
7901
|
-
* console.log(`Variant: ${variant.name} - SKU: ${variant.sku} - Price: ${variant.
|
|
7979
|
+
* console.log(`Variant: ${variant.name} - SKU: ${variant.sku} - Price: ${variant.pricing?.selling_price}`);
|
|
7902
7980
|
* });
|
|
7903
7981
|
* }
|
|
7904
7982
|
*
|
|
7983
|
+
* // By product slug (also accepted in place of product_id)
|
|
7984
|
+
* const { data: slugData, error: slugError } = await pos.listProductVariants(
|
|
7985
|
+
* { product_id: "detox-candy" }
|
|
7986
|
+
* );
|
|
7987
|
+
*
|
|
7905
7988
|
* // Override customer group ID for this specific request
|
|
7906
7989
|
* const { data: overrideData, error: overrideError } = await pos.listProductVariants(
|
|
7907
7990
|
* { product_id: "prod_123" },
|
|
7991
|
+
* undefined,
|
|
7908
7992
|
* {
|
|
7909
7993
|
* "x-customer-group-id": "wholesale_customers" // Override default SDK config
|
|
7910
7994
|
* }
|
|
@@ -7914,11 +7998,12 @@ declare class PosClient extends PosAPIClient {
|
|
|
7914
7998
|
listProductVariants(pathParams: PosListProductVariantsPathParams, query?: PosListProductVariantsQuery, headers?: PosListProductVariantsHeaderParams): Promise<ApiResult<PosListProductVariantsContent>>;
|
|
7915
7999
|
/**
|
|
7916
8000
|
* Get variant details
|
|
7917
|
-
* @param pathParams -
|
|
8001
|
+
* @param pathParams - The path parameters. Accepts product ID or slug for product_id, and variant ID or slug for variant_id.
|
|
7918
8002
|
* @param headers - Optional header parameters
|
|
7919
8003
|
* @returns Promise with variant details
|
|
7920
8004
|
* @example
|
|
7921
8005
|
* ```typescript
|
|
8006
|
+
* // By product ID and variant ID
|
|
7922
8007
|
* const { data, error } = await pos.getVariantDetail(
|
|
7923
8008
|
* {
|
|
7924
8009
|
* product_id: "prod_123",
|
|
@@ -7931,16 +8016,25 @@ declare class PosClient extends PosAPIClient {
|
|
|
7931
8016
|
* } else {
|
|
7932
8017
|
* console.log("Variant:", data.variant.name);
|
|
7933
8018
|
* console.log("SKU:", data.variant.sku);
|
|
7934
|
-
* console.log("Price:", data.variant.
|
|
7935
|
-
* console.log("Stock:", data.variant.
|
|
8019
|
+
* console.log("Price:", data.variant.pricing?.selling_price);
|
|
8020
|
+
* console.log("Stock available:", data.variant.stock_available);
|
|
7936
8021
|
* }
|
|
7937
8022
|
*
|
|
8023
|
+
* // By product slug and variant slug (also accepted in place of IDs)
|
|
8024
|
+
* const { data: slugData, error: slugError } = await pos.getVariantDetail(
|
|
8025
|
+
* {
|
|
8026
|
+
* product_id: "detox-candy",
|
|
8027
|
+
* variant_id: "detox-candy-100g"
|
|
8028
|
+
* }
|
|
8029
|
+
* );
|
|
8030
|
+
*
|
|
7938
8031
|
* // Override customer group ID for this specific request
|
|
7939
8032
|
* const { data: overrideData, error: overrideError } = await pos.getVariantDetail(
|
|
7940
8033
|
* {
|
|
7941
8034
|
* product_id: "prod_123",
|
|
7942
8035
|
* variant_id: "var_456"
|
|
7943
8036
|
* },
|
|
8037
|
+
* undefined,
|
|
7944
8038
|
* {
|
|
7945
8039
|
* "x-customer-group-id": "wholesale_customers" // Override default SDK config
|
|
7946
8040
|
* }
|
|
@@ -8725,5 +8819,5 @@ declare class PosSDK {
|
|
|
8725
8819
|
getTenantId(): Promise<string | null>;
|
|
8726
8820
|
}
|
|
8727
8821
|
//#endregion
|
|
8728
|
-
export { AcceleratedRewardCouponPromotion, AcceleratedRewardRule, AdditionalProductDetails, ApiErrorResponse, ApiResult, ApplicableCoupon, ApplicablePromotion, AppliedCoupon, AppliedPromotion, AssociatedOption, AutoScaleBasedOnAmount, AutoScaleBasedOnQuantity, BankTransfer, BaseAPIClient, BaseSDKOptions, BooleanAttribute, BrowserTokenStorage, BuyXGetYCouponPromotion, BuyXGetYRule, BuyXGetYRuleBasedOnAmount, BuyXGetYRuleBasedOnQuantity, CardPayment, Cart,
|
|
8822
|
+
export { AcceleratedRewardCouponPromotion, AcceleratedRewardRule, AdditionalProductDetails, ApiErrorResponse, ApiResult, ApplicableCoupon, ApplicablePromotion, AppliedCoupon, AppliedPromotion, AssociatedOption, AutoScaleBasedOnAmount, AutoScaleBasedOnQuantity, BankTransfer, BaseAPIClient, BaseSDKOptions, BooleanAttribute, BrowserTokenStorage, BuyXGetYCouponPromotion, BuyXGetYRule, BuyXGetYRuleBasedOnAmount, BuyXGetYRuleBasedOnQuantity, CardPayment, Cart, CartBasedFulfillmentOptionInput, CartItem, CartShipment, Category, ClaimPosDeviceContent, ClaimPosDevicePathParams, ClaimPosDeviceResponse, CollectInStore, CollectInStoreAddress, CollectInStoreFulfillment, CollectInStoreFulfillmentInput, ColorAttribute, ColorOption, Coupon, CouponPromotionCommonDetail, CouponType, CreatePosOrderBody, CreatePosOrderContent, CreatePosOrderResponse, Currency, CustomSlabsBasedOnAmount, CustomSlabsBasedOnQuantity, CustomerAddress, CustomerAddressInput, DateAttribute, DebugLogger, DebugLoggerFn, DeliveryFulfillment, DeliveryFulfillmentInput, DeliveryOption, DiscountBasedPromotion, DiscountCouponPromotion, DiscountRule, Environment, FixedAmountDiscountRule, FixedPriceCouponPromotion, FixedPricePromotion, FixedPriceRule, FixedPriceRuleBasedAmount, FixedPriceRuleBasedQuantity, FreeGoodCouponPromotion, FreeGoodsPromotion, FreeGoodsRule, FreeShipingCouponPromotion, FulfillmentItem, FulfillmentItemInput, FulfillmentPreference, FulfillmentPreferenceInput, GetPosFulfillmentOptionsBody, GetPosFulfillmentOptionsContent, GetPosFulfillmentOptionsResponse, GetPosUserContent, GetPosUserPathParams, GetPosUserResponse, HeaderConfig, InapplicableCoupon, InapplicablePromotion, Item, ListPosDevicesContent, ListPosDevicesResponse, ListPosLocationsContent, ListPosLocationsResponse, LoginPosDeviceWithEmailBody, LoginPosDeviceWithEmailContent, LoginPosDeviceWithEmailHeaderParams, LoginPosDeviceWithEmailResponse, LoginPosDeviceWithPhoneBody, LoginPosDeviceWithPhoneContent, LoginPosDeviceWithPhoneHeaderParams, LoginPosDeviceWithPhoneResponse, LoginPosDeviceWithWhatsappBody, LoginPosDeviceWithWhatsappContent, LoginPosDeviceWithWhatsappHeaderParams, LoginPosDeviceWithWhatsappResponse, LogoutFromPosDeviceResponse, LotBatchDetail, MemoryTokenStorage, MultiSelectAttribute, NetbankingPayment, NumberAttribute, Order, OrderDetail, OrderItem, OrderPayment, OrderRefund, OrderShipment, Pagination, PairPosDeviceBody, PairPosDeviceContent, PairPosDeviceResponse, PartialCollectAndDelivery, PartialCollectAndDeliveryInput, PayWithCardInput, PayWithCashInput, PayWithUpiInput, PaymentInfo, PercentageDiscountRule, PosAPIClient, PosApplyCouponBody, PosApplyCouponContent, PosApplyCouponPathParams, PosApplyCouponResponse, PosClient, PosCreateCartAddressBody, PosCreateCartAddressContent, PosCreateCartAddressPathParams, PosCreateCartAddressResponse, PosCreateCartBody, PosCreateCartContent, PosCreateCartResponse, PosDeleteCartPathParams, PosDeleteCartResponse, PosDevice, PosDeviceClaimedUser, PosEvaluateCouponsContent, PosEvaluateCouponsPathParams, PosEvaluateCouponsResponse, PosEvaluatePromotionsContent, PosEvaluatePromotionsPathParams, PosEvaluatePromotionsResponse, PosGetCartContent, PosGetCartPathParams, PosGetCartResponse, PosGetPaymentStatusContent, PosGetPaymentStatusPathParams, PosGetPaymentStatusResponse, PosGetProductDetailContent, PosGetProductDetailHeaderParams, PosGetProductDetailPathParams, PosGetProductDetailQuery, PosGetProductDetailResponse, PosGetUserCartContent, PosGetUserCartPathParams, PosGetUserCartResponse, PosGetVariantDetailContent, PosGetVariantDetailHeaderParams, PosGetVariantDetailPathParams, PosGetVariantDetailQuery, PosGetVariantDetailResponse, PosListCategoriesContent, PosListCategoriesQuery, PosListCategoriesResponse, PosListCouponsContent, PosListCouponsHeaderParams, PosListCouponsResponse, PosListCrosssellProductsContent, PosListCrosssellProductsHeaderParams, PosListCrosssellProductsQuery, PosListCrosssellProductsResponse, PosListProductReviewsContent, PosListProductReviewsPathParams, PosListProductReviewsQuery, PosListProductReviewsResponse, PosListProductVariantsContent, PosListProductVariantsHeaderParams, PosListProductVariantsPathParams, PosListProductVariantsQuery, PosListProductVariantsResponse, PosListProductsContent, PosListProductsHeaderParams, PosListProductsQuery, PosListProductsResponse, PosListPromotionsContent, PosListPromotionsHeaderParams, PosListPromotionsResponse, PosListSimilarProductsContent, PosListSimilarProductsHeaderParams, PosListSimilarProductsQuery, PosListSimilarProductsResponse, PosListSkusContent, PosListSkusHeaderParams, PosListSkusQuery, PosListSkusResponse, PosListUpsellProductsContent, PosListUpsellProductsHeaderParams, PosListUpsellProductsQuery, PosListUpsellProductsResponse, PosLocation, PosRedeemCreditBalanceBody, PosRedeemCreditBalanceContent, PosRedeemCreditBalancePathParams, PosRedeemCreditBalanceResponse, PosRedeemLoyaltyPointsBody, PosRedeemLoyaltyPointsContent, PosRedeemLoyaltyPointsPathParams, PosRedeemLoyaltyPointsResponse, PosRemoveCouponContent, PosRemoveCouponPathParams, PosRemoveCouponResponse, PosRemoveCreditBalanceContent, PosRemoveCreditBalancePathParams, PosRemoveCreditBalanceResponse, PosRemoveLoyaltyPointsContent, PosRemoveLoyaltyPointsPathParams, PosRemoveLoyaltyPointsResponse, PosSDK, PosSDK as default, PosSDKOptions, PosSearchProductsBody, PosSearchProductsContent, PosSearchProductsHeaderParams, PosSearchProductsResponse, PosUpdateCartBody, PosUpdateCartContent, PosUpdateCartPathParams, PosUpdateCartResponse, PosUpdateCustomerWithEmailInput, PosUpdateCustomerWithIdInput, PosUpdateCustomerWithPhoneInput, PosUpdateFulfillmentPreferenceBody, PosUpdateFulfillmentPreferenceContent, PosUpdateFulfillmentPreferencePathParams, PosUpdateFulfillmentPreferenceResponse, PosUser, Product, ProductAttribute, ProductBundleItem, ProductCategory, ProductDetail, ProductImage, ProductPricing, ProductPromotion, ProductReview, ProductShipping, ProductSubscription, ProductVideo, Promotion, PromotionType, type Readable, RefreshPosAccessTokenBody, RefreshPosAccessTokenContent, RefreshPosAccessTokenResponse, ResponseUtils, SearchProductInput, SellerInfo, Seo, ShipmentItem, ShipmentStatus, SingleSelectAttribute, SingleSelectOption, SupportedDefaultHeaders, TextAttribute, type TokenStorage, UnclaimPosDeviceContent, UnclaimPosDevicePathParams, UnclaimPosDeviceResponse, UpdateCartItemInput, UpdatePosCartCustomerBody, UpdatePosCartCustomerContent, UpdatePosCartCustomerPathParams, UpdatePosCartCustomerResponse, UpiPayment, type UserInfo, Variant, VariantDetail, VariantOption, VerifyPosLoginOtpBody, VerifyPosLoginOtpContent, VerifyPosLoginOtpResponse, VolumeBasedCouponPromotion, VolumeBasedPromotion, VolumeBasedRule, WalletPayment, type Writable, type components, createDebugMiddleware, createTimeoutMiddleware, executeRequest, extractRequestBody, getPathnameFromUrl, mergeAndTransformHeaders, mergeHeaders, type operations, type paths, transformHeaders };
|
|
8729
8823
|
//# sourceMappingURL=index.d.mts.map
|