package
The `shipengine/react-api` library provides React bindings for the [shipengine/js-api](https://www.npmjs.com/package/@shipengine/js-api) client, with the addition of data sharing and cache management via [React Query](https://tanstack.com/query/latest) (h
npm install @shipengine/react-apiGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Estimated unpacked size across 1 packages.
445.2 kB
Includes dependencies.
Latest published Nov 6, 2026
next
latest
agustin.martin.auctane
agustin.martin@auctane.com
joshuaflanagan
joshua@shippingeasy.com
prasadjoshi29
prasad.joshi@auctane.com
binkard-auctane
andrew.binkard@auctane.com
lzhang
lewiszhang@gmail.com
dlblom
danielle.blom@auctane.com
rickyr
ricky.rivera@gmail.com
dbernazal
david.bernazal@auctane.com
auc-rhibbeler
ryan.hibbeler@auctane.com
harris.butler
harris.butler@auctane.com
jeffrysparrow
sparrowjefft@gmail.com
ckroutterauctane
cristina.kroutter@auctane.com
chunter-auctane
chris.hunter@auctane.com
arapicki
adam.rapicki@auctane.com
romofel
felipe@romofel.dev
auctane.joshua.semar
joshua.semar@auctane.com
christian.casado
christian.casado@auctane.com
auctome
tom.coladonato@auctane.com
arjun.modi
arjun.modi@auctane.com
ddygas
danuta.dygas@auctane.com
deeepawesome
deeepawesome@gmail.com
lukasz.parala
lukasz.parala@auctane.com
pspringerauct
przemyslaw.springer@auctane.com
akowalczyk
adam.kowalczyk@auctane.com
alicjawolnikkuzminska
alicja.wolnik-kuzminska@auctane.com
dangnguyen91
dang.nguyen@auctane.com
krzysztof.malcher
krzysztof.malcher@auctane.com
marcin_karwat_auctane
marcin.karwat@auctane.com
maciej_adamek
maciej.adamek@auctane.com
mspiaczka-auctane
marcel.spiaczka@auctane.com
bartoszzurawski
bartosz.zurawski@auctane.com
mmilowska
magdalena.milowska@auctane.com
bmusielak
bartosz.musielak@auctane.com
kdobrzynskiactn
krzysztof.dobrzynski@auctane.com
maciej_sabik_auctane
maciej.sabik@auctane.com
zjaholkowska
zuzanna.czarnecka@auctane.com
rafal.maj
rafal.majewski@auctane.com
greta.ratajczak
greta.ratajczak@auctane.com
jakubhypki
jakub.hypki@auctane.com
alejandro-orta
alejandro.orta@auctane.com
liana.reyes.auctane
liana.reyes@auctane.com
jhkillam-auctane
joseph.killam@auctane.com
The shipengine/react-api library provides React bindings for the shipengine/js-api client, with the addition of data sharing and cache management via React Query (hereon "RQ").
The client interface is exposed via hooks[^1] sharing a single RQ client instance; this allows multiple components to access data from the same ShipEngine API endpoint with a single network request.
For instance, if ComponentA, ComponentB and ComponentC separately invoke the useListShipments hook on a single render, the API requests will be deduped to a single GET /v1/shipments, with all three components sharing the data / loading / error / etc states from the RQ cache. Revalidating the request in one component similarly updates the others.
import { ShipEngine, useListShipments } from "@shipengine/react-api";
const MyComponent = () => {
const { data, isLoading, error } = useListShipments();
if (isLoading) return <div>Loading...</div>;
if (error) return <div>{error.message}</div>;
console.log(data);
// > an object matching the response schema of https://shipengine.github.io/shipengine-openapi/#operation/list_shipments
return <div>Retrieved {data.shipments.length} shipments</div>;
};
const MyApp = () => {
return (
<ShipEngine getToken={() => "your-platform-token"}>
<MyComponent />
<MyComponent />
<MyComponent />
{/* All three components will share the same data and only 1 request will be made */}
</ShipEngine>
);
};