sizeez API (2.0.0)

Authentication

To use the sizeez API, you need to authenticate your requests using the API key you receive from us.

To do so, ensure that the API key is included in the header field named x-api-key for every request.

Important: Please keep your API key secret. If you need use the API key to make API calls directly from frontend, consider implementing a proxy server to safeguard and conceal the API key for added security.

General HTTP Error Codes

HTTP Status Code	Meaning	Description
400	Bad Request	Your request is invalid. A required parameter was missing or invalid.
401	Unauthorized	Your API key is missing or invalid.
403	Forbidden	The http path or verb is not supported. The API will respond with message: "Missing Authentication Token".
404	Not Found	The requested resource is not found.
409	Conflict	The operation is not allowed on a resource with the current status.
429	Quota exceeded	Your API key's quota limit has been reached or too many requests per second.
500	Internal Server Error	A server error occurred.

This list provides a general overview over the errors the API is returning. For detailed information, see the documentation of the individual endpoints.

Step 1 - Initiate Scan

/measurements/init

Call this endpoint to start the process of a new scan.

query Parameters

redirect-url

string

This query parameter is optional.

If you are using the sizeez companion app and want to redirect the user to a particular URL upon the completion of the photo uploading process, please provide the URL here in an URL-encoded format.

For instance, if your desired URL is "myshop.com/product1?color=blue&size=l", provide it in URL-encoded format as: "myshop.com%2Fproduct1%3Fcolor%3Dblue%26size%3Dl"

header Parameters

x-api-key

required

string

API key to access the endpoint

Responses

Request samples

Javascript

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("x-api-key", "<your-api-key>");

const requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.mobilescan.me/v2/measurements/init", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Response samples

Content type

application/json

{"id": "job_20190430_141019_af9b3be0-6b51-11e9-a6bd-35ce92fec529",
"qrcode": "iVBORw0KGgoAAAANSUhEUgAAAPUAAAD1CAAAAACt2uy5AAADH0lEQVR42u3bS1IjMRAFQN//0rCfoOX3JCAGVXo1g2m3Uo6oVn14fUx8vaipqampqampqampqampqampqXv16/3r5Iqv/vvP7z1esb42WCk1NfU49XMADN8NNOvPC7Ztc6XU1NTj1OuVB8G4Oyh+cd/HUL25x9TU1NSrO63PiOknP8bw9fqoqampf0qdJs9BlA6s1NTU1If59cnvVVn1+pd/uapATU39x9RBR+E/+dcvd3yoqan/jrqq7lW7U3U3qtDfLZyamnqGOoiRwQmyp6fXVuujpqYerA56EOtRuyrgb+5JdXKlpqamLpqzwRXBtf15NV0VNTX1OHXfYE1T4a6m14CDnaCmph6nfgy31ZhKFfWrzeqjPjU19XR1eqc09w2KjOnNq7k8amrqmeq0QhdsQpVu923kYPOpqakHq9eGzTfSKmCwd1Ugp6amHqyuUuY0jQ6CbDXistlQoaamnqTuY2SwrONpvKCGeV5VoKamvkodzORWx8OgJds3WdKzMzU1NXVRtatieJVk9xMv5/k1NTX1fep+WLdaYFVzPBnOo6amnqnezG6remAfeIMjckqnpqYeok4Hc48Kdu/fCB4l1S2pqanHqYNu7PGyvnHobuOvLKipqWeoq3NeGoyDmFttx1EKTk1NPUO9WSisSOuHwOZTJP5CqKmpZ6iDoZO+iBekwkErOPhCzk+k1NTUt6j7vuxmXyIp7IXn2vSZQE1NPU6dGqrzar8T/TPhqPdBTU19lbqaMtks2AWfXG3vN82lUFNT36de36kKnn3UD0qL1XQfNTU1dRa0+8PjOh9eFwCDGx393Qc1NfV96qCdka78uG/Sr2r3REpNTX2LumqFBOG2P6CmHd/+Z9TU1JPUr/evk6ifHh6rx0aaWlNTU49TryN3lTfHo7zvk/afjuHU1NSXqqseRJpzx1nwXkaefCvU1NTUpfq4bxIk2WnHg5qamjrLkYNpt+qomo7CVKk1NTX1THX6blVGrJ4O6xulJ2FqaurB6ip/DXBBTa8fNamyampq6nHq61/U1NTU1NTU1NTU1NTU1NTU1NTr1yd+uI/Jo5bI3gAAAABJRU5ErkJggg==",
"link": "https://app.sizeez.com/qrcode/job_20190430_141019_af9b3be0-6b51-11e9-a6bd-35ce92fec529"
}

