{"openapi":"3.1.0","info":{"title":"ShipStation (BYOK) API","version":"0.1.0","description":"ShipStation (BYOK) lets an AI assistant read your own ShipStation data through the ShipStation API with a key you supply (API Key (ShipStation V1 API)). Read-only: 9 tools (list_orders, get_order, list_shipments, list_fulfillments, list_stores, list_carriers, list_warehouses, list_products, list_customers). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-shipstation.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-shipstation/docs"},"termsOfService":"https://connectorbay.com/byok-shipstation/terms"},"servers":[{"url":"https://byok-shipstation.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-shipstation/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/list_orders":{"post":{"operationId":"list_orders","summary":"List orders with status, customer, ship-to address, totals, carrier and items. Filter by status, store, customer, keywor","description":"List orders with status, customer, ship-to address, totals, carrier and items. Filter by status, store, customer, keyword or date range. Use for \"Which ShipStation orders are awaiting shipment\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_status":{"anyOf":[{"enum":["awaiting_payment","awaiting_shipment","pending_fulfillment","shipped","on_hold","cancelled","rejected_fulfillment"],"type":"string"},{"type":"null"}],"default":null,"description":"Order status filter.","title":"Order Status"},"order_number":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Order number prefix to match.","title":"Order Number"},"customer_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Customer name to match.","title":"Customer Name"},"item_keyword":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Keyword matched against item SKU and description.","title":"Item Keyword"},"store_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only orders of this store id.","title":"Store Id"},"create_date_start":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Orders created in ShipStation after this date, for example 2026-01-01.","title":"Create Date Start"},"create_date_end":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Orders created in ShipStation before this date.","title":"Create Date End"},"modify_date_start":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Orders modified after this date.","title":"Modify Date Start"},"sort_by":{"anyOf":[{"enum":["OrderDate","ModifyDate","CreateDate"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: OrderDate, ModifyDate or CreateDate.","title":"Sort By"},"sort_dir":{"anyOf":[{"enum":["ASC","DESC"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: ASC or DESC (default ASC).","title":"Sort Dir"},"page_size":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many records per page (1 to 500, default 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. The answer's pages field gives the page count.","title":"Page"}},"title":"list_ordersArguments","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_order":{"post":{"operationId":"get_order","summary":"Get one order by its numeric ShipStation order id with addresses, items, totals, weight and options. Use for \"Show me Sh","description":"Get one order by its numeric ShipStation order id with addresses, items, totals, weight and options. Use for \"Show me ShipStation order 93348\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_id":{"description":"Numeric orderId from list_orders.","minimum":1,"title":"Order Id","type":"integer"}},"required":["order_id"],"title":"get_orderArguments","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/list_shipments":{"post":{"operationId":"list_shipments","summary":"List shipments (labels) with tracking number, carrier, service, cost, ship date and whether voided. Use for \"What tracki","description":"List shipments (labels) with tracking number, carrier, service, cost, ship date and whether voided. Use for \"What tracking numbers did I ship with USPS this week in ShipStation\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_number":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only shipments of this order number.","title":"Order Number"},"tracking_number":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only the shipment with this tracking number.","title":"Tracking Number"},"carrier_code":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only shipments with this carrier code, from list_carriers.","title":"Carrier Code"},"recipient_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only shipments to this recipient name.","title":"Recipient Name"},"ship_date_start":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Shipped on or after this date, for example 2026-01-01.","title":"Ship Date Start"},"ship_date_end":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Shipped on or before this date.","title":"Ship Date End"},"store_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only shipments of orders in this store id.","title":"Store Id"},"sort_by":{"anyOf":[{"enum":["ShipDate","CreateDate"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: ShipDate or CreateDate.","title":"Sort By"},"sort_dir":{"anyOf":[{"enum":["ASC","DESC"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: ASC or DESC (default ASC).","title":"Sort Dir"},"page_size":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many records per page (1 to 500, default 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. The answer's pages field gives the page count.","title":"Page"}},"title":"list_shipmentsArguments","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/list_fulfillments":{"post":{"operationId":"list_fulfillments","summary":"List fulfillments (shipments marked shipped on orders) with order, tracking number, carrier and ship date. Use for \"Whic","description":"List fulfillments (shipments marked shipped on orders) with order, tracking number, carrier and ship date. Use for \"Which ShipStation orders were fulfilled yesterday\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_number":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only fulfillments of this order number.","title":"Order Number"},"tracking_number":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only fulfillments with this tracking number.","title":"Tracking Number"},"ship_date_start":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Shipped on or after this date.","title":"Ship Date Start"},"ship_date_end":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Shipped on or before this date.","title":"Ship Date End"},"sort_by":{"anyOf":[{"enum":["ShipDate","CreateDate"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: ShipDate or CreateDate.","title":"Sort By"},"sort_dir":{"anyOf":[{"enum":["ASC","DESC"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: ASC or DESC (default ASC).","title":"Sort Dir"},"page_size":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many records per page (1 to 500, default 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. The answer's pages field gives the page count.","title":"Page"}},"title":"list_fulfillmentsArguments","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/list_stores":{"post":{"operationId":"list_stores","summary":"List the selling channels (stores) connected to ShipStation with marketplace and active flag. Use the ids to filter orde","description":"List the selling channels (stores) connected to ShipStation with marketplace and active flag. Use the ids to filter orders. Use for \"Which stores are connected to my ShipStation account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"show_inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include inactive stores.","title":"Show Inactive"}},"title":"list_storesArguments","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/list_carriers":{"post":{"operationId":"list_carriers","summary":"List the shipping carriers connected to the account with account number and balance. Use for \"Which carriers are connect","description":"List the shipping carriers connected to the account with account number and balance. Use for \"Which carriers are connected in ShipStation and what are their balances\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_carriersArguments","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/list_warehouses":{"post":{"operationId":"list_warehouses","summary":"List ship-from warehouses with their origin address and whether each is the default. Use for \"What warehouses do I ship ","description":"List ship-from warehouses with their origin address and whether each is the default. Use for \"What warehouses do I ship from in ShipStation\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_warehousesArguments","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/list_products":{"post":{"operationId":"list_products","summary":"List products with SKU, name and price. Filter by SKU or name. Use for \"Find the product with SKU A1 in ShipStation\".","description":"List products with SKU, name and price. Filter by SKU or name. Use for \"Find the product with SKU A1 in ShipStation\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sku":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only products matching this SKU.","title":"Sku"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only products matching this name.","title":"Name"},"show_inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include inactive products.","title":"Show Inactive"},"sort_by":{"anyOf":[{"enum":["SKU","ModifyDate","CreateDate"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: SKU, ModifyDate or CreateDate.","title":"Sort By"},"sort_dir":{"anyOf":[{"enum":["ASC","DESC"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: ASC or DESC (default ASC).","title":"Sort Dir"},"page_size":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many records per page (1 to 500, default 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. The answer's pages field gives the page count.","title":"Page"}},"title":"list_productsArguments","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/list_customers":{"post":{"operationId":"list_customers","summary":"List customers with name, company, email, phone and location. Filter by state, country or marketplace. Use for \"Which Sh","description":"List customers with name, company, email, phone and location. Filter by state, country or marketplace. Use for \"Which ShipStation customers are in Texas\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"state_code":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only customers in this state code.","title":"State Code"},"country_code":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Only customers in this two-letter country code.","title":"Country Code"},"sort_by":{"anyOf":[{"enum":["Name","ModifyDate","CreateDate"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: Name, ModifyDate or CreateDate.","title":"Sort By"},"sort_dir":{"anyOf":[{"enum":["ASC","DESC"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: ASC or DESC (default ASC).","title":"Sort Dir"},"page_size":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many records per page (1 to 500, default 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1. The answer's pages field gives the page count.","title":"Page"}},"title":"list_customersArguments","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}}}}