Connected stores
Contents 26 pages
What the web app's Stores and Orders pages do, as operations, for an
organization that connected an online store (Shopify, WooCommerce, BigCommerce
or Squarespace). A Shopify store's own key uses
its own order operations instead, and every operation
here answers it not_available_for_shopify.
Connecting a store is the store's own sign-in, so it stays on the web app:
GET /stores answers connect_url, the Stores page. Listing stores,
importing their products and disconnecting one are an owner's or admin's, as
on that page: the person behind the key (who connected the AI app, or made the
key) must be one.
Orders are read live from each store and never stored.
List connected stores#
/api/v1/storesScope settings:readNeeds settings:read. Never answers a store's key or token.
{
"object": "list",
"data": [
{
"object": "store",
"id": "cm7sc01…",
"platform": "woocommerce",
"name": "Acme Home",
"store_key": "shop.acmehome.test",
"status": "active",
"write_back_tracking": true,
"last_error": null,
"last_product_import_at": "2026-11-17T15:04:05.000Z",
"connected_at": "2026-11-17T14:00:00.000Z",
"created_at": "2026-11-17T13:58:00.000Z"
}
],
"has_more": false,
"next_cursor": null,
"connect_url": "https://app.shipeasyco.com/portal/stores"
}Import a store's products#
/api/v1/stores/{storeId}/product_importsScope catalog:writeNeeds catalog:write. One page of the store's products, added or updated as
catalog models; a model someone made by hand or by file
is left exactly as it is. Send the answer's next_cursor back as cursor until
it is null. missing_sizes counts products with no size anywhere: add those by
hand or by file.
Disconnect a store#
/api/v1/stores/{storeId}Scope settings:writeNeeds settings:write. ShipEasy stops reading the store and deletes its key; its
products stay in the catalog, and its quotes and shipments stay.
List open store orders#
/api/v1/store_ordersScope shipments:readNeeds shipments:read, and a key whose person sees every shipment. Open orders
across the connected stores, newest first, each with what was already quoted or
booked. store_id narrows to one store. next_cursor is opaque: pass it back as
cursor. A store that did not answer is listed in unreadable_stores and its
orders are left out of the page.
Rate store orders#
/api/v1/store_orders/quoteScope quotes:writeNeeds quotes:write. Up to 25 order keys, rated together from your default
ship-from, one lane per order, exactly as the web app's Quote selected rates
them; pickup_date defaults to the earliest allowed. Each rate's quote_id is
booked like any other quote (booking). Orders that could
not be rated (no sizes, no address) come back in problems, and the rest are
still rated. Needs bulk quoting on for your organization.