DocsTools

Shippingbo

Orders, products, stock and carriers.

Category
E-commerce
How you connect
Sign in. You sign in with your account. Homla never sees your password.
Time to set up
About 2 minutes
Actions
4 read, 1 write

Connect it#

In Homla, open Connectors, then Shippingbo. The Setup guide button walks you through the same steps, with fields to paste into.

Who can do it. A Homla admin (or a role that lists the Shippingbo service) who can sign in to the company's Shippingbo back office. The connection is shared: one person connects once and everyone in the Homla workspace reads the same Shippingbo account.

Recommended. If your Shippingbo account allows it, sign in with a dedicated back-office user (for example wedge-bot@yourcompany.com) before you click Connect, so the shared connection does not depend on a person who may leave. Check with your Shippingbo account manager whether an extra user is billed.

  1. Sign in to the right Shippingbo account firstOpen the Shippingbo back office in the same browser and check you are on the company account Homla should read. The consent screen uses whichever account is signed in. Open it.
  2. Click Connect Shippingbo in HomlaIn Homla, open Connectors > Shippingbo and click Connect Shippingbo. Homla sends you to Shippingbo's authorization page. Open it.
  3. Approve the access Shippingbo asks forShippingbo lists four permissions: order, product, stock and return. They are what the Homla tools read (see the list below). Approve, and Shippingbo sends you back to Homla, where the account shows as connected and shared with everyone.

    Common errors: signed in to the wrong Shippingbo account (disconnect in Homla and connect again), or your Homla role cannot connect shared accounts (ask a Homla admin). A 403 'Request blocked by security policy' comes from Shippingbo's firewall: contact Shippingbo support.

What your AI can do#

These are the actions Homla gives your AI. Your role decides which ones you get. Write actions are a dry run until confirmed, see Approvals and dry runs.

Read#

Looks things up, never changes anything.

ActionWhat it does
shippingbo_orders_listList Shippingbo orders (newest first), or fetch one by id.
shippingbo_products_listList Shippingbo products, or fetch one by id.
shippingbo_stock_getGet the stock record for one product by product id (GET /product_stocks/{product_id}).
shippingbo_carriers_listList carriers (GET /carriers) or shipping methods (GET /shipping_methods).

Write#

Creates or changes things, as the account owner.

ActionWhat it does
shippingbo_requestArbitrary Shippingbo API call for anything the typed tools don't cover (e.g.

Disconnect it#

In Homla, open the account menu on the tool's page and choose Disconnect. Anyone it was shared with loses access at once. To cut it off on the tool's side too:

To cut Homla off, open Connectors > Shippingbo in Homla and click Disconnect on the shared account: Homla deletes the stored token. Shippingbo does not document a page where a back-office user lists authorized apps; if you need the grant revoked on Shippingbo's side too, ask Shippingbo support. To reconnect with another account, disconnect, then connect again.

Generated from the product code. Action names are what the CLI and the API use.