Getting started as an aggregator/developer brand

Integration

The best source of information for developers looking to integrate with the Postmates API is the Postmates API developer documentation. For any questions, please reach out to welcome-api@postmates.com.

Billing & Pricing

Billing and pricing details are outlined here. To request a copy or for clarification, please contact your Account Manager.

Account/Key Creation

Postmates encourages aggregators/developers to set up their own unique key during the onboarding process in order to create test orders and ensure configurations meet expectations. Once aggregators begin onboarding brands, Postmates strongly recommends having each brand set up their own unique account/key themselves by following the flow below:

  • Visit https://partner.postmates.com/welcome-api and complete the signup flow. This will require the following information:
    • First/Last name
    • Email address (this will be the email address linked to your account)
    • Password
    • Business name
    • Business type, category
    • Weekly delivery volume
    • Website
    • Business description

Once you submit this form, your account will be live in a matter of minutes! Submit key details to aggregator/developer POC to complete integration.

Delivery Settings

There are three ways to configure delivery settings: by account/key, by location, and by order

  • By account/key:
    To make changes at the account/key level, contact your Account Manager. The following settings are configurable at the account/key level:

    • Customer Not Available action: Determines Postmate/courier flow in the case that the customer is not available at dropoff. Choose from:

      • Return to pickup location
      • Discard
      • Leave at door 
    • Disallow end-customer SMS: Prevents the Postmate/courier from being able to text the end customer during the delivery. By default, Postmates are enabled to both call and/or text the end customer while the order is live and they are assigned to it.
    • Proof of delivery: Allows you to require an ID scan (21+) or end-customer signature at dropoff as proof of delivery. This can be set at the order or account/key level.
  • By location:
    Settings are not currently configurable at the location level, but stay tuned as this is coming soon!
  • By order:
    Order-level settings are configurable prior to submitting a delivery request, via either your partner dashboard or webhooks. 
    • The following settings are configurable at the order level:
      • Proof of delivery: Allows you to require an ID scan (21+) or end-customer signature at dropoff as proof of delivery. This can be set at the order or account/key level.