General Notes » History » Version 30
« Previous -
Version 30/40
(diff) -
Next » -
Current version
Paulina Nguyen, 03/05/2015 01:32 AM
General Notes¶
API Base URL¶
https://api.bricklink.com/api/store/v1
SSL only¶
We require that all requests are done over SSL.
UTF-8 encoding¶
Every string passed to and from the Bricklink API needs to be UTF-8 encoded.
Date format¶
All timestamps in the API are strings in ISO 8601 format:
yyyy-MM-dd'T'HH:mm:ss.SSSZ 2013-12-01T18:05:46.123Z
Rounding policy¶
For all financial calculations, BrickLink API uses values with 4 decimal places. Any values that has greater precision will be rounded up to 4 places.
Request¶
- OAuth parameters should be included in every request.
- In the PUT or POST, you represent the resource object you wish to update as form of urlencoded JSON.
- Optional parameters (ex pagination info) should be provided as query string with urlencoded form.
Response¶
BrickLink API supports returning resource representations as JSON with the following structure:
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) | Result Code |
meta.message | String | More granular information about the result | |
meta.description | String | Detailed description of 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), but if the body is not empty, it will always be JSON object. |
{ "code":"200", "message":"OK", "description":"OK", "data": { } }