View an Order

get

https://sandbox.sendle.com/api/orders/{id}

Returns the given order including its status, the public tracking URL, and the metadata you passed when creating it.

Viewing an order should include everything that you need to know about it! Aside from the tracking endpoint, of course. Importantly, the is_cancellable key under the scheduling section tells you whether you can cancel the order.

Responses

500

Indicates that an unhandled error has occured with the Sendle API. We may have more information on the Sendle Status page. Contact [email protected] if the problem persists.

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response.

401Indicates that your Sendle ID or API key was incorrect or not provided. You should double-check your API credentials and confirm whether you're using sandbox or production details.

404Indicates that the given order ID, label URL, parcel reference, or other URI couldn't be found. Double-check the ID or URL before retrying. This can also mean you're trying to return an order you're not the sender/creator of.

503Indicates that Sendle is temporarily offline for maintenance or upgrades. We may have more information on the Sendle Status page.