@returnflows/shop-overlay 1.0.7 → 1.0.8
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.
|
@@ -214,6 +214,7 @@ export interface paths {
|
|
|
214
214
|
nextReturn: string | null;
|
|
215
215
|
statusPageUrl: string | null;
|
|
216
216
|
returnOrderUrl: string;
|
|
217
|
+
labelHolderReturnOrderId: string | null;
|
|
217
218
|
};
|
|
218
219
|
/** @enum {integer} */
|
|
219
220
|
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
@@ -366,6 +367,7 @@ export interface paths {
|
|
|
366
367
|
nextReturn: string | null;
|
|
367
368
|
statusPageUrl: string | null;
|
|
368
369
|
returnOrderUrl: string;
|
|
370
|
+
labelHolderReturnOrderId: string | null;
|
|
369
371
|
};
|
|
370
372
|
/** @enum {integer} */
|
|
371
373
|
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
@@ -724,6 +726,10 @@ export interface paths {
|
|
|
724
726
|
};
|
|
725
727
|
} | null;
|
|
726
728
|
}[];
|
|
729
|
+
groupReturnOrders: {
|
|
730
|
+
id: string;
|
|
731
|
+
shopifyOrderName: string;
|
|
732
|
+
}[];
|
|
727
733
|
numOfLabels: number;
|
|
728
734
|
returner: {
|
|
729
735
|
email: string;
|
|
@@ -1458,8 +1464,12 @@ export interface paths {
|
|
|
1458
1464
|
title: string;
|
|
1459
1465
|
amount: number;
|
|
1460
1466
|
}[];
|
|
1467
|
+
/** @enum {string} */
|
|
1468
|
+
remainderAction?: "REFUND" | "GIFTCARD";
|
|
1461
1469
|
calculatedAt: string;
|
|
1470
|
+
version: string;
|
|
1462
1471
|
};
|
|
1472
|
+
returnUserflowCancel: boolean;
|
|
1463
1473
|
};
|
|
1464
1474
|
/** @enum {integer} */
|
|
1465
1475
|
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
@@ -1722,6 +1732,8 @@ export interface paths {
|
|
|
1722
1732
|
content: {
|
|
1723
1733
|
"application/json": {
|
|
1724
1734
|
lineItems: {
|
|
1735
|
+
/** @description ReturnOrderLine.id - matches a specific row when a line item is split across rows */
|
|
1736
|
+
id?: string;
|
|
1725
1737
|
lineItemId: string;
|
|
1726
1738
|
quantity: number;
|
|
1727
1739
|
/** @enum {string} */
|
|
@@ -1738,6 +1750,8 @@ export interface paths {
|
|
|
1738
1750
|
remainderAction?: "REFUND" | "GIFTCARD";
|
|
1739
1751
|
shippingProductId: string;
|
|
1740
1752
|
numOfLabels?: number;
|
|
1753
|
+
shouldGroupShipment?: boolean;
|
|
1754
|
+
shipmentGroupId?: string;
|
|
1741
1755
|
customerNote?: string | null;
|
|
1742
1756
|
locale?: string;
|
|
1743
1757
|
updatedCustomerInformation?: {
|
|
@@ -10449,11 +10463,16 @@ export interface paths {
|
|
|
10449
10463
|
path?: never;
|
|
10450
10464
|
cookie?: never;
|
|
10451
10465
|
};
|
|
10452
|
-
/**
|
|
10466
|
+
/**
|
|
10467
|
+
* Get shop overlay details
|
|
10468
|
+
* @description Build the exchange overlay for a set of return order lines: the products to exchange, their prices, applicable product rules, and whether the lines are still within their exchange/refund windows.
|
|
10469
|
+
*/
|
|
10453
10470
|
get: {
|
|
10454
10471
|
parameters: {
|
|
10455
10472
|
query: {
|
|
10473
|
+
/** @description Internal return order id (ReturnOrder.id) */
|
|
10456
10474
|
internalId: string;
|
|
10475
|
+
/** @description Comma-separated list of ReturnOrderLine ids to include in the exchange overlay */
|
|
10457
10476
|
orderLines: string;
|
|
10458
10477
|
};
|
|
10459
10478
|
header?: never;
|
|
@@ -10472,21 +10491,36 @@ export interface paths {
|
|
|
10472
10491
|
success: boolean;
|
|
10473
10492
|
message: string;
|
|
10474
10493
|
responseObject?: {
|
|
10494
|
+
/** @description Internal return order id (echoes the request internalId) */
|
|
10475
10495
|
id: string;
|
|
10496
|
+
/** @description Shopify order id */
|
|
10476
10497
|
orderId: string;
|
|
10498
|
+
/** @description Human-readable Shopify order name (e.g. #1001) */
|
|
10477
10499
|
orderName: string;
|
|
10500
|
+
/** @description Whether the market allows instant exchanges */
|
|
10478
10501
|
instantExchange: boolean;
|
|
10502
|
+
/** @description True when the exchange shipping label is free (label price <= 0) */
|
|
10479
10503
|
freeExchangeLabel: boolean;
|
|
10504
|
+
/** @description The requested order lines formatted for exchange */
|
|
10480
10505
|
productsToExchange: {
|
|
10506
|
+
/** @description ReturnOrderLine id */
|
|
10481
10507
|
id: string;
|
|
10508
|
+
/** @description Shopify line item id */
|
|
10482
10509
|
shopifyLineId: string;
|
|
10510
|
+
/** @description Product title (falls back to the line item title) */
|
|
10483
10511
|
title: string;
|
|
10512
|
+
/** @description Variant title, empty when the variant is the default ("Default Title") */
|
|
10484
10513
|
variantTitle: string;
|
|
10514
|
+
/** @description Product or variant image URL, empty when unavailable */
|
|
10485
10515
|
image: string;
|
|
10516
|
+
/** @description Shopify product handle */
|
|
10486
10517
|
handle: string;
|
|
10518
|
+
/** @description Per-unit presented price in the order's presentment currency */
|
|
10487
10519
|
price: number;
|
|
10520
|
+
/** @description Total quantity requested across merged line items */
|
|
10488
10521
|
quantity: number;
|
|
10489
10522
|
}[];
|
|
10523
|
+
/** @description Product exchange rules for the order's country/market */
|
|
10490
10524
|
productRules: {
|
|
10491
10525
|
id: string;
|
|
10492
10526
|
/** @enum {string} */
|
|
@@ -10500,15 +10534,170 @@ export interface paths {
|
|
|
10500
10534
|
shopifyProductId: string;
|
|
10501
10535
|
ruleId: string;
|
|
10502
10536
|
title: string;
|
|
10503
|
-
image
|
|
10537
|
+
image: string | null;
|
|
10538
|
+
extendedBy?: number | null;
|
|
10539
|
+
createdAt: string;
|
|
10540
|
+
updatedAt?: string;
|
|
10541
|
+
} | null)[];
|
|
10542
|
+
}[];
|
|
10543
|
+
/** @description Combined value of all products to exchange (price * quantity) */
|
|
10544
|
+
totalPrice: number;
|
|
10545
|
+
/** @description Whether the requested lines are still eligible for exchange/refund */
|
|
10546
|
+
returnWindows: {
|
|
10547
|
+
/** @description True when at least one requested line is still within its exchange window */
|
|
10548
|
+
exchangeReturnWindow: boolean;
|
|
10549
|
+
/** @description True when at least one requested line is still within its refund window */
|
|
10550
|
+
refundReturnWindow: boolean;
|
|
10551
|
+
};
|
|
10552
|
+
};
|
|
10553
|
+
/** @enum {integer} */
|
|
10554
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10555
|
+
};
|
|
10556
|
+
};
|
|
10557
|
+
};
|
|
10558
|
+
/** @description Missing required parameters */
|
|
10559
|
+
400: {
|
|
10560
|
+
headers: {
|
|
10561
|
+
[name: string]: unknown;
|
|
10562
|
+
};
|
|
10563
|
+
content: {
|
|
10564
|
+
"application/json": {
|
|
10565
|
+
success: boolean;
|
|
10566
|
+
message: string;
|
|
10567
|
+
responseObject?: unknown;
|
|
10568
|
+
/** @enum {integer} */
|
|
10569
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10570
|
+
};
|
|
10571
|
+
};
|
|
10572
|
+
};
|
|
10573
|
+
/** @description Store, country code, order, order lines, or Shopify order not found */
|
|
10574
|
+
404: {
|
|
10575
|
+
headers: {
|
|
10576
|
+
[name: string]: unknown;
|
|
10577
|
+
};
|
|
10578
|
+
content: {
|
|
10579
|
+
"application/json": {
|
|
10580
|
+
success: boolean;
|
|
10581
|
+
message: string;
|
|
10582
|
+
responseObject?: unknown;
|
|
10583
|
+
/** @enum {integer} */
|
|
10584
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10585
|
+
};
|
|
10586
|
+
};
|
|
10587
|
+
};
|
|
10588
|
+
/** @description Error fetching order */
|
|
10589
|
+
500: {
|
|
10590
|
+
headers: {
|
|
10591
|
+
[name: string]: unknown;
|
|
10592
|
+
};
|
|
10593
|
+
content: {
|
|
10594
|
+
"application/json": {
|
|
10595
|
+
success: boolean;
|
|
10596
|
+
message: string;
|
|
10597
|
+
responseObject?: unknown;
|
|
10598
|
+
/** @enum {integer} */
|
|
10599
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10600
|
+
};
|
|
10601
|
+
};
|
|
10602
|
+
};
|
|
10603
|
+
};
|
|
10604
|
+
};
|
|
10605
|
+
put?: never;
|
|
10606
|
+
post?: never;
|
|
10607
|
+
delete?: never;
|
|
10608
|
+
options?: never;
|
|
10609
|
+
head?: never;
|
|
10610
|
+
patch?: never;
|
|
10611
|
+
trace?: never;
|
|
10612
|
+
};
|
|
10613
|
+
"/shop-overlay/session/{id}": {
|
|
10614
|
+
parameters: {
|
|
10615
|
+
query?: never;
|
|
10616
|
+
header?: never;
|
|
10617
|
+
path?: never;
|
|
10618
|
+
cookie?: never;
|
|
10619
|
+
};
|
|
10620
|
+
/**
|
|
10621
|
+
* Get shop overlay details from session
|
|
10622
|
+
* @description Same as GET /shop-overlay but infers the internal order id and order lines from the user's session
|
|
10623
|
+
*/
|
|
10624
|
+
get: {
|
|
10625
|
+
parameters: {
|
|
10626
|
+
query?: never;
|
|
10627
|
+
header?: never;
|
|
10628
|
+
path: {
|
|
10629
|
+
id: string;
|
|
10630
|
+
};
|
|
10631
|
+
cookie?: never;
|
|
10632
|
+
};
|
|
10633
|
+
requestBody?: never;
|
|
10634
|
+
responses: {
|
|
10635
|
+
/** @description Shop overlay fetched successfully */
|
|
10636
|
+
200: {
|
|
10637
|
+
headers: {
|
|
10638
|
+
[name: string]: unknown;
|
|
10639
|
+
};
|
|
10640
|
+
content: {
|
|
10641
|
+
"application/json": {
|
|
10642
|
+
success: boolean;
|
|
10643
|
+
message: string;
|
|
10644
|
+
responseObject?: {
|
|
10645
|
+
/** @description Internal return order id (echoes the request internalId) */
|
|
10646
|
+
id: string;
|
|
10647
|
+
/** @description Shopify order id */
|
|
10648
|
+
orderId: string;
|
|
10649
|
+
/** @description Human-readable Shopify order name (e.g. #1001) */
|
|
10650
|
+
orderName: string;
|
|
10651
|
+
/** @description Whether the market allows instant exchanges */
|
|
10652
|
+
instantExchange: boolean;
|
|
10653
|
+
/** @description True when the exchange shipping label is free (label price <= 0) */
|
|
10654
|
+
freeExchangeLabel: boolean;
|
|
10655
|
+
/** @description The requested order lines formatted for exchange */
|
|
10656
|
+
productsToExchange: {
|
|
10657
|
+
/** @description ReturnOrderLine id */
|
|
10658
|
+
id: string;
|
|
10659
|
+
/** @description Shopify line item id */
|
|
10660
|
+
shopifyLineId: string;
|
|
10661
|
+
/** @description Product title (falls back to the line item title) */
|
|
10662
|
+
title: string;
|
|
10663
|
+
/** @description Variant title, empty when the variant is the default ("Default Title") */
|
|
10664
|
+
variantTitle: string;
|
|
10665
|
+
/** @description Product or variant image URL, empty when unavailable */
|
|
10666
|
+
image: string;
|
|
10667
|
+
/** @description Shopify product handle */
|
|
10668
|
+
handle: string;
|
|
10669
|
+
/** @description Per-unit presented price in the order's presentment currency */
|
|
10670
|
+
price: number;
|
|
10671
|
+
/** @description Total quantity requested across merged line items */
|
|
10672
|
+
quantity: number;
|
|
10673
|
+
}[];
|
|
10674
|
+
/** @description Product exchange rules for the order's country/market */
|
|
10675
|
+
productRules: {
|
|
10676
|
+
id: string;
|
|
10677
|
+
/** @enum {string} */
|
|
10678
|
+
type: "NO_RETURN" | "NO_EXCHANGE_TO" | "NO_REFUND" | "EXTEND_PERIOD" | "FORCE_RETURN";
|
|
10679
|
+
extendedBy: number | null;
|
|
10680
|
+
marketId: string;
|
|
10681
|
+
createdAt: string;
|
|
10682
|
+
updatedAt: string;
|
|
10683
|
+
products: ({
|
|
10684
|
+
id: string;
|
|
10685
|
+
shopifyProductId: string;
|
|
10686
|
+
ruleId: string;
|
|
10687
|
+
title: string;
|
|
10688
|
+
image: string | null;
|
|
10504
10689
|
extendedBy?: number | null;
|
|
10505
10690
|
createdAt: string;
|
|
10506
10691
|
updatedAt?: string;
|
|
10507
10692
|
} | null)[];
|
|
10508
10693
|
}[];
|
|
10694
|
+
/** @description Combined value of all products to exchange (price * quantity) */
|
|
10509
10695
|
totalPrice: number;
|
|
10696
|
+
/** @description Whether the requested lines are still eligible for exchange/refund */
|
|
10510
10697
|
returnWindows: {
|
|
10698
|
+
/** @description True when at least one requested line is still within its exchange window */
|
|
10511
10699
|
exchangeReturnWindow: boolean;
|
|
10700
|
+
/** @description True when at least one requested line is still within its refund window */
|
|
10512
10701
|
refundReturnWindow: boolean;
|
|
10513
10702
|
};
|
|
10514
10703
|
};
|
|
@@ -10517,6 +10706,51 @@ export interface paths {
|
|
|
10517
10706
|
};
|
|
10518
10707
|
};
|
|
10519
10708
|
};
|
|
10709
|
+
/** @description Missing required parameter: id */
|
|
10710
|
+
400: {
|
|
10711
|
+
headers: {
|
|
10712
|
+
[name: string]: unknown;
|
|
10713
|
+
};
|
|
10714
|
+
content: {
|
|
10715
|
+
"application/json": {
|
|
10716
|
+
success: boolean;
|
|
10717
|
+
message: string;
|
|
10718
|
+
responseObject?: unknown;
|
|
10719
|
+
/** @enum {integer} */
|
|
10720
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10721
|
+
};
|
|
10722
|
+
};
|
|
10723
|
+
};
|
|
10724
|
+
/** @description Session, selected items, store, country code, order, order lines, or Shopify order not found */
|
|
10725
|
+
404: {
|
|
10726
|
+
headers: {
|
|
10727
|
+
[name: string]: unknown;
|
|
10728
|
+
};
|
|
10729
|
+
content: {
|
|
10730
|
+
"application/json": {
|
|
10731
|
+
success: boolean;
|
|
10732
|
+
message: string;
|
|
10733
|
+
responseObject?: unknown;
|
|
10734
|
+
/** @enum {integer} */
|
|
10735
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10736
|
+
};
|
|
10737
|
+
};
|
|
10738
|
+
};
|
|
10739
|
+
/** @description Error fetching order */
|
|
10740
|
+
500: {
|
|
10741
|
+
headers: {
|
|
10742
|
+
[name: string]: unknown;
|
|
10743
|
+
};
|
|
10744
|
+
content: {
|
|
10745
|
+
"application/json": {
|
|
10746
|
+
success: boolean;
|
|
10747
|
+
message: string;
|
|
10748
|
+
responseObject?: unknown;
|
|
10749
|
+
/** @enum {integer} */
|
|
10750
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10751
|
+
};
|
|
10752
|
+
};
|
|
10753
|
+
};
|
|
10520
10754
|
};
|
|
10521
10755
|
};
|
|
10522
10756
|
put?: never;
|
|
@@ -10541,7 +10775,9 @@ export interface paths {
|
|
|
10541
10775
|
get: {
|
|
10542
10776
|
parameters: {
|
|
10543
10777
|
query: {
|
|
10778
|
+
/** @description Store slug used to resolve the shop */
|
|
10544
10779
|
slug: string;
|
|
10780
|
+
/** @description Locale to fetch custom translations for (e.g. en, da) */
|
|
10545
10781
|
locale: string;
|
|
10546
10782
|
};
|
|
10547
10783
|
header?: never;
|
|
@@ -10582,6 +10818,51 @@ export interface paths {
|
|
|
10582
10818
|
};
|
|
10583
10819
|
};
|
|
10584
10820
|
};
|
|
10821
|
+
/** @description Missing required parameters: slug, locale */
|
|
10822
|
+
400: {
|
|
10823
|
+
headers: {
|
|
10824
|
+
[name: string]: unknown;
|
|
10825
|
+
};
|
|
10826
|
+
content: {
|
|
10827
|
+
"application/json": {
|
|
10828
|
+
success: boolean;
|
|
10829
|
+
message: string;
|
|
10830
|
+
responseObject?: unknown;
|
|
10831
|
+
/** @enum {integer} */
|
|
10832
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10833
|
+
};
|
|
10834
|
+
};
|
|
10835
|
+
};
|
|
10836
|
+
/** @description Store not found */
|
|
10837
|
+
404: {
|
|
10838
|
+
headers: {
|
|
10839
|
+
[name: string]: unknown;
|
|
10840
|
+
};
|
|
10841
|
+
content: {
|
|
10842
|
+
"application/json": {
|
|
10843
|
+
success: boolean;
|
|
10844
|
+
message: string;
|
|
10845
|
+
responseObject?: unknown;
|
|
10846
|
+
/** @enum {integer} */
|
|
10847
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10848
|
+
};
|
|
10849
|
+
};
|
|
10850
|
+
};
|
|
10851
|
+
/** @description Error fetching shop overlay config */
|
|
10852
|
+
500: {
|
|
10853
|
+
headers: {
|
|
10854
|
+
[name: string]: unknown;
|
|
10855
|
+
};
|
|
10856
|
+
content: {
|
|
10857
|
+
"application/json": {
|
|
10858
|
+
success: boolean;
|
|
10859
|
+
message: string;
|
|
10860
|
+
responseObject?: unknown;
|
|
10861
|
+
/** @enum {integer} */
|
|
10862
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10863
|
+
};
|
|
10864
|
+
};
|
|
10865
|
+
};
|
|
10585
10866
|
};
|
|
10586
10867
|
};
|
|
10587
10868
|
put?: never;
|
|
@@ -10601,7 +10882,7 @@ export interface paths {
|
|
|
10601
10882
|
};
|
|
10602
10883
|
/**
|
|
10603
10884
|
* Validate theme configuration
|
|
10604
|
-
* @description
|
|
10885
|
+
* @description Inspect a Shopify theme's settings_data.json to determine whether an enabled Returnflows app embed block is present. Validates the main theme when no theme id is provided.
|
|
10605
10886
|
*/
|
|
10606
10887
|
get: {
|
|
10607
10888
|
parameters: {
|
|
@@ -10627,10 +10908,15 @@ export interface paths {
|
|
|
10627
10908
|
success: boolean;
|
|
10628
10909
|
message: string;
|
|
10629
10910
|
responseObject?: {
|
|
10911
|
+
/** @description True when an enabled Returnflows app embed block is present in the theme */
|
|
10630
10912
|
hasActiveAppEmbed: boolean;
|
|
10913
|
+
/** @description Resolved theme id */
|
|
10631
10914
|
themeId?: string;
|
|
10915
|
+
/** @description Resolved theme name */
|
|
10632
10916
|
themeName?: string;
|
|
10917
|
+
/** @description Number of app embed blocks found in the theme settings */
|
|
10633
10918
|
blocksFound?: number;
|
|
10919
|
+
/** @description Error detail when validation fails */
|
|
10634
10920
|
error?: string;
|
|
10635
10921
|
};
|
|
10636
10922
|
/** @enum {integer} */
|
|
@@ -10638,42 +10924,94 @@ export interface paths {
|
|
|
10638
10924
|
};
|
|
10639
10925
|
};
|
|
10640
10926
|
};
|
|
10641
|
-
|
|
10642
|
-
|
|
10643
|
-
|
|
10644
|
-
|
|
10645
|
-
|
|
10646
|
-
|
|
10647
|
-
|
|
10648
|
-
|
|
10649
|
-
|
|
10650
|
-
|
|
10651
|
-
|
|
10652
|
-
|
|
10653
|
-
|
|
10654
|
-
|
|
10655
|
-
|
|
10656
|
-
|
|
10657
|
-
|
|
10658
|
-
|
|
10659
|
-
|
|
10660
|
-
|
|
10661
|
-
|
|
10662
|
-
|
|
10663
|
-
|
|
10664
|
-
|
|
10665
|
-
|
|
10666
|
-
|
|
10667
|
-
|
|
10668
|
-
|
|
10669
|
-
|
|
10670
|
-
|
|
10671
|
-
|
|
10672
|
-
|
|
10673
|
-
|
|
10674
|
-
|
|
10675
|
-
|
|
10676
|
-
|
|
10927
|
+
/** @description No theme data or theme settings found */
|
|
10928
|
+
404: {
|
|
10929
|
+
headers: {
|
|
10930
|
+
[name: string]: unknown;
|
|
10931
|
+
};
|
|
10932
|
+
content: {
|
|
10933
|
+
"application/json": {
|
|
10934
|
+
success: boolean;
|
|
10935
|
+
message: string;
|
|
10936
|
+
responseObject?: {
|
|
10937
|
+
/** @description True when an enabled Returnflows app embed block is present in the theme */
|
|
10938
|
+
hasActiveAppEmbed: boolean;
|
|
10939
|
+
/** @description Resolved theme id */
|
|
10940
|
+
themeId?: string;
|
|
10941
|
+
/** @description Resolved theme name */
|
|
10942
|
+
themeName?: string;
|
|
10943
|
+
/** @description Number of app embed blocks found in the theme settings */
|
|
10944
|
+
blocksFound?: number;
|
|
10945
|
+
/** @description Error detail when validation fails */
|
|
10946
|
+
error?: string;
|
|
10947
|
+
};
|
|
10948
|
+
/** @enum {integer} */
|
|
10949
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10950
|
+
};
|
|
10951
|
+
};
|
|
10952
|
+
};
|
|
10953
|
+
/** @description Failed to parse theme settings or theme validation failed */
|
|
10954
|
+
500: {
|
|
10955
|
+
headers: {
|
|
10956
|
+
[name: string]: unknown;
|
|
10957
|
+
};
|
|
10958
|
+
content: {
|
|
10959
|
+
"application/json": {
|
|
10960
|
+
success: boolean;
|
|
10961
|
+
message: string;
|
|
10962
|
+
responseObject?: {
|
|
10963
|
+
/** @description True when an enabled Returnflows app embed block is present in the theme */
|
|
10964
|
+
hasActiveAppEmbed: boolean;
|
|
10965
|
+
/** @description Resolved theme id */
|
|
10966
|
+
themeId?: string;
|
|
10967
|
+
/** @description Resolved theme name */
|
|
10968
|
+
themeName?: string;
|
|
10969
|
+
/** @description Number of app embed blocks found in the theme settings */
|
|
10970
|
+
blocksFound?: number;
|
|
10971
|
+
/** @description Error detail when validation fails */
|
|
10972
|
+
error?: string;
|
|
10973
|
+
};
|
|
10974
|
+
/** @enum {integer} */
|
|
10975
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
10976
|
+
};
|
|
10977
|
+
};
|
|
10978
|
+
};
|
|
10979
|
+
};
|
|
10980
|
+
};
|
|
10981
|
+
put?: never;
|
|
10982
|
+
post?: never;
|
|
10983
|
+
delete?: never;
|
|
10984
|
+
options?: never;
|
|
10985
|
+
head?: never;
|
|
10986
|
+
patch?: never;
|
|
10987
|
+
trace?: never;
|
|
10988
|
+
};
|
|
10989
|
+
"/export/return-order": {
|
|
10990
|
+
parameters: {
|
|
10991
|
+
query?: never;
|
|
10992
|
+
header?: never;
|
|
10993
|
+
path?: never;
|
|
10994
|
+
cookie?: never;
|
|
10995
|
+
};
|
|
10996
|
+
get?: never;
|
|
10997
|
+
put?: never;
|
|
10998
|
+
/** Export return orders to a CSV file */
|
|
10999
|
+
post: {
|
|
11000
|
+
parameters: {
|
|
11001
|
+
query?: never;
|
|
11002
|
+
header?: never;
|
|
11003
|
+
path?: never;
|
|
11004
|
+
cookie?: never;
|
|
11005
|
+
};
|
|
11006
|
+
requestBody?: {
|
|
11007
|
+
content: {
|
|
11008
|
+
"application/json": {
|
|
11009
|
+
/** @enum {string} */
|
|
11010
|
+
format: "excel" | "csv";
|
|
11011
|
+
/** @enum {string} */
|
|
11012
|
+
range: "search" | "all" | "page" | "selected";
|
|
11013
|
+
searchQuery?: string;
|
|
11014
|
+
selectedIds?: string[];
|
|
10677
11015
|
dateRangeStart?: number;
|
|
10678
11016
|
dateRangeEnd?: number;
|
|
10679
11017
|
};
|
|
@@ -15521,6 +15859,7 @@ export interface paths {
|
|
|
15521
15859
|
instantExchangeFraudRiskMedium: boolean;
|
|
15522
15860
|
/** @enum {string} */
|
|
15523
15861
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
15862
|
+
groupReturnsEnabled: boolean;
|
|
15524
15863
|
} | null;
|
|
15525
15864
|
productRules: {
|
|
15526
15865
|
id: string;
|
|
@@ -16109,6 +16448,7 @@ export interface paths {
|
|
|
16109
16448
|
instantExchangeFraudRiskMedium: boolean;
|
|
16110
16449
|
/** @enum {string} */
|
|
16111
16450
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
16451
|
+
groupReturnsEnabled: boolean;
|
|
16112
16452
|
} | null;
|
|
16113
16453
|
productRules: {
|
|
16114
16454
|
id: string;
|
|
@@ -16796,6 +17136,7 @@ export interface paths {
|
|
|
16796
17136
|
instantExchangeFraudRiskMedium: boolean;
|
|
16797
17137
|
/** @enum {string} */
|
|
16798
17138
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
17139
|
+
groupReturnsEnabled: boolean;
|
|
16799
17140
|
} | null;
|
|
16800
17141
|
claimQuestions: {
|
|
16801
17142
|
id: string;
|
|
@@ -16922,6 +17263,8 @@ export interface paths {
|
|
|
16922
17263
|
primaryTextColor: string;
|
|
16923
17264
|
secondaryTextColor: string;
|
|
16924
17265
|
} | null;
|
|
17266
|
+
brandColor: string | null;
|
|
17267
|
+
accentColor: string | null;
|
|
16925
17268
|
claimsEnabled: boolean;
|
|
16926
17269
|
};
|
|
16927
17270
|
/** @enum {integer} */
|
|
@@ -18242,6 +18585,7 @@ export interface paths {
|
|
|
18242
18585
|
instantExchangeFraudRiskMedium: boolean;
|
|
18243
18586
|
/** @enum {string} */
|
|
18244
18587
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
18588
|
+
groupReturnsEnabled: boolean;
|
|
18245
18589
|
} | null;
|
|
18246
18590
|
productRules: {
|
|
18247
18591
|
id: string;
|
|
@@ -19251,6 +19595,7 @@ export interface paths {
|
|
|
19251
19595
|
instantExchangeFraudRiskMedium: boolean;
|
|
19252
19596
|
/** @enum {string} */
|
|
19253
19597
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
19598
|
+
groupReturnsEnabled: boolean;
|
|
19254
19599
|
} | null;
|
|
19255
19600
|
productRules: {
|
|
19256
19601
|
id: string;
|
|
@@ -20259,6 +20604,7 @@ export interface paths {
|
|
|
20259
20604
|
instantExchangeFraudRiskMedium: boolean;
|
|
20260
20605
|
/** @enum {string} */
|
|
20261
20606
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
20607
|
+
groupReturnsEnabled: boolean;
|
|
20262
20608
|
} | null;
|
|
20263
20609
|
productRules: {
|
|
20264
20610
|
id: string;
|
|
@@ -21345,6 +21691,7 @@ export interface paths {
|
|
|
21345
21691
|
instantExchangeFraudRiskMedium: boolean;
|
|
21346
21692
|
/** @enum {string} */
|
|
21347
21693
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
21694
|
+
groupReturnsEnabled: boolean;
|
|
21348
21695
|
} | null;
|
|
21349
21696
|
productRules: {
|
|
21350
21697
|
id: string;
|
|
@@ -21990,6 +22337,8 @@ export interface paths {
|
|
|
21990
22337
|
description?: string;
|
|
21991
22338
|
desktopImageUrl?: string;
|
|
21992
22339
|
mobileImageUrl?: string;
|
|
22340
|
+
/** @enum {string} */
|
|
22341
|
+
backgroundImageLogo?: "light" | "dark" | "none";
|
|
21993
22342
|
};
|
|
21994
22343
|
id: string;
|
|
21995
22344
|
title: string;
|
|
@@ -25017,7 +25366,10 @@ export interface paths {
|
|
|
25017
25366
|
title: string;
|
|
25018
25367
|
amount: number;
|
|
25019
25368
|
}[];
|
|
25369
|
+
/** @enum {string} */
|
|
25370
|
+
remainderAction?: "REFUND" | "GIFTCARD";
|
|
25020
25371
|
calculatedAt: string;
|
|
25372
|
+
version: string;
|
|
25021
25373
|
};
|
|
25022
25374
|
/** @enum {integer} */
|
|
25023
25375
|
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
@@ -25096,6 +25448,8 @@ export interface paths {
|
|
|
25096
25448
|
description?: string;
|
|
25097
25449
|
desktopImageUrl?: string;
|
|
25098
25450
|
mobileImageUrl?: string;
|
|
25451
|
+
/** @enum {string} */
|
|
25452
|
+
backgroundImageLogo?: "light" | "dark" | "none";
|
|
25099
25453
|
};
|
|
25100
25454
|
id: string;
|
|
25101
25455
|
title: string;
|
|
@@ -25358,6 +25712,8 @@ export interface paths {
|
|
|
25358
25712
|
description?: string;
|
|
25359
25713
|
desktopImageUrl?: string;
|
|
25360
25714
|
mobileImageUrl?: string;
|
|
25715
|
+
/** @enum {string} */
|
|
25716
|
+
backgroundImageLogo?: "light" | "dark" | "none";
|
|
25361
25717
|
};
|
|
25362
25718
|
id?: string;
|
|
25363
25719
|
title: string;
|
|
@@ -25613,6 +25969,8 @@ export interface paths {
|
|
|
25613
25969
|
description?: string;
|
|
25614
25970
|
desktopImageUrl?: string;
|
|
25615
25971
|
mobileImageUrl?: string;
|
|
25972
|
+
/** @enum {string} */
|
|
25973
|
+
backgroundImageLogo?: "light" | "dark" | "none";
|
|
25616
25974
|
};
|
|
25617
25975
|
id: string;
|
|
25618
25976
|
title: string;
|
|
@@ -25849,6 +26207,56 @@ export interface paths {
|
|
|
25849
26207
|
patch?: never;
|
|
25850
26208
|
trace?: never;
|
|
25851
26209
|
};
|
|
26210
|
+
"/settings/flow/step-defaults": {
|
|
26211
|
+
parameters: {
|
|
26212
|
+
query?: never;
|
|
26213
|
+
header?: never;
|
|
26214
|
+
path?: never;
|
|
26215
|
+
cookie?: never;
|
|
26216
|
+
};
|
|
26217
|
+
/**
|
|
26218
|
+
* Get default userflow translations for flow steps
|
|
26219
|
+
* @description Returns the default title and subtitle for each predefined flow step in the store's configured language. Used to show placeholder text in the flow step editor.
|
|
26220
|
+
*/
|
|
26221
|
+
get: {
|
|
26222
|
+
parameters: {
|
|
26223
|
+
query?: never;
|
|
26224
|
+
header?: never;
|
|
26225
|
+
path?: never;
|
|
26226
|
+
cookie?: never;
|
|
26227
|
+
};
|
|
26228
|
+
requestBody?: never;
|
|
26229
|
+
responses: {
|
|
26230
|
+
/** @description Success */
|
|
26231
|
+
200: {
|
|
26232
|
+
headers: {
|
|
26233
|
+
[name: string]: unknown;
|
|
26234
|
+
};
|
|
26235
|
+
content: {
|
|
26236
|
+
"application/json": {
|
|
26237
|
+
success: boolean;
|
|
26238
|
+
message: string;
|
|
26239
|
+
responseObject?: {
|
|
26240
|
+
[key: string]: {
|
|
26241
|
+
title?: string;
|
|
26242
|
+
subtitle?: string;
|
|
26243
|
+
};
|
|
26244
|
+
};
|
|
26245
|
+
/** @enum {integer} */
|
|
26246
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
26247
|
+
};
|
|
26248
|
+
};
|
|
26249
|
+
};
|
|
26250
|
+
};
|
|
26251
|
+
};
|
|
26252
|
+
put?: never;
|
|
26253
|
+
post?: never;
|
|
26254
|
+
delete?: never;
|
|
26255
|
+
options?: never;
|
|
26256
|
+
head?: never;
|
|
26257
|
+
patch?: never;
|
|
26258
|
+
trace?: never;
|
|
26259
|
+
};
|
|
25852
26260
|
"/settings/flow/sections/{sectionId}/steps/{stepId}": {
|
|
25853
26261
|
parameters: {
|
|
25854
26262
|
query?: never;
|
|
@@ -25921,6 +26329,8 @@ export interface paths {
|
|
|
25921
26329
|
description?: string;
|
|
25922
26330
|
desktopImageUrl?: string;
|
|
25923
26331
|
mobileImageUrl?: string;
|
|
26332
|
+
/** @enum {string} */
|
|
26333
|
+
backgroundImageLogo?: "light" | "dark" | "none";
|
|
25924
26334
|
};
|
|
25925
26335
|
id: string;
|
|
25926
26336
|
title: string;
|
|
@@ -26667,6 +27077,7 @@ export interface paths {
|
|
|
26667
27077
|
instantExchangeFraudRiskMedium: boolean;
|
|
26668
27078
|
/** @enum {string} */
|
|
26669
27079
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
27080
|
+
groupReturnsEnabled: boolean;
|
|
26670
27081
|
};
|
|
26671
27082
|
/** @enum {integer} */
|
|
26672
27083
|
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
@@ -26780,6 +27191,7 @@ export interface paths {
|
|
|
26780
27191
|
instantExchangeFraudRiskMedium: boolean;
|
|
26781
27192
|
/** @enum {string} */
|
|
26782
27193
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
27194
|
+
groupReturnsEnabled: boolean;
|
|
26783
27195
|
};
|
|
26784
27196
|
/** @enum {integer} */
|
|
26785
27197
|
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
@@ -26878,6 +27290,7 @@ export interface paths {
|
|
|
26878
27290
|
instantExchangeFraudRiskMedium: boolean;
|
|
26879
27291
|
/** @enum {string} */
|
|
26880
27292
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
27293
|
+
groupReturnsEnabled: boolean;
|
|
26881
27294
|
};
|
|
26882
27295
|
/** @enum {integer} */
|
|
26883
27296
|
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
@@ -26984,6 +27397,7 @@ export interface paths {
|
|
|
26984
27397
|
/** @enum {string} */
|
|
26985
27398
|
bxgyHandlingAction?: "ALL_ACTIONS" | "NON_EXCHANGE_ACTIONS";
|
|
26986
27399
|
returnUserflowCancel?: boolean;
|
|
27400
|
+
groupReturnsEnabled?: boolean;
|
|
26987
27401
|
claimsEnabled?: boolean;
|
|
26988
27402
|
claimWindowInMonths?: number | null;
|
|
26989
27403
|
claimsAllowRejectedProducts?: boolean;
|
|
@@ -27088,6 +27502,7 @@ export interface paths {
|
|
|
27088
27502
|
instantExchangeFraudRiskMedium: boolean;
|
|
27089
27503
|
/** @enum {string} */
|
|
27090
27504
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
27505
|
+
groupReturnsEnabled: boolean;
|
|
27091
27506
|
};
|
|
27092
27507
|
/** @enum {integer} */
|
|
27093
27508
|
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
@@ -28298,6 +28713,336 @@ export interface paths {
|
|
|
28298
28713
|
patch?: never;
|
|
28299
28714
|
trace?: never;
|
|
28300
28715
|
};
|
|
28716
|
+
"/shipment-groups/check-eligibility": {
|
|
28717
|
+
parameters: {
|
|
28718
|
+
query?: never;
|
|
28719
|
+
header?: never;
|
|
28720
|
+
path?: never;
|
|
28721
|
+
cookie?: never;
|
|
28722
|
+
};
|
|
28723
|
+
get?: never;
|
|
28724
|
+
put?: never;
|
|
28725
|
+
/**
|
|
28726
|
+
* Check if a return order is eligible for group shipment
|
|
28727
|
+
* @description Validates whether a return order can be grouped with a preceding order based on weight limits and eligibility criteria.
|
|
28728
|
+
*/
|
|
28729
|
+
post: {
|
|
28730
|
+
parameters: {
|
|
28731
|
+
query?: never;
|
|
28732
|
+
header?: never;
|
|
28733
|
+
path?: never;
|
|
28734
|
+
cookie?: never;
|
|
28735
|
+
};
|
|
28736
|
+
requestBody?: {
|
|
28737
|
+
content: {
|
|
28738
|
+
"application/json": {
|
|
28739
|
+
returnOrderId: string;
|
|
28740
|
+
selectedLineItemIds: string[];
|
|
28741
|
+
};
|
|
28742
|
+
};
|
|
28743
|
+
};
|
|
28744
|
+
responses: {
|
|
28745
|
+
/** @description Eligibility check result */
|
|
28746
|
+
200: {
|
|
28747
|
+
headers: {
|
|
28748
|
+
[name: string]: unknown;
|
|
28749
|
+
};
|
|
28750
|
+
content: {
|
|
28751
|
+
"application/json": {
|
|
28752
|
+
success: boolean;
|
|
28753
|
+
message: string;
|
|
28754
|
+
responseObject?: {
|
|
28755
|
+
eligible: boolean;
|
|
28756
|
+
shipmentGroupId: string | null;
|
|
28757
|
+
shippingProductId: string | null;
|
|
28758
|
+
groupReturnOrders: {
|
|
28759
|
+
id: string;
|
|
28760
|
+
shopifyOrderName: string;
|
|
28761
|
+
}[];
|
|
28762
|
+
carrier: {
|
|
28763
|
+
id: string;
|
|
28764
|
+
name: string;
|
|
28765
|
+
logoUrl: string;
|
|
28766
|
+
} | null;
|
|
28767
|
+
reason?: string;
|
|
28768
|
+
};
|
|
28769
|
+
/** @enum {integer} */
|
|
28770
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
28771
|
+
};
|
|
28772
|
+
};
|
|
28773
|
+
};
|
|
28774
|
+
};
|
|
28775
|
+
};
|
|
28776
|
+
delete?: never;
|
|
28777
|
+
options?: never;
|
|
28778
|
+
head?: never;
|
|
28779
|
+
patch?: never;
|
|
28780
|
+
trace?: never;
|
|
28781
|
+
};
|
|
28782
|
+
"/shipment-groups/{id}": {
|
|
28783
|
+
parameters: {
|
|
28784
|
+
query?: never;
|
|
28785
|
+
header?: never;
|
|
28786
|
+
path?: never;
|
|
28787
|
+
cookie?: never;
|
|
28788
|
+
};
|
|
28789
|
+
/** Get a shipment group */
|
|
28790
|
+
get: {
|
|
28791
|
+
parameters: {
|
|
28792
|
+
query?: never;
|
|
28793
|
+
header: {
|
|
28794
|
+
authorization: string;
|
|
28795
|
+
};
|
|
28796
|
+
path: {
|
|
28797
|
+
id: string;
|
|
28798
|
+
};
|
|
28799
|
+
cookie?: never;
|
|
28800
|
+
};
|
|
28801
|
+
requestBody?: never;
|
|
28802
|
+
responses: {
|
|
28803
|
+
/** @description Shipment group retrieved */
|
|
28804
|
+
200: {
|
|
28805
|
+
headers: {
|
|
28806
|
+
[name: string]: unknown;
|
|
28807
|
+
};
|
|
28808
|
+
content: {
|
|
28809
|
+
"application/json": {
|
|
28810
|
+
success: boolean;
|
|
28811
|
+
message: string;
|
|
28812
|
+
responseObject?: {
|
|
28813
|
+
id: string;
|
|
28814
|
+
shop: string;
|
|
28815
|
+
createdByUsername: string;
|
|
28816
|
+
/** Format: date-time */
|
|
28817
|
+
createdAt: string;
|
|
28818
|
+
/** Format: date-time */
|
|
28819
|
+
updatedAt: string;
|
|
28820
|
+
/** @enum {string} */
|
|
28821
|
+
status: "pending" | "active" | "completed";
|
|
28822
|
+
shipments: {
|
|
28823
|
+
id: string;
|
|
28824
|
+
type: string;
|
|
28825
|
+
status: string;
|
|
28826
|
+
packageNumber: string | null;
|
|
28827
|
+
labelPdfUrl: string | null;
|
|
28828
|
+
trackingUrl: string | null;
|
|
28829
|
+
labelName: string | null;
|
|
28830
|
+
/** Format: date-time */
|
|
28831
|
+
createdAt: string;
|
|
28832
|
+
transportMarketProduct: {
|
|
28833
|
+
id: string;
|
|
28834
|
+
name: string | null;
|
|
28835
|
+
description: string | null;
|
|
28836
|
+
Carrier: {
|
|
28837
|
+
id: string;
|
|
28838
|
+
name: string;
|
|
28839
|
+
logoUrl: string;
|
|
28840
|
+
} | null;
|
|
28841
|
+
} | null;
|
|
28842
|
+
shipmentAddress: {
|
|
28843
|
+
id: string;
|
|
28844
|
+
address: string;
|
|
28845
|
+
city: string;
|
|
28846
|
+
zipCode: string;
|
|
28847
|
+
state: string | null;
|
|
28848
|
+
country: string;
|
|
28849
|
+
};
|
|
28850
|
+
shipmentContactInfo: {
|
|
28851
|
+
id: string;
|
|
28852
|
+
name: string;
|
|
28853
|
+
email: string;
|
|
28854
|
+
phone: string | null;
|
|
28855
|
+
};
|
|
28856
|
+
shipmentProducts: {
|
|
28857
|
+
id: string;
|
|
28858
|
+
weight: number;
|
|
28859
|
+
hsCode: string | null;
|
|
28860
|
+
returnOrderLine: {
|
|
28861
|
+
id: string;
|
|
28862
|
+
shopifyLineId: string | null;
|
|
28863
|
+
shopifyVariantId: string | null;
|
|
28864
|
+
shopifyProductId: string | null;
|
|
28865
|
+
title: string | null;
|
|
28866
|
+
variantTitle: string | null;
|
|
28867
|
+
imageUrl: string | null;
|
|
28868
|
+
} | null;
|
|
28869
|
+
}[];
|
|
28870
|
+
}[];
|
|
28871
|
+
returnOrders: {
|
|
28872
|
+
id: string;
|
|
28873
|
+
shopifyOrderId: string;
|
|
28874
|
+
returnOrderName: string;
|
|
28875
|
+
returnerEmail: string;
|
|
28876
|
+
returnerName: string;
|
|
28877
|
+
status: string;
|
|
28878
|
+
transportMarketProductId: string | null;
|
|
28879
|
+
ReturnOrderLine: {
|
|
28880
|
+
id: string;
|
|
28881
|
+
shopifyLineId: string | null;
|
|
28882
|
+
shopifyVariantId: string | null;
|
|
28883
|
+
shopifyProductId: string | null;
|
|
28884
|
+
title: string | null;
|
|
28885
|
+
variantTitle: string | null;
|
|
28886
|
+
imageUrl: string | null;
|
|
28887
|
+
}[];
|
|
28888
|
+
}[];
|
|
28889
|
+
};
|
|
28890
|
+
/** @enum {integer} */
|
|
28891
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
28892
|
+
};
|
|
28893
|
+
};
|
|
28894
|
+
};
|
|
28895
|
+
/** @description Group not found */
|
|
28896
|
+
404: {
|
|
28897
|
+
headers: {
|
|
28898
|
+
[name: string]: unknown;
|
|
28899
|
+
};
|
|
28900
|
+
content: {
|
|
28901
|
+
"application/json": {
|
|
28902
|
+
success: boolean;
|
|
28903
|
+
message: string;
|
|
28904
|
+
responseObject?: {
|
|
28905
|
+
code: string;
|
|
28906
|
+
message: string;
|
|
28907
|
+
};
|
|
28908
|
+
/** @enum {integer} */
|
|
28909
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
28910
|
+
};
|
|
28911
|
+
};
|
|
28912
|
+
};
|
|
28913
|
+
};
|
|
28914
|
+
};
|
|
28915
|
+
put?: never;
|
|
28916
|
+
post?: never;
|
|
28917
|
+
/**
|
|
28918
|
+
* Cancel a shipment group
|
|
28919
|
+
* @description Dissolves the group and unlinks all orders. Regenerates individual labels for each order.
|
|
28920
|
+
*/
|
|
28921
|
+
delete: {
|
|
28922
|
+
parameters: {
|
|
28923
|
+
query?: never;
|
|
28924
|
+
header: {
|
|
28925
|
+
authorization: string;
|
|
28926
|
+
};
|
|
28927
|
+
path: {
|
|
28928
|
+
id: string;
|
|
28929
|
+
};
|
|
28930
|
+
cookie?: never;
|
|
28931
|
+
};
|
|
28932
|
+
requestBody?: never;
|
|
28933
|
+
responses: {
|
|
28934
|
+
/** @description Group cancelled */
|
|
28935
|
+
200: {
|
|
28936
|
+
headers: {
|
|
28937
|
+
[name: string]: unknown;
|
|
28938
|
+
};
|
|
28939
|
+
content: {
|
|
28940
|
+
"application/json": {
|
|
28941
|
+
success: boolean;
|
|
28942
|
+
message: string;
|
|
28943
|
+
responseObject?: {
|
|
28944
|
+
message: string;
|
|
28945
|
+
};
|
|
28946
|
+
/** @enum {integer} */
|
|
28947
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
28948
|
+
};
|
|
28949
|
+
};
|
|
28950
|
+
};
|
|
28951
|
+
/** @description Group not found */
|
|
28952
|
+
404: {
|
|
28953
|
+
headers: {
|
|
28954
|
+
[name: string]: unknown;
|
|
28955
|
+
};
|
|
28956
|
+
content: {
|
|
28957
|
+
"application/json": {
|
|
28958
|
+
success: boolean;
|
|
28959
|
+
message: string;
|
|
28960
|
+
responseObject?: {
|
|
28961
|
+
code: string;
|
|
28962
|
+
message: string;
|
|
28963
|
+
};
|
|
28964
|
+
/** @enum {integer} */
|
|
28965
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
28966
|
+
};
|
|
28967
|
+
};
|
|
28968
|
+
};
|
|
28969
|
+
};
|
|
28970
|
+
};
|
|
28971
|
+
options?: never;
|
|
28972
|
+
head?: never;
|
|
28973
|
+
patch?: never;
|
|
28974
|
+
trace?: never;
|
|
28975
|
+
};
|
|
28976
|
+
"/shipment-groups/{id}/orders/{returnOrderId}": {
|
|
28977
|
+
parameters: {
|
|
28978
|
+
query?: never;
|
|
28979
|
+
header?: never;
|
|
28980
|
+
path?: never;
|
|
28981
|
+
cookie?: never;
|
|
28982
|
+
};
|
|
28983
|
+
get?: never;
|
|
28984
|
+
put?: never;
|
|
28985
|
+
post?: never;
|
|
28986
|
+
/**
|
|
28987
|
+
* Remove an order from a shipment group
|
|
28988
|
+
* @description Removes a single return order from the group and regenerates the group label for the remaining orders.
|
|
28989
|
+
*/
|
|
28990
|
+
delete: {
|
|
28991
|
+
parameters: {
|
|
28992
|
+
query?: never;
|
|
28993
|
+
header: {
|
|
28994
|
+
authorization: string;
|
|
28995
|
+
};
|
|
28996
|
+
path: {
|
|
28997
|
+
id: string;
|
|
28998
|
+
returnOrderId: string;
|
|
28999
|
+
};
|
|
29000
|
+
cookie?: never;
|
|
29001
|
+
};
|
|
29002
|
+
requestBody?: never;
|
|
29003
|
+
responses: {
|
|
29004
|
+
/** @description Order removed from group */
|
|
29005
|
+
200: {
|
|
29006
|
+
headers: {
|
|
29007
|
+
[name: string]: unknown;
|
|
29008
|
+
};
|
|
29009
|
+
content: {
|
|
29010
|
+
"application/json": {
|
|
29011
|
+
success: boolean;
|
|
29012
|
+
message: string;
|
|
29013
|
+
responseObject?: {
|
|
29014
|
+
message: string;
|
|
29015
|
+
};
|
|
29016
|
+
/** @enum {integer} */
|
|
29017
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
29018
|
+
};
|
|
29019
|
+
};
|
|
29020
|
+
};
|
|
29021
|
+
/** @description Group or order not found */
|
|
29022
|
+
404: {
|
|
29023
|
+
headers: {
|
|
29024
|
+
[name: string]: unknown;
|
|
29025
|
+
};
|
|
29026
|
+
content: {
|
|
29027
|
+
"application/json": {
|
|
29028
|
+
success: boolean;
|
|
29029
|
+
message: string;
|
|
29030
|
+
responseObject?: {
|
|
29031
|
+
code: string;
|
|
29032
|
+
message: string;
|
|
29033
|
+
};
|
|
29034
|
+
/** @enum {integer} */
|
|
29035
|
+
statusCode: 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
|
|
29036
|
+
};
|
|
29037
|
+
};
|
|
29038
|
+
};
|
|
29039
|
+
};
|
|
29040
|
+
};
|
|
29041
|
+
options?: never;
|
|
29042
|
+
head?: never;
|
|
29043
|
+
patch?: never;
|
|
29044
|
+
trace?: never;
|
|
29045
|
+
};
|
|
28301
29046
|
}
|
|
28302
29047
|
export type webhooks = Record<string, never>;
|
|
28303
29048
|
export interface components {
|
|
@@ -29319,6 +30064,7 @@ export interface components {
|
|
|
29319
30064
|
instantExchangeFraudRiskMedium: boolean;
|
|
29320
30065
|
/** @enum {string} */
|
|
29321
30066
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
30067
|
+
groupReturnsEnabled: boolean;
|
|
29322
30068
|
};
|
|
29323
30069
|
/**
|
|
29324
30070
|
* Market
|
|
@@ -29381,6 +30127,7 @@ export interface components {
|
|
|
29381
30127
|
instantExchangeFraudRiskMedium: boolean;
|
|
29382
30128
|
/** @enum {string} */
|
|
29383
30129
|
instantExchangeReturnOrderTrigger: "IN_TRANSIT" | "DELIVERED";
|
|
30130
|
+
groupReturnsEnabled: boolean;
|
|
29384
30131
|
};
|
|
29385
30132
|
/**
|
|
29386
30133
|
* FaqItem
|
|
@@ -29460,6 +30207,7 @@ export interface components {
|
|
|
29460
30207
|
/** @enum {string} */
|
|
29461
30208
|
bxgyHandlingAction?: "ALL_ACTIONS" | "NON_EXCHANGE_ACTIONS";
|
|
29462
30209
|
returnUserflowCancel?: boolean;
|
|
30210
|
+
groupReturnsEnabled?: boolean;
|
|
29463
30211
|
claimsEnabled?: boolean;
|
|
29464
30212
|
claimWindowInMonths?: number | null;
|
|
29465
30213
|
claimsAllowRejectedProducts?: boolean;
|