Skip to content

Commit 28e16c4

Browse files
committed
[Auto Generated] 3.28.0
1 parent cff8b41 commit 28e16c4

8 files changed

Lines changed: 4405 additions & 2365 deletions

File tree

openapi/application.json

Lines changed: 243 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"info": {
3-
"title": "Fynd Platform's Application Side APIs v2.12.2",
4-
"version": "3.27.0",
3+
"title": "Fynd Platform's Application Side APIs v2.12.3",
4+
"version": "3.28.0",
55
"description": "Fynd Platform's Application Side APIs"
66
},
77
"openapi": "3.0.2",
@@ -9068,6 +9068,10 @@
90689068
"example": {
90699069
"checkout_mode": "self",
90709070
"gstin": "27AAAAA0939A1AA",
9071+
"ship_to_gst_details": {
9072+
"gstin": "27AAPFU0939F1ZV",
9073+
"trade_name": "XYZ Traders"
9074+
},
90719075
"custom_cart_meta": {
90729076
"test": "test"
90739077
},
@@ -22469,6 +22473,23 @@
2246922473
"value": "Fynd"
2247022474
}
2247122475
}
22476+
},
22477+
{
22478+
"name": "app_permissions",
22479+
"in": "query",
22480+
"description": "App permissions.",
22481+
"required": false,
22482+
"schema": {
22483+
"type": "string"
22484+
},
22485+
"examples": {
22486+
"400": {
22487+
"value": "customer"
22488+
},
22489+
"success": {
22490+
"value": "customer"
22491+
}
22492+
}
2247222493
}
2247322494
],
2247422495
"responses": {
@@ -28875,6 +28896,20 @@
2887528896
"value": "%7B%22first_name%22:%22Fynd%22,%22last_name%22:%22Dummy%22,%22mobile%22:%229999999999%22,%22email%22:%22test@example.com"
2887628897
}
2887728898
}
28899+
},
28900+
{
28901+
"name": "display_split",
28902+
"in": "query",
28903+
"description": "Display Split Payment Option or not.",
28904+
"schema": {
28905+
"type": "boolean"
28906+
},
28907+
"examples": {
28908+
"payment_pos_success": {
28909+
"summary": "display_split",
28910+
"value": false
28911+
}
28912+
}
2887828913
}
2887928914
],
2888028915
"responses": {
@@ -32372,6 +32407,76 @@
3237232407
]
3237332408
}
3237432409
},
32410+
"/service/application/payment/v1.0/orders/{order_id}/transactions": {
32411+
"get": {
32412+
"summary": "getOrderTransactions | List all transactions for an order",
32413+
"description": "Returns all payment transactions for the given order ID, ordered by creation timestamp ascending. Each entry includes merchant transaction ID, payment mode name, logo, amount, latest status, and created_on.",
32414+
"tags": [
32415+
"Payment"
32416+
],
32417+
"parameters": [
32418+
{
32419+
"name": "order_id",
32420+
"in": "path",
32421+
"required": true,
32422+
"description": "Merchant order ID. Example: FY692D2AC45171FB895B",
32423+
"schema": {
32424+
"type": "string",
32425+
"example": "FY692D2AC45171FB895B"
32426+
}
32427+
}
32428+
],
32429+
"responses": {
32430+
"200": {
32431+
"description": "List of transactions for the order.",
32432+
"content": {
32433+
"application/json": {
32434+
"schema": {
32435+
"$ref": "#/components/schemas/OrderTransactionList"
32436+
},
32437+
"examples": {
32438+
"order_transactions_success": {
32439+
"value": {
32440+
"success": true,
32441+
"items": [
32442+
{
32443+
"transaction_id": "TR692D2BC451FA77D8GF",
32444+
"payment_mode": "UPI",
32445+
"logo": "https://cdn.fynd.com/payment/upi_small.png",
32446+
"amount": 499,
32447+
"status": "complete",
32448+
"created_on": "2024-01-15T10:30:00Z"
32449+
}
32450+
]
32451+
}
32452+
}
32453+
}
32454+
}
32455+
}
32456+
},
32457+
"400": {
32458+
"description": "Bad Request. See the error object in the response body to know the exact reason.",
32459+
"content": {
32460+
"application/json": {
32461+
"schema": {
32462+
"$ref": "#/components/schemas/HttpErrorCodeDetails"
32463+
},
32464+
"example": {
32465+
"success": false,
32466+
"error": {
32467+
"code": "BAD_REQUEST_ERROR",
32468+
"description": "Invalid order_id."
32469+
}
32470+
}
32471+
}
32472+
}
32473+
}
32474+
},
32475+
"x-groups": [
32476+
"Payment"
32477+
]
32478+
}
32479+
},
3237532480
"/service/application/share/v1.0/qr/": {
3237632481
"post": {
3237732482
"description": "Generates a QR code for the application for easy sharing.",
@@ -38582,6 +38687,12 @@
3858238687
"title": {
3858338688
"type": "string",
3858438689
"description": "Unique title for loyalty program applicable."
38690+
},
38691+
"meta": {
38692+
"type": "object",
38693+
"nullable": true,
38694+
"description": "Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.",
38695+
"additionalProperties": true
3858538696
}
3858638697
},
3858738698
"description": "Engage points data for the user cart."
@@ -38852,6 +38963,9 @@
3885238963
"type": "string",
3885338964
"description": "GSTIN added in user cart."
3885438965
},
38966+
"ship_to_gst_details": {
38967+
"$ref": "#/components/schemas/ShipToGstDetails"
38968+
},
3885538969
"restrict_checkout": {
3885638970
"type": "boolean",
3885738971
"description": "Restrict checkout flag to restrict the checkout process."
@@ -38885,6 +38999,12 @@
3888538999
"additionalProperties": true,
3888639000
"description": "Custom meta details added cart checkout API payload"
3888739001
},
39002+
"loyalty_meta": {
39003+
"type": "object",
39004+
"nullable": true,
39005+
"additionalProperties": true,
39006+
"description": "Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation."
39007+
},
3888839008
"alternate_pickup_person": {
3888939009
"$ref": "#/components/schemas/AlternatePickupPerson"
3889039010
},
@@ -39627,12 +39747,17 @@
3962739747
"redeem_points": {
3962839748
"type": "boolean",
3962939749
"description": "Marks if engage points are to be redeemed for the given cart."
39750+
},
39751+
"meta": {
39752+
"type": "object",
39753+
"description": "Free-form metadata forwarded to the loyalty engine. Any field can be passed (e.g. points, redeem_rule_id). Engage reads from this dict when processing redemption.",
39754+
"additionalProperties": true
3963039755
}
3963139756
},
3963239757
"required": [
3963339758
"redeem_points"
3963439759
],
39635-
"description": "loyaltys point request details."
39760+
"description": "Loyalty point request details."
3963639761
},
3963739762
"GeoLocation": {
3963839763
"type": "object",
@@ -40056,6 +40181,9 @@
4005640181
"type": "string",
4005740182
"description": "GSTIN number added in cart."
4005840183
},
40184+
"ship_to_gst_details": {
40185+
"$ref": "#/components/schemas/ShipToGstDetails"
40186+
},
4005940187
"restrict_checkout": {
4006040188
"type": "boolean",
4006140189
"description": "Restrict checkout flag to restrict the checkout process."
@@ -40440,6 +40568,9 @@
4044040568
"type": "string",
4044140569
"description": "GSTIN number added in cart."
4044240570
},
40571+
"ship_to_gst_details": {
40572+
"$ref": "#/components/schemas/ShipToGstDetails"
40573+
},
4044340574
"restrict_checkout": {
4044440575
"type": "boolean",
4044540576
"description": "Restrict checkout flag to restrict the checkout process."
@@ -40548,6 +40679,23 @@
4054840679
},
4054940680
"description": "Article level gift details which includes article id."
4055040681
},
40682+
"ShipToGstDetails": {
40683+
"type": "object",
40684+
"nullable": true,
40685+
"properties": {
40686+
"gstin": {
40687+
"type": "string",
40688+
"nullable": true,
40689+
"description": "Ship-to GSTIN for bill-to ship-to e-way bill generation."
40690+
},
40691+
"trade_name": {
40692+
"type": "string",
40693+
"nullable": true,
40694+
"description": "Ship-to trade name for bill-to ship-to e-way bill generation."
40695+
}
40696+
},
40697+
"description": "Ship-to GST and trade name details used for bill-to ship-to e-way bill generation."
40698+
},
4055140699
"CartMetaCreation": {
4055240700
"type": "object",
4055340701
"properties": {
@@ -40579,6 +40727,9 @@
4057940727
"type": "string",
4058040728
"description": "GSTIN number to be added in user cart."
4058140729
},
40730+
"ship_to_gst_details": {
40731+
"$ref": "#/components/schemas/ShipToGstDetails"
40732+
},
4058240733
"custom_cart_meta": {
4058340734
"type": "object",
4058440735
"additionalProperties": true,
@@ -40726,6 +40877,9 @@
4072640877
"type": "string",
4072740878
"description": "GSTIN added in user cart."
4072840879
},
40880+
"ship_to_gst_details": {
40881+
"$ref": "#/components/schemas/ShipToGstDetails"
40882+
},
4072940883
"shared_cart_details": {
4073040884
"$ref": "#/components/schemas/SharedCartDetails"
4073140885
},
@@ -42209,7 +42363,9 @@
4220942363
"m",
4221042364
"cm",
4221142365
"nos",
42212-
"pack"
42366+
"pack",
42367+
"ea",
42368+
"set"
4221342369
],
4221442370
"description": "The unit of measurement used for the net quantity of the product."
4221542371
},
@@ -48146,6 +48302,27 @@
4814648302
}
4814748303
}
4814848304
},
48305+
"BuyBoxFeature": {
48306+
"type": "object",
48307+
"properties": {
48308+
"show_name": {
48309+
"type": "boolean",
48310+
"description": "Shows whether the name should be displayed in the buybox.",
48311+
"default": true
48312+
},
48313+
"enable_selection": {
48314+
"type": "boolean",
48315+
"description": "Indicates if selection is enabled in the buybox.",
48316+
"default": true
48317+
},
48318+
"is_seller_buybox_enabled": {
48319+
"type": "boolean",
48320+
"description": "Determines if the seller buybox is enabled.",
48321+
"default": false
48322+
}
48323+
},
48324+
"description": "Configuration options for the BuyBox feature, allowing control over visibility and selection settings."
48325+
},
4814948326
"AppFeature": {
4815048327
"type": "object",
4815148328
"properties": {
@@ -48226,6 +48403,9 @@
4822648403
"type": "integer",
4822748404
"format": "int32",
4822848405
"description": "Version key for tracking revisions. Default value is zero."
48406+
},
48407+
"buybox": {
48408+
"$ref": "#/components/schemas/BuyBoxFeature"
4822948409
}
4823048410
},
4823148411
"description": "Configuration for various features of the application."
@@ -62474,6 +62654,65 @@
6247462654
}
6247562655
}
6247662656
},
62657+
"OrderTransactionList": {
62658+
"type": "object",
62659+
"properties": {
62660+
"success": {
62661+
"type": "boolean",
62662+
"description": "Whether the request was successful.",
62663+
"example": true
62664+
},
62665+
"items": {
62666+
"type": "array",
62667+
"description": "List of transactions ordered by created_on ascending.",
62668+
"example": [],
62669+
"items": {
62670+
"$ref": "#/components/schemas/OrderTransactionItem"
62671+
}
62672+
}
62673+
}
62674+
},
62675+
"OrderTransactionItem": {
62676+
"type": "object",
62677+
"properties": {
62678+
"transaction_id": {
62679+
"type": "string",
62680+
"description": "Merchant transaction ID.",
62681+
"example": "TR692D2BC451FA77D8GF"
62682+
},
62683+
"payment_mode": {
62684+
"type": "string",
62685+
"nullable": true,
62686+
"description": "Payment mode name (e.g. UPI, Card, COD).",
62687+
"example": "UPI"
62688+
},
62689+
"logo": {
62690+
"type": "string",
62691+
"nullable": true,
62692+
"description": "Payment mode logo URL. Returns the small logo if available, falls back to large logo. Null if no logo is configured.",
62693+
"example": "https://cdn.fynd.com/payment/upi_small.png"
62694+
},
62695+
"amount": {
62696+
"type": "number",
62697+
"format": "double",
62698+
"nullable": true,
62699+
"description": "Transaction amount.",
62700+
"example": 499
62701+
},
62702+
"status": {
62703+
"type": "string",
62704+
"nullable": true,
62705+
"description": "Latest transaction status (e.g. complete, pending, failed, cancelled).",
62706+
"example": "complete"
62707+
},
62708+
"created_on": {
62709+
"type": "string",
62710+
"format": "date-time",
62711+
"description": "Transaction creation timestamp (ISO 8601).",
62712+
"example": "2024-01-15T10:30:00Z"
62713+
}
62714+
}
62715+
},
6247762716
"QRCodeResp": {
6247862717
"type": "object",
6247962718
"description": "Response schema for QR code api that returns the original Link, which is the URL encoded by the QR code, and svg, which is the QR code in SVG format.",

openapi/partner.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"info": {
3-
"title": "Fynd Platform's Partner Side APIs v2.12.2",
4-
"version": "3.27.0",
3+
"title": "Fynd Platform's Partner Side APIs v2.12.3",
4+
"version": "3.28.0",
55
"description": "Fynd Platform's Partner Side APIs"
66
},
77
"openapi": "3.0.2",

0 commit comments

Comments
 (0)