Sections

• Overview
• API Authentication

Endpoints

Calls to the API must be for genuine use and responses from the API must not be stored for the purpose of creating an offline copy of the information stored. Failure to comply with this requirement will infringe the API License.

Make & Model Extended API Calls

Make Model Extended

POST /makemodelext

Purpose

To return the make and model of a product using the supplied serial number.

Inputs

• storeid - This must be a valid API store ID and is used to identify the store requesting the make and model information.
• serials - An array of serial numbers. Serial numbers must consist only of alpha-numeric characters (a-z and 0-9) and be at least 3 characters in length. The maximum number of serials that can be supplied in a single call is 3.
• category - OPTIONAL - A numeric category number to identify the type of product the serial relates to. This defaults to 1. Setting this to 0 (zero) will perform the search on all product categories. At present this method supports the following product categories:-
  
  Supported Categories

Example Request

curl -H 'Accept: application/json' \
-u 123:XXXXXXXXXXXXXXXXXXXXXX \
https://gapi.checkmend.com/makemodelext

{
    "storeid": 1,
    "category": 1,
    "serials": ["012341234512340"]
}

Output

A JSON object containing the make and model of the handset. In the event of an error a JSON object containing an errors array will be returned.

Additional fields can be returned by add-on packages, for example: 5G capability, images or your internal reference. Please contact your account manager to discuss add-on features.

Example Response

Response with matches:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "makes":[
        {
            "make":"APPLE",
            "category":1,
            "serials": ["012341234512340"],
            "models":[
                {
                    "name":"IPHONE 5",
                    "colour":"BLACK",
                    "storage":"32GB"
                },{
                    "name":"IPHONE 5",
                    "colour":"WHITE",
                    "storage":"32GB"
                },{
                    "name":"IPHONE 5",
                    "colour":"BLACK",
                    "storage":"64GB"
                },{
                    "name":"IPHONE 5",
                    "colour":"WHITE",
                    "storage":"64GB"
                }
            ]
        }
    ]
}

Response with matches and modelreference status enabled (requires add-on):

HTTP/1.1 200 OK
Content-Type: application/json

{
    "makes":[
        {
            "make":"APPLE",
            "category":1,
            "serials": ["012341234512340"],
            "models":[
                {
                    "name":"IPHONE 5",
                    "colour":"BLACK",
                    "storage":"32GB",
                    "modelreference":"REFIP5432"
                },{
                    "name":"IPHONE 5",
                    "colour":"WHITE",
                    "storage":"32GB",
                    "modelreference":"REFIP5W32"
                }
            ]
        }
    ]
}

Response with matches and 5G status enabled (requires add-on):

HTTP/1.1 200 OK
Content-Type: application/json

{
    "makes":[
        {
            "make":"APPLE",
            "category":1,
            "serials": ["012341234512340"],
            "models":[
                {
                    "name":"IPHONE 12",
                    "colour":"BLACK",
                    "storage":"32GB",
                    "5g":"true"
                },{
                    "name":"IPHONE 12",
                    "colour":"WHITE",
                    "storage":"32GB",
                    "5g":"true"
                }
            ]
        }
    ]
}

Response with matches and images enabled (requires add-on):

HTTP/1.1 200 OK
Content-Type: application/json

{
    "makes":[
        {
            "make":"APPLE",
            "category":1,
            "serials": ["012341234512340"],
            "models":[
                {
                    "name":"IPHONE 12",
                    "colour":"BLACK",
                    "storage":"32GB",
                    "images":[
                        {
                            "url":"https://cdn.recipero.com/modelcheck/5439cd5a-f8b1-4c2e-884f-d6c1ed48b868",
                            "description":"Front View"
                        },
                        {
                            "url":"https://cdn.recipero.com/modelcheck/1139sd5a-f8b1-4c2e-884f-d6c1ed43b899",
                            "description":"Side View"
                        }
                    ]
                },{
                    "name":"IPHONE 12",
                    "colour":"WHITE",
                    "storage":"32GB",
                    "images":[
                        {
                            "url":"https://cdn.recipero.com/modelcheck/5439cd5a-f8b1-4c2e-884f-d6c1ed48b868",
                            "description":"Front View"
                        },
                        {
                            "url":"https://cdn.recipero.com/modelcheck/1139sd5a-f8b1-4c2e-884f-d6c1ed43b899",
                            "description":"Side View"
                        }
                    ]
                }
            ]
        }
    ]
}

Response with no matches:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "makes":
    [
    ]
}