@lecxa/shipstation-react-query

React Query hooks for ShipStation API v2.

Installation

``bash
npm install @lecxa/shipstation-react-query @tanstack/react-query
`

Peer dependencies:
- @tanstack/react-query ^5.0.0
- react >=18

Usage

$3

`tsx
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';

const queryClient = new QueryClient();

function App() {
return (



);
}
`

$3

`tsx
import { useListShipments, useGetShipmentById } from '@lecxa/shipstation-react-query';

function ShipmentsPage() {
const { data, isLoading, error } = useListShipments({ page: 1 });

if (isLoading) return

`tsx
import { useCreateLabel } from '@lecxa/shipstation-react-query';

function CreateLabelButton() {
const createLabel = useCreateLabel();

const handleClick = async () => {
const result = await createLabel.mutateAsync({
shipment: { / ... / },
carrier_code: 'stamps_com',
service_code: 'usps_priority_mail',
});
};

return (

Create Label

);
}
`

$3

`tsx
import { useListShipmentsInfinite } from '@lecxa/shipstation-react-query';

function InfiniteList() {
const { data, fetchNextPage, hasNextPage } = useListShipmentsInfinite({
page_size: 50,
});

return (


Query hooks (GET):
- useListShipments, useListShipmentsInfinite
- useGetShipmentById
- useListLabels, useListLabelsInfinite
- useGetLabelById
- useListCarriers
- useCalculateRates
- And more...

Mutation hooks (POST/PUT/DELETE):
- useCreateLabel
- useCreateShipments
- useVoidLabel
- useCreateBatch`
- And more...

License

MIT