Overview

Business API allows you to automatically place delivery orders in Quickers. You also can manage your orders and subscribe to updates on any changes in them.

First you should register as a client at apitest.quickers.co.kr. If you are unable to receive the SMS code when registering, please ask for it at api@quickers.co.kr, including your phone number in the email.

Integration of Quickers Business API is done in two steps:

Setting everything up using test environment at robotapitest.quickers.co.kr;

When it works with apitest, you can switch to production at robot.quickers.co.kr.

When you have successfully tested Business API integration with apitest.quickers.co.kr, please email us at api@quickers.co.kr, so we can enable your access to Business API in production environment.

URL for production requests: https://robot.quickers.co.kr/api/business/1.0

API versions are increased with incompatible changes, e.g. changes to data types or removal of request parameters. Non-latest API versions will still be supported for some reasonable time. New requests and parameters in existing requests (e.g. a new field in order structure) can be added at any time without new API versions. You should ignore unknown fields in any API data structures.

If you have any questions or suggestions about the API, please email our support at api@quickers.co.kr.

Requests

All requests to Business API must be made via HTTPS. Only GET and POST request methods are supported. POST requests should send all parameters in the body of the request in JSON format and UTF-8 encoding; GET requests should send parameters in the query string.

Error codes for request parameters. If errors field contains error code invalid_parameters, this field will have detailed parameter errors. Structure of this object corresponds to structure of the request.

Request parameters

Try to make this description useful for the courier. For example, putting a category from your catalog here is better than only a concrete model number. If the item is fragile or oversized, please mention it here.

Request parameters

Try to make this description useful for the courier. For example, putting a category from your catalog here is better than only a concrete model number. If the item is fragile or oversized, please mention it here.

Request parameters

To edit the order, send any number of extra parameters from order creation. If modified value is valid, it will be applied to the order. If a parameter is not sent with the request, its value will not be changed. If a parameter is sent with null value, corresponding value will be removed from the order.

When editing a point, always send its ID along with changed values, otherwise a new point will be added to the order. Also, any points with IDs not mentioned in the request will be deleted.

If your URL responds with any HTTP status other than 200 (OK), our server will treat it as an error. We will then retry to send the request with increasing intervals between attempts for 24 hours until we get HTTP status 200 in response.

If a successful response was not received after 24 hours, we will stop retrying. In this case an email notification will be sent to your address.