Retailer API Docs

• The Peddler Retailer API is a RESTful web service for developers to programmatically interact with Peddler's data and real-time order/delivery management services.
• All data exchanged between clients and the API is JSON (unless specified otherwise) over HTTPS.
• The staging URL for the Peddler API is https://alphadev-api.peddler.com
• Peddler utilises the CRUD standardised use of HTTP Action Verbs.
  • POST (create)
  • GET (read)
  • PUT (update/replace)
  • DELETE (remove)

Production Environment

Once all testing has been done in the staging environment and desired results are obtained, the production environment can be used. The base URL for the production environment is https://api-lokl.peddler.com

High-level CRUD Operation examples

1. If you want to create an "Order", you should send a POST request to the API as follows:
   https://alphadev-api.peddler.com/api/Orders
2. If you want to read an "Order", you should send a GET request to the API as follows:
   https://alphadev-api.peddler.com/api/Orders/{id}
3. If you want to read multiple "Orders", you should send a GET request to the API as follows:
   https://alphadev-api.peddler.com/api/Orders/
4. If you want to update an "Order" in Peddler, you should send a PUT request to the API as follows:
   https://alphadev-api.peddler.com/api/Orders/{id}
5. If you want to add an delivery to an "Order" in Peddler, you should POST to the API:
   https://alphadev-api.peddler.com/api/Orders/{id}/deliveryLineItems/

• All parameters, where relevant, are required unless otherwise specified.
• Peddler API uses OAuth2 based authentication methods. All keys are provided by the peddler team and are available on request.
• If you have questions about using the API, want to share some feedback, or have come across a bug you'd like to report, write us an email at [email protected].

Security Warning

We will never ask you for credentials/API keys so do not provide them.

API Status

The Peddler API has 100% uptime and is monitored 24/7. To check the status of the API, check the following status page: Peddler API System status. If you are experiencing issues with the API, please contact us by sending an email to [email protected].