order

Use order for the account order list, a single order page and the thank-you page after checkout. Orders belong to the signed-in customer, so gate calls with useUser().isLoggedIn.

import { useQuery } from '@tanstack/react-query';
import { useUser } from '@salla.sa/twilight-theme-engine/hooks/useUser';
import { order } from '@salla.sa/twilight-theme-engine/api/order';

export function MyOrders() {
  const { isLoggedIn } = useUser();
  const { data } = useQuery({
    ...order.queries.list({ with_items: true }),
    enabled: isLoggedIn,
  });
  const orders = data?.data ?? [];

  return <p>{orders.length} orders</p>;
}

import { order } from '@salla.sa/twilight-theme-engine/api/order';
import { getTwilightContext } from '@salla.sa/twilight-theme-engine/tanstack';

loader: () => {
  const { queryClient } = getTwilightContext();
  return queryClient.fetchQuery(order.queries.list({ status: 'completed' }));
},

MethodsCopy Anchor Link

OrdersListParams: page, cursor, status, feedback_status, with_items (adds each order's items) and signal. "Login needed" means the API wants the customer's token; the module does not check it for you.

QueriesCopy Anchor Link

No key includes the locale, the scope or the customer. The token is what separates customers, so clear ['orders'] on logout so the next customer does not see cached data.

GotchasCopy Anchor Link

• Guests get an error from the API (token_not_provided). Skip the call with isLoggedIn.
• list turns a null data into []; cursor may be absent. Pass cursor.next back as cursor.
• findOrThrow turns a 401 or 403 into the unauthorized page and a 404 or 410 (an order the customer cannot see) into the not-found page, and lets other errors through. A guest's 400 token_not_provided is neither, so it still reaches the error boundary. thankYouOrThrow turns a 404 or 410 into not-found. See Errors.
• shipments and ratings return [] when the response has no data.
• Orders are read-only here. Invalidate ['orders'] after an SDK action that changes one, such as a rating or a cancel.

See alsoCopy Anchor Link

• Account orders route and Account order route
• Thank-you route
• user