Function: usePlaceOrder()

usePlaceOrder(param: { mutation: MutationOptions<Order | ResponseStatus, Error, NewOrder>; supportingDocument: File; }): MutationResult<"placeOrder", Order | ResponseStatus, Error, NewOrder>

When the order has been placed, the orders query will be invalidated and re-fetched.

If the order amount is above 15000, a supporting document is required.

Note: For multi-signature orders, the API returns a 202 Accepted response with {status: 202, statusText: "Accepted"} instead of the full Order object.

Parameters

Parameter	Type	Description
param	{ mutation: MutationOptions<Order | ResponseStatus, Error, NewOrder>; supportingDocument: File; }
param.mutation?	MutationOptions<Order | ResponseStatus, Error, NewOrder>	See Tanstack Query - useMutation options.
param.supportingDocument?	File	Supporting document file.

Returns

MutationResult<"placeOrder", Order | ResponseStatus, Error, NewOrder>

Example

const {
   placeOrder, // useMutation's `mutateAsync` property
   isPending,
   isError,
   error,
   status,
   ...moreUseMutationResults
} = usePlaceOrder();

See

API Documentation