@commercengine/pos 0.3.11 → 0.4.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/dist/admin-types.d.mts +721 -773
- package/dist/index.d.mts +1630 -2163
- package/dist/index.mjs +31 -26
- package/dist/index.mjs.map +1 -1
- package/package.json +9 -10
package/dist/admin-types.d.mts
CHANGED
|
@@ -3,7 +3,14 @@
|
|
|
3
3
|
* This file was auto-generated by openapi-typescript.
|
|
4
4
|
* Do not make direct changes to the file.
|
|
5
5
|
*/
|
|
6
|
-
|
|
6
|
+
type $Read<T> = {
|
|
7
|
+
readonly $read: T;
|
|
8
|
+
};
|
|
9
|
+
type $Write<T> = {
|
|
10
|
+
readonly $write: T;
|
|
11
|
+
};
|
|
12
|
+
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;
|
|
13
|
+
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;
|
|
7
14
|
interface paths {
|
|
8
15
|
"/pos/catalog/inventories": {
|
|
9
16
|
parameters: {
|
|
@@ -165,6 +172,26 @@ interface paths {
|
|
|
165
172
|
patch?: never;
|
|
166
173
|
trace?: never;
|
|
167
174
|
};
|
|
175
|
+
"/pos/orders/{order_number}/check-inventory": {
|
|
176
|
+
parameters: {
|
|
177
|
+
query?: never;
|
|
178
|
+
header?: never;
|
|
179
|
+
path?: never;
|
|
180
|
+
cookie?: never;
|
|
181
|
+
};
|
|
182
|
+
/**
|
|
183
|
+
* Check Inventory
|
|
184
|
+
* @description Check Inventory
|
|
185
|
+
*/
|
|
186
|
+
get: operations["pos-check-order-inventory"];
|
|
187
|
+
put?: never;
|
|
188
|
+
post?: never;
|
|
189
|
+
delete?: never;
|
|
190
|
+
options?: never;
|
|
191
|
+
head?: never;
|
|
192
|
+
patch?: never;
|
|
193
|
+
trace?: never;
|
|
194
|
+
};
|
|
168
195
|
"/pos/orders/{order_number}/invoice": {
|
|
169
196
|
parameters: {
|
|
170
197
|
query?: never;
|
|
@@ -245,47 +272,47 @@ interface paths {
|
|
|
245
272
|
patch?: never;
|
|
246
273
|
trace?: never;
|
|
247
274
|
};
|
|
248
|
-
"/pos/shipping/shipments/{order_number}/
|
|
275
|
+
"/pos/shipping/shipments/{order_number}/refund-shortfall": {
|
|
249
276
|
parameters: {
|
|
250
277
|
query?: never;
|
|
251
278
|
header?: never;
|
|
252
279
|
path?: never;
|
|
253
280
|
cookie?: never;
|
|
254
281
|
};
|
|
282
|
+
get?: never;
|
|
283
|
+
put?: never;
|
|
255
284
|
/**
|
|
256
|
-
*
|
|
257
|
-
* @description
|
|
285
|
+
* Refund shortfall
|
|
286
|
+
* @description Refund shortfall
|
|
258
287
|
*/
|
|
259
|
-
|
|
260
|
-
put?: never;
|
|
261
|
-
post?: never;
|
|
288
|
+
post: operations["pos-refund-shortfall"];
|
|
262
289
|
delete?: never;
|
|
263
290
|
options?: never;
|
|
264
291
|
head?: never;
|
|
265
292
|
patch?: never;
|
|
266
293
|
trace?: never;
|
|
267
294
|
};
|
|
268
|
-
"/pos/shipping/shipments/{
|
|
295
|
+
"/pos/shipping/shipments/{reference_number}": {
|
|
269
296
|
parameters: {
|
|
270
297
|
query?: never;
|
|
271
298
|
header?: never;
|
|
272
299
|
path?: never;
|
|
273
300
|
cookie?: never;
|
|
274
301
|
};
|
|
275
|
-
get?: never;
|
|
276
|
-
put?: never;
|
|
277
302
|
/**
|
|
278
|
-
*
|
|
279
|
-
* @description
|
|
303
|
+
* Retrieve shipment detail
|
|
304
|
+
* @description Retrieve shipment detail
|
|
280
305
|
*/
|
|
281
|
-
|
|
306
|
+
get: operations["pos-get-shipment-detail"];
|
|
307
|
+
put?: never;
|
|
308
|
+
post?: never;
|
|
282
309
|
delete?: never;
|
|
283
310
|
options?: never;
|
|
284
311
|
head?: never;
|
|
285
312
|
patch?: never;
|
|
286
313
|
trace?: never;
|
|
287
314
|
};
|
|
288
|
-
"/pos/shipping/shipments/{reference_number}": {
|
|
315
|
+
"/pos/shipping/shipments/{reference_number}/activities": {
|
|
289
316
|
parameters: {
|
|
290
317
|
query?: never;
|
|
291
318
|
header?: never;
|
|
@@ -293,10 +320,10 @@ interface paths {
|
|
|
293
320
|
cookie?: never;
|
|
294
321
|
};
|
|
295
322
|
/**
|
|
296
|
-
* Retrieve shipment
|
|
297
|
-
* @description Retrieve shipment
|
|
323
|
+
* Retrieve shipment activities
|
|
324
|
+
* @description Retrieve shipment activities
|
|
298
325
|
*/
|
|
299
|
-
get: operations["pos-get-shipment-
|
|
326
|
+
get: operations["pos-get-shipment-activities"];
|
|
300
327
|
put?: never;
|
|
301
328
|
post?: never;
|
|
302
329
|
delete?: never;
|
|
@@ -353,8 +380,7 @@ interface components {
|
|
|
353
380
|
* @description Details about an active coupon applied to a cart/order
|
|
354
381
|
*/
|
|
355
382
|
AppliedCoupon: {
|
|
356
|
-
coupon_id: string;
|
|
357
|
-
/** @enum {unknown} */
|
|
383
|
+
coupon_id: string; /** @enum {unknown} */
|
|
358
384
|
coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
|
|
359
385
|
savings: number;
|
|
360
386
|
product_id: string | null;
|
|
@@ -367,8 +393,7 @@ interface components {
|
|
|
367
393
|
* @description Details about an active promotion applied to a cart/order
|
|
368
394
|
*/
|
|
369
395
|
AppliedPromotion: {
|
|
370
|
-
promotion_id: string;
|
|
371
|
-
/** @enum {unknown} */
|
|
396
|
+
promotion_id: string; /** @enum {unknown} */
|
|
372
397
|
promotion_type: "discount" | "free-goods" | "free-shipping" | "buy-x-get-y" | "volume-based";
|
|
373
398
|
savings: number;
|
|
374
399
|
product_id: string | null;
|
|
@@ -383,12 +408,13 @@ interface components {
|
|
|
383
408
|
* @description Bank transfer payment - IMPS, NEFT, RTGS
|
|
384
409
|
*/
|
|
385
410
|
BankTransfer: components["schemas"]["OrderPaymentInfo"] & {
|
|
386
|
-
/**
|
|
387
|
-
*
|
|
411
|
+
/**
|
|
412
|
+
* @description masked account number
|
|
413
|
+
* e.g. ************1234
|
|
414
|
+
*/
|
|
388
415
|
bank_account_number?: string;
|
|
389
416
|
bank_name?: string;
|
|
390
|
-
};
|
|
391
|
-
/** BusinessInfo */
|
|
417
|
+
}; /** BusinessInfo */
|
|
392
418
|
BusinessInfo: {
|
|
393
419
|
name?: string;
|
|
394
420
|
business_type?: string;
|
|
@@ -401,32 +427,61 @@ interface components {
|
|
|
401
427
|
* @description Payments using credit card, debit card
|
|
402
428
|
*/
|
|
403
429
|
CardPayment: components["schemas"]["OrderPaymentInfo"] & {
|
|
404
|
-
/**
|
|
405
|
-
*
|
|
406
|
-
|
|
407
|
-
|
|
430
|
+
/**
|
|
431
|
+
* @description masked card number
|
|
432
|
+
* e.g. ************1111
|
|
433
|
+
*/
|
|
434
|
+
card_number?: string; /** @enum {unknown} */
|
|
408
435
|
card_type?: "Visa" | "Master Card" | "Rupay";
|
|
409
|
-
};
|
|
410
|
-
|
|
436
|
+
}; /** CheckInventoryResponse */
|
|
437
|
+
CheckInventoryResponse: {
|
|
438
|
+
allowed_actions?: components["schemas"]["InventoryAction"][];
|
|
439
|
+
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
440
|
+
inventory_status?: components["schemas"]["InventoryStatus"];
|
|
441
|
+
inventory_detail?: {
|
|
442
|
+
product_id?: string;
|
|
443
|
+
variant_id?: string;
|
|
444
|
+
product_name?: string;
|
|
445
|
+
variant_name?: string;
|
|
446
|
+
sku?: string;
|
|
447
|
+
track_inventory?: boolean;
|
|
448
|
+
allow_backorder?: boolean;
|
|
449
|
+
requested_quantity?: number;
|
|
450
|
+
stock_quantity?: number;
|
|
451
|
+
inventory_status?: components["schemas"]["InventoryStatus"];
|
|
452
|
+
warehouses?: {
|
|
453
|
+
warehouse_id?: string;
|
|
454
|
+
warehouse_name?: string;
|
|
455
|
+
stock_quantity?: number;
|
|
456
|
+
inventory_status?: components["schemas"]["InventoryStatus"];
|
|
457
|
+
}[];
|
|
458
|
+
}[];
|
|
459
|
+
recommended_warehouses?: {
|
|
460
|
+
id?: string;
|
|
461
|
+
name?: string;
|
|
462
|
+
inventory_status?: components["schemas"]["InventoryStatus"];
|
|
463
|
+
}[];
|
|
464
|
+
}; /** CollectInStoreFulfillment */
|
|
411
465
|
CollectInStoreFulfillment: {
|
|
412
|
-
/**
|
|
413
|
-
|
|
466
|
+
/**
|
|
467
|
+
* @description discriminator enum property added by openapi-typescript
|
|
468
|
+
* @enum {string}
|
|
469
|
+
*/
|
|
470
|
+
fulfillment_type: "collect-in-store"; /** @enum {string} */
|
|
471
|
+
preference_type?: $Read<"user" | "auto">;
|
|
414
472
|
pickup_location_id: string;
|
|
415
|
-
|
|
416
|
-
/** Customer */
|
|
473
|
+
pickup_location_name?: $Read<string>;
|
|
474
|
+
}; /** Customer */
|
|
417
475
|
Customer: components["schemas"]["CustomerInfo"] & {
|
|
418
476
|
business?: components["schemas"]["BusinessInfo"];
|
|
419
477
|
segments?: components["schemas"]["CustomerSegment"][];
|
|
420
|
-
|
|
421
|
-
/** CustomerAddress */
|
|
478
|
+
address?: components["schemas"]["CustomerAddress"];
|
|
479
|
+
}; /** CustomerAddress */
|
|
422
480
|
CustomerAddress: {
|
|
423
|
-
|
|
481
|
+
id?: $Read<string>;
|
|
424
482
|
first_name: string;
|
|
425
|
-
last_name?: string;
|
|
426
|
-
/** @description
|
|
427
|
-
* */
|
|
428
|
-
country_code?: string;
|
|
429
|
-
/** @description 10 digit phone number without country code. */
|
|
483
|
+
last_name?: string | null; /** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
|
|
484
|
+
country_code?: string; /** @description 10 digit phone number without country code. */
|
|
430
485
|
phone: string;
|
|
431
486
|
email: string;
|
|
432
487
|
address_line1: string;
|
|
@@ -434,67 +489,51 @@ interface components {
|
|
|
434
489
|
landmark?: string | null;
|
|
435
490
|
pincode: string;
|
|
436
491
|
city: string;
|
|
437
|
-
state: string;
|
|
438
|
-
/** @
|
|
439
|
-
|
|
440
|
-
/** @description Use in shipping details only for third party. */
|
|
441
|
-
gstin?: string | null;
|
|
442
|
-
/** @description Use in shipping details only for third party. */
|
|
492
|
+
state: string; /** @enum {unknown} */
|
|
493
|
+
country: "India"; /** @description Use in shipping details only for third party. */
|
|
494
|
+
gstin?: string | null; /** @description Use in shipping details only for third party. */
|
|
443
495
|
business_name?: string | null;
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
496
|
+
is_phone_verified?: $Read<boolean>;
|
|
497
|
+
is_email_verified?: $Read<boolean>;
|
|
498
|
+
is_default_shipping?: boolean;
|
|
499
|
+
is_default_billing?: boolean;
|
|
500
|
+
}; /** CustomerDetail */
|
|
448
501
|
CustomerDetail: components["schemas"]["Customer"] & {
|
|
449
502
|
loyalty?: components["schemas"]["CustomerLoyalty"];
|
|
450
503
|
notification_preferences?: components["schemas"]["NotificationPreferences"];
|
|
451
|
-
};
|
|
452
|
-
/** CustomerInfo */
|
|
504
|
+
}; /** CustomerInfo */
|
|
453
505
|
CustomerInfo: {
|
|
454
|
-
/** @description user id */
|
|
455
|
-
readonly id?: string;
|
|
506
|
+
/** @description user id */id?: $Read<string>;
|
|
456
507
|
first_name?: string;
|
|
457
508
|
last_name?: string;
|
|
458
|
-
|
|
459
|
-
|
|
509
|
+
full_name?: $Read<string>;
|
|
510
|
+
profile_image_url?: $Read<string>;
|
|
460
511
|
country_code?: string;
|
|
461
512
|
phone?: string;
|
|
462
513
|
email?: string;
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
/**
|
|
467
|
-
|
|
468
|
-
/** Format: date-time */
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
/** Format: date-time */
|
|
473
|
-
readonly last_seen?: string;
|
|
474
|
-
readonly kyc_status?: boolean;
|
|
475
|
-
readonly is_verified?: boolean;
|
|
514
|
+
is_phone_verified?: $Read<boolean>;
|
|
515
|
+
is_email_verified?: $Read<boolean>;
|
|
516
|
+
is_whatsapp_verified?: $Read<boolean>;
|
|
517
|
+
status?: components["schemas"]["CustomerStatus"]; /** Format: date-time */
|
|
518
|
+
created_at?: $Read<string>; /** Format: date-time */
|
|
519
|
+
modified_at?: $Read<string>; /** Format: date-time */
|
|
520
|
+
last_seen?: $Read<string>;
|
|
521
|
+
kyc_status?: components["schemas"]["KycStatus"];
|
|
522
|
+
is_verified?: $Read<boolean>;
|
|
476
523
|
tags?: string[];
|
|
477
|
-
};
|
|
478
|
-
/** CustomerLoyalty */
|
|
524
|
+
}; /** CustomerLoyalty */
|
|
479
525
|
CustomerLoyalty: {
|
|
480
|
-
membership_number?: string;
|
|
481
|
-
/** @description total points
|
|
482
|
-
|
|
483
|
-
/** @description total
|
|
484
|
-
|
|
485
|
-
/** @description total
|
|
486
|
-
|
|
487
|
-
/** @description The total amount a customer has spent within the current loyalty program, excluding taxes, promotional discounts, and redeemed loyalty points. This value is used to determine tier eligibility and earning points calculation. */
|
|
488
|
-
total_spent?: number;
|
|
489
|
-
/** @description The total number of completed orders counted in the current loyalty program. */
|
|
490
|
-
total_orders?: number;
|
|
491
|
-
/** @description The total amount a customer has spent across all time, regardless of loyalty program participation. This includes all completed orders and excludes taxes, promotional discounts, and redeemed points. */
|
|
492
|
-
lifetime_spent?: number;
|
|
493
|
-
/** @description The total number of completed orders across all time, regardless of loyalty program. */
|
|
526
|
+
membership_number?: string; /** @description total points earned within the current loyalty program. */
|
|
527
|
+
points_earned?: number; /** @description total points redeemed within the current loyalty program. */
|
|
528
|
+
points_redeemed?: number; /** @description total points available. */
|
|
529
|
+
points_balance?: number; /** @description The total amount a customer has spent within the current loyalty program, excluding taxes, promotional discounts, and redeemed loyalty points. This value is used to determine tier eligibility and earning points calculation. */
|
|
530
|
+
total_spent?: number; /** @description The total number of completed orders counted in the current loyalty program. */
|
|
531
|
+
total_orders?: number; /** @description The total amount a customer has spent across all time, regardless of loyalty program participation. This includes all completed orders and excludes taxes, promotional discounts, and redeemed points. */
|
|
532
|
+
lifetime_spent?: number; /** @description The total number of completed orders across all time, regardless of loyalty program. */
|
|
494
533
|
lifetime_orders?: number;
|
|
495
534
|
/**
|
|
496
535
|
* Format: date-time
|
|
497
|
-
* @description
|
|
536
|
+
* @description The date and time when the customer first enrolled in the loyalty program.
|
|
498
537
|
*/
|
|
499
538
|
date_of_join?: string;
|
|
500
539
|
/**
|
|
@@ -504,7 +543,7 @@ interface components {
|
|
|
504
543
|
date_of_assign?: string | null;
|
|
505
544
|
/**
|
|
506
545
|
* Format: date-time
|
|
507
|
-
* @description
|
|
546
|
+
* @description The date and time when the customer’s current loyalty program cycle will reset, at which points earned, points redeemed, balance points, total spent, total orders will be cleared.
|
|
508
547
|
*/
|
|
509
548
|
date_of_reset?: string | null;
|
|
510
549
|
current_tier?: {
|
|
@@ -517,34 +556,40 @@ interface components {
|
|
|
517
556
|
total_spent_threshold?: number | null;
|
|
518
557
|
total_orders_threshold?: number | null;
|
|
519
558
|
};
|
|
520
|
-
|
|
521
|
-
|
|
559
|
+
name?: string; /** @enum {string} */
|
|
560
|
+
renewal_type?: "yearly" | "never" | "custom"; /** @enum {string} */
|
|
561
|
+
tier_upgrade_criteria?: "total-spent" | "total-orders" | "custom";
|
|
562
|
+
}; /** CustomerSegment */
|
|
522
563
|
CustomerSegment: {
|
|
523
564
|
id?: string;
|
|
524
565
|
name?: string;
|
|
525
|
-
};
|
|
526
|
-
/** DeliveryFulfillment */
|
|
566
|
+
}; /** @enum {unknown} */
|
|
567
|
+
CustomerStatus: "active" | "inactive"; /** DeliveryFulfillment */
|
|
527
568
|
DeliveryFulfillment: {
|
|
528
|
-
/**
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
569
|
+
/**
|
|
570
|
+
* @description discriminator enum property added by openapi-typescript
|
|
571
|
+
* @enum {string}
|
|
572
|
+
*/
|
|
573
|
+
fulfillment_type: "delivery"; /** @enum {string} */
|
|
574
|
+
preference_type?: $Read<"user" | "auto">;
|
|
575
|
+
shipping_provider_id: string | null;
|
|
576
|
+
shipping_provider_name?: $Read<string | null>;
|
|
532
577
|
courier_company_id?: string | null;
|
|
533
|
-
courier_company_name?: string | null
|
|
534
|
-
};
|
|
535
|
-
/** FulfillmentItem */
|
|
578
|
+
courier_company_name?: $Read<string | null>;
|
|
579
|
+
}; /** FulfillmentItem */
|
|
536
580
|
FulfillmentItem: {
|
|
537
581
|
product_id: string;
|
|
538
|
-
|
|
582
|
+
product_name: $Read<string>;
|
|
539
583
|
variant_id: string | null;
|
|
540
|
-
|
|
584
|
+
variant_name: $Read<string | null>;
|
|
541
585
|
quantity: number;
|
|
542
|
-
};
|
|
543
|
-
/** FulfillmentPreference */
|
|
586
|
+
}; /** FulfillmentPreference */
|
|
544
587
|
FulfillmentPreference: components["schemas"]["CollectInStoreFulfillment"] | components["schemas"]["DeliveryFulfillment"] | components["schemas"]["PartialCollectAndDelivery"];
|
|
545
|
-
/**
|
|
546
|
-
|
|
547
|
-
|
|
588
|
+
/**
|
|
589
|
+
* InventoryAction
|
|
590
|
+
* @enum {unknown}
|
|
591
|
+
*/
|
|
592
|
+
InventoryAction: "create-shipment" | "refund-shortfall" | "wait-for-inventory" | "reject-order"; /** InventoryActivity */
|
|
548
593
|
InventoryActivity: {
|
|
549
594
|
product_id?: string;
|
|
550
595
|
product_name?: string;
|
|
@@ -552,37 +597,29 @@ interface components {
|
|
|
552
597
|
variant_name?: string;
|
|
553
598
|
sku?: string;
|
|
554
599
|
warehouse_id?: string;
|
|
555
|
-
warehouse?: components["schemas"]["WarehouseBasicDetail"];
|
|
556
|
-
/** @enum {unknown} */
|
|
600
|
+
warehouse?: components["schemas"]["WarehouseBasicDetail"]; /** @enum {unknown} */
|
|
557
601
|
activity_type?: "add" | "reserve" | "reduce" | "adjust" | "update";
|
|
558
602
|
quantity?: number;
|
|
559
603
|
reason?: string;
|
|
560
|
-
lot_batch?: string;
|
|
561
|
-
/** Format: date */
|
|
562
|
-
mfg_date?: string;
|
|
563
|
-
/** Format: date */
|
|
604
|
+
lot_batch?: string; /** Format: date */
|
|
605
|
+
mfg_date?: string; /** Format: date */
|
|
564
606
|
exp_date?: string;
|
|
565
|
-
manufacturer?: string;
|
|
566
|
-
/** Format: date-time */
|
|
567
|
-
created_at?: string;
|
|
568
|
-
/** Format: date-time */
|
|
607
|
+
manufacturer?: string; /** Format: date-time */
|
|
608
|
+
created_at?: string; /** Format: date-time */
|
|
569
609
|
modified_at?: string;
|
|
570
|
-
};
|
|
571
|
-
/** InventoryDetail */
|
|
610
|
+
}; /** InventoryDetail */
|
|
572
611
|
InventoryDetail: components["schemas"]["ItemWiseInventory"] & {
|
|
573
612
|
details?: components["schemas"]["WarehouseWiseInventory"][];
|
|
574
|
-
};
|
|
613
|
+
}; /** @enum {unknown} */
|
|
614
|
+
InventoryStatus: "fulfilled" | "partially-fulfilled" | "not-fulfilled";
|
|
575
615
|
/**
|
|
576
616
|
* Invoice
|
|
577
617
|
* @description Invoice model
|
|
578
618
|
*/
|
|
579
619
|
Invoice: {
|
|
580
|
-
invoice_number?: string;
|
|
581
|
-
/**
|
|
582
|
-
|
|
583
|
-
/** @description Invoice Reference Number */
|
|
584
|
-
irn_number?: string;
|
|
585
|
-
/** @description Acknowledgement Number */
|
|
620
|
+
invoice_number?: string; /** Format: date-time */
|
|
621
|
+
invoice_date?: string; /** @description Invoice Reference Number */
|
|
622
|
+
irn_number?: string; /** @description Acknowledgement Number */
|
|
586
623
|
ack_number?: string;
|
|
587
624
|
/**
|
|
588
625
|
* Format: date-time
|
|
@@ -607,10 +644,8 @@ interface components {
|
|
|
607
644
|
igst?: number;
|
|
608
645
|
cgst?: number;
|
|
609
646
|
sgst?: number;
|
|
610
|
-
}[];
|
|
611
|
-
/** Format: date-time */
|
|
612
|
-
created_at?: string;
|
|
613
|
-
/** Format: date-time */
|
|
647
|
+
}[]; /** Format: date-time */
|
|
648
|
+
created_at?: string; /** Format: date-time */
|
|
614
649
|
modified_at?: string;
|
|
615
650
|
};
|
|
616
651
|
/**
|
|
@@ -638,8 +673,7 @@ interface components {
|
|
|
638
673
|
batch_number?: string;
|
|
639
674
|
expiry?: string;
|
|
640
675
|
amount?: number;
|
|
641
|
-
};
|
|
642
|
-
/** ItemWiseInventory */
|
|
676
|
+
}; /** ItemWiseInventory */
|
|
643
677
|
ItemWiseInventory: {
|
|
644
678
|
product_id?: string;
|
|
645
679
|
product_name?: string;
|
|
@@ -648,19 +682,19 @@ interface components {
|
|
|
648
682
|
sku?: string;
|
|
649
683
|
track_quantity?: boolean;
|
|
650
684
|
allow_backorder?: boolean;
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
685
|
+
track_lot_batch?: boolean; /** Format: decimal */
|
|
686
|
+
low_stock_threshold?: number; /** Format: decimal */
|
|
687
|
+
received_quantity?: number; /** Format: decimal */
|
|
688
|
+
reserved_quantity?: number; /** Format: decimal */
|
|
689
|
+
sold_quantity?: number; /** Format: decimal */
|
|
690
|
+
adjusted_quantity?: number; /** Format: decimal */
|
|
656
691
|
stock_quantity?: number;
|
|
657
|
-
|
|
658
|
-
/**
|
|
692
|
+
images?: components["schemas"]["ProductImage"][];
|
|
693
|
+
}; /** @enum {unknown} */
|
|
694
|
+
KycStatus: "pending" | "approved" | "rejected"; /** LotBatchWiseInventory */
|
|
659
695
|
LotBatchWiseInventory: components["schemas"]["ItemWiseInventory"] & {
|
|
660
|
-
lot_batch?: string;
|
|
661
|
-
/** Format: date */
|
|
662
|
-
mfg_date?: string;
|
|
663
|
-
/** Format: date */
|
|
696
|
+
lot_batch?: string; /** Format: date */
|
|
697
|
+
mfg_date?: string; /** Format: date */
|
|
664
698
|
exp_date?: string;
|
|
665
699
|
manufacturer?: string;
|
|
666
700
|
};
|
|
@@ -702,68 +736,45 @@ interface components {
|
|
|
702
736
|
* @description Set channel preferences for each type of
|
|
703
737
|
*/
|
|
704
738
|
NotificationPreferences: {
|
|
705
|
-
/** @description These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities. */
|
|
706
|
-
|
|
707
|
-
/** @description These notifications aim to engage users with promotional content and enhance their overall experience with the platform. */
|
|
708
|
-
promotional?: components["schemas"]["NotificationChannelPreferences"];
|
|
709
|
-
/** @description These notifications are often sent periodically as part of a subscription service.
|
|
710
|
-
* */
|
|
739
|
+
/** @description These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities. */transactional?: components["schemas"]["NotificationChannelPreferences"]; /** @description These notifications aim to engage users with promotional content and enhance their overall experience with the platform. */
|
|
740
|
+
promotional?: components["schemas"]["NotificationChannelPreferences"]; /** @description These notifications are often sent periodically as part of a subscription service. */
|
|
711
741
|
newsletter?: components["schemas"]["NotificationChannelPreferences"];
|
|
712
742
|
};
|
|
713
743
|
OpeningHours: {
|
|
714
744
|
monday: {
|
|
715
|
-
/** Format: time */
|
|
716
|
-
opening_time: string;
|
|
717
|
-
/** Format: time */
|
|
745
|
+
/** Format: time */opening_time: string; /** Format: time */
|
|
718
746
|
closing_time: string;
|
|
719
747
|
} | null;
|
|
720
748
|
tuesday: {
|
|
721
|
-
/** Format: time */
|
|
722
|
-
opening_time: string;
|
|
723
|
-
/** Format: time */
|
|
749
|
+
/** Format: time */opening_time: string; /** Format: time */
|
|
724
750
|
closing_time: string;
|
|
725
751
|
} | null;
|
|
726
752
|
wednesday: {
|
|
727
|
-
/** Format: time */
|
|
728
|
-
opening_time: string;
|
|
729
|
-
/** Format: time */
|
|
753
|
+
/** Format: time */opening_time: string; /** Format: time */
|
|
730
754
|
closing_time: string;
|
|
731
755
|
} | null;
|
|
732
756
|
thursday: {
|
|
733
|
-
/** Format: time */
|
|
734
|
-
opening_time: string;
|
|
735
|
-
/** Format: time */
|
|
757
|
+
/** Format: time */opening_time: string; /** Format: time */
|
|
736
758
|
closing_time: string;
|
|
737
759
|
} | null;
|
|
738
760
|
friday: {
|
|
739
|
-
/** Format: time */
|
|
740
|
-
opening_time: string;
|
|
741
|
-
/** Format: time */
|
|
761
|
+
/** Format: time */opening_time: string; /** Format: time */
|
|
742
762
|
closing_time: string;
|
|
743
763
|
} | null;
|
|
744
764
|
saturday: {
|
|
745
|
-
/** Format: time */
|
|
746
|
-
opening_time: string;
|
|
747
|
-
/** Format: time */
|
|
765
|
+
/** Format: time */opening_time: string; /** Format: time */
|
|
748
766
|
closing_time: string;
|
|
749
767
|
} | null;
|
|
750
768
|
sunday: {
|
|
751
|
-
/** Format: time */
|
|
752
|
-
opening_time: string;
|
|
753
|
-
/** Format: time */
|
|
769
|
+
/** Format: time */opening_time: string; /** Format: time */
|
|
754
770
|
closing_time: string;
|
|
755
771
|
} | null;
|
|
756
|
-
};
|
|
757
|
-
/** Order */
|
|
772
|
+
}; /** Order */
|
|
758
773
|
Order: {
|
|
759
|
-
order_number?: string;
|
|
760
|
-
/** Format: date-time */
|
|
774
|
+
order_number?: string; /** Format: date-time */
|
|
761
775
|
order_date?: string;
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
/** @enum {string} */
|
|
765
|
-
payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refunded";
|
|
766
|
-
/** Format: date-time */
|
|
776
|
+
status?: components["schemas"]["OrderStatus"];
|
|
777
|
+
payment_status?: components["schemas"]["PaymentStatus"]; /** Format: date-time */
|
|
767
778
|
payment_success_date?: string;
|
|
768
779
|
customer_id?: string;
|
|
769
780
|
customer_email?: string | null;
|
|
@@ -772,29 +783,19 @@ interface components {
|
|
|
772
783
|
is_promotion_applied?: boolean;
|
|
773
784
|
promotion_discount_amount?: number | null;
|
|
774
785
|
is_coupon_applied?: boolean;
|
|
775
|
-
coupon_code?: string | null;
|
|
776
|
-
/** Format: double */
|
|
786
|
+
coupon_code?: string | null; /** Format: double */
|
|
777
787
|
coupon_discount_amount?: number | null;
|
|
778
|
-
on_subscription?: boolean;
|
|
779
|
-
/** Format: double */
|
|
780
|
-
|
|
781
|
-
/** Format: double */
|
|
782
|
-
|
|
783
|
-
/** Format: double */
|
|
784
|
-
|
|
785
|
-
/** Format: double */
|
|
786
|
-
shipping_amount?: number;
|
|
787
|
-
/** Format: double */
|
|
788
|
-
shipping_total_tax?: number;
|
|
789
|
-
/** Format: double */
|
|
790
|
-
shipping_amount_including_tax?: number;
|
|
791
|
-
/** Format: double */
|
|
792
|
-
total_tax?: number;
|
|
793
|
-
/** Format: double */
|
|
788
|
+
on_subscription?: boolean; /** Format: double */
|
|
789
|
+
subtotal?: number; /** Format: double */
|
|
790
|
+
item_total_tax?: number; /** Format: double */
|
|
791
|
+
subtotal_including_tax?: number; /** Format: double */
|
|
792
|
+
shipping_amount?: number; /** Format: double */
|
|
793
|
+
shipping_total_tax?: number; /** Format: double */
|
|
794
|
+
shipping_amount_including_tax?: number; /** Format: double */
|
|
795
|
+
total_tax?: number; /** Format: double */
|
|
794
796
|
grand_total?: number;
|
|
795
797
|
loyalty_point_redeemed?: number;
|
|
796
|
-
credit_balance_used?: number;
|
|
797
|
-
/** Format: double */
|
|
798
|
+
credit_balance_used?: number; /** Format: double */
|
|
798
799
|
to_be_paid?: number;
|
|
799
800
|
loyalty_point_earned?: number;
|
|
800
801
|
order_items_count?: number;
|
|
@@ -802,201 +803,163 @@ interface components {
|
|
|
802
803
|
name?: string;
|
|
803
804
|
code?: string;
|
|
804
805
|
symbol?: string;
|
|
805
|
-
};
|
|
806
|
-
/** Format: date-time */
|
|
807
|
-
created_at?: string;
|
|
808
|
-
/** Format: date-time */
|
|
806
|
+
}; /** Format: date-time */
|
|
807
|
+
created_at?: string; /** Format: date-time */
|
|
809
808
|
modified_at?: string;
|
|
810
|
-
};
|
|
811
|
-
/** OrderActivity */
|
|
809
|
+
}; /** @enum {unknown} */
|
|
810
|
+
OrderAction: "create-shipment" | "download-invoice" | "inventory-check" | "refresh-payment-status" | "return-replace" | "update-payment-status" | "cancel-order"; /** OrderActivity */
|
|
812
811
|
OrderActivity: {
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
comment: string;
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
/** Format: date-time */
|
|
822
|
-
readonly modified_at?: string;
|
|
823
|
-
};
|
|
824
|
-
/** OrderDetail */
|
|
812
|
+
activity_type?: $Read<string>;
|
|
813
|
+
order_status?: $Read<string>;
|
|
814
|
+
comment: string; /** @enum {unknown} */
|
|
815
|
+
user_type?: $Read<"customer" | "admin" | "system">;
|
|
816
|
+
user_name?: $Read<string>; /** Format: date-time */
|
|
817
|
+
created_at?: $Read<string>; /** Format: date-time */
|
|
818
|
+
modified_at?: $Read<string>;
|
|
819
|
+
}; /** OrderDetail */
|
|
825
820
|
OrderDetail: {
|
|
826
|
-
order_number
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
fulfillment_type?: components["schemas"]["FulfillmentType"];
|
|
847
|
-
fulfillment_preference?: components["schemas"]["FulfillmentPreference"];
|
|
848
|
-
sales_channel?: {
|
|
849
|
-
id?: string;
|
|
850
|
-
name?: string;
|
|
851
|
-
type?: string;
|
|
821
|
+
order_number: string; /** Format: date-time */
|
|
822
|
+
order_date: string;
|
|
823
|
+
status: components["schemas"]["OrderStatus"];
|
|
824
|
+
payment_status: components["schemas"]["PaymentStatus"];
|
|
825
|
+
payment_success_date: string | null;
|
|
826
|
+
customer_id: string;
|
|
827
|
+
customer_email: string | null;
|
|
828
|
+
customer_phone: string | null;
|
|
829
|
+
customer_note: string | null;
|
|
830
|
+
is_promotion_applied: boolean; /** Format: double */
|
|
831
|
+
promotion_discount_amount: number | null;
|
|
832
|
+
is_coupon_applied: boolean;
|
|
833
|
+
coupon_code: string | null; /** Format: double */
|
|
834
|
+
coupon_discount_amount: number | null;
|
|
835
|
+
on_subscription: boolean;
|
|
836
|
+
fulfillment_preference: components["schemas"]["FulfillmentPreference"];
|
|
837
|
+
sales_channel: {
|
|
838
|
+
id: string;
|
|
839
|
+
name: string;
|
|
840
|
+
type: string;
|
|
852
841
|
};
|
|
853
|
-
metadata
|
|
842
|
+
metadata: {
|
|
854
843
|
[key: string]: string;
|
|
855
|
-
};
|
|
856
|
-
/** Format: double */
|
|
857
|
-
|
|
858
|
-
/** Format: double */
|
|
859
|
-
|
|
860
|
-
/** Format: double */
|
|
861
|
-
|
|
862
|
-
/** Format: double */
|
|
863
|
-
|
|
864
|
-
/** Format: double */
|
|
865
|
-
|
|
866
|
-
/** Format: double */
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
loyalty_point_redeemed?: number;
|
|
875
|
-
credit_balance_used?: number;
|
|
876
|
-
/** Format: double */
|
|
877
|
-
to_be_paid?: number;
|
|
878
|
-
loyalty_point_earned?: number;
|
|
879
|
-
order_items_count?: number;
|
|
880
|
-
order_items?: components["schemas"]["OrderItem"][];
|
|
881
|
-
billing_address?: components["schemas"]["CustomerAddress"];
|
|
882
|
-
shipping_address?: components["schemas"]["CustomerAddress"];
|
|
883
|
-
currency?: {
|
|
844
|
+
}; /** Format: double */
|
|
845
|
+
subtotal: number; /** Format: double */
|
|
846
|
+
subtotal_tax: number; /** Format: double */
|
|
847
|
+
subtotal_including_tax: number; /** Format: double */
|
|
848
|
+
shipping_amount: number; /** Format: double */
|
|
849
|
+
shipping_tax_rate: number; /** Format: double */
|
|
850
|
+
shipping_total_tax: number; /** Format: double */
|
|
851
|
+
shipping_amount_including_tax: number; /** Format: double */
|
|
852
|
+
total_tax: number; /** Format: double */
|
|
853
|
+
grand_total: number; /** Format: double */
|
|
854
|
+
loyalty_point_redeemed: number; /** Format: double */
|
|
855
|
+
credit_balance_used: number; /** Format: double */
|
|
856
|
+
to_be_paid: number; /** Format: double */
|
|
857
|
+
loyalty_point_earned: number;
|
|
858
|
+
order_items_count: number;
|
|
859
|
+
order_items: components["schemas"]["OrderItem"][];
|
|
860
|
+
billing_address: components["schemas"]["CustomerAddress"];
|
|
861
|
+
shipping_address: components["schemas"]["CustomerAddress"];
|
|
862
|
+
currency: {
|
|
884
863
|
name?: string;
|
|
885
864
|
code?: string;
|
|
886
865
|
symbol?: string;
|
|
887
866
|
};
|
|
888
|
-
feedback
|
|
889
|
-
allowed_actions
|
|
890
|
-
applied_coupons
|
|
891
|
-
applied_promotions
|
|
892
|
-
payments
|
|
893
|
-
shipments
|
|
894
|
-
/** Format: date-time */
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
modified_at?: string;
|
|
898
|
-
};
|
|
899
|
-
/** OrderItem */
|
|
867
|
+
feedback: string | null;
|
|
868
|
+
allowed_actions: components["schemas"]["OrderAction"][];
|
|
869
|
+
applied_coupons: components["schemas"]["AppliedCoupon"][];
|
|
870
|
+
applied_promotions: components["schemas"]["AppliedPromotion"][];
|
|
871
|
+
payments: components["schemas"]["OrderPayment"][];
|
|
872
|
+
shipments: components["schemas"]["OrderShipment"][]; /** Format: date-time */
|
|
873
|
+
created_at: string; /** Format: date-time */
|
|
874
|
+
modified_at: string;
|
|
875
|
+
}; /** OrderItem */
|
|
900
876
|
OrderItem: {
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
877
|
+
product_id?: $Read<string>;
|
|
878
|
+
product_name?: $Read<string>;
|
|
879
|
+
product_image_url?: $Read<string | null>;
|
|
904
880
|
sku: string;
|
|
905
|
-
|
|
906
|
-
|
|
881
|
+
on_offer?: $Read<boolean>;
|
|
882
|
+
on_promotion?: $Read<boolean>;
|
|
907
883
|
on_subscription?: boolean;
|
|
908
884
|
subscription_plan?: string | null;
|
|
909
|
-
|
|
910
|
-
|
|
885
|
+
subscription_interval?: $Read<number | null>;
|
|
886
|
+
subscription_frequency?: $Read<string | null>;
|
|
911
887
|
quantity: number;
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
/** Format: double */
|
|
915
|
-
|
|
916
|
-
/** Format: double */
|
|
917
|
-
|
|
918
|
-
/** Format:
|
|
919
|
-
|
|
920
|
-
/** Format: double */
|
|
921
|
-
|
|
922
|
-
/**
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
/** Format: double */
|
|
927
|
-
readonly tax_amount?: number;
|
|
928
|
-
/** Format: double */
|
|
929
|
-
readonly shipping_additional_cost?: number;
|
|
888
|
+
free_quantity?: $Read<number>;
|
|
889
|
+
is_free_item?: $Read<boolean>; /** Format: double */
|
|
890
|
+
selling_price?: $Read<number>; /** Format: double */
|
|
891
|
+
listing_price?: $Read<number>; /** Format: double */
|
|
892
|
+
promotion_discount_amount?: $Read<number>; /** Format: double */
|
|
893
|
+
coupon_discount_amount?: $Read<number>; /** @enum {unknown} */
|
|
894
|
+
tax_type?: $Read<"GST">; /** Format: float */
|
|
895
|
+
tax_rate?: $Read<number>; /** Format: double */
|
|
896
|
+
tax_amount?: $Read<number>; /** Format: double */
|
|
897
|
+
handling_charge_excluding_tax?: $Read<number>; /** Format: double */
|
|
898
|
+
handling_charge_including_tax?: number; /** Format: double */
|
|
899
|
+
handling_charge_tax_rate?: number;
|
|
900
|
+
variant_id?: string | null;
|
|
901
|
+
variant_name?: string | null;
|
|
930
902
|
};
|
|
931
903
|
/**
|
|
932
904
|
* OrderList
|
|
933
905
|
* @description order list model
|
|
934
906
|
*/
|
|
935
907
|
OrderList: {
|
|
936
|
-
/** @description Order id. Same as order number. */
|
|
937
|
-
|
|
938
|
-
/** @description Unique number associated with the order. */
|
|
939
|
-
order_number?: string;
|
|
908
|
+
/** @description Order id. Same as order number. */id: string; /** @description Unique number associated with the order. */
|
|
909
|
+
order_number: string;
|
|
940
910
|
/**
|
|
941
911
|
* Format: date-time
|
|
942
912
|
* @description Date and time when the order was placed.
|
|
943
913
|
*/
|
|
944
|
-
order_date
|
|
914
|
+
order_date: string;
|
|
915
|
+
status: components["schemas"]["OrderStatus"];
|
|
916
|
+
payment_status: components["schemas"]["PaymentStatus"]; /** @description Date and time when the payment for the order was successfully processed. */
|
|
917
|
+
payment_success_date: string | null; /** @enum {unknown} */
|
|
918
|
+
fulfillment_type: "collect-in-store" | "delivery"; /** @description Indicates whether the order includes subscription items. */
|
|
919
|
+
on_subscription: boolean;
|
|
945
920
|
/**
|
|
946
|
-
*
|
|
947
|
-
* @
|
|
921
|
+
* Format: double
|
|
922
|
+
* @description Total amount for the order, including all items, taxes, and discounts.
|
|
948
923
|
*/
|
|
949
|
-
|
|
924
|
+
grand_total: number;
|
|
950
925
|
/**
|
|
951
|
-
*
|
|
952
|
-
* @
|
|
926
|
+
* Format: double
|
|
927
|
+
* @description Number of loyalty points redeemed in the order.
|
|
953
928
|
*/
|
|
954
|
-
|
|
955
|
-
/** @description Date and time when the payment for the order was successfully processed. */
|
|
956
|
-
payment_success_date?: string | null;
|
|
957
|
-
/** @enum {unknown} */
|
|
958
|
-
fulfillment_type?: "collect-in-store" | "delivery";
|
|
959
|
-
/** @description Indicates whether the order includes subscription items. */
|
|
960
|
-
on_subscription?: boolean;
|
|
929
|
+
loyalty_point_redeemed: number;
|
|
961
930
|
/**
|
|
962
931
|
* Format: double
|
|
963
|
-
* @description
|
|
932
|
+
* @description Amount of credit balance used in the order.
|
|
964
933
|
*/
|
|
965
|
-
|
|
966
|
-
/** @description Number of loyalty points redeemed in the order. */
|
|
967
|
-
loyalty_point_redeemed?: number;
|
|
968
|
-
/** @description Amount of credit balance used in the order. */
|
|
969
|
-
credit_balance_used?: number;
|
|
934
|
+
credit_balance_used: number;
|
|
970
935
|
/**
|
|
971
936
|
* Format: double
|
|
972
937
|
* @description Amount remaining to be paid for the order.
|
|
973
938
|
*/
|
|
974
|
-
to_be_paid
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
currency
|
|
984
|
-
name
|
|
985
|
-
code
|
|
986
|
-
symbol
|
|
939
|
+
to_be_paid: number; /** @description Total count of items included in the order. */
|
|
940
|
+
order_items_count: number;
|
|
941
|
+
order_items: components["schemas"]["OrderItem"][];
|
|
942
|
+
customer_id: string;
|
|
943
|
+
customer_note: string | null;
|
|
944
|
+
billing_address: components["schemas"]["CustomerAddress"];
|
|
945
|
+
shipping_address: components["schemas"]["CustomerAddress"]; /** Format: double */
|
|
946
|
+
loyalty_point_earned: number;
|
|
947
|
+
coupon_code: string | null;
|
|
948
|
+
currency: {
|
|
949
|
+
name: string;
|
|
950
|
+
code: string;
|
|
951
|
+
symbol: string;
|
|
987
952
|
};
|
|
988
953
|
sales_channel?: {
|
|
989
|
-
id
|
|
990
|
-
name
|
|
991
|
-
type
|
|
954
|
+
id: string;
|
|
955
|
+
name: string;
|
|
956
|
+
type: string;
|
|
992
957
|
};
|
|
993
958
|
metadata?: {
|
|
994
959
|
[key: string]: string;
|
|
995
|
-
};
|
|
996
|
-
/** Format: date-time */
|
|
997
|
-
|
|
998
|
-
/** Format: date-time */
|
|
999
|
-
modified_at?: string;
|
|
960
|
+
}; /** Format: date-time */
|
|
961
|
+
created_at: string; /** Format: date-time */
|
|
962
|
+
modified_at: string;
|
|
1000
963
|
};
|
|
1001
964
|
/**
|
|
1002
965
|
* OrderPayment
|
|
@@ -1008,21 +971,15 @@ interface components {
|
|
|
1008
971
|
* @description Common fields in all types of payments.
|
|
1009
972
|
*/
|
|
1010
973
|
OrderPaymentInfo: {
|
|
1011
|
-
/** @enum {unknown} */
|
|
1012
|
-
|
|
1013
|
-
request_number?: string;
|
|
1014
|
-
/** Format: double */
|
|
974
|
+
/** @enum {unknown} */transaction_type?: "payment" | "refund";
|
|
975
|
+
request_number?: string; /** Format: double */
|
|
1015
976
|
amount?: number;
|
|
1016
|
-
/**
|
|
1017
|
-
payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated";
|
|
1018
|
-
/** Format: date-time */
|
|
977
|
+
payment_status?: components["schemas"]["PaymentStatus"]; /** Format: date-time */
|
|
1019
978
|
payment_date?: string;
|
|
1020
|
-
payment_reference_number?: string | null;
|
|
1021
|
-
/** @enum {unknown} */
|
|
979
|
+
payment_reference_number?: string | null; /** @enum {unknown} */
|
|
1022
980
|
payment_method?: "Credit Card" | "Debit Card" | "Netbanking" | "UPI" | "Wallet" | "Loyalty Point" | "IMPS" | "NEFT" | "RTGS";
|
|
1023
981
|
icon_url?: string;
|
|
1024
|
-
};
|
|
1025
|
-
/** OrderReceiptJsonFormat */
|
|
982
|
+
}; /** OrderReceiptJsonFormat */
|
|
1026
983
|
OrderReceiptJsonFormat: components["schemas"]["Order"] & {
|
|
1027
984
|
billing_address?: components["schemas"]["CustomerAddress"];
|
|
1028
985
|
shipping_address?: components["schemas"]["CustomerAddress"];
|
|
@@ -1035,33 +992,40 @@ interface components {
|
|
|
1035
992
|
*/
|
|
1036
993
|
OrderShipment: {
|
|
1037
994
|
reference_number?: string;
|
|
1038
|
-
|
|
1039
|
-
status?: "pending" | "approved" | "shipped" | "delivered" | "cancelled";
|
|
995
|
+
status?: components["schemas"]["ShipmentStatus"];
|
|
1040
996
|
total_weight?: number;
|
|
1041
|
-
total_boxes?: number;
|
|
997
|
+
total_boxes?: number | null;
|
|
1042
998
|
shipment_items_count?: number;
|
|
1043
|
-
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
1044
|
-
/** Format: double */
|
|
1045
|
-
|
|
1046
|
-
/** Format: double */
|
|
1047
|
-
shipping_tax_amount?: number;
|
|
1048
|
-
/** Format: double */
|
|
999
|
+
shipment_items?: components["schemas"]["ShipmentItem"][]; /** Format: double */
|
|
1000
|
+
shipping_amount?: number; /** Format: double */
|
|
1001
|
+
shipping_tax_amount?: number; /** Format: double */
|
|
1049
1002
|
shipping_amount_including_tax?: number;
|
|
1050
|
-
courier_company_id?: string;
|
|
1051
|
-
courier_company_name?: string;
|
|
1003
|
+
courier_company_id?: string | null;
|
|
1004
|
+
courier_company_name?: string | null;
|
|
1052
1005
|
shipping_label_url?: string;
|
|
1053
|
-
awb_no?: string;
|
|
1054
|
-
eta_delivery?: string;
|
|
1055
|
-
/** Format: date-time */
|
|
1056
|
-
|
|
1057
|
-
/** Format: date-time */
|
|
1058
|
-
|
|
1059
|
-
cancellation_reason?: string;
|
|
1060
|
-
/** Format: date-time */
|
|
1061
|
-
created_at?: string;
|
|
1062
|
-
/** Format: date-time */
|
|
1006
|
+
awb_no?: string | null; /** Format: date-time */
|
|
1007
|
+
eta_delivery?: string | null; /** Format: date-time */
|
|
1008
|
+
shipped_date?: string | null; /** Format: date-time */
|
|
1009
|
+
delivered_date?: string | null;
|
|
1010
|
+
cancellation_reason?: string | null; /** Format: date-time */
|
|
1011
|
+
created_at?: string; /** Format: date-time */
|
|
1063
1012
|
modified_at?: string;
|
|
1064
|
-
};
|
|
1013
|
+
}; /** OrderShipmentDetail */
|
|
1014
|
+
OrderShipmentDetail: {
|
|
1015
|
+
order_number: string; /** Format: date-time */
|
|
1016
|
+
order_date: string;
|
|
1017
|
+
order_status: string;
|
|
1018
|
+
sales_channel: {
|
|
1019
|
+
id: string;
|
|
1020
|
+
name: string;
|
|
1021
|
+
type: string;
|
|
1022
|
+
};
|
|
1023
|
+
payment_status: components["schemas"]["PaymentStatus"];
|
|
1024
|
+
customer_name: string;
|
|
1025
|
+
shipments: components["schemas"]["Shipment"][];
|
|
1026
|
+
allowed_actions: components["schemas"]["ShipmentAction"][];
|
|
1027
|
+
}; /** @enum {unknown} */
|
|
1028
|
+
OrderStatus: "draft" | "awaiting_approval" | "confirmed" | "scheduled_requested" | "partially_scheduled" | "awaiting_shipment" | "shipped" | "partially_shipped" | "undelivered" | "partially_undelivered" | "return_to_origin" | "partially_return_to_origin" | "complete" | "partially_delivered" | "cancelled" | "pending" | "lost";
|
|
1065
1029
|
/**
|
|
1066
1030
|
* Pagination
|
|
1067
1031
|
* @description pagination metadata structure
|
|
@@ -1069,36 +1033,64 @@ interface components {
|
|
|
1069
1033
|
Pagination: {
|
|
1070
1034
|
total_records?: number;
|
|
1071
1035
|
total_pages?: number;
|
|
1072
|
-
previous_page?: ((number | null) | null) | null;
|
|
1073
|
-
/** @default 25 */
|
|
1036
|
+
previous_page?: ((number | null) | null) | null; /** @default 25 */
|
|
1074
1037
|
limit: number;
|
|
1075
1038
|
next_page?: ((number | null) | null) | null;
|
|
1076
|
-
};
|
|
1077
|
-
/** PartialCollectAndDelivery */
|
|
1039
|
+
}; /** PartialCollectAndDelivery */
|
|
1078
1040
|
PartialCollectAndDelivery: {
|
|
1079
|
-
/**
|
|
1080
|
-
|
|
1041
|
+
/**
|
|
1042
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1043
|
+
* @enum {string}
|
|
1044
|
+
*/
|
|
1045
|
+
fulfillment_type: "partial-collect-and-delivery"; /** @enum {string} */
|
|
1046
|
+
preference_type?: $Read<"user" | "auto">;
|
|
1081
1047
|
"collect-in-store": {
|
|
1082
|
-
pickup_location_id
|
|
1083
|
-
|
|
1048
|
+
pickup_location_id: string;
|
|
1049
|
+
pickup_location_name?: $Read<string>;
|
|
1050
|
+
items: components["schemas"]["FulfillmentItem"][];
|
|
1084
1051
|
};
|
|
1085
1052
|
delivery: {
|
|
1086
|
-
shipping_provider_id: string
|
|
1087
|
-
|
|
1053
|
+
shipping_provider_id: string;
|
|
1054
|
+
shipping_provider_name?: $Read<string | null>;
|
|
1088
1055
|
courier_company_id?: string | null;
|
|
1089
|
-
|
|
1056
|
+
courier_company_name?: $Read<string | null>;
|
|
1090
1057
|
items: components["schemas"]["FulfillmentItem"][];
|
|
1091
1058
|
};
|
|
1092
1059
|
};
|
|
1093
|
-
/**
|
|
1060
|
+
/**
|
|
1061
|
+
* PaymentStatus
|
|
1062
|
+
* @enum {unknown}
|
|
1063
|
+
*/
|
|
1064
|
+
PaymentStatus: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated" | "refunded" | "unsettled" | "settled" | "partially_settled"; /** ProductImage */
|
|
1065
|
+
ProductImage: {
|
|
1066
|
+
title?: string | null;
|
|
1067
|
+
alternate_text?: string | null; /** Format: int32 */
|
|
1068
|
+
sort_order?: number;
|
|
1069
|
+
url_tiny?: string;
|
|
1070
|
+
url_thumbnail?: string;
|
|
1071
|
+
url_standard?: string;
|
|
1072
|
+
url_zoom?: string;
|
|
1073
|
+
file_id?: string; /** @enum {unknown} */
|
|
1074
|
+
file_type?: "image";
|
|
1075
|
+
}; /** Shipment */
|
|
1094
1076
|
Shipment: components["schemas"]["ShipmentInfo"] & {
|
|
1095
1077
|
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
1096
1078
|
} & {
|
|
1097
1079
|
packing?: components["schemas"]["ShipmentPackaging"];
|
|
1098
1080
|
} & {
|
|
1099
1081
|
progression?: components["schemas"]["ShipmentProgression"][];
|
|
1100
|
-
};
|
|
1101
|
-
/**
|
|
1082
|
+
}; /** @enum {unknown} */
|
|
1083
|
+
ShipmentAction: "create-shipment" | "download-invoice" | "inventory-check" | "return-replace" | "update-manual" | "cancel"; /** ShipmentActivity */
|
|
1084
|
+
ShipmentActivity: {
|
|
1085
|
+
activity_type: string;
|
|
1086
|
+
comment: string; /** @enum {unknown} */
|
|
1087
|
+
status: "success" | "failed";
|
|
1088
|
+
user_type: string;
|
|
1089
|
+
user_name: string;
|
|
1090
|
+
details: string | null; /** Format: date-time */
|
|
1091
|
+
created_at: string; /** Format: date-time */
|
|
1092
|
+
modified_at: string;
|
|
1093
|
+
}; /** ShipmentBox */
|
|
1102
1094
|
ShipmentBox: {
|
|
1103
1095
|
box_name?: string;
|
|
1104
1096
|
box_length?: number;
|
|
@@ -1107,63 +1099,69 @@ interface components {
|
|
|
1107
1099
|
box_weight?: number;
|
|
1108
1100
|
items_count?: number | null;
|
|
1109
1101
|
box_count?: number | null;
|
|
1110
|
-
};
|
|
1111
|
-
/** ShipmentDetail */
|
|
1102
|
+
}; /** ShipmentDetail */
|
|
1112
1103
|
ShipmentDetail: {
|
|
1113
|
-
order_number
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1104
|
+
order_number: string; /** Format: date-time */
|
|
1105
|
+
order_date: string;
|
|
1106
|
+
order_status: string;
|
|
1107
|
+
sales_channel: {
|
|
1108
|
+
id: string;
|
|
1109
|
+
name: string;
|
|
1110
|
+
type: string;
|
|
1111
|
+
};
|
|
1112
|
+
payment_status: components["schemas"]["PaymentStatus"];
|
|
1113
|
+
customer_name?: string | null;
|
|
1114
|
+
shipment_detail: components["schemas"]["Shipment"];
|
|
1115
|
+
allowed_actions: components["schemas"]["ShipmentAction"][];
|
|
1116
|
+
}; /** ShipmentInfo */
|
|
1125
1117
|
ShipmentInfo: {
|
|
1126
|
-
order_number
|
|
1127
|
-
order_status
|
|
1128
|
-
shipment_number
|
|
1129
|
-
warehouse_id
|
|
1130
|
-
warehouse_name
|
|
1131
|
-
status
|
|
1132
|
-
total_weight
|
|
1133
|
-
total_boxes
|
|
1134
|
-
shipment_items_count
|
|
1135
|
-
/** Format: double */
|
|
1136
|
-
|
|
1137
|
-
/** Format: double */
|
|
1138
|
-
|
|
1139
|
-
/** Format: double */
|
|
1140
|
-
shipping_amount_including_tax
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1118
|
+
order_number: string;
|
|
1119
|
+
order_status: string;
|
|
1120
|
+
shipment_number: string;
|
|
1121
|
+
warehouse_id: string;
|
|
1122
|
+
warehouse_name: string | null;
|
|
1123
|
+
status: components["schemas"]["ShipmentStatus"];
|
|
1124
|
+
total_weight: number;
|
|
1125
|
+
total_boxes: number | null;
|
|
1126
|
+
shipment_items_count: number; /** Format: double */
|
|
1127
|
+
shipping_estimated_cost: number; /** Format: double */
|
|
1128
|
+
shipping_discount_amount: number; /** Format: double */
|
|
1129
|
+
shipping_amount: number; /** Format: double */
|
|
1130
|
+
shipping_tax_rate: number; /** Format: double */
|
|
1131
|
+
shipping_tax_amount: number; /** Format: double */
|
|
1132
|
+
shipping_amount_including_tax: number;
|
|
1133
|
+
shipping_provider_id: string | null;
|
|
1134
|
+
shipping_provider_name: string | null;
|
|
1135
|
+
courier_company_id: string | null;
|
|
1136
|
+
courier_company_name: string | null;
|
|
1137
|
+
courier_company_image_url: string | null;
|
|
1138
|
+
awb_no: string | null;
|
|
1139
|
+
shipping_label_url: string | null;
|
|
1140
|
+
eta_delivery: string | null;
|
|
1141
|
+
estimated_delivery_date: string | null;
|
|
1142
|
+
promised_delivery_date: string | null;
|
|
1143
|
+
out_for_delivery_date?: string | null;
|
|
1144
|
+
shipped_date: string | null;
|
|
1145
|
+
delivered_date: string | null;
|
|
1146
|
+
returned_date: string | null; /** @enum {unknown} */
|
|
1147
|
+
fulfillment_type: "delivery" | "collect-in-store";
|
|
1148
|
+
slo: {
|
|
1149
|
+
/** Format: date */expected_date?: string; /** Format: date */
|
|
1153
1150
|
actual_date?: string;
|
|
1154
|
-
difference?: string;
|
|
1151
|
+
difference?: string; /** @enum {unknown} */
|
|
1152
|
+
slo_status?: "on-time" | "delay" | "early";
|
|
1155
1153
|
};
|
|
1156
|
-
cancellation_reason
|
|
1157
|
-
customer_id
|
|
1158
|
-
customer_name
|
|
1159
|
-
shipping_address_line1
|
|
1160
|
-
shipping_address_line2
|
|
1161
|
-
shipping_landmark
|
|
1162
|
-
shipping_pincode
|
|
1163
|
-
shipping_city
|
|
1164
|
-
shipping_state
|
|
1165
|
-
created_at
|
|
1166
|
-
modified_at
|
|
1154
|
+
cancellation_reason: string | null;
|
|
1155
|
+
customer_id: string;
|
|
1156
|
+
customer_name: string;
|
|
1157
|
+
shipping_address_line1: string;
|
|
1158
|
+
shipping_address_line2: string | null;
|
|
1159
|
+
shipping_landmark: string | null;
|
|
1160
|
+
shipping_pincode: string;
|
|
1161
|
+
shipping_city: string;
|
|
1162
|
+
shipping_state: string;
|
|
1163
|
+
created_at: string;
|
|
1164
|
+
modified_at: string;
|
|
1167
1165
|
};
|
|
1168
1166
|
/**
|
|
1169
1167
|
* ShipmentItem
|
|
@@ -1171,42 +1169,43 @@ interface components {
|
|
|
1171
1169
|
*/
|
|
1172
1170
|
ShipmentItem: {
|
|
1173
1171
|
product_id: string;
|
|
1174
|
-
|
|
1172
|
+
product_name?: $Read<string>;
|
|
1175
1173
|
variant_id: string | null;
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1174
|
+
variant_name?: $Read<string | null>;
|
|
1175
|
+
product_image_url?: $Read<string | null>;
|
|
1176
|
+
sku?: $Read<string>;
|
|
1179
1177
|
quantity: number;
|
|
1180
1178
|
free_quantity?: number;
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
/** ShipmentList */
|
|
1179
|
+
is_free_item?: $Read<boolean>; /** Format: double */
|
|
1180
|
+
selling_price?: number;
|
|
1181
|
+
}; /** ShipmentList */
|
|
1184
1182
|
ShipmentList: {
|
|
1185
1183
|
order_number?: string;
|
|
1186
|
-
|
|
1187
|
-
|
|
1184
|
+
sales_channel?: {
|
|
1185
|
+
id?: string;
|
|
1186
|
+
name?: string;
|
|
1187
|
+
type?: string;
|
|
1188
|
+
};
|
|
1189
|
+
} & components["schemas"]["ShipmentInfo"]; /** ShipmentPackaging */
|
|
1188
1190
|
ShipmentPackaging: {
|
|
1189
|
-
/** @enum {unknown} */
|
|
1190
|
-
package_option?: "Automatic" | "Custom";
|
|
1191
|
+
/** @enum {unknown} */package_option?: "Automatic" | "Custom";
|
|
1191
1192
|
boxes_count?: number;
|
|
1192
1193
|
boxes?: components["schemas"]["ShipmentBox"][];
|
|
1193
|
-
};
|
|
1194
|
-
/** ShipmentProgression */
|
|
1194
|
+
}; /** ShipmentProgression */
|
|
1195
1195
|
ShipmentProgression: {
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1196
|
+
status?: components["schemas"]["ShipmentStatus"];
|
|
1197
|
+
is_current?: $Read<boolean>;
|
|
1198
|
+
is_completed?: $Read<boolean>; /** Format: date-time */
|
|
1199
|
+
completion_date?: string | null;
|
|
1200
|
+
}; /** @enum {unknown} */
|
|
1201
|
+
ShipmentStatus: "unscheduled" | "schedule_requested" | "scheduled" | "packed" | "shipped" | "in_transit" | "out_for_delivery" | "delivery_attempted" | "undelivered" | "return_to_origin" | "delivered" | "cancelled" | "lost" | "sent_to_store" | "processing" | "ready_to_collect";
|
|
1202
1202
|
/**
|
|
1203
1203
|
* UpiPayment
|
|
1204
1204
|
* @description UPI Payment
|
|
1205
1205
|
*/
|
|
1206
1206
|
UpiPayment: components["schemas"]["OrderPaymentInfo"] & {
|
|
1207
1207
|
upi_id?: string;
|
|
1208
|
-
};
|
|
1209
|
-
/** WalletPayment */
|
|
1208
|
+
}; /** WalletPayment */
|
|
1210
1209
|
WalletPayment: components["schemas"]["OrderPaymentInfo"] & {
|
|
1211
1210
|
wallet_name?: string;
|
|
1212
1211
|
};
|
|
@@ -1220,13 +1219,9 @@ interface components {
|
|
|
1220
1219
|
* 4) If 'can_receive_stock' is false then 'can_ship_parcel' and 'can_collect' fields should be false.
|
|
1221
1220
|
*/
|
|
1222
1221
|
Warehouse: {
|
|
1223
|
-
/** @description warehouse id */
|
|
1224
|
-
|
|
1225
|
-
/** @
|
|
1226
|
-
name: string;
|
|
1227
|
-
/** @enum {unknown} */
|
|
1228
|
-
warehouse_type: "retail-store" | "distribution-center";
|
|
1229
|
-
/** @default true */
|
|
1222
|
+
/** @description warehouse id */id?: $Read<string>; /** @description legal name */
|
|
1223
|
+
name: string; /** @enum {unknown} */
|
|
1224
|
+
warehouse_type: "retail-store" | "distribution-center"; /** @default true */
|
|
1230
1225
|
active: boolean;
|
|
1231
1226
|
gstin?: string | null;
|
|
1232
1227
|
city: string;
|
|
@@ -1235,10 +1230,8 @@ interface components {
|
|
|
1235
1230
|
landmark?: string | null;
|
|
1236
1231
|
pincode: string;
|
|
1237
1232
|
state: string;
|
|
1238
|
-
country: string;
|
|
1239
|
-
/** @
|
|
1240
|
-
country_code: string;
|
|
1241
|
-
/** @description 10 digit number without country code. */
|
|
1233
|
+
country: string; /** @default +91 */
|
|
1234
|
+
country_code: string; /** @description 10 digit number without country code. */
|
|
1242
1235
|
contact_phone: number;
|
|
1243
1236
|
contact_email: string;
|
|
1244
1237
|
is_default?: boolean;
|
|
@@ -1246,13 +1239,11 @@ interface components {
|
|
|
1246
1239
|
seller_warehouse_id?: string | null;
|
|
1247
1240
|
can_receive_stock: boolean;
|
|
1248
1241
|
can_ship_parcel: boolean;
|
|
1249
|
-
can_collect: boolean;
|
|
1250
|
-
/** @description this field will be always true for warehouse_type = retail-store. */
|
|
1242
|
+
can_collect: boolean; /** @description this field will be always true for warehouse_type = retail-store. */
|
|
1251
1243
|
is_checkout_point: boolean;
|
|
1252
1244
|
accepts_returns: boolean;
|
|
1253
1245
|
opening_hours?: components["schemas"]["OpeningHours"];
|
|
1254
|
-
};
|
|
1255
|
-
/** WarehouseBasicDetail */
|
|
1246
|
+
}; /** WarehouseBasicDetail */
|
|
1256
1247
|
WarehouseBasicDetail: {
|
|
1257
1248
|
id?: string;
|
|
1258
1249
|
name?: string;
|
|
@@ -1261,13 +1252,10 @@ interface components {
|
|
|
1261
1252
|
city?: string;
|
|
1262
1253
|
state?: string;
|
|
1263
1254
|
is_default?: boolean;
|
|
1264
|
-
};
|
|
1265
|
-
/** WarehouseWiseInventory */
|
|
1255
|
+
}; /** WarehouseWiseInventory */
|
|
1266
1256
|
WarehouseWiseInventory: {
|
|
1267
|
-
|
|
1268
|
-
/** Format: date */
|
|
1269
|
-
mfg_date?: string;
|
|
1270
|
-
/** Format: date */
|
|
1257
|
+
lot_batch?: string; /** Format: date */
|
|
1258
|
+
mfg_date?: string; /** Format: date */
|
|
1271
1259
|
exp_date?: string;
|
|
1272
1260
|
manufacturer?: string;
|
|
1273
1261
|
warehouse_id?: string;
|
|
@@ -1281,15 +1269,11 @@ interface components {
|
|
|
1281
1269
|
};
|
|
1282
1270
|
responses: never;
|
|
1283
1271
|
parameters: {
|
|
1284
|
-
/** @description JSON object */
|
|
1285
|
-
|
|
1286
|
-
/** @description
|
|
1287
|
-
|
|
1288
|
-
/** @description
|
|
1289
|
-
pageNumber: number;
|
|
1290
|
-
/** @description search keyword */
|
|
1291
|
-
searchKeyword: string;
|
|
1292
|
-
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1272
|
+
/** @description JSON object */columnBasedFilters: string; /** @description view to be used to display the data */
|
|
1273
|
+
dataView: "warehouse"; /** @description no of rows per page */
|
|
1274
|
+
pageLimit: number; /** @description page number of pagination list */
|
|
1275
|
+
pageNumber: number; /** @description search keyword */
|
|
1276
|
+
searchKeyword: string; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1293
1277
|
sortByOptions: string;
|
|
1294
1278
|
};
|
|
1295
1279
|
requestBodies: never;
|
|
@@ -1300,13 +1284,10 @@ interface operations {
|
|
|
1300
1284
|
"pos-list-inventory": {
|
|
1301
1285
|
parameters: {
|
|
1302
1286
|
query?: {
|
|
1303
|
-
/** @description page number of pagination list */
|
|
1304
|
-
page?: components["parameters"]["pageNumber"];
|
|
1305
|
-
/** @description
|
|
1306
|
-
|
|
1307
|
-
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1308
|
-
sort_by?: components["parameters"]["sortByOptions"];
|
|
1309
|
-
/** @description JSON object */
|
|
1287
|
+
/** @description view to be used to display the data */view?: components["parameters"]["dataView"]; /** @description page number of pagination list */
|
|
1288
|
+
page?: components["parameters"]["pageNumber"]; /** @description no of rows per page */
|
|
1289
|
+
limit?: components["parameters"]["pageLimit"]; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1290
|
+
sort_by?: components["parameters"]["sortByOptions"]; /** @description JSON object */
|
|
1310
1291
|
filters?: components["parameters"]["columnBasedFilters"];
|
|
1311
1292
|
};
|
|
1312
1293
|
header?: never;
|
|
@@ -1315,8 +1296,7 @@ interface operations {
|
|
|
1315
1296
|
};
|
|
1316
1297
|
requestBody?: never;
|
|
1317
1298
|
responses: {
|
|
1318
|
-
/** @description OK */
|
|
1319
|
-
200: {
|
|
1299
|
+
/** @description OK */200: {
|
|
1320
1300
|
headers: {
|
|
1321
1301
|
[name: string]: unknown;
|
|
1322
1302
|
};
|
|
@@ -1326,6 +1306,7 @@ interface operations {
|
|
|
1326
1306
|
success?: boolean;
|
|
1327
1307
|
content?: {
|
|
1328
1308
|
inventories?: (components["schemas"]["ItemWiseInventory"] | components["schemas"]["LotBatchWiseInventory"])[];
|
|
1309
|
+
pagination?: components["schemas"]["Pagination"];
|
|
1329
1310
|
};
|
|
1330
1311
|
};
|
|
1331
1312
|
};
|
|
@@ -1335,13 +1316,9 @@ interface operations {
|
|
|
1335
1316
|
"pos-list-inventory-activity": {
|
|
1336
1317
|
parameters: {
|
|
1337
1318
|
query?: {
|
|
1338
|
-
/** @description page number of pagination list */
|
|
1339
|
-
|
|
1340
|
-
/** @description
|
|
1341
|
-
limit?: components["parameters"]["pageLimit"];
|
|
1342
|
-
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1343
|
-
sort_by?: components["parameters"]["sortByOptions"];
|
|
1344
|
-
/** @description JSON object */
|
|
1319
|
+
/** @description page number of pagination list */page?: components["parameters"]["pageNumber"]; /** @description no of rows per page */
|
|
1320
|
+
limit?: components["parameters"]["pageLimit"]; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1321
|
+
sort_by?: components["parameters"]["sortByOptions"]; /** @description JSON object */
|
|
1345
1322
|
filters?: components["parameters"]["columnBasedFilters"];
|
|
1346
1323
|
};
|
|
1347
1324
|
header?: never;
|
|
@@ -1350,8 +1327,7 @@ interface operations {
|
|
|
1350
1327
|
};
|
|
1351
1328
|
requestBody?: never;
|
|
1352
1329
|
responses: {
|
|
1353
|
-
/** @description OK */
|
|
1354
|
-
200: {
|
|
1330
|
+
/** @description OK */200: {
|
|
1355
1331
|
headers: {
|
|
1356
1332
|
[name: string]: unknown;
|
|
1357
1333
|
};
|
|
@@ -1361,6 +1337,7 @@ interface operations {
|
|
|
1361
1337
|
success?: boolean;
|
|
1362
1338
|
content?: {
|
|
1363
1339
|
activities?: components["schemas"]["InventoryActivity"][];
|
|
1340
|
+
pagination?: components["schemas"]["Pagination"];
|
|
1364
1341
|
};
|
|
1365
1342
|
};
|
|
1366
1343
|
};
|
|
@@ -1370,11 +1347,8 @@ interface operations {
|
|
|
1370
1347
|
"pos-list-inventory-detail": {
|
|
1371
1348
|
parameters: {
|
|
1372
1349
|
query: {
|
|
1373
|
-
/** @description lot batch of selected productor or variant. */
|
|
1374
|
-
|
|
1375
|
-
/** @description Product Id */
|
|
1376
|
-
product_id: string;
|
|
1377
|
-
/** @description Variant Id */
|
|
1350
|
+
/** @description lot batch of selected productor or variant. */lot_batch?: string; /** @description Product Id */
|
|
1351
|
+
product_id: string; /** @description Variant Id */
|
|
1378
1352
|
variant_id?: string;
|
|
1379
1353
|
};
|
|
1380
1354
|
header?: never;
|
|
@@ -1383,8 +1357,7 @@ interface operations {
|
|
|
1383
1357
|
};
|
|
1384
1358
|
requestBody?: never;
|
|
1385
1359
|
responses: {
|
|
1386
|
-
/** @description OK */
|
|
1387
|
-
200: {
|
|
1360
|
+
/** @description OK */200: {
|
|
1388
1361
|
headers: {
|
|
1389
1362
|
[name: string]: unknown;
|
|
1390
1363
|
};
|
|
@@ -1403,15 +1376,10 @@ interface operations {
|
|
|
1403
1376
|
"pos-list-customers": {
|
|
1404
1377
|
parameters: {
|
|
1405
1378
|
query?: {
|
|
1406
|
-
/** @description page number of pagination list */
|
|
1407
|
-
|
|
1408
|
-
/** @description
|
|
1409
|
-
|
|
1410
|
-
/** @description JSON object */
|
|
1411
|
-
filters?: components["parameters"]["columnBasedFilters"];
|
|
1412
|
-
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1413
|
-
sort_by?: components["parameters"]["sortByOptions"];
|
|
1414
|
-
/** @description search keyword */
|
|
1379
|
+
/** @description page number of pagination list */page?: components["parameters"]["pageNumber"]; /** @description no of rows per page */
|
|
1380
|
+
limit?: components["parameters"]["pageLimit"]; /** @description JSON object */
|
|
1381
|
+
filters?: components["parameters"]["columnBasedFilters"]; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1382
|
+
sort_by?: components["parameters"]["sortByOptions"]; /** @description search keyword */
|
|
1415
1383
|
search?: components["parameters"]["searchKeyword"];
|
|
1416
1384
|
};
|
|
1417
1385
|
header?: never;
|
|
@@ -1420,8 +1388,7 @@ interface operations {
|
|
|
1420
1388
|
};
|
|
1421
1389
|
requestBody?: never;
|
|
1422
1390
|
responses: {
|
|
1423
|
-
/** @description OK */
|
|
1424
|
-
200: {
|
|
1391
|
+
/** @description OK */200: {
|
|
1425
1392
|
headers: {
|
|
1426
1393
|
[name: string]: unknown;
|
|
1427
1394
|
};
|
|
@@ -1443,15 +1410,13 @@ interface operations {
|
|
|
1443
1410
|
query?: never;
|
|
1444
1411
|
header?: never;
|
|
1445
1412
|
path: {
|
|
1446
|
-
/** @description Customer Id */
|
|
1447
|
-
id: string;
|
|
1413
|
+
/** @description Customer Id */id: string;
|
|
1448
1414
|
};
|
|
1449
1415
|
cookie?: never;
|
|
1450
1416
|
};
|
|
1451
1417
|
requestBody?: never;
|
|
1452
1418
|
responses: {
|
|
1453
|
-
/** @description OK */
|
|
1454
|
-
200: {
|
|
1419
|
+
/** @description OK */200: {
|
|
1455
1420
|
headers: {
|
|
1456
1421
|
[name: string]: unknown;
|
|
1457
1422
|
};
|
|
@@ -1470,15 +1435,10 @@ interface operations {
|
|
|
1470
1435
|
"pos-list-orders": {
|
|
1471
1436
|
parameters: {
|
|
1472
1437
|
query?: {
|
|
1473
|
-
/** @description page number of pagination list */
|
|
1474
|
-
|
|
1475
|
-
/** @description
|
|
1476
|
-
|
|
1477
|
-
/** @description JSON object */
|
|
1478
|
-
filters?: components["parameters"]["columnBasedFilters"];
|
|
1479
|
-
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1480
|
-
sort_by?: components["parameters"]["sortByOptions"];
|
|
1481
|
-
/** @description search keyword */
|
|
1438
|
+
/** @description page number of pagination list */page?: components["parameters"]["pageNumber"]; /** @description no of rows per page */
|
|
1439
|
+
limit?: components["parameters"]["pageLimit"]; /** @description JSON object */
|
|
1440
|
+
filters?: components["parameters"]["columnBasedFilters"]; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1441
|
+
sort_by?: components["parameters"]["sortByOptions"]; /** @description search keyword */
|
|
1482
1442
|
search?: components["parameters"]["searchKeyword"];
|
|
1483
1443
|
};
|
|
1484
1444
|
header?: never;
|
|
@@ -1487,8 +1447,7 @@ interface operations {
|
|
|
1487
1447
|
};
|
|
1488
1448
|
requestBody?: never;
|
|
1489
1449
|
responses: {
|
|
1490
|
-
/** @description OK */
|
|
1491
|
-
200: {
|
|
1450
|
+
/** @description OK */200: {
|
|
1492
1451
|
headers: {
|
|
1493
1452
|
[name: string]: unknown;
|
|
1494
1453
|
};
|
|
@@ -1510,15 +1469,13 @@ interface operations {
|
|
|
1510
1469
|
query?: never;
|
|
1511
1470
|
header?: never;
|
|
1512
1471
|
path: {
|
|
1513
|
-
/** @description order number */
|
|
1514
|
-
order_number: string;
|
|
1472
|
+
/** @description order number */order_number: string;
|
|
1515
1473
|
};
|
|
1516
1474
|
cookie?: never;
|
|
1517
1475
|
};
|
|
1518
1476
|
requestBody?: never;
|
|
1519
1477
|
responses: {
|
|
1520
|
-
/** @description OK */
|
|
1521
|
-
200: {
|
|
1478
|
+
/** @description OK */200: {
|
|
1522
1479
|
headers: {
|
|
1523
1480
|
[name: string]: unknown;
|
|
1524
1481
|
};
|
|
@@ -1539,15 +1496,13 @@ interface operations {
|
|
|
1539
1496
|
query?: never;
|
|
1540
1497
|
header?: never;
|
|
1541
1498
|
path: {
|
|
1542
|
-
/** @description order number */
|
|
1543
|
-
order_number: string;
|
|
1499
|
+
/** @description order number */order_number: string;
|
|
1544
1500
|
};
|
|
1545
1501
|
cookie?: never;
|
|
1546
1502
|
};
|
|
1547
1503
|
requestBody?: never;
|
|
1548
1504
|
responses: {
|
|
1549
|
-
/** @description OK */
|
|
1550
|
-
200: {
|
|
1505
|
+
/** @description OK */200: {
|
|
1551
1506
|
headers: {
|
|
1552
1507
|
[name: string]: unknown;
|
|
1553
1508
|
};
|
|
@@ -1564,23 +1519,47 @@ interface operations {
|
|
|
1564
1519
|
};
|
|
1565
1520
|
};
|
|
1566
1521
|
};
|
|
1522
|
+
"pos-check-order-inventory": {
|
|
1523
|
+
parameters: {
|
|
1524
|
+
query?: never;
|
|
1525
|
+
header?: never;
|
|
1526
|
+
path: {
|
|
1527
|
+
/** @description Order number */order_number: string;
|
|
1528
|
+
};
|
|
1529
|
+
cookie?: never;
|
|
1530
|
+
};
|
|
1531
|
+
requestBody?: never;
|
|
1532
|
+
responses: {
|
|
1533
|
+
/** @description OK */200: {
|
|
1534
|
+
headers: {
|
|
1535
|
+
[name: string]: unknown;
|
|
1536
|
+
};
|
|
1537
|
+
content: {
|
|
1538
|
+
"application/json": {
|
|
1539
|
+
message?: string;
|
|
1540
|
+
success?: boolean;
|
|
1541
|
+
content?: {
|
|
1542
|
+
inventory?: components["schemas"]["CheckInventoryResponse"];
|
|
1543
|
+
};
|
|
1544
|
+
};
|
|
1545
|
+
};
|
|
1546
|
+
};
|
|
1547
|
+
};
|
|
1548
|
+
};
|
|
1567
1549
|
"pos-get-order-invoice": {
|
|
1568
1550
|
parameters: {
|
|
1569
1551
|
query?: {
|
|
1570
|
-
/** @description Response data format */
|
|
1571
|
-
format?: "json" | "pdf";
|
|
1552
|
+
/** @description Response data format */format?: "json" | "pdf";
|
|
1572
1553
|
};
|
|
1573
1554
|
header?: never;
|
|
1574
1555
|
path: {
|
|
1575
|
-
/** @description order number */
|
|
1576
|
-
order_number: string;
|
|
1556
|
+
/** @description order number */order_number: string;
|
|
1577
1557
|
};
|
|
1578
1558
|
cookie?: never;
|
|
1579
1559
|
};
|
|
1580
1560
|
requestBody?: never;
|
|
1581
1561
|
responses: {
|
|
1582
|
-
/** @description OK */
|
|
1583
|
-
200: {
|
|
1562
|
+
/** @description OK */200: {
|
|
1584
1563
|
headers: {
|
|
1585
1564
|
[name: string]: unknown;
|
|
1586
1565
|
};
|
|
@@ -1600,20 +1579,17 @@ interface operations {
|
|
|
1600
1579
|
"pos-get-order-receipt": {
|
|
1601
1580
|
parameters: {
|
|
1602
1581
|
query?: {
|
|
1603
|
-
/** @description Response data format */
|
|
1604
|
-
format?: "json" | "pdf";
|
|
1582
|
+
/** @description Response data format */format?: "json" | "pdf";
|
|
1605
1583
|
};
|
|
1606
1584
|
header?: never;
|
|
1607
1585
|
path: {
|
|
1608
|
-
/** @description order number */
|
|
1609
|
-
order_number: string;
|
|
1586
|
+
/** @description order number */order_number: string;
|
|
1610
1587
|
};
|
|
1611
1588
|
cookie?: never;
|
|
1612
1589
|
};
|
|
1613
1590
|
requestBody?: never;
|
|
1614
1591
|
responses: {
|
|
1615
|
-
/** @description OK */
|
|
1616
|
-
200: {
|
|
1592
|
+
/** @description OK */200: {
|
|
1617
1593
|
headers: {
|
|
1618
1594
|
[name: string]: unknown;
|
|
1619
1595
|
};
|
|
@@ -1635,15 +1611,13 @@ interface operations {
|
|
|
1635
1611
|
query?: never;
|
|
1636
1612
|
header?: never;
|
|
1637
1613
|
path: {
|
|
1638
|
-
/** @description order number */
|
|
1639
|
-
order_number: string;
|
|
1614
|
+
/** @description order number */order_number: string;
|
|
1640
1615
|
};
|
|
1641
1616
|
cookie?: never;
|
|
1642
1617
|
};
|
|
1643
1618
|
requestBody?: never;
|
|
1644
1619
|
responses: {
|
|
1645
|
-
/** @description OK */
|
|
1646
|
-
200: {
|
|
1620
|
+
/** @description OK */200: {
|
|
1647
1621
|
headers: {
|
|
1648
1622
|
[name: string]: unknown;
|
|
1649
1623
|
};
|
|
@@ -1652,7 +1626,7 @@ interface operations {
|
|
|
1652
1626
|
message?: string;
|
|
1653
1627
|
success?: boolean;
|
|
1654
1628
|
content?: {
|
|
1655
|
-
shipment?: components["schemas"]["
|
|
1629
|
+
shipment?: components["schemas"]["OrderShipmentDetail"];
|
|
1656
1630
|
};
|
|
1657
1631
|
};
|
|
1658
1632
|
};
|
|
@@ -1662,15 +1636,10 @@ interface operations {
|
|
|
1662
1636
|
"pos-list-shipments": {
|
|
1663
1637
|
parameters: {
|
|
1664
1638
|
query?: {
|
|
1665
|
-
/** @description page number of pagination list */
|
|
1666
|
-
|
|
1667
|
-
/** @description
|
|
1668
|
-
|
|
1669
|
-
/** @description JSON object */
|
|
1670
|
-
filters?: components["parameters"]["columnBasedFilters"];
|
|
1671
|
-
/** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1672
|
-
sort_by?: components["parameters"]["sortByOptions"];
|
|
1673
|
-
/** @description search keyword */
|
|
1639
|
+
/** @description page number of pagination list */page?: components["parameters"]["pageNumber"]; /** @description no of rows per page */
|
|
1640
|
+
limit?: components["parameters"]["pageLimit"]; /** @description JSON object */
|
|
1641
|
+
filters?: components["parameters"]["columnBasedFilters"]; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
1642
|
+
sort_by?: components["parameters"]["sortByOptions"]; /** @description search keyword */
|
|
1674
1643
|
search?: components["parameters"]["searchKeyword"];
|
|
1675
1644
|
};
|
|
1676
1645
|
header?: never;
|
|
@@ -1679,8 +1648,7 @@ interface operations {
|
|
|
1679
1648
|
};
|
|
1680
1649
|
requestBody?: never;
|
|
1681
1650
|
responses: {
|
|
1682
|
-
/** @description OK */
|
|
1683
|
-
200: {
|
|
1651
|
+
/** @description OK */200: {
|
|
1684
1652
|
headers: {
|
|
1685
1653
|
[name: string]: unknown;
|
|
1686
1654
|
};
|
|
@@ -1697,20 +1665,30 @@ interface operations {
|
|
|
1697
1665
|
};
|
|
1698
1666
|
};
|
|
1699
1667
|
};
|
|
1700
|
-
"pos-
|
|
1668
|
+
"pos-refund-shortfall": {
|
|
1701
1669
|
parameters: {
|
|
1702
1670
|
query?: never;
|
|
1703
1671
|
header?: never;
|
|
1704
1672
|
path: {
|
|
1705
|
-
/** @description Order
|
|
1706
|
-
order_number: string;
|
|
1673
|
+
/** @description Order Number */order_number: string;
|
|
1707
1674
|
};
|
|
1708
1675
|
cookie?: never;
|
|
1709
1676
|
};
|
|
1710
|
-
requestBody?:
|
|
1677
|
+
requestBody?: {
|
|
1678
|
+
content: {
|
|
1679
|
+
"application/json": {
|
|
1680
|
+
items: {
|
|
1681
|
+
sku: string;
|
|
1682
|
+
quantity: number; /** @default 0 */
|
|
1683
|
+
free_quantity?: number;
|
|
1684
|
+
}[]; /** @enum {unknown} */
|
|
1685
|
+
payment_method: "original-payment-mode" | "bank-transfer"; /** @description required if payment_method = bank-transfer */
|
|
1686
|
+
bank_account_id?: string | null;
|
|
1687
|
+
};
|
|
1688
|
+
};
|
|
1689
|
+
};
|
|
1711
1690
|
responses: {
|
|
1712
|
-
/** @description OK */
|
|
1713
|
-
200: {
|
|
1691
|
+
/** @description OK */200: {
|
|
1714
1692
|
headers: {
|
|
1715
1693
|
[name: string]: unknown;
|
|
1716
1694
|
};
|
|
@@ -1718,61 +1696,23 @@ interface operations {
|
|
|
1718
1696
|
"application/json": {
|
|
1719
1697
|
message?: string;
|
|
1720
1698
|
success?: boolean;
|
|
1721
|
-
content?: {
|
|
1722
|
-
/** @enum {unknown} */
|
|
1723
|
-
inventory_status?: "fulfilled" | "partially-fulfilled" | "not-fulfilled";
|
|
1724
|
-
shipment_items?: components["schemas"]["ShipmentItem"][];
|
|
1725
|
-
recommended_warehouses?: {
|
|
1726
|
-
id?: string;
|
|
1727
|
-
name?: string;
|
|
1728
|
-
/** @enum {unknown} */
|
|
1729
|
-
inventory_status?: "fulfilled" | "partially-fulfilled" | "not-fulfilled";
|
|
1730
|
-
}[];
|
|
1731
|
-
inventory_detail?: {
|
|
1732
|
-
sku?: string;
|
|
1733
|
-
total_quantity?: number;
|
|
1734
|
-
warehouses?: {
|
|
1735
|
-
warehouse_id?: string;
|
|
1736
|
-
warehouse_name?: string;
|
|
1737
|
-
quantity?: number;
|
|
1738
|
-
}[];
|
|
1739
|
-
}[];
|
|
1740
|
-
allowed_action?: string[];
|
|
1741
|
-
};
|
|
1742
1699
|
};
|
|
1743
1700
|
};
|
|
1744
1701
|
};
|
|
1745
1702
|
};
|
|
1746
1703
|
};
|
|
1747
|
-
"pos-
|
|
1704
|
+
"pos-get-shipment-detail": {
|
|
1748
1705
|
parameters: {
|
|
1749
1706
|
query?: never;
|
|
1750
1707
|
header?: never;
|
|
1751
1708
|
path: {
|
|
1752
|
-
/** @description
|
|
1753
|
-
order_number: string;
|
|
1709
|
+
/** @description Shipment reference number */reference_number: string;
|
|
1754
1710
|
};
|
|
1755
1711
|
cookie?: never;
|
|
1756
1712
|
};
|
|
1757
|
-
requestBody?:
|
|
1758
|
-
content: {
|
|
1759
|
-
"application/json": {
|
|
1760
|
-
items: {
|
|
1761
|
-
sku: string;
|
|
1762
|
-
quantity: number;
|
|
1763
|
-
/** @default 0 */
|
|
1764
|
-
free_quantity?: number;
|
|
1765
|
-
}[];
|
|
1766
|
-
/** @enum {unknown} */
|
|
1767
|
-
payment_method: "original-payment-mode" | "bank-transfer";
|
|
1768
|
-
/** @description required if payment_method = bank-transfer */
|
|
1769
|
-
bank_account_id?: string | null;
|
|
1770
|
-
};
|
|
1771
|
-
};
|
|
1772
|
-
};
|
|
1713
|
+
requestBody?: never;
|
|
1773
1714
|
responses: {
|
|
1774
|
-
/** @description OK */
|
|
1775
|
-
200: {
|
|
1715
|
+
/** @description OK */200: {
|
|
1776
1716
|
headers: {
|
|
1777
1717
|
[name: string]: unknown;
|
|
1778
1718
|
};
|
|
@@ -1780,25 +1720,26 @@ interface operations {
|
|
|
1780
1720
|
"application/json": {
|
|
1781
1721
|
message?: string;
|
|
1782
1722
|
success?: boolean;
|
|
1723
|
+
content?: {
|
|
1724
|
+
shipment?: components["schemas"]["ShipmentDetail"];
|
|
1725
|
+
};
|
|
1783
1726
|
};
|
|
1784
1727
|
};
|
|
1785
1728
|
};
|
|
1786
1729
|
};
|
|
1787
1730
|
};
|
|
1788
|
-
"pos-get-shipment-
|
|
1731
|
+
"pos-get-shipment-activities": {
|
|
1789
1732
|
parameters: {
|
|
1790
1733
|
query?: never;
|
|
1791
1734
|
header?: never;
|
|
1792
1735
|
path: {
|
|
1793
|
-
/** @description Shipment reference number */
|
|
1794
|
-
reference_number: string;
|
|
1736
|
+
/** @description Shipment reference number */reference_number: string;
|
|
1795
1737
|
};
|
|
1796
1738
|
cookie?: never;
|
|
1797
1739
|
};
|
|
1798
1740
|
requestBody?: never;
|
|
1799
1741
|
responses: {
|
|
1800
|
-
/** @description OK */
|
|
1801
|
-
200: {
|
|
1742
|
+
/** @description OK */200: {
|
|
1802
1743
|
headers: {
|
|
1803
1744
|
[name: string]: unknown;
|
|
1804
1745
|
};
|
|
@@ -1807,7 +1748,8 @@ interface operations {
|
|
|
1807
1748
|
message?: string;
|
|
1808
1749
|
success?: boolean;
|
|
1809
1750
|
content?: {
|
|
1810
|
-
|
|
1751
|
+
activities?: components["schemas"]["ShipmentActivity"][];
|
|
1752
|
+
pagination?: components["schemas"]["Pagination"];
|
|
1811
1753
|
};
|
|
1812
1754
|
};
|
|
1813
1755
|
};
|
|
@@ -1817,20 +1759,17 @@ interface operations {
|
|
|
1817
1759
|
"pos-get-shipment-invoice": {
|
|
1818
1760
|
parameters: {
|
|
1819
1761
|
query?: {
|
|
1820
|
-
/** @description Response data format */
|
|
1821
|
-
format?: "json" | "pdf";
|
|
1762
|
+
/** @description Response data format */format?: "json" | "pdf";
|
|
1822
1763
|
};
|
|
1823
1764
|
header?: never;
|
|
1824
1765
|
path: {
|
|
1825
|
-
/** @description Shipment reference number */
|
|
1826
|
-
reference_number: string;
|
|
1766
|
+
/** @description Shipment reference number */reference_number: string;
|
|
1827
1767
|
};
|
|
1828
1768
|
cookie?: never;
|
|
1829
1769
|
};
|
|
1830
1770
|
requestBody?: never;
|
|
1831
1771
|
responses: {
|
|
1832
|
-
/** @description OK */
|
|
1833
|
-
200: {
|
|
1772
|
+
/** @description OK */200: {
|
|
1834
1773
|
headers: {
|
|
1835
1774
|
[name: string]: unknown;
|
|
1836
1775
|
};
|
|
@@ -1852,8 +1791,7 @@ interface operations {
|
|
|
1852
1791
|
query?: never;
|
|
1853
1792
|
header?: never;
|
|
1854
1793
|
path: {
|
|
1855
|
-
/** @description Shipment reference number */
|
|
1856
|
-
reference_number: string;
|
|
1794
|
+
/** @description Shipment reference number */reference_number: string;
|
|
1857
1795
|
};
|
|
1858
1796
|
cookie?: never;
|
|
1859
1797
|
};
|
|
@@ -1866,21 +1804,16 @@ interface operations {
|
|
|
1866
1804
|
courier_company_name?: string;
|
|
1867
1805
|
shipping_label_url?: string;
|
|
1868
1806
|
tracking_url?: string;
|
|
1869
|
-
manual_shipping_charges?: number;
|
|
1870
|
-
/** Format: date-time */
|
|
1871
|
-
|
|
1872
|
-
/** Format: date-time */
|
|
1873
|
-
shipped_date?: string;
|
|
1874
|
-
/** Format: date-time */
|
|
1875
|
-
out_for_delivery_date?: string;
|
|
1876
|
-
/** Format: date-time */
|
|
1807
|
+
manual_shipping_charges?: number; /** Format: date-time */
|
|
1808
|
+
eta_delivery?: string; /** Format: date-time */
|
|
1809
|
+
shipped_date?: string; /** Format: date-time */
|
|
1810
|
+
out_for_delivery_date?: string; /** Format: date-time */
|
|
1877
1811
|
delivered_date?: string;
|
|
1878
1812
|
};
|
|
1879
1813
|
};
|
|
1880
1814
|
};
|
|
1881
1815
|
responses: {
|
|
1882
|
-
/** @description OK */
|
|
1883
|
-
200: {
|
|
1816
|
+
/** @description OK */200: {
|
|
1884
1817
|
headers: {
|
|
1885
1818
|
[name: string]: unknown;
|
|
1886
1819
|
};
|
|
@@ -1899,112 +1832,127 @@ interface operations {
|
|
|
1899
1832
|
}
|
|
1900
1833
|
//#endregion
|
|
1901
1834
|
//#region src/types/admin-pos-api-types.d.ts
|
|
1902
|
-
type AppliedCoupon = components[
|
|
1903
|
-
type AppliedPromotion = components[
|
|
1904
|
-
type BankTransfer = components[
|
|
1905
|
-
type BusinessInfo = components[
|
|
1906
|
-
type CardPayment = components[
|
|
1907
|
-
type
|
|
1908
|
-
type
|
|
1909
|
-
type
|
|
1910
|
-
type
|
|
1911
|
-
type
|
|
1912
|
-
type
|
|
1913
|
-
type
|
|
1914
|
-
type
|
|
1915
|
-
type
|
|
1916
|
-
type
|
|
1917
|
-
type
|
|
1918
|
-
type
|
|
1919
|
-
type
|
|
1920
|
-
type
|
|
1921
|
-
type
|
|
1922
|
-
type
|
|
1923
|
-
type
|
|
1924
|
-
type
|
|
1925
|
-
type
|
|
1926
|
-
type
|
|
1927
|
-
type
|
|
1928
|
-
type
|
|
1929
|
-
type
|
|
1930
|
-
type
|
|
1931
|
-
type
|
|
1932
|
-
type
|
|
1933
|
-
type
|
|
1934
|
-
type
|
|
1935
|
-
type
|
|
1936
|
-
type
|
|
1937
|
-
type
|
|
1938
|
-
type
|
|
1939
|
-
type
|
|
1940
|
-
type
|
|
1941
|
-
type
|
|
1942
|
-
type
|
|
1943
|
-
type
|
|
1944
|
-
type
|
|
1945
|
-
type
|
|
1946
|
-
type
|
|
1947
|
-
type
|
|
1948
|
-
type
|
|
1949
|
-
type
|
|
1950
|
-
type
|
|
1951
|
-
type
|
|
1952
|
-
type
|
|
1953
|
-
type
|
|
1954
|
-
type
|
|
1955
|
-
type
|
|
1956
|
-
type
|
|
1957
|
-
type
|
|
1958
|
-
type
|
|
1959
|
-
type
|
|
1960
|
-
type
|
|
1961
|
-
type
|
|
1962
|
-
type
|
|
1963
|
-
type
|
|
1964
|
-
type
|
|
1965
|
-
type
|
|
1966
|
-
type
|
|
1967
|
-
type
|
|
1968
|
-
type
|
|
1969
|
-
type
|
|
1970
|
-
type
|
|
1971
|
-
type
|
|
1972
|
-
type
|
|
1973
|
-
type
|
|
1974
|
-
type
|
|
1975
|
-
type
|
|
1976
|
-
type
|
|
1977
|
-
type
|
|
1978
|
-
type
|
|
1979
|
-
type
|
|
1980
|
-
type
|
|
1981
|
-
type
|
|
1982
|
-
type
|
|
1983
|
-
type
|
|
1984
|
-
type
|
|
1985
|
-
type
|
|
1986
|
-
type
|
|
1987
|
-
type
|
|
1988
|
-
type
|
|
1989
|
-
type
|
|
1990
|
-
type
|
|
1991
|
-
type
|
|
1992
|
-
type
|
|
1993
|
-
type
|
|
1994
|
-
type
|
|
1995
|
-
type
|
|
1996
|
-
type
|
|
1997
|
-
type
|
|
1998
|
-
type
|
|
1999
|
-
type
|
|
2000
|
-
type
|
|
2001
|
-
type
|
|
2002
|
-
type
|
|
2003
|
-
type
|
|
2004
|
-
type
|
|
2005
|
-
type
|
|
2006
|
-
type
|
|
2007
|
-
type
|
|
2008
|
-
type
|
|
1835
|
+
type AppliedCoupon = components['schemas']['AppliedCoupon'];
|
|
1836
|
+
type AppliedPromotion = components['schemas']['AppliedPromotion'];
|
|
1837
|
+
type BankTransfer = components['schemas']['BankTransfer'];
|
|
1838
|
+
type BusinessInfo = components['schemas']['BusinessInfo'];
|
|
1839
|
+
type CardPayment = components['schemas']['CardPayment'];
|
|
1840
|
+
type CheckInventoryResponse = components['schemas']['CheckInventoryResponse'];
|
|
1841
|
+
type CollectInStoreFulfillment = components['schemas']['CollectInStoreFulfillment'];
|
|
1842
|
+
type Customer = components['schemas']['Customer'];
|
|
1843
|
+
type CustomerAddress = components['schemas']['CustomerAddress'];
|
|
1844
|
+
type CustomerDetail = components['schemas']['CustomerDetail'];
|
|
1845
|
+
type CustomerInfo = components['schemas']['CustomerInfo'];
|
|
1846
|
+
type CustomerLoyalty = components['schemas']['CustomerLoyalty'];
|
|
1847
|
+
type CustomerSegment = components['schemas']['CustomerSegment'];
|
|
1848
|
+
type CustomerStatus = components['schemas']['CustomerStatus'];
|
|
1849
|
+
type DeliveryFulfillment = components['schemas']['DeliveryFulfillment'];
|
|
1850
|
+
type FulfillmentItem = components['schemas']['FulfillmentItem'];
|
|
1851
|
+
type FulfillmentPreference = components['schemas']['FulfillmentPreference'];
|
|
1852
|
+
type InventoryAction = components['schemas']['InventoryAction'];
|
|
1853
|
+
type InventoryActivity = components['schemas']['InventoryActivity'];
|
|
1854
|
+
type InventoryDetail = components['schemas']['InventoryDetail'];
|
|
1855
|
+
type InventoryStatus = components['schemas']['InventoryStatus'];
|
|
1856
|
+
type Invoice = components['schemas']['Invoice'];
|
|
1857
|
+
type InvoiceDetail = components['schemas']['InvoiceDetail'];
|
|
1858
|
+
type InvoiceItem = components['schemas']['InvoiceItem'];
|
|
1859
|
+
type ItemWiseInventory = components['schemas']['ItemWiseInventory'];
|
|
1860
|
+
type KycStatus = components['schemas']['KycStatus'];
|
|
1861
|
+
type LotBatchWiseInventory = components['schemas']['LotBatchWiseInventory'];
|
|
1862
|
+
type LoyaltyPointPayment = components['schemas']['LoyaltyPointPayment'];
|
|
1863
|
+
type NetbankingPayment = components['schemas']['NetbankingPayment'];
|
|
1864
|
+
type NotificationChannelPreferences = components['schemas']['NotificationChannelPreferences'];
|
|
1865
|
+
type NotificationPreferences = components['schemas']['NotificationPreferences'];
|
|
1866
|
+
type OpeningHours = components['schemas']['OpeningHours'];
|
|
1867
|
+
type Order = components['schemas']['Order'];
|
|
1868
|
+
type OrderAction = components['schemas']['OrderAction'];
|
|
1869
|
+
type OrderActivity = components['schemas']['OrderActivity'];
|
|
1870
|
+
type OrderDetail = components['schemas']['OrderDetail'];
|
|
1871
|
+
type OrderItem = components['schemas']['OrderItem'];
|
|
1872
|
+
type OrderList = components['schemas']['OrderList'];
|
|
1873
|
+
type OrderPayment = components['schemas']['OrderPayment'];
|
|
1874
|
+
type OrderPaymentInfo = components['schemas']['OrderPaymentInfo'];
|
|
1875
|
+
type OrderReceiptJsonFormat = components['schemas']['OrderReceiptJsonFormat'];
|
|
1876
|
+
type OrderShipment = components['schemas']['OrderShipment'];
|
|
1877
|
+
type OrderShipmentDetail = components['schemas']['OrderShipmentDetail'];
|
|
1878
|
+
type OrderStatus = components['schemas']['OrderStatus'];
|
|
1879
|
+
type Pagination = components['schemas']['Pagination'];
|
|
1880
|
+
type PartialCollectAndDelivery = components['schemas']['PartialCollectAndDelivery'];
|
|
1881
|
+
type PaymentStatus = components['schemas']['PaymentStatus'];
|
|
1882
|
+
type ProductImage = components['schemas']['ProductImage'];
|
|
1883
|
+
type Shipment = components['schemas']['Shipment'];
|
|
1884
|
+
type ShipmentAction = components['schemas']['ShipmentAction'];
|
|
1885
|
+
type ShipmentActivity = components['schemas']['ShipmentActivity'];
|
|
1886
|
+
type ShipmentBox = components['schemas']['ShipmentBox'];
|
|
1887
|
+
type ShipmentDetail = components['schemas']['ShipmentDetail'];
|
|
1888
|
+
type ShipmentInfo = components['schemas']['ShipmentInfo'];
|
|
1889
|
+
type ShipmentItem = components['schemas']['ShipmentItem'];
|
|
1890
|
+
type ShipmentList = components['schemas']['ShipmentList'];
|
|
1891
|
+
type ShipmentPackaging = components['schemas']['ShipmentPackaging'];
|
|
1892
|
+
type ShipmentProgression = components['schemas']['ShipmentProgression'];
|
|
1893
|
+
type ShipmentStatus = components['schemas']['ShipmentStatus'];
|
|
1894
|
+
type UpiPayment = components['schemas']['UpiPayment'];
|
|
1895
|
+
type WalletPayment = components['schemas']['WalletPayment'];
|
|
1896
|
+
type Warehouse = components['schemas']['Warehouse'];
|
|
1897
|
+
type WarehouseBasicDetail = components['schemas']['WarehouseBasicDetail'];
|
|
1898
|
+
type WarehouseWiseInventory = components['schemas']['WarehouseWiseInventory'];
|
|
1899
|
+
type PosListInventoryResponse = Readable<paths['/pos/catalog/inventories']['get']['responses'][200]['content']['application/json']>;
|
|
1900
|
+
type PosListInventoryContent = PosListInventoryResponse['content'];
|
|
1901
|
+
type PosListInventoryQuery = paths['/pos/catalog/inventories']['get']['parameters']['query'];
|
|
1902
|
+
type PosListInventoryActivityResponse = Readable<paths['/pos/catalog/inventories/activites']['get']['responses'][200]['content']['application/json']>;
|
|
1903
|
+
type PosListInventoryActivityContent = PosListInventoryActivityResponse['content'];
|
|
1904
|
+
type PosListInventoryActivityQuery = paths['/pos/catalog/inventories/activites']['get']['parameters']['query'];
|
|
1905
|
+
type PosListInventoryDetailResponse = Readable<paths['/pos/catalog/inventories/detail']['get']['responses'][200]['content']['application/json']>;
|
|
1906
|
+
type PosListInventoryDetailContent = PosListInventoryDetailResponse['content'];
|
|
1907
|
+
type PosListInventoryDetailQuery = paths['/pos/catalog/inventories/detail']['get']['parameters']['query'];
|
|
1908
|
+
type PosListCustomersResponse = Readable<paths['/pos/customers']['get']['responses'][200]['content']['application/json']>;
|
|
1909
|
+
type PosListCustomersContent = PosListCustomersResponse['content'];
|
|
1910
|
+
type PosListCustomersQuery = paths['/pos/customers']['get']['parameters']['query'];
|
|
1911
|
+
type PosGetCustomerDetailResponse = Readable<paths['/pos/customers/{id}']['get']['responses'][200]['content']['application/json']>;
|
|
1912
|
+
type PosGetCustomerDetailContent = PosGetCustomerDetailResponse['content'];
|
|
1913
|
+
type PosGetCustomerDetailPathParams = paths['/pos/customers/{id}']['get']['parameters']['path'];
|
|
1914
|
+
type PosListOrdersResponse = Readable<paths['/pos/orders']['get']['responses'][200]['content']['application/json']>;
|
|
1915
|
+
type PosListOrdersContent = PosListOrdersResponse['content'];
|
|
1916
|
+
type PosListOrdersQuery = paths['/pos/orders']['get']['parameters']['query'];
|
|
1917
|
+
type PosGetOrderDetailResponse = Readable<paths['/pos/orders/{order_number}']['get']['responses'][200]['content']['application/json']>;
|
|
1918
|
+
type PosGetOrderDetailContent = PosGetOrderDetailResponse['content'];
|
|
1919
|
+
type PosGetOrderDetailPathParams = paths['/pos/orders/{order_number}']['get']['parameters']['path'];
|
|
1920
|
+
type PosListOrderActivityResponse = Readable<paths['/pos/orders/{order_number}/activity']['get']['responses'][200]['content']['application/json']>;
|
|
1921
|
+
type PosListOrderActivityContent = PosListOrderActivityResponse['content'];
|
|
1922
|
+
type PosListOrderActivityPathParams = paths['/pos/orders/{order_number}/activity']['get']['parameters']['path'];
|
|
1923
|
+
type PosCheckOrderInventoryResponse = Readable<paths['/pos/orders/{order_number}/check-inventory']['get']['responses'][200]['content']['application/json']>;
|
|
1924
|
+
type PosCheckOrderInventoryContent = PosCheckOrderInventoryResponse['content'];
|
|
1925
|
+
type PosCheckOrderInventoryPathParams = paths['/pos/orders/{order_number}/check-inventory']['get']['parameters']['path'];
|
|
1926
|
+
type PosGetOrderInvoiceResponse = Readable<paths['/pos/orders/{order_number}/invoice']['get']['responses'][200]['content']['application/json']>;
|
|
1927
|
+
type PosGetOrderInvoiceContent = PosGetOrderInvoiceResponse['content'];
|
|
1928
|
+
type PosGetOrderInvoiceQuery = paths['/pos/orders/{order_number}/invoice']['get']['parameters']['query'];
|
|
1929
|
+
type PosGetOrderInvoicePathParams = paths['/pos/orders/{order_number}/invoice']['get']['parameters']['path'];
|
|
1930
|
+
type PosGetOrderReceiptResponse = Readable<paths['/pos/orders/{order_number}/receipt']['get']['responses'][200]['content']['application/json']>;
|
|
1931
|
+
type PosGetOrderReceiptContent = PosGetOrderReceiptResponse['content'];
|
|
1932
|
+
type PosGetOrderReceiptQuery = paths['/pos/orders/{order_number}/receipt']['get']['parameters']['query'];
|
|
1933
|
+
type PosGetOrderReceiptPathParams = paths['/pos/orders/{order_number}/receipt']['get']['parameters']['path'];
|
|
1934
|
+
type PosListOrderShipmentsResponse = Readable<paths['/pos/orders/{order_number}/shipments']['get']['responses'][200]['content']['application/json']>;
|
|
1935
|
+
type PosListOrderShipmentsContent = PosListOrderShipmentsResponse['content'];
|
|
1936
|
+
type PosListOrderShipmentsPathParams = paths['/pos/orders/{order_number}/shipments']['get']['parameters']['path'];
|
|
1937
|
+
type PosListShipmentsResponse = Readable<paths['/pos/shipping/shipments']['get']['responses'][200]['content']['application/json']>;
|
|
1938
|
+
type PosListShipmentsContent = PosListShipmentsResponse['content'];
|
|
1939
|
+
type PosListShipmentsQuery = paths['/pos/shipping/shipments']['get']['parameters']['query'];
|
|
1940
|
+
type PosRefundShortfallResponse = Readable<paths['/pos/shipping/shipments/{order_number}/refund-shortfall']['post']['responses'][200]['content']['application/json']>;
|
|
1941
|
+
type PosRefundShortfallPathParams = paths['/pos/shipping/shipments/{order_number}/refund-shortfall']['post']['parameters']['path'];
|
|
1942
|
+
type PosRefundShortfallBody = Writable<NonNullable<paths['/pos/shipping/shipments/{order_number}/refund-shortfall']['post']['requestBody']>['content']['application/json']>;
|
|
1943
|
+
type PosGetShipmentDetailResponse = Readable<paths['/pos/shipping/shipments/{reference_number}']['get']['responses'][200]['content']['application/json']>;
|
|
1944
|
+
type PosGetShipmentDetailContent = PosGetShipmentDetailResponse['content'];
|
|
1945
|
+
type PosGetShipmentDetailPathParams = paths['/pos/shipping/shipments/{reference_number}']['get']['parameters']['path'];
|
|
1946
|
+
type PosGetShipmentActivitiesResponse = Readable<paths['/pos/shipping/shipments/{reference_number}/activities']['get']['responses'][200]['content']['application/json']>;
|
|
1947
|
+
type PosGetShipmentActivitiesContent = PosGetShipmentActivitiesResponse['content'];
|
|
1948
|
+
type PosGetShipmentActivitiesPathParams = paths['/pos/shipping/shipments/{reference_number}/activities']['get']['parameters']['path'];
|
|
1949
|
+
type PosGetShipmentInvoiceResponse = Readable<paths['/pos/shipping/shipments/{reference_number}/invoice']['get']['responses'][200]['content']['application/json']>;
|
|
1950
|
+
type PosGetShipmentInvoiceContent = PosGetShipmentInvoiceResponse['content'];
|
|
1951
|
+
type PosGetShipmentInvoiceQuery = paths['/pos/shipping/shipments/{reference_number}/invoice']['get']['parameters']['query'];
|
|
1952
|
+
type PosGetShipmentInvoicePathParams = paths['/pos/shipping/shipments/{reference_number}/invoice']['get']['parameters']['path'];
|
|
1953
|
+
type PosUpdateShipmentResponse = Readable<paths['/pos/shipping/shipments/{reference_number}/manual-update']['put']['responses'][200]['content']['application/json']>;
|
|
1954
|
+
type PosUpdateShipmentContent = PosUpdateShipmentResponse['content'];
|
|
1955
|
+
type PosUpdateShipmentPathParams = paths['/pos/shipping/shipments/{reference_number}/manual-update']['put']['parameters']['path'];
|
|
1956
|
+
type PosUpdateShipmentBody = Writable<NonNullable<paths['/pos/shipping/shipments/{reference_number}/manual-update']['put']['requestBody']>['content']['application/json']>;
|
|
2009
1957
|
//#endregion
|
|
2010
|
-
export { AppliedCoupon, AppliedPromotion, BankTransfer, BusinessInfo, CardPayment, CollectInStoreFulfillment, Customer, CustomerAddress, CustomerDetail, CustomerInfo, CustomerLoyalty, CustomerSegment, DeliveryFulfillment, FulfillmentItem, FulfillmentPreference,
|
|
1958
|
+
export { AppliedCoupon, AppliedPromotion, BankTransfer, BusinessInfo, CardPayment, CheckInventoryResponse, CollectInStoreFulfillment, Customer, CustomerAddress, CustomerDetail, CustomerInfo, CustomerLoyalty, CustomerSegment, CustomerStatus, DeliveryFulfillment, FulfillmentItem, FulfillmentPreference, InventoryAction, InventoryActivity, InventoryDetail, InventoryStatus, Invoice, InvoiceDetail, InvoiceItem, ItemWiseInventory, KycStatus, LotBatchWiseInventory, LoyaltyPointPayment, NetbankingPayment, NotificationChannelPreferences, NotificationPreferences, OpeningHours, Order, OrderAction, OrderActivity, OrderDetail, OrderItem, OrderList, OrderPayment, OrderPaymentInfo, OrderReceiptJsonFormat, OrderShipment, OrderShipmentDetail, OrderStatus, Pagination, PartialCollectAndDelivery, PaymentStatus, PosCheckOrderInventoryContent, PosCheckOrderInventoryPathParams, PosCheckOrderInventoryResponse, PosGetCustomerDetailContent, PosGetCustomerDetailPathParams, PosGetCustomerDetailResponse, PosGetOrderDetailContent, PosGetOrderDetailPathParams, PosGetOrderDetailResponse, PosGetOrderInvoiceContent, PosGetOrderInvoicePathParams, PosGetOrderInvoiceQuery, PosGetOrderInvoiceResponse, PosGetOrderReceiptContent, PosGetOrderReceiptPathParams, PosGetOrderReceiptQuery, PosGetOrderReceiptResponse, PosGetShipmentActivitiesContent, PosGetShipmentActivitiesPathParams, PosGetShipmentActivitiesResponse, PosGetShipmentDetailContent, PosGetShipmentDetailPathParams, PosGetShipmentDetailResponse, PosGetShipmentInvoiceContent, PosGetShipmentInvoicePathParams, PosGetShipmentInvoiceQuery, PosGetShipmentInvoiceResponse, PosListCustomersContent, PosListCustomersQuery, PosListCustomersResponse, PosListInventoryActivityContent, PosListInventoryActivityQuery, PosListInventoryActivityResponse, PosListInventoryContent, PosListInventoryDetailContent, PosListInventoryDetailQuery, PosListInventoryDetailResponse, PosListInventoryQuery, PosListInventoryResponse, PosListOrderActivityContent, PosListOrderActivityPathParams, PosListOrderActivityResponse, PosListOrderShipmentsContent, PosListOrderShipmentsPathParams, PosListOrderShipmentsResponse, PosListOrdersContent, PosListOrdersQuery, PosListOrdersResponse, PosListShipmentsContent, PosListShipmentsQuery, PosListShipmentsResponse, PosRefundShortfallBody, PosRefundShortfallPathParams, PosRefundShortfallResponse, PosUpdateShipmentBody, PosUpdateShipmentContent, PosUpdateShipmentPathParams, PosUpdateShipmentResponse, ProductImage, Shipment, ShipmentAction, ShipmentActivity, ShipmentBox, ShipmentDetail, ShipmentInfo, ShipmentItem, ShipmentList, ShipmentPackaging, ShipmentProgression, ShipmentStatus, UpiPayment, WalletPayment, Warehouse, WarehouseBasicDetail, WarehouseWiseInventory, type components, type operations, type paths };
|