|
1 | 1 | { |
2 | 2 | "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", |
5 | 5 | "description": "Fynd Platform's Application Side APIs" |
6 | 6 | }, |
7 | 7 | "openapi": "3.0.2", |
|
9068 | 9068 | "example": { |
9069 | 9069 | "checkout_mode": "self", |
9070 | 9070 | "gstin": "27AAAAA0939A1AA", |
| 9071 | + "ship_to_gst_details": { |
| 9072 | + "gstin": "27AAPFU0939F1ZV", |
| 9073 | + "trade_name": "XYZ Traders" |
| 9074 | + }, |
9071 | 9075 | "custom_cart_meta": { |
9072 | 9076 | "test": "test" |
9073 | 9077 | }, |
|
22469 | 22473 | "value": "Fynd" |
22470 | 22474 | } |
22471 | 22475 | } |
| 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 | + } |
22472 | 22493 | } |
22473 | 22494 | ], |
22474 | 22495 | "responses": { |
|
28875 | 28896 | "value": "%7B%22first_name%22:%22Fynd%22,%22last_name%22:%22Dummy%22,%22mobile%22:%229999999999%22,%22email%22:%22test@example.com" |
28876 | 28897 | } |
28877 | 28898 | } |
| 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 | + } |
28878 | 28913 | } |
28879 | 28914 | ], |
28880 | 28915 | "responses": { |
|
32372 | 32407 | ] |
32373 | 32408 | } |
32374 | 32409 | }, |
| 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 | + }, |
32375 | 32480 | "/service/application/share/v1.0/qr/": { |
32376 | 32481 | "post": { |
32377 | 32482 | "description": "Generates a QR code for the application for easy sharing.", |
|
38582 | 38687 | "title": { |
38583 | 38688 | "type": "string", |
38584 | 38689 | "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 |
38585 | 38696 | } |
38586 | 38697 | }, |
38587 | 38698 | "description": "Engage points data for the user cart." |
|
38852 | 38963 | "type": "string", |
38853 | 38964 | "description": "GSTIN added in user cart." |
38854 | 38965 | }, |
| 38966 | + "ship_to_gst_details": { |
| 38967 | + "$ref": "#/components/schemas/ShipToGstDetails" |
| 38968 | + }, |
38855 | 38969 | "restrict_checkout": { |
38856 | 38970 | "type": "boolean", |
38857 | 38971 | "description": "Restrict checkout flag to restrict the checkout process." |
|
38885 | 38999 | "additionalProperties": true, |
38886 | 39000 | "description": "Custom meta details added cart checkout API payload" |
38887 | 39001 | }, |
| 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 | + }, |
38888 | 39008 | "alternate_pickup_person": { |
38889 | 39009 | "$ref": "#/components/schemas/AlternatePickupPerson" |
38890 | 39010 | }, |
@@ -39627,12 +39747,17 @@ |
39627 | 39747 | "redeem_points": { |
39628 | 39748 | "type": "boolean", |
39629 | 39749 | "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 |
39630 | 39755 | } |
39631 | 39756 | }, |
39632 | 39757 | "required": [ |
39633 | 39758 | "redeem_points" |
39634 | 39759 | ], |
39635 | | - "description": "loyaltys point request details." |
| 39760 | + "description": "Loyalty point request details." |
39636 | 39761 | }, |
39637 | 39762 | "GeoLocation": { |
39638 | 39763 | "type": "object", |
|
40056 | 40181 | "type": "string", |
40057 | 40182 | "description": "GSTIN number added in cart." |
40058 | 40183 | }, |
| 40184 | + "ship_to_gst_details": { |
| 40185 | + "$ref": "#/components/schemas/ShipToGstDetails" |
| 40186 | + }, |
40059 | 40187 | "restrict_checkout": { |
40060 | 40188 | "type": "boolean", |
40061 | 40189 | "description": "Restrict checkout flag to restrict the checkout process." |
|
40440 | 40568 | "type": "string", |
40441 | 40569 | "description": "GSTIN number added in cart." |
40442 | 40570 | }, |
| 40571 | + "ship_to_gst_details": { |
| 40572 | + "$ref": "#/components/schemas/ShipToGstDetails" |
| 40573 | + }, |
40443 | 40574 | "restrict_checkout": { |
40444 | 40575 | "type": "boolean", |
40445 | 40576 | "description": "Restrict checkout flag to restrict the checkout process." |
|
40548 | 40679 | }, |
40549 | 40680 | "description": "Article level gift details which includes article id." |
40550 | 40681 | }, |
| 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 | + }, |
40551 | 40699 | "CartMetaCreation": { |
40552 | 40700 | "type": "object", |
40553 | 40701 | "properties": { |
|
40579 | 40727 | "type": "string", |
40580 | 40728 | "description": "GSTIN number to be added in user cart." |
40581 | 40729 | }, |
| 40730 | + "ship_to_gst_details": { |
| 40731 | + "$ref": "#/components/schemas/ShipToGstDetails" |
| 40732 | + }, |
40582 | 40733 | "custom_cart_meta": { |
40583 | 40734 | "type": "object", |
40584 | 40735 | "additionalProperties": true, |
|
40726 | 40877 | "type": "string", |
40727 | 40878 | "description": "GSTIN added in user cart." |
40728 | 40879 | }, |
| 40880 | + "ship_to_gst_details": { |
| 40881 | + "$ref": "#/components/schemas/ShipToGstDetails" |
| 40882 | + }, |
40729 | 40883 | "shared_cart_details": { |
40730 | 40884 | "$ref": "#/components/schemas/SharedCartDetails" |
40731 | 40885 | }, |
|
42209 | 42363 | "m", |
42210 | 42364 | "cm", |
42211 | 42365 | "nos", |
42212 | | - "pack" |
| 42366 | + "pack", |
| 42367 | + "ea", |
| 42368 | + "set" |
42213 | 42369 | ], |
42214 | 42370 | "description": "The unit of measurement used for the net quantity of the product." |
42215 | 42371 | }, |
|
48146 | 48302 | } |
48147 | 48303 | } |
48148 | 48304 | }, |
| 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 | + }, |
48149 | 48326 | "AppFeature": { |
48150 | 48327 | "type": "object", |
48151 | 48328 | "properties": { |
|
48226 | 48403 | "type": "integer", |
48227 | 48404 | "format": "int32", |
48228 | 48405 | "description": "Version key for tracking revisions. Default value is zero." |
| 48406 | + }, |
| 48407 | + "buybox": { |
| 48408 | + "$ref": "#/components/schemas/BuyBoxFeature" |
48229 | 48409 | } |
48230 | 48410 | }, |
48231 | 48411 | "description": "Configuration for various features of the application." |
|
62474 | 62654 | } |
62475 | 62655 | } |
62476 | 62656 | }, |
| 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 | + }, |
62477 | 62716 | "QRCodeResp": { |
62478 | 62717 | "type": "object", |
62479 | 62718 | "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.", |
|
0 commit comments