Register Issue
Submit a customer grievance for an order. This is the primary entry point for the IGM (Issue & Grievance Management) flow. Get valid categories and sub-categories from issue-reasons.
IGM Flow Overview
Register Issue← Start here
→
Create Issue/create-issue
→
Reply / Resolve/reply-issue
Register Issue
POST/ret11/register-issue
Auth Required
Include a Bearer token.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| orderId | string | required | Order the issue relates to |
| category | string | required | Issue category from issue-reasons. E.g., "order", "Item" |
| subCategory | string | required | Sub-category code from issue-reasons |
| name | string | required | Customer’s full name |
| phone | string | required | Customer’s phone number |
| string | required | Customer’s email address | |
| fulfillmentId | string | required | Fulfillment ID from select response |
| providerId | string | required | Provider ID from nearby-restaurants |
| shortDesc | string | required | Brief one-line description of the issue |
| longDesc | string | required | Detailed description of the issue |
| itemId | string | optional | Specific item ID if the issue is item-specific |
| itemQuantity | number | optional | Quantity of the affected item |
| images | string[] | optional | Evidence image URLs |
| userId | string | optional | Your own platform's user ID for the logged-in user |
Request Example
{
"orderId": "019c2ed4b42a79b4b093b41d5dcd1352",
"category": "Item",
"subCategory": "FLM02",
"name": "John Doe",
"phone": "9876543210",
"email": "john@example.com",
"fulfillmentId": "6c00379b-17ec-42b1-bf36-037a744d2056",
"providerId": "pramaan_provider_1",
"shortDesc": "Wrong item delivered",
"longDesc": "I ordered a Margherita pizza but received a Pepperoni pizza",
"itemId": "id_ancc5_0_0",
"itemQuantity": 1,
"images": ["https://example.com/photo.jpg"]
}
Response
{
"data": {
"message": "successfully registered the issue"
}
}
After registering, use create-issue to open the formal ONDC issue ticket using the returned issueId.