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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vendasta

Vendasta Platform REST API

The Platform REST APIs are the core of the Vendasta API Gateway: business locations, sales accounts, users and their location permissions, orders and order custom fields, order fulfillment forms, subscriptions and subscription assignments, purchases, products, partner activatable products, automations and automation runs, plus country/region reference data. Requests and responses follow JSON:API over application/vnd.api+json with page[limit]/page[cursor] paging and filter[] query params. Secured with OAuth2 bearer tokens issued by sso-api-prod.apigateway.co. Deliberately unversioned ("Evergreen") — maturity is tracked per operation and per field with the x-lifecycle extension.

Documentation Provider Profile APIs.io OpenAPI GitHub

Vendasta Platform REST API is one of 38 APIs that Vendasta publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Platform, Order, User, business-locations, and SalesAccounts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 91 operations across 38 paths, organized into 18 resource areas, and defines 25 schemas. It is described by OpenAPI 3.0.0, at version Evergreen.

Requests are made against 4 base URLs: https://prod.apigateway.co/platform, https://demo.apigateway.co/platform, {local}/platform, http://localhost:11001/platform.

91 operations 38 paths 25 schemas 2 DELETE34 GET37 OPTIONS9 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
Evergreen
Base URL
https://prod.apigateway.co/platform
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0
Resource Areas
18

Authentication & Security 3

Vendasta Platform REST API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWT). It supports OAuth 2.0 (OAuth2Demo) using the authorizationCode flow, exposing 24 scopes. It supports OAuth 2.0 (OAuth2Prod) using the authorizationCode flow, exposing 24 scopes.

Paths & Operations 91

Across 38 paths, the API surfaces 91 operations — 2 DELETE, 34 GET, 37 OPTIONS, 9 PATCH, 9 POST. They span 18 resource areas, including Business Locations, Options, Users, Purchases, Business Categories, Orders, Order Custom Fields, Order Fulfillment Forms, and 10 more. Each is listed below with its method, path, parameters, and response codes.

