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

Vendasta Sales Orders API

Sales Orders service and its auxiliary field schema, exposed through the gRPC gateway — the order surface behind the platform marketplace.

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

Tagged areas include Sales, Order, Commerce, and gRPC. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, organized into 2 resource areas, and defines 61 schemas. It is described by OpenAPI 3.0.0, at version 1.134.0.

Requests are made against a single base URL, https://prod.apigateway.co/grpc.

5 operations 5 paths 61 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.134.0
Base URL
https://prod.apigateway.co/grpc
Authentication
OAuth 2.0
Resource Areas
2

Authentication & Security 1

Vendasta Sales Orders API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 2 scopes.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. They span 2 resource areas: SalesOrders, SalesOrdersAuxiliaryFieldSchema. Each is listed below with its method, path, parameters, and response codes.

SalesOrders 3
POST
/v1/order/create
Create Sales Order
SalesOrders_CreateSalesOrder body → 200default
POST
/v1/order/get
Get Sales Order
SalesOrders_GetSalesOrder body → 200default
POST
/v1/order/list
List Sales Orders
SalesOrders_ListSalesOrder body → 200default
SalesOrdersAuxiliaryFieldSchema 2
POST
/v1/order/custom-fields/get
Get Auxiliary Data Field Schema
SalesOrdersAuxiliaryFieldSchema_GetAuxiliaryDataFieldSchema body → 200default
POST
/v1/order/custom-fields/list
List Auxiliary Data Field Schema
SalesOrdersAuxiliaryFieldSchema_ListAuxiliaryDataFieldSchema body → 200default

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are v1Order (44 properties), v1CreateSalesOrderRequest (24 properties), v1ListSalesOrderRequestFilters (17 properties), v1LineItem (16 properties). Each schema is shown below with its type and property counts.

LineItemAppKey
object
4 properties
googlerpcStatus
object
3 properties
protobufAny
object
1 property
salesordersv1Status
string
- SUBMITTED: Submitted is the status when an order is ready for admin approval - APPROVED: Approved is the status when an order is has been approved by an admi…
salesv1Duration
object
2 properties
v1ActivationStatus
string
- PENDING: The product is in the process of being activated - ACTIVATED: The product was successfully activated via the order - ERRORED: An error occured while…
v1AddonActivation
object
A single addon and its corresponding activation status within an order.
3 properties
v1AddonKey
object
2 properties
v1Agreement
object
A terms of service agreement that a customer has accepted or declined on an order.
3 properties 3 required
v1Attachment
object
A file attachment associated with an order.
2 properties 2 required
v1AuxiliaryDataFieldSchema
object
11 properties
v1AuxiliaryDataFieldType
string
v1BillingPeriod
object
3 properties
v1Business
object
Details about the business that an order is associated with.
10 properties
v1CommonField
object
A field answer that may be shared across multiple products or addons.
3 properties
v1Cost
object
1 property
v1CreateSalesOrderRequest
object
24 properties
v1CreateSalesOrderResponse
object
1 property
v1Currency
string
- ZAR: Do not add to this list. If more currencies are required currencycode should be used instead
v1CustomField
object
A set of custom field answers that are unique to a specific product or addon.
3 properties
v1CustomPriceMapping
object
2 properties
v1CustomerRecipient
object
Details about the customer who receives the order.
3 properties
v1DropdownOption
object
2 properties
v1DurationPeriod
string
v1Field
object
An information field pertaining to a product, containing a question and its answer.
9 properties 1 required
v1FieldSchemaIdentifier
object
3 properties
v1FieldType
string
v1FulfillmentOrderStatus
string
- FULFILLMENTSTATUSDETAILSNEEDED: Details Needed: Fulfillment Form needs to be submitted - FULFILLMENTSTATUSINREVIEW: In Review: Fulfillment Form has been subm…
v1GetAuxiliaryDataFieldSchemaRequest
object
1 property
v1GetAuxiliaryDataFieldSchemaResponse
object
1 property
v1GetSalesOrderRequest
object
3 properties
v1GetSalesOrderResponse
object
1 property
v1LineItem
object
16 properties
v1ListAuxiliaryDataFieldSchemaRequest
object
3 properties
v1ListAuxiliaryDataFieldSchemaRequestFilters
object
1 property
v1ListAuxiliaryDataFieldSchemaResponse
object
2 properties
v1ListSalesOrderRequest
object
5 properties
v1ListSalesOrderRequestDateRangeFilter
object
2 properties
v1ListSalesOrderRequestFilters
object
17 properties
v1ListSalesOrderRequestSortDirection
string
v1ListSalesOrderRequestSortField
string
v1ListSalesOrderRequestSortOption
object
2 properties
v1ListSalesOrderResponse
object
4 properties
v1Order
object
A sales order representing a request to activate products for a business.
44 properties 3 required
v1Origin
string
v1Package
object
7 properties
v1Product
object
5 properties
v1ProductActivation
object
A single product and its corresponding activation status within an order.
7 properties
v1RetailSubscriptionGroup
object
4 properties
v1RetailSubscriptionGroupDisplayOption
string
v1Revenue
object
1 property
v1RevenueComponent
object
3 properties
v1RevenuePeriod
string
v1SalesOrderProjectionFilter
object
2 properties
v1Salesperson
object
Details about the salesperson who submitted the order.
4 properties
v1Source
string
v1StatusHistoryItem
object
A record of a status change on an order, including who made the change and when.
8 properties
v1TaxOptions
object
4 properties
v1UserRole
string
vendastatypesPagedRequestOptions
object
2 properties
vendastatypesPagedResponseMetadata
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vendasta-sales-orders-openapi.json Raw ↑

Other APIs Vendasta publishes across the network.

Vendasta account API
Vendasta activity API
Vendasta change_spend API
Vendasta customer API
Vendasta executive_report API
Vendasta marketplace_app API
Vendasta oauth API
Vendasta user API
Vendasta Platform REST API
Vendasta SCIM 2.0 User Management API
Vendasta CRM REST API
Vendasta CRM API (gRPC gateway)
Where this information came from

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