How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

grubhub Merchant Onboarding API

Endpoints for onboarding merchants to the Grubhub platform, including referrals, activation, and association.

grubhub Merchant Onboarding API is one of 17 APIs that Grubhub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Merchant Onboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 5 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api-third-party-gtm.grubhub.com, https://api-third-party-gtm-pp.grubhub.com.

5 operations 5 paths 8 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.grubhub.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

grubhub Merchant Onboarding API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmacAuth). By default, every request must be authenticated.

  • hmacAuth — HMAC-based authentication. Every request must include X-GH-PARTNER-KEY and an Authorization header with MAC authentication details.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Merchant Onboarding 5

Endpoints for onboarding merchants to the Grubhub platform, including referrals, activation, and association.

POST
/pos/v1/onboarding/referral
Grubhub Create a New Merchant Referral
createMerchantReferral body → 201400401
POST
/pos/v1/onboarding/activate
Grubhub Activate a Merchant
activateMerchant body → 200400401404
POST
/pos/v1/onboarding/deactivate
Grubhub Deactivate a Merchant
deactivateMerchant body → 200400401404
POST
/pos/v1/onboarding/deactivate/partner
Grubhub Deactivate a Merchant (partner Auth)
deactivateMerchantPartner body → 200400401404
POST
/pos/v1/onboarding/associate
Grubhub Associate Merchants with Partner
associateMerchants body → 200400401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are MerchantReferral (5 properties), Address (4 properties), ReferralResponse (3 properties), Contact (3 properties). Each schema is shown below with its type and property counts.

ReferralResponse
object
Response after successfully creating a merchant referral.
3 properties
MerchantActivationRequest
object
Request to activate a merchant for partner integration.
1 property 1 required
Contact
object
Contact information for a merchant.
3 properties
Address
object
A physical address.
4 properties
Error
object
Standard error response from the Grubhub API.
3 properties
MerchantAssociationRequest
object
Request to associate merchants with the partner.
1 property 1 required
MerchantReferral
object
Details of a new merchant being referred for onboarding.
5 properties 3 required
MerchantDeactivationRequest
object
Request to deactivate a merchant and remove partner association.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

grubhub-merchant-onboarding-api-openapi.yml Raw ↑

Other APIs Grubhub publishes across the network.

grubhub Delivery Status API
grubhub Driver Communication API
grubhub Issue Reporting API
grubhub Menu Ingestion API
grubhub Menu Retrieval API
grubhub Menu Schedule Overrides API
grubhub Merchant Eligibility API
grubhub Merchant Properties API
grubhub Merchant Status API
grubhub Merchants API
grubhub Order Change Requests API
grubhub Order Polling API
Where this information came from

This is an independent, third-party profile of grubhub Merchant Onboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.