Business Client API
Generated client method reference for the business namespace.
This page documents 3 schema-registry client methods in the business namespace.
getBusinessProducts
Get business products
Signature client.getBusinessProducts(contactId: string): Promise<Product[] \| false>
Usage
import { SocketClient } from '@open-wa/socket-client';
const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getBusinessProducts({
contactId: "447123456789@c.us",
});Parameters
Prop
Type
Returns
| Prop | Value |
|---|---|
| Return type | Promise<Product[] | false> |
| Product | View fields |
Resolves to Product[] \| false. A rejected Promise indicates input validation or dispatch failure.
This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.
Advanced method metadata
Overview
| Prop | Value |
|---|---|
| Namespace | business |
| Action | read |
| Functionality | both |
| Positional parameter order | contactId |
| Aliases | business.getProducts, business.getProfilesProducts, getBusinessProfilesProducts |
| Deprecated aliases | business.getProfilesProducts, getBusinessProfilesProducts |
| License | none |
| WAPI override | getBusinessProfilesProducts |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/business/getProducts | getBusinessProducts | Active |
| Deprecated alias | GET | /api/business/getProfilesProducts | business.getProfilesProducts | Deprecated |
| Alias | GET | /api/getBusinessProducts | getBusinessProducts | Active |
| Deprecated alias | GET | /api/getBusinessProfilesProducts | getBusinessProfilesProducts | Deprecated |
getBusinessProfile
Get business profile
Signature client.getBusinessProfile(contactId: string): Promise<BusinessProfile>
Usage
import { SocketClient } from '@open-wa/socket-client';
const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getBusinessProfile({
contactId: "447123456789@c.us",
});Parameters
Prop
Type
Returns
| Prop | Value |
|---|---|
| Return type | Promise<BusinessProfile> |
| BusinessProfile | View fields |
Resolves to BusinessProfile. A rejected Promise indicates input validation or dispatch failure.
This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.
Advanced method metadata
Overview
| Prop | Value |
|---|---|
| Namespace | business |
| Action | read |
| Functionality | both |
| Positional parameter order | contactId |
| Aliases | business.getProfile |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/business/getProfile | getBusinessProfile | Active |
| Alias | GET | /api/getBusinessProfile | getBusinessProfile | Active |
getOrder
Get order details
Signature client.getOrder(id: string): Promise<Order>
Usage
import { SocketClient } from '@open-wa/socket-client';
const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getOrder({
id: "id",
});Parameters
Prop
Type
Returns
| Prop | Value |
|---|---|
| Return type | Promise<Order> |
| Order | View fields |
Resolves to Order. A rejected Promise indicates input validation or dispatch failure.
This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API.
Advanced method metadata
Overview
| Prop | Value |
|---|---|
| Namespace | business |
| Action | read |
| Functionality | both |
| Positional parameter order | id |
| Aliases | business.getOrder |
| Deprecated aliases | - |
| License | insiders |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/business/getOrder | getOrder | Active |
| Alias | GET | /api/getOrder | getOrder | Active |
Was this helpful?
Your answer includes the page path and docs version.
