Vendasta Sales Orders Auxiliary Field Schema API

The SalesOrdersAuxiliaryFieldSchema API from Vendasta — 2 operation(s) for salesordersauxiliaryfieldschema.

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/order/custom-fields/get Get one order custom field definition · Get Auxiliary Data Field Schema #
Ask an LLM
“What type and settings does a specific sales order custom field have?”
“Can I read one order auxiliary field schema by its identifier?”
Tell an agent
Get the order custom field schema {identifier}.
Show the definition of sales order field {identifier}.
POST /v1/order/custom-fields/list List order custom field definitions · List Auxiliary Data Field Schema #
Ask an LLM
“Which custom fields has my partner defined for sales orders?”
“Can I filter and page through the order field schemas?”
Tell an agent
List sales order custom field schemas for partner {partnerId}.
Show all auxiliary order field definitions.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vendasta:vendasta-salesordersauxiliaryfieldschema-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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

OpenAPI Specification

vendasta-salesordersauxiliaryfieldschema-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Sales Orders Auxiliary Field Schema API
  version: 1.134.0
servers:
- description: Production
  url: https://prod.apigateway.co/grpc
tags:
- name: SalesOrdersAuxiliaryFieldSchema
paths:
  /v1/order/custom-fields/get:
    post:
      operationId: SalesOrdersAuxiliaryFieldSchema_GetAuxiliaryDataFieldSchema
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1GetAuxiliaryDataFieldSchemaRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetAuxiliaryDataFieldSchemaResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
          description: An unexpected error response.
      summary: Get Auxiliary Data Field Schema
      tags:
      - SalesOrdersAuxiliaryFieldSchema
  /v1/order/custom-fields/list:
    post:
      operationId: SalesOrdersAuxiliaryFieldSchema_ListAuxiliaryDataFieldSchema
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1ListAuxiliaryDataFieldSchemaRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ListAuxiliaryDataFieldSchemaResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
          description: An unexpected error response.
      summary: List Auxiliary Data Field Schema
      tags:
      - SalesOrdersAuxiliaryFieldSchema
components:
  schemas:
    v1AuxiliaryDataFieldType:
      default: AUXILIARY_DATA_FIELD_TYPE_INVALID
      enum:
      - AUXILIARY_DATA_FIELD_TYPE_INVALID
      - AUXILIARY_DATA_FIELD_TYPE_STRING
      - AUXILIARY_DATA_FIELD_TYPE_INTEGER
      - AUXILIARY_DATA_FIELD_TYPE_DATE
      - AUXILIARY_DATA_FIELD_TYPE_DROPDOWN
      - AUXILIARY_DATA_FIELD_TYPE_CURRENCY
      type: string
    v1DropdownOption:
      properties:
        label:
          type: string
        value:
          type: string
      type: object
    protobufAny:
      additionalProperties: {}
      properties:
        '@type':
          type: string
      type: object
    googlerpcStatus:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        message:
          type: string
      type: object
    v1ListAuxiliaryDataFieldSchemaResponse:
      properties:
        fieldSchemas:
          items:
            $ref: '#/components/schemas/v1AuxiliaryDataFieldSchema'
          type: array
        pagingMetadata:
          $ref: '#/components/schemas/vendastatypesPagedResponseMetadata'
      type: object
    vendastatypesPagedResponseMetadata:
      properties:
        hasMore:
          title: Whether or not more results exist
          type: boolean
        nextCursor:
          title: A cursor that can be provided to retrieve the next page of results
          type: string
        totalResults:
          format: int64
          title: The total number of results. This is not supported on all paged apis and will be 0 if it is not supported
          type: string
      type: object
    v1ListAuxiliaryDataFieldSchemaRequest:
      properties:
        filters:
          $ref: '#/components/schemas/v1ListAuxiliaryDataFieldSchemaRequestFilters'
        pagingOptions:
          $ref: '#/components/schemas/vendastatypesPagedRequestOptions'
        partnerId:
          type: string
      type: object
    v1GetAuxiliaryDataFieldSchemaResponse:
      properties:
        fieldSchema:
          $ref: '#/components/schemas/v1AuxiliaryDataFieldSchema'
      type: object
    v1ListAuxiliaryDataFieldSchemaRequestFilters:
      properties:
        onlyArchived:
          type: boolean
      type: object
    v1FieldSchemaIdentifier:
      properties:
        externalId:
          type: string
        fieldId:
          type: string
        partnerId:
          type: string
      type: object
    v1GetAuxiliaryDataFieldSchemaRequest:
      properties:
        identifier:
          $ref: '#/components/schemas/v1FieldSchemaIdentifier'
      type: object
    vendastatypesPagedRequestOptions:
      properties:
        cursor:
          description: Optional. An opaque token from a previous response's next_cursor to retrieve the next page of results. Omit or leave empty for the first page.
          type: string
        pageSize:
          description: Optional. The maximum number of items to return per page.
          format: int64
          type: string
      type: object
    v1AuxiliaryDataFieldSchema:
      properties:
        archived:
          format: date-time
          type: string
        created:
          format: date-time
          type: string
        currencyCode:
          title: currency code according to ISO-4217, e.g. 'USD', 'CAD', 'BRL', etc
          type: string
        dropdownOptions:
          items:
            $ref: '#/components/schemas/v1DropdownOption'
          type: array
        externalId:
          type: string
        fieldDescription:
          type: string
        fieldId:
          type: string
        fieldName:
          type: string
        fieldType:
          $ref: '#/components/schemas/v1AuxiliaryDataFieldType'
        partnerId:
          type: string
        updated:
          format: date-time
          type: string
      type: object
  securitySchemes:
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://sso-api-prod.apigateway.co/oauth2/auth
          scopes:
            order: Allows the application to manage orders
            order:read: Allows the application view-only access to orders
          tokenUrl: https://sso-api-prod.apigateway.co/oauth2/token
      type: oauth2