WhatsApp Catalog Manager
Use the WhatsApp Catalog Manager APIs to upload catalog files, create and manage product feeds, fetch catalog details, and retrieve upload errors.
API overview
Upload the product feed file.
Create a feed of products for a WhatsApp Business account.
Update an existing feed of products for a WhatsApp Business account.
Delete an existing feed of products for a WhatsApp Business account.
Retrieve details about a specific product feed.
Fetch a list of all product feeds associated with a WhatsApp Business account.
Fetch details about a specific product catalog.
Fetch scheduled product feeds associated with a WhatsApp Business account.
Retrieve error outputs for a particular upload session ID.
Endpoint summary
| API | Purpose | URL |
|---|---|---|
| Upload File | Upload the product feed file. | https://apis.rmlconnect.net/wba/catalog/manager/v1/upload |
| Create Product Feed | Create a feed of products for a WhatsApp Business account. | https://apis.rmlconnect.net/wba/catalog/manager/v1/create_product_feed |
| Update Product Feed | Update an existing feed of products for a WhatsApp Business account. | https://apis.rmlconnect.net/wba/catalog/manager/v1/update_product_feed |
| Delete Product Feed | Delete an existing feed of products for a WhatsApp Business account. | https://apis.rmlconnect.net/wba/catalog/manager/v1/delete_product_feed |
| Fetch Product Feed Details | Retrieve details about a specific product feed. | https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_product_feed |
| Fetch All Product Feed | Fetch a list of all product feeds associated with a WhatsApp Business account. | https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_product_details |
| Fetch Catalog Details | Fetch details about a specific product catalog. | https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_catalog_details |
| Fetch Schedule Product Feed Details | Fetch scheduled product feeds associated with a WhatsApp Business account. | https://apis.rmlconnect.net/wba/catalog/manager/v1/schedule_product_feed_details |
| Fetch Errors | Retrieve error outputs for a particular upload session ID. | https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_errors |
Upload File
Upload the product feed file.
Endpoint details
| Field | Value |
|---|---|
| URL | https://apis.rmlconnect.net/wba/catalog/manager/v1/upload |
| Authorization | jwt |
| Request Body schema | multipart/form-data |
Request sample
{
"action": "Update",
"file": "string",
"file_name": "file_name"
}Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| action | Yes | string | The action to be taken on the catalog. |
| file | Yes | string | The data of the product feed file that contains catalog details such as ID, name, and image URL. See the sample catalog file for more information on catalog details and its format. |
| file_name | Yes | string | The name of the product feed file that contains the updated catalog. |
Upload File responses
200 Success
Response
{
"status": "success",
"file_url": "AWS S3 url",
"count": 20
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of the upload file. |
| file_url | string | The URL for uploading a file. |
| count | integer | The number of products added in the catalog file. |
400 Bad Request
Response
{
"error": [
"Provide file_name"
]
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| error | Array of strings | The error received during file upload. |
401 Authentication Failure
Response
{
"message": "unable to process campaign request",
"reason": "jwt token expired",
"status": "failure"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| response | string | The response message. |
404 Page Not Found
Response
{
"message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The message response. |
500 Internal Server Error
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of the message delivery. |
| message | string | The message response. |
| reason | string | The reason for not processing the file upload request. |
Create Product Feed
Create a feed of products for a WhatsApp Business account.
Endpoint details
| Field | Value |
|---|---|
| URL | https://apis.rmlconnect.net/wba/catalog/manager/v1/create_product_feed |
| Authorization | jwt |
| Request Body schema | multipart/form-data |
Request sample
{
"file_url": "file_url",
"name": "product_feed_name",
"schedule": "\"interval\":\"HOURLY\",\"scheduled_time\":\"2022-09-06 11:38:00\""
}Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| file_url | Yes | string | The URL of the file that contains the product feed, hosted publicly and starting with "https://" and ending with the file extension. |
| name | Yes | string | The name of the product feed. |
| schedule | No | string | The schedule for updating the product feed. It contains a JSON object with two keys: a. interval: This key specifies the interval at which the product feed should be updated. In this case, it is set to "HOURLY", indicating that the feed should be updated hourly. b. scheduled_time: This key specifies the date and time at which the first update of the product feed should occur, in UTC format. |
Create Product Feed responses
200 SUCCESS
Response
{
"status": "processing"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of the create product feed. |
400 Bad Request
Response
{
"name": [
"Missing data for required field."
]
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| name | Array of strings | The required fields name. |
401 Authentication Failure
Response
{
"message": "Unable to process request",
"status": "Failed",
"reason": "Please check the integrity or validity of the token sent."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
| reason | string | The reason for not processing the product feed update request. |
| status | string | The status of the product feed update. |
404 Page Not Found
Response
{
"message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The message response. |
500 Internal Server Error
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of the message delivery. |
| message | string | The message response. |
| reason | string | The reason for not processing the product feed request. |
Update Product Feed
Update an existing feed of products for a WhatsApp Business account.
Endpoint details
| Field | Value |
|---|---|
| URL | https://apis.rmlconnect.net/wba/catalog/manager/v1/update_product_feed |
| Authorization | Jwt |
| Request Body schema | multipart/form-data |
Request sample
{
"file_url": "string",
"product_feed_id": "string",
"schedule": "\"interval\":\"HOURLY\",\"scheduled_time\":\"2022-09-06 11:38:00\""
}Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| file_url | Yes | string | The URL of the file that contains the updated product feed, hosted publicly and starting with "https://" and ending with the file extension. |
| product_feed_id | Yes | string | The unique ID of the product feed that should be updated. |
| schedule | No | string | The schedule for recurrently updating the product feed. It contains a JSON object with two keys: a. interval: This key specifies the interval at which the product feed should be updated. In this case, it is set to "HOURLY", indicating that the feed should be updated hourly. b. scheduled_time: This key specifies the date and time at which the first update of the product feed should occur, in UTC format. |
Update Product Feed responses
200 Success
Response
{
"status": "processing"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of the product feed. |
400 Bad Request
Response
{
"product_feed_id": [
"Missing data for required field."
]
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| product_feed_id | Array of strings | The unique identifier of the product feed. |
401 Authentication Failure
Response
{
"message": "Unable to process request",
"status": "Failed",
"reason": "Please check the integrity or validity of the token sent."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
| reason | string | The reason for not processing the product feed update request. |
| status | string | The status of the product feed update. |
404 Page Not Found
Response
{
"message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The message response. |
500 Internal Server Error
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of product feed updates. |
| message | string | The message response. |
| reason | string | The reason for not updating the product feed. |
Delete Product Feed
Delete an existing feed of products for a WhatsApp Business account.
Endpoint details
| Field | Value |
|---|---|
| URL | https://apis.rmlconnect.net/wba/catalog/manager/v1/delete_product_feed |
| Authorization | jwt |
Request sample
{
"product_feed_id": "string"
}Request body schema
| Field | Required | Type | Description |
|---|---|---|---|
| product_feed_id | Yes | string | The unique ID of the product feed that should be deleted. |
| Field | Type | Description |
|---|---|---|
| product_feed_id | string | Specify the identification of the product feed to delete from WhatsApp business messaging APIs. |
Delete Product Feed responses
200 Success
Response
{
"status": "processing"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of the product feed. |
400 Bad Request
Response
{
"product_feed_id": [
"Missing data for required field."
]
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| product_feed_id | Array of strings | The unique identifier of the product feed. |
401 Authentication Failure
Response
{
"message": "Unable to process request",
"status": "Failed",
"reason": "Please check the integrity or validity of the token sent."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
| status | string | The status of the message. |
| reason | string | The reason for not processing the message. |
404 Page Not Found
Response
{
"message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The message response. |
500 Internal Server Error
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status for the product feed. |
| message | string | The response message. |
| reason | string | The reason for not deleting the product feed request. |
Fetch Product Feed Details
Fetch product feed details, which is used to retrieve details about a specific product feed.
Available product feed fields
The product feed includes a comma-separated list of field names:
| Field | Description |
|---|---|
| retailer_id | The ID of the retailer associated with the product. |
| name | The name of the product. |
| price | The price of the product. |
| availability | The availability status of the product. |
| id | The ID of the product. |
| description | The description of the product. |
| color | The color of the product. |
| size | The size of the product. |
| condition | The condition of the product. |
| product_type | The type of product. |
| quantity_to_sell_on_facebook | The quantity of the product to be sold on Facebook. |
| url | The URL of the product. |
| gender | The gender for which the product is intended. |
| age_group | The age group for which the product is intended. |
| sale_price | The sale price of the product. |
| mpn | The manufacturer part number of the product. |
| sale_price_effective_date | The effective date range of the sale price. |
| brand | The brand of the product. |
| custom_label_0 | A custom label for the product. |
Endpoint details
| Field | Value |
|---|---|
| URL | https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_product_feed |
| Authorization | jwt |
Query parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| product_feed_id | Yes | string | The unique ID of the product feed for which details should be fetched. |
| fields | Yes | string | The fields that should be included in the response. The value should be a comma-separated list of field names, such as "retailer_id, name, price, id". |
| limit | Yes | string | The maximum number of products to return in the response. The value should be an integer. |
Fetch Product Feed Details responses
200 Success
Response
{
"data": [
{
"name": "Dairy Milk Silk",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b9125.00",
"description": "Dairy Products",
"retailer_id": "xxxxx"
},
{
"name": "Maggie Pasta",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b925.00",
"description": "Instant Food",
"retailer_id": "xxxxx"
},
{
"name": "Pulses 1kg",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b9200.00",
"description": "Pulses are very good for health",
"retailer_id": "xxxxx"
},
{
"name": "Cow Ghee",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b9499.00",
"description": "Healty Cow Ghee",
"retailer_id": "xxxxx"
},
{
"name": "BESAN 250 Gm",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b932.00",
"description": "Besan or Gram flour is made from Chana Dal. Besan atta is used too make Bhaji, Vada , Sev, Chaklis, and many more items. It has various beauty benefits.",
"retailer_id": "xxxxx"
},
{
"name": "Pastry",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b950.00",
"description": "Dairy Products",
"retailer_id": "xxxxx"
},
{
"name": "Tea 2 kg",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b9800.00",
"description": "Tea & Coffee",
"retailer_id": "xxxxx"
},
{
"name": "Olive Oil 1L",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b9400.00",
"description": "Olive Oil",
"retailer_id": "xxxxx"
},
{
"name": "Olive Oil 2L",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b9799.00",
"description": "Olive Oil",
"retailer_id": "xxxxx"
},
{
"name": "Yippe Pasta",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b925.00",
"description": "Instant Food",
"retailer_id": "xxxxx"
},
{
"name": "Cotton Oil",
"id": "xxxxxxxxxxxxxxxxx",
"price": "\u20b9499.00",
"description": "Cotton Oil",
"retailer_id": "xxxxx"
}
],
"next_url": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/v1/fetch_product_feed?access_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&limit=10&fields=name,id,price,description,retailer_id&product_feed_id=xxxxxxxxxxxxxxx&after=xxxxxxxxxxxxxxxxxxxxxxxx&before=",
"prev_url": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/v1/fetch_product_feed?access_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&limit=10&fields=name,id,price,description,retailer_id&product_feed_id=xxxxxxxxxxxxxx&after=&before=xxxxxxxxxxxxxxxxx"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| data | Array of objects | The product feed details. |
400 Bad Request
Response
{
"message": "Error validating access token: The session has been invalidated because the user changed their password or Facebook has changed the session for security reasons."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
401 Authentication Failure
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
| reason | string | The reason for not processing the product feed update request. |
| status | string | The status of the product feed update. |
404 Page Not Found
Response
{
"message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The message response. |
500 Internal Server Error
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
| status | string | The status of the product feed. |
| reason | string | The reason for not fetching product feed details. |
Fetch All Product Feed
Fetch a list of all product feeds associated with a WhatsApp Business account. To use this endpoint, specify the necessary authorization token credentials.
Endpoint details
| Field | Value |
|---|---|
| URL | https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_product_details |
| Authorization | jwt |
Fetch All Product Feed responses
200 Success
Response
{
"catalog_id": "62305622836xxxxx",
"file_url": "https://www.example.com/demo_xxxx-xxxd-965a-0a58a9feac02.csv",
"interval": "string",
"product_feed_count": 0,
"product_feed_id": "122543386xxxxxxx",
"product_feed_name": "testammy",
"scheduled": false,
"scheduled_timestamp": "string",
"timestamp": "2023-02-27 09:54:47.337571",
"upload_session_id": "1225433871xxxxxx"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| catalog_id | string | The unique ID of the catalog that contains the product. |
| file_url | string | The URL of the file. |
| interval | string or null | The time interval at which the product feed should be updated. |
| product_feed_count | integer | The total number of products to fetch. |
| product_feed_id | string | The unique ID of the product feed. |
| product_feed_name | string | The name of the product feed. |
| scheduled | boolean | Indicates whether this event is scheduled. |
| scheduled_timestamp | string or null | The scheduled time of the message. |
| timestamp | string | The timestamp of when the message was submitted to the API. |
| upload_session_id | string | The unique ID for the product feed upload session that you want to retrieve the errors for. |
401 Authentication Failure
Response
{
"message": "Unable to process request",
"status": "Failed",
"reason": "Please check the integrity or validity of the token sent."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
| reason | string | The reason for not processing the product feed update request. |
| status | string | The status of the product feed update. |
404 Page Not Found
Response
{
"message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The message response. |
500 Internal Server Error
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of the product feed. |
| message | string | The message response. |
| reason | string | The reason for not fetching product feeds. |
Fetch Catalog Details
Fetch details about a specific product catalog associated with a WhatsApp Business account.
Available catalog fields
The fields information includes a comma-separated list:
| Field | Description |
|---|---|
| name | The name of the product catalog. |
| product_count | The total number of products in the product catalog. |
| schedule | The schedule for updating the product catalog. |
| latest_upload | The date and time of the most recent upload to the product catalog. |
| retailer_id | The ID of the retailer associated with the product catalog. |
| price | The price of the product. |
| availability | The availability status of the product. |
| id | The ID of the product. |
| description | The description of the product. |
| color | The color of the product. |
| size | The size of the product. |
| condition | The condition of the product. |
| product_type | The type of product. |
| quantity_to_sell_on_facebook | The quantity of the product to sell on Facebook. |
| url | The URL of the product. |
| gender | The gender of the product. |
| age_group | The age group of the product. |
| sale_price | The sale price of the product. |
| mpn | The manufacturer part number of the product. |
| sale_price_effective_date | The effective date of the sale price of the product. |
| brand | The brand of the product. |
| custom_label_0 | The custom label of the product. |
| image_url | The URL of the product image. |
Endpoint details
| Field | Value |
|---|---|
| URL | https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_catalog_details |
| Authorization | jwt |
Query parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| catalog_id | Yes | string | The ID of the catalog the product belongs to. |
| fetch_details | Yes | string | Option to fetch the product catalog details. |
| fields | Yes | string | The fields that should be included in the response. The value should be a comma-separated list of field names, such as "name, product_count". |
Fetch Catalog Details responses
200 Success
Response
{
"data": [
{
"retailer_id": "12641xxx",
"name": "Coca-Cola Zero 500ml 1 24",
"price": "\u062f.\u0625.85.00",
"availability": "in stock",
"id": "5856857177xxxxxx",
"description": "Coca-Cola Zero 500ml PET (Pack of 24)",
"condition": "new",
"quantity_to_sell_on_facebook": 0,
"url": "https://en.coca-colaarabia.com/brands/coca-cola-original-taste",
"gender": "",
"age_group": "",
"brand": "Coca-Cola",
"image_url": "https://800mycoke.ae/app/images/wa/Cokexxxl.jpg"
}
],
"next_url": "https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_catalog_details?access_token=EAAfkxRwYZCloBAPRyGP69xQcIf3MWYUZCwFcMyEHxTdnXCawZCVJy8AHX9ynmmYKNM0ZAgfSOCsdAkZBHPi6yauFIe682jfswkdWcotj5BMlHpjZCiuhWZCLYl52z4b6abEwsg1zxvOVLkBxxxxxxxxxxxxxxxxxxxxxZCBHEXZCK4UrnYL4ymHYHZB0&limit=10&fields=retailer_id,name,price,availability,id,description,color,size,condition,product_type,quantity_to_sell_on_facebook,url,gender,age_group,sale_price,mpn,sale_price_effective_date,brand,custom_label_0,image_url&catalog_id=965968734067732&fetch_details=true&after=QVFIUkFOVWJJX2d0a1BMbEw0Q0Jxxxxxxxxxxxxxxxxxxxx2Y2dDNQN0ZAMU0IzaGJtRlBKUXZACWHpuUEp6YUE5VWdmTWVyT0ZA5U1RBN0RaQ2owcDVPSkJNS3h3&before=",
"prev_url": "https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_catalog_details?access_token=EAAfkxRwYZCloBAPRyGP69xQcIf3MWYUZxxxxxxxxxxxxxxxxxxxxx8AHX9ynmmYKNM0ZAgfSOCsdAkZBHPi6yauFIe682jfswkdWcotj5BMlHpjZCiuhWZCLYl52z4b6abEwsg1zxvOVLkBxxxxxxxzVElEol1kLrZCcZCBHEXZCK4UrnYL4ymHYHZB0&limit=10&fields=retailer_id,name,price,availability,id,description,color,size,condition,product_type,quantity_to_sell_on_facebook,url,gender,age_group,sale_price,mpn,sale_price_effective_date,brand,custom_label_0,image_url&catalog_id=9659687xxxxxxxx&fetch_details=true&after=&before=QVFIUl84bDh3UDlaU0tPZAkhDUVJNN3p6c0ktNUZAodktJTXpkekVLMFdwSzllOW5GZAWxSOTQ1NHloUWpxxxxxxxxxxxxxxxxxxVFsVU1ZAaDUzR0tVZAzM3VXZAB"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| data | Array of objects | An array of objects representing the catalog details of a specific product. |
| next_url | string | The URL for the next page. |
| prev_url | string | The URL for the previous page. |
400 Bad Request
Response
{
"fields": [
"Allowed fields are retailer_id,name,price,availability,id,description,color,size,condition,product_type,quantity_to_sell_on_facebook,url,gender,age_group,sale_price,mpn,sale_price_effective_date,brand,custom_label_0,image_url"
]
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| fields | Array of strings | The list of allowed fields. |
401 Authentication Failure
Response
{
"message": "Unable to process request",
"status": "Failed",
"reason": "Please check the integrity or validity of the token sent."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
| reason | string | The reason for not processing the product feed update request. |
| status | string | The status of the product feed update. |
404 Page Not Found
Response
{
"message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The message response. |
500 Internal Server Error
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of the catalog. |
| message | string | The response message. |
| reason | string | The reason for not fetching catalog details. |
Fetch Schedule Product Feed Details
Fetch scheduled product feeds associated with a WhatsApp Business account.
Endpoint details
| Field | Value |
|---|---|
| URL | https://apis.rmlconnect.net/wba/catalog/manager/v1/schedule_product_feed_details |
| Authorization | jwt |
Query parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| product_feed_id | Yes | string | The unique ID of the product feed fetches from your system and then schedules the product feed. |
Fetch Schedule Product Feed Details responses
200 Success
Response
{
"schedule": {
"hour": 11,
"id": "51143928431xxxx",
"interval": "HOURLY",
"interval_count": 1,
"minute": 38,
"timezone": "UTC",
"url": "http://wbm-nextgen.s3.ap-south-1.amazonaws.com/demo_af11-efe9f3bxxxxx.csv"
},
"uploads": {
"data": [
{
"id": "128427331883xxxx",
"start_time": "2023-04-28T10:28:24+0000",
"end_time": "2023-04-28T10:38:17+0000"
}
]
},
"latest_upload": {
"id": "128427331883xxxx",
"start_time": "2023-04-28T10:28:24+0000",
"end_time": "2023-04-28T10:38:17+0000"
},
"name": "schedule_product_feed",
"id": "113616569031xxxx"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| schedule | object | The scheduled job for processing a product feed. |
| uploads | object | The information about previous uploads of the product feed. |
| latest_upload | object | The details of the most recent upload of the product feed. |
| name | string | The name of the product feed schedule. |
| id | string | The unique identifier for the product feed schedule. |
400 Bad Request
Response
{
"message": "Unsupported get request. Object with ID '1136165690310xxxx' does not exist, cannot be loaded due to missing permissions, or does not support this operation. Please read the Graph API documentation at https://developers.facebook.com/docs/graph-api"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
401 Authentication Failure
Response
{
"message": "Unable to process request",
"status": "Failed",
"reason": "Please check the integrity or validity of the token sent."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
| reason | string | The reason for not processing the product feed update request. |
| status | string | The status of the product feed update. |
404 Page Not Found
Response
{
"message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The message response. |
500 Internal Server Error
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status of the product feed. |
| message | string | The response message. |
| reason | string | The reason for not processing the request. |
Fetch Errors
The Fetch Errors API calls all error outputs for the particular upload session ID.
Endpoint details
| Field | Value |
|---|---|
| URL | https://apis.rmlconnect.net/wba/catalog/manager/v1/fetch_errors |
| Authorization | jwt |
Query parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| upload_session_id | Yes | string | The unique ID for the product feed upload session that you want to retrieve the errors for. |
Fetch Errors responses
200 Success
Response
{
"error": [
{
"summary": "",
"description": "",
"severity": ""
}
]
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| error | Array of objects | An array that describes the error description. |
400 Bad Request
Response
{
"message": "Unsupported get request. Object with ID '44029838816xxxx' does not exist, cannot be loaded due to missing permissions, or does not support this operation. Please read the Graph API documentation at https://developers.facebook.com/docs/graph-api"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
401 Authentication Failure
Response
{
"message": "Unable to process request",
"status": "Failed",
"reason": "Please check the integrity or validity of the token sent."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The response message. |
| reason | string | The reason for not processing the product feed update request. |
| status | string | The status of the product feed update. |
404 Page Not Found
Response
{
"message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| message | string | The message response. |
500 Internal Server Error
Response
{
"status": "failed",
"message": "unable to process request",
"reason": "reason"
}Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| status | string | The status for fetching errors. |
| message | string | The response message. |
| reason | string | The reason for not processing a request. |
Updated 4 days ago