Business Client API
Generated client method reference for the business namespace.
Business Client API
Generated file warning: this page is generated by
packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.
This page documents 3 schema-registry client methods in the business namespace.
getBusinessProducts
Get business products
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 |
Usage
const result = await client.getBusinessProducts({
contactId: "447123456789@c.us",
});const result = await client.business.getProducts({
contactId: "447123456789@c.us",
});curl -G "http://localhost:8080/api/business/getProducts" \
-H "x-api-key: YOUR_API_KEY" \
--data-urlencode "contactId=447123456789@c.us"Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | unknown |
getBusinessProfile
Get business profile
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 |
Usage
const result = await client.getBusinessProfile({
contactId: "447123456789@c.us",
});const result = await client.business.getProfile({
contactId: "447123456789@c.us",
});curl -G "http://localhost:8080/api/business/getProfile" \
-H "x-api-key: YOUR_API_KEY" \
--data-urlencode "contactId=447123456789@c.us"Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | unknown |
getOrderInsiders
Get order details
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 |
Usage
const result = await client.getOrder({
id: "id",
});const result = await client.business.getOrder({
id: "id",
});curl -G "http://localhost:8080/api/business/getOrder" \
-H "x-api-key: YOUR_API_KEY" \
--data-urlencode "id=id"Parameters
Prop
Type
Output
| Prop | Value |
|---|---|
| Return type | unknown |
Was this helpful?
Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!