{"openapi":"3.1.0","info":{"title":"REVER (BYOK) API","version":"0.1.0","description":"REVER (BYOK) lets an AI assistant read your own REVER data through the REVER API with a key you supply (REVER API key). Read-only: 10 tools (list_return_summaries, get_return_summary, get_return_summary_by_platform_id, get_return_authorization_status, get_reverse_delivery_info, get_ecommerce_config, get_return_conditions, get_refund_configuration, get_logistics_settings, get_exchange_conditions)....\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-rever.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-rever/docs"},"termsOfService":"https://connectorbay.com/byok-rever/terms"},"servers":[{"url":"https://byok-rever.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-rever/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_return_summaries":{"post":{"operationId":"list_return_summaries","summary":"List return processes of an e-commerce group within a lookback window, with order, platform, status, refund method and t","description":"List return processes of an e-commerce group within a lookback window, with order, platform, status, refund method and timing. Customer details are not returned. 50 per page. Use for \"Which returns were started in the last 30 days\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group_id":{"description":"E-commerce group id your key was issued for.","maxLength":100,"title":"Group Id","type":"string"},"days":{"description":"Lookback window in days (at least 1).","maximum":3650,"minimum":1,"title":"Days","type":"integer"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"order_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only returns for this e-commerce order id.","title":"Order Id"},"warehouse_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only returns routed to this warehouse id.","title":"Warehouse Id"},"started_before":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the window as a timestamp, for example 2026-09-01T00:00:00Z; the days window counts back from it.","title":"Started Before"}},"required":["group_id","days"],"title":"list_return_summariesArguments","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_return_summary":{"post":{"operationId":"get_return_summary","summary":"Get one return process by REVER process id: order, platform, status, refund payment method and timing. Customer details ","description":"Get one return process by REVER process id: order, platform, status, refund payment method and timing. Customer details are not returned. Use for \"What is the status of return prc_01HZX8K2\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"process_id":{"description":"REVER return process id (the process_id from a return summary).","maxLength":200,"title":"Process Id","type":"string"}},"required":["process_id"],"title":"get_return_summaryArguments","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_return_summary_by_platform_id":{"post":{"operationId":"get_return_summary_by_platform_id","summary":"Get a return process by the shop platform's own id (for example a Shopify or Shopware order or return id). Use for \"Find","description":"Get a return process by the shop platform's own id (for example a Shopify or Shopware order or return id). Use for \"Find the REVER return for platform id gid-77\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"platform_process_id":{"description":"Process id assigned by the e-commerce platform.","maxLength":200,"title":"Platform Process Id","type":"string"}},"required":["platform_process_id"],"title":"get_return_summary_by_platform_idArguments","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_return_authorization_status":{"post":{"operationId":"get_return_authorization_status","summary":"Show whether a return needs or has received authorization, with any refund override amount and decline reason. Use for \"","description":"Show whether a return needs or has received authorization, with any refund override amount and decline reason. Use for \"Has return prc_01HZX8K2 been authorized\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"process_id":{"description":"REVER return process id (the process_id from a return summary).","maxLength":200,"title":"Process Id","type":"string"}},"required":["process_id"],"title":"get_return_authorization_statusArguments","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_reverse_delivery_info":{"post":{"operationId":"get_reverse_delivery_info","summary":"Get the return shipment of a return process: carrier, return method, shipping status, tracking id and URL, scheduled pic","description":"Get the return shipment of a return process: carrier, return method, shipping status, tracking id and URL, scheduled pickups and the receiving warehouse city. Customer pickup address is not returned. Use for \"Where is the parcel for return prc_01HZX8K2\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"process_id":{"description":"REVER return process id (the process_id from a return summary).","maxLength":200,"title":"Process Id","type":"string"}},"required":["process_id"],"title":"get_reverse_delivery_infoArguments","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_ecommerce_config":{"post":{"operationId":"get_ecommerce_config","summary":"Get a return portal's configuration: name, platform, currency, group, enabled and test flags, identification flow, retur","description":"Get a return portal's configuration: name, platform, currency, group, enabled and test flags, identification flow, return policy URL and website. Use for \"How is my REVER portal shop-es configured\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ecommerce_id":{"description":"REVER e-commerce (return portal) id.","maxLength":200,"title":"Ecommerce Id","type":"string"}},"required":["ecommerce_id"],"title":"get_ecommerce_configArguments","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_return_conditions":{"post":{"operationId":"get_return_conditions","summary":"Get the return rules of a portal: return period in days, days to send the parcel, review flow, payments enabled, who pay","description":"Get the return rules of a portal: return period in days, days to send the parcel, review flow, payments enabled, who pays logistics and non-returnable product, tag and category ids. Use for \"What is the return window for shop-es\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ecommerce_id":{"description":"REVER e-commerce (return portal) id.","maxLength":200,"title":"Ecommerce Id","type":"string"}},"required":["ecommerce_id"],"title":"get_return_conditionsArguments","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_refund_configuration":{"post":{"operationId":"get_refund_configuration","summary":"Get a portal's refund settings: refund actions with timing, payment method configs, promo code rounding and discount han","description":"Get a portal's refund settings: refund actions with timing, payment method configs, promo code rounding and discount handling. Use for \"How are refunds configured for shop-es\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ecommerce_id":{"description":"REVER e-commerce (return portal) id.","maxLength":100,"title":"Ecommerce Id","type":"string"}},"required":["ecommerce_id"],"title":"get_refund_configurationArguments","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_logistics_settings":{"post":{"operationId":"get_logistics_settings","summary":"Get a portal's return logistics settings: the carriers and providers per return method, delivery note type and reminder ","description":"Get a portal's return logistics settings: the carriers and providers per return method, delivery note type and reminder flow. Use for \"Which carriers handle returns for shop-es\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ecommerce_id":{"description":"REVER e-commerce (return portal) id.","maxLength":200,"title":"Ecommerce Id","type":"string"}},"required":["ecommerce_id"],"title":"get_logistics_settingsArguments","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_exchange_conditions":{"post":{"operationId":"get_exchange_conditions","summary":"Get a portal's exchange rules: exchange flow type and threshold. Use for \"Does shop-es allow exchanges\".","description":"Get a portal's exchange rules: exchange flow type and threshold. Use for \"Does shop-es allow exchanges\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ecommerce_id":{"description":"REVER e-commerce (return portal) id.","maxLength":200,"title":"Ecommerce Id","type":"string"}},"required":["ecommerce_id"],"title":"get_exchange_conditionsArguments","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}}}}