Business Locations 4
POST
/businessLocations
Create Business Location
post-businessLocations 2 params body → 201
GET
/businessLocations
List Business Locations
get-businessLocations 9 params → 200500
GET
/businessLocations/{id}
Get Business Location
get-businessLocations-id 4 params → 200
PATCH
/businessLocations/{id}
Update Business Location
patch-businessLocations-id 3 params body → 200
Options 37
OPTIONS
/businessLocations
List valid HTTP verbs for /businessLocations
options-businessLocations → 204
OPTIONS
/businessLocations/{id}
List valid HTTP verbs for /businessLocations/{id}
options-businessLocations-id 1 param → 204
OPTIONS
/users
List valid HTTP verbs for /users
options-users → 204
OPTIONS
/users/{id}
List valid HTTP verbs for /users/{id}
options-users-id 1 param → 204
OPTIONS
/purchases
List valid HTTP verbs for /purchases
options-purchases → 204
OPTIONS
/businessCategories
List valid HTTP verbs for /businessCategories
options-businessCategories → 204
OPTIONS
/orders
List valid HTTP verbs for /orders/{id}
options-orders → 204
OPTIONS
/orders/{id}
List valid HTTP verbs for /orders/{id}
options-order-id 1 param → 204
OPTIONS
/orders/{id}/relationships/customFields
List valid HTTP verbs for /orders/{id}/relationships/customFields
options-orderCustomFieldsID-by-order 1 param → 204
OPTIONS
/orders/{id}/customFields
List valid HTTP verbs for /orders/{id}/customFields
options-orderCustomFields-by-order 1 param → 204
OPTIONS
/orderCustomFields/{id}
List valid HTTP verbs for /orderCustomFields/{id}
options-orderCustomFields-by-id 1 param → 204
OPTIONS
/orderFulfillmentForms
List valid HTTP verbs for /orderFulfillmentForms
options-orderFulfillmentForms → 204
OPTIONS
/orderFulfillmentForms/{id}
List valid HTTP verbs for /orderFulfillmentForms/{id}
options-orderFulfillmentForms-by-id 1 param → 204
OPTIONS
/users/{id}/relationships/businessLocations
List valid HTTP verbs for /users/{id}/relationships/businessLocations
options-users-id-relationships-businessLocations 1 param → 204
OPTIONS
/automationRuns
List valid HTTP verbs for /automationRuns
options-automationruns-id → 204
OPTIONS
/automations
List valid HTTP verbs for /automations
options-automations → 204
OPTIONS
/automations/{id}
List valid HTTP verbs for /automations/{id}
options-automations-id 1 param → 204
OPTIONS
/salesAccounts
List valid HTTP verbs for /salesAccounts
options-salesAccounts → 204
OPTIONS
/salesAccounts/{id}
List valid HTTP verbs for /salesAccounts/{id}
options-salesAccounts-by-id 1 param → 204
OPTIONS
/subscriptionAssignments
List valid HTTP verbs for /subscriptionAssignments
options-subscriptionAssignments 1 param → 204
OPTIONS
/subscriptions
List valid HTTP verbs for /subscriptions
options-subscriptions 2 params → 204
OPTIONS
/subscriptionAssignments/{id}
List valid HTTP verbs for /subscriptionAssignments/{id}
options-subscriptionAssignment-id 1 param → 204
OPTIONS
/subscriptionAssignments/{id}/actions/requestCancellation
List valid HTTP verbs for /subscriptionAssignments/{id}/actions/requestCancellation
options-subscriptionAssignment-requestCancellationAction 1 param → 204
OPTIONS
/subscriptionAssignments/{id}/actions/undoCancellation
List valid HTTP verbs for /subscriptionAssignments/{id}/actions/undoCancellation
options-subscriptionAssignment-undoCancellationAction 1 param → 204
OPTIONS
/salesAccounts/{id}/relationships/customFields
List valid HTTP verbs for /salesAccounts/{id}/relationships/customFields
options-salesAccountCustomFieldsID-by-salesAccount 1 param → 204
OPTIONS
/salesAccounts/{id}/customFields
List valid HTTP verbs for /salesAccounts/{id}/customFields
options-salesAccountCustomFields-by-salesAccount 1 param → 204
OPTIONS
/salesAccountCustomFields/{id}
List valid HTTP verbs for /salesAccountCustomFields/{id}
options-salesAccountCustomFields-by-id 1 param → 204
OPTIONS
/users/{id}/customFields
List valid HTTP verbs for /users/{id}/customFields
options-userCustomFields-by-userid 1 param → 204
OPTIONS
/users/{id}/actions/sendWelcomeEmail
List valid HTTP verbs for/users/{id}/actions/sendWelcomeEmail
options-sendWelcomeEmail-by-userid 1 param → 204
OPTIONS
/userCustomFields/{id}
List valid HTTP verbs for /userCustomFields/{id}
options-userCustomFields-by-id 1 param → 204
OPTIONS
/productCustomFields/{id}
List valid HTTP verbs for /productCustomFields/{id}
options-productCustomFields-by-id 1 param → 204
OPTIONS
/countries
List valid HTTP verbs for /countries
options-countries → 204
OPTIONS
/countries/{id}
List valid HTTP verbs for /countries/{id}
options-countries-id 1 param → 204
OPTIONS
/countryRegions
List valid HTTP verbs for /countryRegions
options-countryRegions → 204
OPTIONS
/countryRegions/{id}
List valid HTTP verbs for /countryRegions/{id}
options-countryRegions-id 1 param → 204
OPTIONS
/partnerActivatableProducts/{id}
List valid HTTP verbs for
options-partnerActivatableProducts-id 1 param → 200
OPTIONS
/partnerActivatableProducts
List valid HTTP verbs for /partnerActivatableProducts
options-partnerActivatableProducts → 200
Users 11
POST
/users
Create User
post-users 2 params body → 201
GET
/users
List Users
get-users 8 params → 200
GET
/users/{id}
Get User
get-users-id 2 params → 200
PATCH
/users/{id}
Update User
patch-users-id 3 params body → 200
DELETE
/users/{id}
Delete User
delete-users-id 2 params → 204
POST
/users/{id}/relationships/businessLocations
Associate user with location
post-users-id-relationships-businessLocations 3 params body → 201
GET
/users/{id}/relationships/businessLocations
Get user locations
get-users-id-relationships-businessLocations 2 params → 200
PATCH
/users/{id}/relationships/businessLocations
Replace user location access
patch-users-id-relationships-businessLocations 3 params body → 200
DELETE
/users/{id}/relationships/businessLocations
Dissociate user from location
delete-users-id-relationships-businessLocations 3 params body → 204
GET
/users/{id}/customFields
Get Custom Fields
get-userCustomFields-by-userid 2 params → 200
GET
/users/{id}/actions/sendWelcomeEmail
Send Welcome Email
get-sendWelcomeEmail-by-userid 2 params → 202
Purchases 1
GET
/purchases
List Purchases
get-purchases 6 params → 200
Business Categories 1
GET
/businessCategories
List Business Categories
get-businessCategories 7 params → 200
Orders 5
POST
/orders
Create Order
post-orders 2 params body → 201
GET
/orders
List Orders
get-orders 5 params → 200
GET
/orders/{id}
Get Order
get-orders-id 2 params → 200
GET
/orders/{id}/relationships/customFields
Get Custom Fields ID
get-orderCustomFieldsID-by-order 2 params → 200
GET
/orders/{id}/customFields
Get Custom Fields
get-orderCustomFields-by-order 2 params → 200
Order Custom Fields 2
PATCH
/orderCustomFields/{id}
Update Custom Fields
patch-orderCustomFields-by-id 3 params body → 200
GET
/orderCustomFields/{id}
Get Custom Fields by ID
get-orderCustomFields-by-id 2 params → 200
Order Fulfillment Forms 4
GET
/orderFulfillmentForms
List Fulfillment Forms for an Order
get-orderFulfillmentForms 2 params → 200
GET
/orderFulfillmentForms/{id}
Get Fulfillment Form by ID
get-orderFulfillmentForms-by-id 2 params → 200
PATCH
/orderFulfillmentForms/{id}
Update Fulfillment Form
patch-orderFulfillmentForms-by-id 3 params body → 200
POST
/orderFulfillmentForms/{id}/actions/submit
Submit a fulfillment form to the vendor
post-orderFulfillmentForms-submit 2 params body → 204404
Automation Runs 1
POST
/automationRuns
Create automation run
post-autoamtionruns 2 params body → 202
Automations 2
GET
/automations
List Automations
list-automations 8 params → 200
GET
/automations/{id}
Get Automation
get-automation-by-id 2 params → 200
Sales Accounts 6
POST
/salesAccounts
Create Sales Account
post-salesAccounts 2 params body → 201
GET
/salesAccounts
List Sales Accounts
get-salesAccounts 10 params → 200
GET
/salesAccounts/{id}
Get Sales Accounts
get-salesAccounts-by-id 4 params → 200
PATCH
/salesAccounts/{id}
Update Sales Account
patch-salesAccounts-by-id 3 params body → 200
GET
/salesAccounts/{id}/relationships/customFields
Get Custom Fields ID
get-salesAccountCustomFieldsID-by-salesAccount 2 params → 200
GET
/salesAccounts/{id}/customFields
Get Custom Fields
get-salesAccountCustomFields-by-salesAccount 2 params → 200
Subscription Assignments 4
GET
/subscriptionAssignments
List Subscription Assignments
get-subscriptionAssignments 3 params → 200
GET
/subscriptionAssignments/{id}
Get a particular Subscription Assignment
get-subscriptionAssignments-by-id 1 param → 200
POST
/subscriptionAssignments/{id}/actions/requestCancellation
Cancel Subscription Assignment
cancel-subscriptionAssignments-by-id 2 params body → 204
POST
/subscriptionAssignments/{id}/actions/undoCancellation
Restore a Canceled Subscription Assignment
restore-subscriptionAssignments-by-id 2 params → 204
Subscriptions 1
GET
/subscriptions
List Subscriptions
get-subscriptions 7 params → 200
Sales Account Custom Fields 2
PATCH
/salesAccountCustomFields/{id}
Update Custom Fields
patch-salesAccountCustomFields-by-id 3 params body → 200
GET
/salesAccountCustomFields/{id}
Get Custom Fields by ID
get-salesAccountCustomFields-by-id 2 params → 200
User Custom Fields 2
PATCH
/userCustomFields/{id}
Update Custom Fields
patch-userCustomFields-by-id 3 params body → 200
GET
/userCustomFields/{id}
Get Custom Fields by ID
get-userCustomFields-by-id 2 params → 200
Product Custom Fields 2
PATCH
/productCustomFields/{id}
Update Custom Fields for a product
patch-productCustomFields-by-id 3 params body → 200
GET
/productCustomFields/{id}
Get Product Custom Fields by ID
get-productCustomFields-by-id 2 params → 200
Countries 4
GET
/countries
List Countries
get-countries 4 params → 200
GET
/countries/{id}
Get Country
get-countries-id 3 params → 200
GET
/countryRegions
List Country Regions
get-country-regions 5 params → 200
GET
/countryRegions/{id}
Get Country Region
get-country-regions-id 3 params → 200
Partner Activatable Products 2
GET
/partnerActivatableProducts/{id}
Get Partner Activatable Product
get-partnerActivatableProducts-id 3 params → 200
GET
/partnerActivatableProducts
List Partner Activatable Products
get-partnerActivatableProducts 6 params → 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are lineItem (7 properties), salesAccounts (5 properties), orderFormField (5 properties), businessLocations (4 properties). Each schema is shown below with its type and property counts.

