Objects
Last update: 6 hours ago by Irais Aguirre
Request objects and fields for C-Commerce product messages (single product and multiple products).
Single product
General structure
| Name | Description | Type | Requirements |
|---|---|---|---|
| from | Phone number (with country code) the message is sent from. | String | Required |
| to | Phone number (with country code) of the customer receiving the message. Plus signs (+), hyphens (-), parentheses ((,)), and spaces are allowed. You can also use the user's BSUID, for example, US.13491208655302741918. | String | Required |
| type | Message type. Constant value: "interactive" | String | Required |
| singleProductMessage | Message structure | Object | Required |
SingleProductMessage object
| Name | Description | Type | Requirements |
|---|---|---|---|
| type | Message type. Constant value: "product". | String | Required |
| body | Message text. | String | Required |
| footer | Short description of the product. | String | Required |
| action | Shopping catalog. | Object | Required |
Action single product object
| Name | Description | Type | Requirements |
|---|---|---|---|
| catalogId | Catalog ID. | String | Required |
| productRetailerId | Product ID. | String | Required |
Multiple products
General structure
| Name | Description | Type | Requirements |
|---|---|---|---|
| from | Phone number (with country code) the message is sent from. | String | Required |
| to | Phone number (with country code) of the customer receiving the message. Plus signs (+), hyphens (-), parentheses ((,)), and spaces are allowed. You can also use the user's BSUID, for example, US.13491208655302741918. | String | Required |
| type | Message type. Constant value: "interactive" | String | Required |
| multiProductMessage | Message structure | Object | Required |
MultiProductMessage object
Header object
| Name | Description | Type | Requirements |
|---|---|---|---|
| type | Header type. Fixed value: text. | String | Required |
| text | Message header text. | String | Required |
Action multiple products object
| Name | Description | Type | Requirements |
|---|---|---|---|
| catalogId | Catalog ID. | String | Required |
| sections | List of sections with products. At least one productItem is required; body max 1024, footer and header.text max 60, section title max 24. | List of objects | Required |
Section object
| Name | Description | Type | Requirements |
|---|---|---|---|
| title | Section title. | String | Required |
| productItems | List of product IDs. | Object list | Required |
ProductItem object
| Name | Description | Type | Requirements |
|---|---|---|---|
| productRetailerId | Product ID. | String | Required |