api

Response

On success, the API will return a JSON API document with a procedure object as the data member.

The id member of the response object will contain the LHost procedure token.

Note: If the id is empty it does not indicate an error, and no further action is required; it only means that the procedure data needs to be processed manually.

The shipment meta will contain the status member (please see status codes below).

Response codes

Result HTTP status code
Success 200 OK
Success 202 Accepted
Error 400 Bad Request
Not Found 404 Not Found

Please see the Error Handling documentation for further information about errors.


README