Product Choice List

Some product items have choice lists that support their purchase. This section describes how a product's choice list can be obtained.

Get Choice List

To retrieve the choice list, pass the choice list ID as a query parameter. Currently, only NWSC has a defined choice list and it's ID is NWSC.Area. Whenever more choice list IDs are created, the document will be updated accordingly

GET https://sandbox.ellypayapp.com/merchant/products/choice-list?list_id={listId}

This section applies to products returned from the list above whose value for has_choice_list is a boolean true.

Request

Query Parameters

Parameter	Type	Description	Required
list_id	string	The ID of the choice list. Only one list ID is supported at the moment; NWSC.Area	YES

Response

Response Body

Parameter	Type	Description
id	string	The unique ID of the choice
name	string	The name of the choice

Sample Response (OK)

// using list_id as NWSC.Area

{
    "code": 200,
    "status": "success",
    "message": "Request completed successfully.",
    "data": {
        "description": "Choose NWSC Area",
        "choice_list": [
            {
                "id": "NWSC.Area:249378",
                "name": "NWSC Mukono"
            },
            {
                "id": "NWSC.Area:249375",
                "name": "NWSC Entebbe"
            },
            {
                "id": "NWSC.Area:249376",
                "name": "NWSC Kawuku"
            },
            {
                "id": "NWSC.Area:249372",
                "name": "NWSC Iganga"
            },
            {
                "id": "NWSC.Area:249377",
                "name": "NWSC Lugazi"
            },
            {
                "id": "NWSC.Area:249373",
                "name": "NWSC Jinja"
            },
            {
                "id": "NWSC.Area:249374",
                "name": "NWSC Kajjansi"
            },
            {
                "id": "NWSC.Area:249371",
                "name": "NWSC Kampala"
            },
            {
                "id": "NWSC.Area:249379",
                "name": "Other NWSC Areas"
            }
        ]
    }
}

Sample Response (Error)

{
    "code": 422,
    "status": "error",
    "message": "Invalid list_id 'NWSC'",
    "data": {}
}

Supported Choice Lists

List ID	Description
NWSC.Area	Returns the list of the different NWSC areas