vCita Product Orders API
The Product Orders API from vCita — 3 operation(s) for product orders.
The Product Orders API from vCita — 3 operation(s) for product orders.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/vcita:vcita-product-orders-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Vcita Product Orders API
version: '3.0'
x-refined-note:
- x-generated differs across the merged source definitions and was not carried
description: 'Operations tagged Product Orders across 2 of this provider''s published API definitions: vcita-clients-api-openapi.yml, vcita-sales-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
tags:
- name: Product Orders
paths:
/client/payments/v1/product_orders:
get:
description: '## Overview
Show list of product orders.
## Authentication
**Available for Client Tokens only.**'
parameters:
- description: relevant matter_uid to fetch products orders for
in: query
name: matter_uid
required: true
schema:
type: string
- description: 'Page offset (default: 1)'
in: query
name: page
required: false
schema:
type: string
- description: 'Page size (default: 25)'
in: query
name: per_page
required: false
schema:
type: string
- description: 'Available filters: client_uid, uid, entity_type. example: filter[client_uid][in]=uId1&filter[uid][in]=123.'
in: query
name: filter
required: false
schema:
type: string
- description: 'Sort by one of the following: created_at, updated_at. available operators: asc, desc. example: sort=created_at:asc,updated_at:desc'
in: query
name: sort
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
example:
data:
product_orders:
- client_id: amebs8yr715qhz9l
cost: null
created_at: '2025-08-05T01:55:35.643-05:00'
currency: USD
description: Best hair shampoo
id: rwi3bicfvmjmxjph
matter_uid: kmiu5c4ox5r1t1eg
name: Shampoo
payment_request_id: g2zg6kg3q59oxlgn
payment_request_state: pending
price: '10.0'
product_id: 6sukaz56hxev8b9c
staff_id: 7edde4a6d219fa49
taxes: []
total_price: null
success: true
'422':
description: Failure
content:
application/json:
example:
errors:
- code: Error Code
field: Error Field (optional)
message: Error Message
success: false
summary: Show Product Orders List
tags:
- Product Orders
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///client/payments/v1/product_orders
x-auth-type: Application & Application User
security:
- Bearer: []
operationId: getClientPaymentsV1ProductOrders
x-operation-id-source: derived
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
/business/payments/v1/product_orders:
post:
description: '## Overview
Creates a Product Order. Available for **Staff and Internal tokens**.'
parameters: []
responses:
'201':
description: Success
content:
application/json:
example:
data:
product_order:
client_id: u9mqcvkj4s4l5c44
cost: null
created_at: '2025-08-05T09:54:33.423+03:00'
currency: USD
description: Best hair shampoo
id: irtbidn0039v6c7e
matter_uid: 46nrcmt1lzeyccsg
name: Shampoo
payment_request_id: 3nzp3dnyxwhu8glv
payment_request_state: pending
price: '5.0'
product_id: kg3mnfc8j9qvqeu2
staff_id: 6d9ec6fb26d819cc
taxes:
- name: VAT
rate: 10
tax_total: 0.5
total_price: '5.5'
success: true
'422':
description: Failure
content:
application/json:
example:
errors:
- code: Error Code
field: Error Field (optional)
message: Error Message
success: false
summary: Create Product Order
tags:
- Product Orders
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: POST
responses:
default:
statusCode: '201'
type: http_proxy
uri: https:///business/payments/v1/product_orders
x-auth-type: Application & Application User
requestBody:
content:
application/json:
schema:
properties:
product_order:
properties:
client_id:
description: Client UID
type: string
x-reference-to: clients.contact
matter_uid:
description: Matter UID
type: string
x-reference-to: clients.matter
price:
description: 'Price. Default: product price.'
type: number
product_id:
description: Product UID
type: string
x-reference-to: sales.product
tax_ids:
description: 'Tax UIDs. Default: product taxes. [] will remove the product''s taxes. Up to 3 taxes per product are allowed.'
items:
type: string
type: array
required:
- client_id
- product_id
type: object
required:
- product_order
type: object
security:
- Bearer: []
operationId: postBusinessPaymentsV1ProductOrders
x-operation-id-source: derived
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
/business/payments/v1/product_orders/{product_order_uid}:
get:
description: '## Overview
Gets a Product Order. Available for **Staff Tokens**.'
parameters:
- description: Product Order UID
in: path
name: product_order_uid
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
example:
data:
product_order:
client_id: u9mqcvkj4s4l5c44
cost: null
created_at: '2025-08-05T09:54:31.840+03:00'
currency: USD
description: Best hair shampoo
id: j1yv50998tacuuod
matter_uid: 46nrcmt1lzeyccsg
name: Shampoo
payment_request_id: oki75v7odnl6l9at
payment_request_state: pending
price: '10.0'
product_id: kg3mnfc8j9qvqeu2
staff_id: 6d9ec6fb26d819cc
taxes:
- name: VAT
rate: 10
tax_total: 1
total_price: '11.0'
success: true
'422':
description: Failure
content:
application/json:
example:
errors:
- code: Error Code
field: Error Field (optional)
message: Error Message
success: false
summary: Get Product Order
tags:
- Product Orders
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///business/payments/v1/product_orders/{product_order_uid}
x-auth-type: Application & Application User
security:
- Bearer: []
operationId: getBusinessPaymentsV1ProductOrdersByProductOrderUid
x-operation-id-source: derived
put:
description: '## Overview
Updates a Product Order. Available for **Staff and Internal tokens**.'
parameters:
- description: Product Order UID
in: path
name: product_order_uid
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
example:
data:
product_order:
client_id: u9mqcvkj4s4l5c44
cost: null
created_at: '2025-08-05T09:54:31.840+03:00'
currency: USD
description: Best hair shampoo
id: j1yv50998tacuuod
matter_uid: 46nrcmt1lzeyccsg
name: Shampoo
payment_request_id: oki75v7odnl6l9at
payment_request_state: pending
price: '100.0'
product_id: kg3mnfc8j9qvqeu2
staff_id: 6d9ec6fb26d819cc
taxes:
- name: VAT
rate: 10
tax_total: 10
total_price: '110.0'
success: true
'422':
description: Failure
content:
application/json:
example:
errors:
- code: Error Code
field: Error Field (optional)
message: Error Message
success: false
summary: Update Product Order
tags:
- Product Orders
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: PUT
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///business/payments/v1/product_orders/{product_order_uid}
x-auth-type: Application & Application User
requestBody:
content:
application/json:
schema:
properties:
product_order:
properties:
price:
description: Price
type: number
tax_ids:
description: Tax UIDs. [] will remove the product order's taxes. Up to 3 taxes per product order are allowed.
items:
type: string
type: array
type: object
required:
- product_order
type: object
security:
- Bearer: []
operationId: putBusinessPaymentsV1ProductOrdersByProductOrderUid
x-operation-id-source: derived
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
components:
securitySchemes:
ActivitySources:
type: http
scheme: bearer
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
Notes:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
ClientMessaging:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid client bearer token in the Authorization header. Example: ''Authorization: Bearer {client_token}'''
ClientPaymentCards:
type: http
scheme: bearer
description: Provide a valid bearer token in the Authorization header.
PaymentPlans:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
x-refined-from:
- vcita-clients-api-openapi.yml
- vcita-sales-api-openapi.yml