Generated by API Evangelist
Written by API Evangelist tooling for Vendasta's API. It is a proposal applied on top of the contract, not a document Vendasta publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Platform REST Order Custom Fields API
version: 1.0.0
extends: openapi/vendasta-order-custom-fields-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/orderCustomFields/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a sales order's custom field values
effect: read
questions:
- What custom field values were captured on a sales order?
- Can I read the partner-defined extra attributes of an order?
instructions:
- text: Get the custom fields for order {id}.
slots:
id: path.id
- text: Show custom attribute values on sales order {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/orderCustomFields/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a sales order's custom field values
effect: write
questions:
- Can I change a custom field value on an existing order?
- Is there a way to fill in partner-defined attributes on a sales order after it's placed?
instructions:
- text: Update custom fields of order {id} with {data}.
slots:
id: path.id
data: requestBody.data
- text: Set sales order {id}'s custom attribute values to {data}.
slots:
id: path.id
data: requestBody.data
method: generated
generated: '2026-10-01'
- target: $.paths['/orderCustomFields/{id}'].options
update:
x-apievangelist-phrasing:
intent: Check allowed methods for order custom fields
effect: read
questions:
- Which HTTP verbs does an order custom fields record accept cross-origin?
- Will a browser pass the CORS preflight for an order's custom fields?
instructions:
- text: Run OPTIONS on orderCustomFields record {id}.
slots:
id: path.id
- text: List the methods permitted on order custom field set {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
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.