Revel Systems

   membrane connect --connectorId=CONNECTOR_ID --json
   

Getting list of existing connections

   membrane connection list --json
   

Searching for actions

When you know what you want to do but not the exact action ID:

membrane action list --intent=QUERY --connectionId=CONNECTION_ID --json

Popular actions

| Name | Key | Description | |---|---|---| | List Orders | list-orders | Returns a paginated list of orders from Revel Systems | | List Order Items | list-order-items | Returns a paginated list of order items from Revel Systems | | List Products | list-products | Returns a paginated list of products from Revel Systems | | List Customers | list-customers | Returns a paginated list of customers from Revel Systems | | List Employees | list-employees | Returns a paginated list of employees from Revel Systems | | List Payments | list-payments | Returns a paginated list of payments from Revel Systems | | List Establishments | list-establishments | Returns a paginated list of establishments (locations/stores) from Revel Systems | | List Product Categories | list-product-categories | Returns a paginated list of product categories from Revel Systems | | List Discounts | list-discounts | Returns a paginated list of discounts from Revel Systems | | Get Order | get-order | Retrieves a single order by ID from Revel Systems | | Get Product | get-product | Retrieves a single product by ID from Revel Systems | | Get Customer | get-customer | Retrieves a single customer by ID from Revel Systems | | Get Employee | get-employee | Retrieves a single employee by ID from Revel Systems | | Get Payment | get-payment | Retrieves a single payment by ID from Revel Systems | | Get Establishment | get-establishment | Retrieves a single establishment (location/store) by ID from Revel Systems | | Create Order | create-order | Creates a new order in Revel Systems | | Create Customer | create-customer | Creates a new customer in Revel Systems | | Create Payment | create-payment | Creates a new payment for an order in Revel Systems | | Update Order | update-order | Updates an existing order in Revel Systems | | Update Customer | update-customer | Updates an existing customer in Revel Systems |

Running actions

membrane action run --connectionId=CONNECTION_ID ACTION_ID --json

To pass JSON parameters:

membrane action run --connectionId=CONNECTION_ID ACTION_ID --json --input "{ \"key\": \"value\" }"

Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Revel Systems API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

membrane request CONNECTION_ID /path/to/endpoint

Common options:

| Flag | Description | |------|-------------| | -X, --method | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET | | -H, --header | Add a request header (repeatable), e.g. -H "Accept: application/json" | | -d, --data | Request body (string) | | --json | Shorthand to send a JSON body and set Content-Type: application/json | | --rawData | Send the body as-is without any processing | | --query | Query-string parameter (repeatable), e.g. --query "limit=10" | | --pathParam | Path parameter (repeatable), e.g. --pathParam "id=123" |

Best practices