ListProduct - Chat App Message Service - Alibaba Cloud Documentation Center

Retrieves products in a catalog.

Operation description

This API is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cams:ListProduct

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CatalogId	string	Yes	The catalog ID. You can get it from the Meta platform.	2939838xxxx
Fields	string	No	A list of fields to return. Separate multiple fields with a comma (,). For more information, see Product fields.	id,name
Before	string	No	The cursor that points to the end of the previous page of results.	wiidkd939kek93
After	string	No	The cursor that points to the start of the next page of results.	kdkii48jfjjei3
Limit	integer	No	The number of items to return. Valid values: 1 to 1000.	73
CustSpaceId	string	No	The Space ID of the ISV sub-customer.	C2939838xxxx
WabaId	string	Yes	The WhatsApp Business Account (WABA) ID.	3848747xxxx

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details about the access denial.	None
Message	string	The message returned if the request fails.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Model	object	The data returned.
Paging	object	Paging details.
Cursors	object	The cursors for paging.
Before	string	The cursor that points to the previous page.	sjjsjdjjdjd83883
After	string	The cursor that points to the next page.	sjsuueu83838
Data	array<object>	The returned data.
	object	Product data.	{"id":"293983883", "name":"product1"}
Code	string	The request status code. A value of OK indicates that the request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the request was successful. true: successful. false: failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Model": {
    "Paging": {
      "Cursors": {
        "Before": "sjjsjdjjdjd83883",
        "After": "sjsuueu83838"
      }
    },
    "Data": [
      {
        "id": "293983883",
        "name": "product1"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.