{"openapi":"3.1.0","info":{"title":"ShipBob Shipping Methods, Variants and Inventory by Center (your token) API","version":"0.1.0","description":"ShipBob Shipping Methods, Variants and Inventory by Center (your token) lets an AI assistant read your own ShipBob Fulfillment Setup data through the ShipBob Fulfillment Setup API with a key you supply (personal access token (PAT)). Read-only: 8 tools (get_shipping_methods, get_fulfillment_centers, get_packaging_requirements, get_taxonomies, get_taxonomy, get_product_variants,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-shipbob-fulfillment-setup.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-shipbob-fulfillment-setup/docs"},"termsOfService":"https://connectorbay.com/byok-shipbob-fulfillment-setup/terms"},"servers":[{"url":"https://byok-shipbob-fulfillment-setup.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-shipbob-fulfillment-setup/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_shipping_methods":{"post":{"operationId":"get_shipping_methods","summary":"List the shipping methods available to the account with id, name, active and default flags and service level. Use for \"W","description":"List the shipping methods available to the account with id, name, active and default flags and service level. Use for \"Which shipping methods can my ShipBob account use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"limit":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Items per page (1 to 250).","title":"Limit"}},"title":"get_shipping_methodsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_fulfillment_centers":{"post":{"operationId":"get_fulfillment_centers","summary":"List the ShipBob fulfillment centers with id, name, city, state, country and time zone (street, phone and email are left","description":"List the ShipBob fulfillment centers with id, name, city, state, country and time zone (street, phone and email are left out). Use for \"Which ShipBob fulfillment centers exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_fulfillment_centersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_packaging_requirements":{"post":{"operationId":"get_packaging_requirements","summary":"List the packaging requirements a product variant can be assigned (such as poly bag or ships in own container) with desc","description":"List the packaging requirements a product variant can be assigned (such as poly bag or ships in own container) with description. Use for \"Which packaging requirements does ShipBob offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_packaging_requirementsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_taxonomies":{"post":{"operationId":"get_taxonomies","summary":"List the product taxonomy categories (id, name, full path), optionally filtered by a search term. Use for \"Which ShipBob","description":"List the product taxonomy categories (id, name, full path), optionally filtered by a search term. Use for \"Which ShipBob taxonomy categories mention mugs\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only categories whose name or path contains this text.","title":"Search"}},"title":"get_taxonomiesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_taxonomy":{"post":{"operationId":"get_taxonomy","summary":"Get one product taxonomy category by id with its name and full path. Use for \"Show ShipBob taxonomy category 1285\".","description":"Get one product taxonomy category by id with its name and full path. Use for \"Show ShipBob taxonomy category 1285\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"taxonomy_id":{"description":"Numeric taxonomy id from get_taxonomies.","minimum":1,"title":"Taxonomy Id","type":"integer"}},"required":["taxonomy_id"],"title":"get_taxonomyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_product_variants":{"post":{"operationId":"get_product_variants","summary":"List the variants of one ShipBob product with SKU, status, barcodes, dimensions, weight, customs tariff code and on-hand","description":"List the variants of one ShipBob product with SKU, status, barcodes, dimensions, weight, customs tariff code and on-hand quantity. Use for \"Show the variants of ShipBob product 2001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product_id":{"description":"Numeric product id from the products list.","minimum":1,"title":"Product Id","type":"integer"}},"required":["product_id"],"title":"get_product_variantsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_inventory_by_fulfillment_center":{"post":{"operationId":"get_inventory_by_fulfillment_center","summary":"List inventory levels per fulfillment center for each inventory item (id, name, SKU and the per-center stock breakdown).","description":"List inventory levels per fulfillment center for each inventory item (id, name, SKU and the per-center stock breakdown). Use for \"How much of each SKU does ShipBob hold in each fulfillment center\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search_by":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose name or SKU contains this text.","title":"Search By"},"page_size":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Items per page (1 to 250).","title":"Page Size"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active items only, false for inactive.","title":"Is Active"}},"title":"get_inventory_by_fulfillment_centerArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_transaction_fees":{"post":{"operationId":"get_transaction_fees","summary":"List the transaction fee types available for billing. Use for \"Which ShipBob transaction fee types exist\".","description":"List the transaction fee types available for billing. Use for \"Which ShipBob transaction fee types exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_transaction_feesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}