Shippingbo
Shippingbo is an ecommerce operations platform covering order management, warehouse management, shipping, returns, supplier flows, stock, and uploads.
Model
- Orders are the central object. Order tools expose order reads, order-item changes, redispatch, split, suborders, and mapped-product recomputation.
- Products, product barcodes, logistic units, stock variations, slot stock variations, kit components, pack components, and supplier product stock types cover catalog and stock workflows.
- Return orders, expected return items, received products, supply capsules, suppliers, supplier products, supplier stock types, and resellers cover reverse-logistics and supplier workflows.
- Uploads and uploaded files are asynchronous document/file surfaces; uploads are created first, then read back by id for processing status.
Request shape
Use the operation catalog first when choosing a resource family. Paths are Shippingbo resource names on the live app host — orders, products, stock variations, return orders, and similar collections — with numeric ids in the path for single-entity reads and writes.
Pagination on index endpoints uses limit and offset; the default and maximum limit is 50. Query parameters and JSON bodies accept either an object or a JSON string. Path placeholders are not filled automatically; pass the final concrete path with the resolved numeric id, for example an order id discovered from a list read.
Operations
Read tools take resource_path plus optional query_params_json. Use list endpoints such as orders with limit=1 to discover ids before calling entity paths with a concrete order id.
Write tools take http_method, resource_path, optional query_params_json, and json_body. Use create verbs for new rows and patch verbs for updates exactly as listed in the operation catalog. Examples: order tags attach a tag value to an order id; product creation supplies source reference, sku, and name fields.
Destructive operations require the concrete resource id in resource_path — for example a specific order tag id or product id. Read the resource first and use the returned id; do not invent ids from names or SKU values.
Permission boundaries
Shippingbo OAuth scopes and account feature permissions are separate. A token can report a granted scope while the API still returns 403 FORBIDDEN for that resource family when the Shippingbo account or app authorization does not have backend access to the module. Treat those responses as upstream authorization failures, not as missing request parameters.
Shippingbo documents production and staging environments. Production requests are live and not rolled back. Staging is unstable and intended for special integrations that cannot be exercised safely in production.
