Public
Documentation Settings

Deliverex API Documentation

Welcome to Deliverex's API Documentation. We've crafted this document to assist developers and Deliverex users in comprehending and seamlessly integrating our API for efficient implementation. Our APIs enable users to fully utilize the extensive features available in your Deliverex account.

We've provided a comprehensive list of APIs, their requisite parameters, along with example requests and responses for clear comprehension.

Deilverex APIs adhere to the REST architecture and utilize standard HTTP request methods. They accept JSON-encoded body requests and return data in the same format.

Navigate through the following sections to smoothly proceed with the integration process.

Getting Started

  • To begin, please register or login on Deliverex via the provided link: https://deliverex.in/.

  • Next, navigate to the "Integrations" portal, locate "Deliverex Retail API" and find the means to contact Deliverex's team to get started with our Retail API Services.

  • Upon contacting, Deliverex's team will verify your account and subsequently provide your API key and API secret via email.

  • Utilize the provided API key and API secret to generate an access token, enabling access to our APIs.

API Usage Guidelines

  • Deliverex's APIs support the fundamental HTTP methods: POST, GET, PATCH, PUT and DELETE.

  • To specify the desired language for request and response codes, simply select it from the dropdown menu provided.

  • You can seamlessly import and evaluate our entire API collection within the Postman application by clicking on the 'Run in Postman' button.

  • Kindly note that any requests executed with valid API credentials will directly impact the real-time data within your Deliverex account.

  • Authorization: Bearer

  • Each API is accompanied by example requests and responses, illustrating both successful and unsuccessful scenarios.

Errors and Response Codes

RESPONSE CODESDESCRIPTION
200 & 201 - Ok & AcceptedAPI worked as expected, and the client will get a response.
400 - Bad RequestIndicates that the client's request to the API contains invalid syntax or parameters.
401 - UnauthorizedThe client lacks valid authentication credentials for accessing the requested resource.
404 - Not FoundThe requested resource could not be found on the server.
429 - Too Many RequestsThe client has sent too many requests to the server within a given timeframe.
500 - Internal Server ErrorAn unexpected condition occurred on the server, preventing it from fulfilling the request.