Skip to main content

fdk-order

Order Action Component

Tag

fdk-order

Description

The action component is used for performing actions related to order such as cancel order, return order, add beneficiary details, verify otp, add beneficiary for Bank, validate IFSC code, and getting invoice by shipment id.

Props

KeyTypeDescriptionPayload
cancelOrderfuctionThis function is used to cancel the order cancelOrder({ body : [CancelOrderRequest](https://github.com/gofynd/fdk-client-javascript/blob/main/documentation/platform/ORDER.md#UpdateShipmentStatusRequest) } : object)
returnOrderfunctionThis function is used to return the order returnOrder({ body : [ReturnOrderRequest](https://github.com/gofynd/fdk-client-javascript/blob/main/documentation/platform/ORDER.md#UpdateShipmentStatusRequest) } : object)
addBeneficiaryDetailsfunctionThis function is used for saving bank details for cancelled/returned orderaddBeneficiaryDetails({ body : [AddBeneficiaryDetailsRequest](https://github.com/gofynd/fdk-client-javascript/blob/main/documentation/application/PAYMENT.md#AddBeneficiaryDetailsRequest) } : object)
verifyOtpAndAddBeneficiaryForBankfunctionThis function is used for Verifying the beneficiary details using OTP verifyOtpAndAddBeneficiaryForBank({ body : [AddBeneficiaryViaOtpVerificationRequest](https://github.com/gofynd/fdk-client-javascript/blob/main/documentation/application/PAYMENT.md#AddBeneficiaryViaOtpVerificationRequest) } : object)
validateIfscCodefunctionThis function is used for verifying the IFSC Code validateIfscCode({ifscCode: string} : object)
invoiceByShipmentIdfunctionThis function is used to get the Invoice URL invoiceByShipmentId({shipmentId: string} : object)
getOrdersfunctionThis function is used for getting order details getOrders({pageNo: number, pageSize : number, fromDate : string, toDate : string, customMeta: string} : object)
getOrderByIdfunctionThis function is used for getting single order details getOrderById({orderId: string} : object)
creditNoteByShipmentIdfunctionThis function is used for generate credit note creditNoteByShipmentId({} : object)

Example

<fdk-order>
<template slot-scope="order">
///code
</template
</fdk-order>

Was this section helpful?