businessLocations
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester Any entity that works with a provider company (two-way communica…
4 properties
partners
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Proposed A partner is an organization that has a store filled with products tha…
4 properties 2 required
purchases
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester Purchases are a receipt of items sold to your organization. When…
4 properties 2 required
orders
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester An order records a sale to a business location. For example requ…
4 properties
orderCustomFields
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester Custom fields associated with a sales order. The field definitio…
3 properties 2 required
orderForm
object
A group of form fields associated with an order. The id identifies the form: - standard: Vendasta shared fields (business name, address, etc.) - admin: Partner…
2 properties 2 required
orderFormField
object
A single field within an order form.
5 properties 2 required
orderFulfillmentForms
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester A fulfillment form submission for an app within an order. Fulfil…
3 properties
businessCategories
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester The taxonomy to be applied to business locations indicating the…
3 properties
countries
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester A country that is valid for use with the API
3 properties
countryRegions
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester A country region that is valid for use with the API
4 properties
users
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Proposed A “user” is a person or bot that could potentially interact with the p…
4 properties
automationRuns
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester An Automation run is the instance of an automation executing its…
3 properties 2 required
automations
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester An Automation is a trigger and set of actions performed when the…
3 properties 2 required
salesAccounts
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester A Sales Account is used by partners to track their interactions…
5 properties
subscriptions
object
Subscriptions represent a product, product edition or service that will be billed for on the defined recurrence period.
3 properties
subscriptionAssignment
object
A SubscriptionAssignment is an allocation of a single Subscription unit. The way a subscription unit is allocated depends on the Product or Service represented…
3 properties
salesAccountCustomFields
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester Custom fields associated with a sales account. The field definit…
3 properties 2 required
userCustomFields
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester Custom fields associated with a user. The field definitions can…
3 properties 2 required
productCustomFields
object
[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): Trusted Tester Custom fields associated with a product. These attributes can be…
3 properties 2 required
hoursOfOperation
array
The operating hours for the business location. Each entry in the array is a set of hours for a particular department or customer of the business. It is recomme…
dayOfTheWeek
string
timeOfDay
string
Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.
lineItem
object
Represents an item that is being bought/sold
7 properties 1 required
partnerActivatableProducts
object
Details on the products you are currently selling in your store.
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vendasta-platform-openapi.yml Raw ↑

Other APIs Vendasta publishes across the network.

Vendasta account API
AE Profile APIs.io
Vendasta activity API
AE Profile APIs.io
Vendasta change_spend API
AE Profile APIs.io
Vendasta customer API
AE Profile APIs.io
Vendasta executive_report API
AE Profile APIs.io
Vendasta marketplace_app API
AE Profile APIs.io
Vendasta oauth API
AE Profile APIs.io
Vendasta user API
AE Profile APIs.io
Vendasta SCIM 2.0 User Management API
AE Profile APIs.io
Vendasta CRM REST API
AE Profile APIs.io
Vendasta CRM API (gRPC gateway)
AE Profile APIs.io
Vendasta Local SEO REST API
AE Profile APIs.io
#Platform#Order#User#business-locations#SalesAccounts#Subscription#Automations#JSON:API
← Back to V APIs
API Details
ID
vendasta:vendasta-platform-api
Base URL
https://prod.apigateway.co/platform
Docs
https://developers.vendasta.com/platform
Provider
Vendasta
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vendasta-platform-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vendasta-platform-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Vendasta Platform REST 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.