Step 2 - Upload 2 Photos

/measurements/upload

Call the /measurements/upload endpoint to retrieve two separate upload URLs for both the front and side photos. Then, upload both photos in binary format calling the obtained upload URLs using HTTP PUT method.

header Parameters

x-api-key

required

string

API key to access the endpoint

Request Body schema: application/json
required

id required	string The job ID as returned by GET /measurements/init
gender required	string Gender of the person in the image. Valid options include: `female`, `male`, `unisex`
height required	string Height of the person in the image in cm. Valid value should be between `100` and `300`
format required	string The format of the images to be uploaded. Valid options include: `jpg`, `jpeg`, `png`, `bmp`, `tiff`
mode	string Optional: Image taking mode. Valid options include: `single`, `partner`

Responses

Request samples

Payload
Javascript

Content type

application/json

{"id": "job_202204221234598603492",
"gender": "female",
"height": "167",
"format": "png",
"mode": "partner"
}

Response samples

Content type

application/json

{"id": "job_202204221234598603492",
"scanId": "fk42",
"front": "https://bucket.s3.amazonaws.com/20190430_141951_04b502e0-6b53-11e9-8ed1-858443cd6225/front.png?Content-Type=application%2Foctet-stream",
"side": "https://bucket.s3.amazonaws.com/20190430_141951_04b502e0-6b53-11e9-8ed1-858443cd6225/side.png?Content-Type=application%2Foctet-stream"
}

Step 3 - Check Job State

/measurements/{id}/state

Retrieve the processing state of the scan associated with the provided job ID. Possible states include:

0: Measurement process is initiated, waiting for photos to be uploaded

1: Photos are uploaded and the measurement process has started

2: The measurement process is completed. Now you can call GET /measurements/{id} or GET /measurements/{id}/recommendation endpoint to get the result

-1: An error has occurred during processing

It might be necessary to call this endpoint repeatedly until state 2 or -1 is returned.

path Parameters

required

string

The job ID as returned by GET /measurements/init

header Parameters

x-api-key

required

string

API key to access the endpoint

Responses

Request samples

Javascript

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("x-api-key", "<your-api-key>");

const requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.mobilescan.me/v2/measurements/job_20190430_141019_af9b3be0-6b51-11e9-a6bd-35ce92fec529/state", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Response samples

Content type

application/json

{"id": "job_20190430_141019_af9b3be0-6b51-11e9-a6bd-35ce92fec529",
"state": "1",
"err": ""
}

Step 4 - Get Results

/measurements/{id}

Retrieve the body measurement result of the scan associated with the provided job ID.

For the definition of each measurement included in the API response, please refer to this link: List of Body Measurements

path Parameters

required

string

The job ID as returned by GET /measurements/init

header Parameters

x-api-key

required

string

API key to access the endpoint

Responses

Request samples

Javascript

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("x-api-key", "<your-api-key>");

const requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.mobilescan.me/v2/measurements/job_20190430_141019_af9b3be0-6b51-11e9-a6bd-35ce92fec529", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Response samples

Content type

application/json

{"scanId": "dfk8",
"girths": {"head": {"neck_girth": 35.5
},
"torso": {"bust_girth": 91.5,
"waist_girth": 85.5,
"hip_girth": 92
},
"arms": {"upperarm_girth": 29.5,
"elbow_girth": 24.5,
"wrist_girth": 16.5
},
"legs": {"thigh_girth": 53,
"calf_girth": 36,
"ankle_girth": 24
}
},
"lengths": {"height": 179,
"torso": {"across_back_shoulder_width": 43,
"shoulder_length": 15,
"torso_height": 76
},
"arms": {"arm_length": 62,
"upperarm_length": 35.5,
"lowerarm_length": 26.5
},
"legs": {"inside_leg_height": 78.5
}
}
}

/measurements/{id}/recommendation

Retrieve the size recommendation result of a given scan and a given size chart.

Please Note: you are required to provide a size chart ID to receive size recommendation result. For further details, please refer to: Size Chart

path Parameters

required

string

The job ID as returned by GET /measurements/init

query Parameters

size-chart-id

required

string

Unique identifier for the size chart.

header Parameters

x-api-key

required

string

API key to access the endpoint

Responses

Request samples

Javascript

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("x-api-key", "<your-api-key>");

const requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.mobilescan.me/v2/measurements/job_20190430_141019_af9b3be0-6b51-11e9-a6bd-35ce92fec529/recommendation?size-chart-id=sizeChart_20220920_095339_1a2401b0-38ca-11ed-9e5b-179be3a648cd", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Response samples

Content type

application/json

{"chart": "Men's shirts and tops",
"gender": "male",
"scanGender": "male",
"primary": {"sizes": [{"int": "L"
}
],
"indices": ["3"
],
"perfectFit": false
},
"secondary": {"sizes": [{"int": "XL"
}
],
"indices": ["4"
]
},
"size_details": [[{"index": "2",
"ranges": {"waist_girth": [81,
88
],
"hip_girth": [92,
99
],
"bust_girth": [93,
100
]
},
"sizes": {"int": "M"
}
},
{"index": "3",
"ranges": {"waist_girth": [89,
96
],
"hip_girth": [100,
107
],
"bust_girth": [101,
108
]
},
"sizes": {"int": "L"
}
},
{"index": "4",
"ranges": {"waist_girth": [97,
106
],
"hip_girth": [108,
116
],
"bust_girth": [109,
118
]
},
"sizes": {"int": "XL"
}
}
]
],
"fit_details": [[[{"body_measurement_name": "waist_girth",
"body_measurement_value": 101,
"index": "4"
},
{"body_measurement_name": "hip_girth",
"body_measurement_value": 103,
"index": "3"
},
{"body_measurement_name": "bust_girth",
"body_measurement_value": 100.5,
"index": "2"
}
]
]
]
}

Optional - Reuse a Scan

/measurements/share

Reuse the body measurement result of an existing scan. The body measurement values will be copied from an old scan to a new scan.

header Parameters

x-api-key

required

string

API key to access the endpoint

Request Body schema: application/json

newJobId required	string The job ID of a newly initialized scan
oldId required	string The job ID of an existing scan. This scan should be completed already.

Responses

Request samples

Payload
Javascript

Content type

application/json

{"newJobId": "job_202204221234598603492",
"oldId": "job_2022042212345986033454"
}

Response samples

Content type

application/json

{"message": {"message": "success"
}
}

sizeez API (2.0.0)

Authentication

General HTTP Error Codes

Step 1 - Initiate Scan

/measurements/init

query Parameters

header Parameters

Responses

Request samples

Response samples

Step 2 - Upload 2 Photos

/measurements/upload

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Step 3 - Check Job State

/measurements/{id}/state

path Parameters

header Parameters

Responses

Request samples

Response samples

Step 4 - Get Results

/measurements/{id}

path Parameters

header Parameters

Responses

Request samples

Response samples

/measurements/{id}/recommendation

path Parameters

query Parameters

header Parameters

Responses

Request samples

Response samples

Optional - Reuse a Scan

/measurements/share

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Request Body schema: application/json
required