PostmatesAPI

FREE
By serg.osipchuk
Updated 5 months ago
Logistics
4.1/10
Popularity Score
238ms
Latency
100%
Success Rate

PostmatesAPI API Documentation

Integrate on-demand local delivery service into your app.

View API Details
POSTcancelDelivery
POSTcreateDelivery
POSTgetAllDeliveries
POSTgetDelivery
POSTgetDeliveryQuote
POSTgetDeliveryZones
POSTcancelDelivery

Cancel an ongoing delivery. A delivery can only be canceled prior to a courier completing pickup. Delivery fees still apply.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
customerIdCREDENTIALS
REQUIREDThe customer id obtained from Postmates.
deliveryIdSTRING
REQUIREDThe ID of the created delivery.
apiKeyCREDENTIALS
REQUIREDThe API Key obtained from Postmates.
Code Snippet
unirest.post("https://PostmatesAPIserg-osipchukV1.p.rapidapi.com/cancelDelivery")
.header("X-RapidAPI-Host", "PostmatesAPIserg-osipchukV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://PostmatesAPIserg-osipchukV1.p.rapidapi.com/cancelDelivery
Request Method: POST
Response Headers
Response Body

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://PostmatesAPIserg-osipchukV1.p.rapidapi.com/cancelDelivery")
.header("X-RapidAPI-Host", "PostmatesAPIserg-osipchukV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication