Project

General

Profile

General Notes » History » Version 39

Version 38 (Paulina Nguyen, 03/06/2015 01:57 AM) → Version 39/40 (Don Lee, 12/29/2016 07:12 PM)

h1. General Notes

h2. API Base URL

<pre>https://api.bricklink.com/api/store/v1</pre>



h2. SSL Only

All requests are required to be done over SSL.



h2. UTF-8 Encoding

Every string passed to and from the Bricklink API needs to be UTF-8 encoded.



h2. Date Format

All timestamps in the API are strings in "ISO 8601":http://en.wikipedia.org/wiki/ISO_8601 format:
<pre>
yyyy-MM-dd'T'HH:mm:ss.SSSZ
2013-12-01T18:05:46.123Z
</pre>



h2. Rounding Policy

BrickLink API uses values with 4 decimal places for all financial calculations. Any value with greater precision will be rounded up to 4 places.



h2. Request

* [[Authorization|OAuth parameters]] should be included in every request.
* In PUT or POST, you represent the resource object you wish to update using URL encoded JSON.
* Optional parameters should be provided as a query string using URL encoded form.



h2. Response

BrickLink API supports returning resource representations as JSON with the following structures:

|_. Property Name |_. Value |_. Description |_. Notes |
| meta | Object | Extra information about the response | |
| meta.code | Integer | API result code. (2xx if successful, any other number otherwise) | [[Error_Handling#Result-Code|Result Code]]|
| meta.message | String | More granular information about the result | |
| meta.description | String | Detailed description about the result | |
| data | Object | Requested information. Depending on the type of request you made, the HTTP response message body may be empty (typically for DELETE messages). If the body is not empty, it will always be JSON object. | |

<pre>
<code class="json">
{ "meta": {

"code":"200",

"message":"OK",
"description":"OK"

}, "description":"OK",
"data": {

}
}</code>
</pre>
Add picture from clipboard (Maximum size: 24.4 MB)