README

Magento Module

Are you reading this because you need to integrate Postmates into your Magento store? Do yourself a favor and checkout the Postmates Shipping extension; you’ll save time and money!

Overview

An API client for Postmates on demand logistics. You can find the Postmates documentation here.

The Postmates API is RESTful and the Postmates client library extends \Guzzlehttp\Client. You may easily incorporate the Postmates client into your project using composer.

Installing via Composer

The recommended way to install the Postmates client is through Composer.

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version of postmates-client:

composer require quickshiftin/postmates-client

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

Authentication

You instantiate \Postmates\Client the same as you would \Guzzlehttp\Client except there are 2 new required configuration options and one new optional configuration option. The new required options are customer_id and api_key which you get once you register your app. There's also an optional configuration option postmates_version which you can use to ensure consistent fields. Instantiating the client then looks like so

$oClient = new Client(['customer_id' => $cust_id, 'api_key' => $api_key]);

Where $cust_id and $api_key are your respective credentials.

API Methods

All the API methods have become public member functions of the \Postmates\Client class.

Request Delivery Quote

// $oQuote is an instance of \Postmates\Dao\DeliveryQuote
$oQuote = $oClient->requestDeliveryQuote($sPickupAddress, $sDropoffAddress);

// You may access a value from the JSON using array notation.
// Also remember the timestamps have been converted to \DateTime instances for us.
$oDropoffEta = $oQuote['dropoff_eta'];
echo 'Dropoff ETA: ' . $oDropoffEta->format("h:i a\n");

Create a Delivery

// $oDelivery is an instance of \Postmates\Dao\Delivery
$oDelivery = $oClient->createDelivery(
    /* Required arguments */
    $sManifest,
    $sPickupName,
    $sPickupAddress,
    $sDropoffName,
    $sDropoffAddress,
    $sDropoffPhoneNumber,

    /* Optional arguments */   
    $sDropoffBusinessName='',
    $sManifestReference='',
    $sPickupBusinessName='',
    $sPickupNotes='',
    $sDropoffNotes='',
    $iQuoteId=null // @hint You can pass the id of a quote as $oQuote['id']
);

List Deliveries

When listing deliveries you may filter by one of the order statuses, pending, pickup, pickup_complete, dropoff, canceled, delivered, returned. There are more details on the meanings of each status in the code and on the Postmates API documentation.

// Get a list of all Deliveries
// $oDeliveries is an instance of \Postmates\Dao\PList
// Assuming there is at least one Delivery in the response,
// $oDeliveries[0] is an instance of \Postmates\Dao\Delivery
$oDeliveries = $oClient->listDeliveries();

// Get a list of *pickup_complete* Deliveries
$oDelivereies = $oClient->listDeliveries(\Postmates\Client::STATUS_PICKUP_COMPLETE);

Get Delivery Status

// Just pass the id of a delivery and you'll get back a \Postmates\Dao\Delivery.
$oDelivery = $oClient->getDeliveryStatus($sDeliveryId);

Cancel a Delivery

A delivery can only be canceled prior to a courier completing pickup, which means the status must be either pending or pickup.

$oDelivery = $oClient->cancelDelivery($iDeliveryId);

Return a Delivery

A delivery can only be reversed once the courier completed pickup and before the courier has completed dropoff. This means the status can only be pickup_complete.

$oDelivery = $oClient->returnDelivery($iDeliveryId);

Client Library Data Objects

The Postmates client handily converts response JSON objects from the API into objects that subclass \ArrayObject. As a matter of convenience the client library also converts textual timestamps from the response to \DateTime instances.

TODO

Pagination support and testing
Configurable Exception handling
Configurable Dao classes
Optional Dao instead of id for client library methods
- EG $oDelivery = $oClient->createDelivery(); $oClient->cancelDelivery($oDelivery);

aglipanci / postmates-client

Maintainers

Details