open-wa
DocsAPI reference

Business Client API

Generated client method reference for the business namespace.

Business Client API

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

PropValue
Return typePromise<Product[] | false>
ProductView 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

PropValue
Namespacebusiness
Actionread
Functionalityboth
Positional parameter ordercontactId
Aliasesbusiness.getProducts, business.getProfilesProducts, getBusinessProfilesProducts
Deprecated aliasesbusiness.getProfilesProducts, getBusinessProfilesProducts
Licensenone
WAPI overridegetBusinessProfilesProducts
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/business/getProductsgetBusinessProductsActive
Deprecated aliasGET/api/business/getProfilesProductsbusiness.getProfilesProductsDeprecated
AliasGET/api/getBusinessProductsgetBusinessProductsActive
Deprecated aliasGET/api/getBusinessProfilesProductsgetBusinessProfilesProductsDeprecated

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

PropValue
Return typePromise<BusinessProfile>
BusinessProfileView 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

PropValue
Namespacebusiness
Actionread
Functionalityboth
Positional parameter ordercontactId
Aliasesbusiness.getProfile
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/business/getProfilegetBusinessProfileActive
AliasGET/api/getBusinessProfilegetBusinessProfileActive
Insiders

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

PropValue
Return typePromise<Order>
OrderView 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

PropValue
Namespacebusiness
Actionread
Functionalityboth
Positional parameter orderid
Aliasesbusiness.getOrder
Deprecated aliases-
Licenseinsiders
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/business/getOrdergetOrderActive
AliasGET/api/getOrdergetOrderActive

Was this helpful?

Your answer includes the page path and docs version.

On this page