Shop-Ware Vendors API
The Vendors API from Shop-Ware — 2 operation(s) for vendors.
OpenAPI Specification
openapi: 3.0.1
info:
title: API V1 API Partners Vendors API
version: v1
contact:
name: API Support
email: support@shop-ware.com
security:
- api_partner_id: []
api_secret: []
tags:
- name: Vendors
paths:
/api/v1/tenants/{tenant_id}/vendors:
parameters:
- name: tenant_id
in: path
required: true
example: '1'
schema:
type: integer
get:
summary: Get a list of all vendors
tags:
- Vendors
parameters:
- name: updated_after
in: query
required: false
format: date-time
description: Filter response to only include records updated after a given time
example: 2022-10-24T12%3A00%3A00%2B08%3A00
schema:
type: string
- name: page
in: query
required: false
example: '1'
schema:
type: integer
- name: per_page
in: query
required: false
example: '30'
schema:
type: integer
responses:
'200':
description: successful
content:
application/json:
examples:
successful:
value:
results:
- id: 1
created_at: '2026-06-09T14:26:55Z'
updated_at: '2026-06-09T14:26:55Z'
name: Vendor 3
phone: null
account_number: null
info: null
notes: null
website: vendor21.com
shop_id: 1
active: true
preferred: false
integrator_tags:
- id: 1
created_at: '2026-06-09T14:26:55Z'
updated_at: '2026-06-09T14:26:55Z'
taggable_type: Vendor
taggable_id: 1
name: tag_name
value: tag_value
limit: 1
limited: false
total_count: 1
current_page: 1
total_pages: 1
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: integer
description: Unique identifier of this record.
created_at:
type: string
format: date-time
description: Date and time when record was created.
updated_at:
type: string
format: date-time
description: Date and time when record was last updated.
name:
type: string
description: Vendor name.
phone:
type: string
description: Vendor phone.
nullable: true
account_number:
type: string
description: Account number.
nullable: true
info:
type: string
description: Vendor information.
nullable: true
notes:
type: text
description: Notes.
nullable: true
website:
type: string
description: Vendor website.
nullable: true
shop_id:
type: integer
description: A foreign key that points to the Shop that this Vendor belongs to.
active:
type: boolean
description: True if the vendor is still active and in use, false if the vendor has been archived.
preferred:
type: boolean
description: True if the user has marked this vendor as a frequently-used vendor.
integrator_tags:
type: array
items:
type: object
properties:
id:
type: integer
description: The tag primary key.
taggable_type:
type: string
description: Entity type the tag attached to.
taggable_id:
type: integer
description: Entity identifier the tag attached to.
name:
type: string
description: Tag Name.
value:
type: string
description: Tag Value.
created_at:
type: string
format: date-time
description: The date and time when tag was created.
updated_at:
type: string
format: date-time
description: The date and time when tag was last updated.
limit:
type: integer
limited:
type: boolean
total_count:
type: integer
current_page:
type: integer
total_pages:
type: integer
/api/v1/tenants/{tenant_id}/vendors/{id}:
parameters:
- name: tenant_id
in: path
required: true
example: '1'
schema:
type: integer
- name: id
in: path
required: true
example: '1'
schema:
type: integer
get:
summary: Get a vendor by ID
tags:
- Vendors
responses:
'200':
description: successful
content:
application/json:
examples:
successful:
value:
id: 1
created_at: '2026-06-09T14:26:58Z'
updated_at: '2026-06-09T14:26:58Z'
name: Vendor 4
phone: null
account_number: null
info: null
notes: null
website: vendor22.com
shop_id: 1
active: true
preferred: false
integrator_tags:
- id: 1
created_at: '2026-06-09T14:26:58Z'
updated_at: '2026-06-09T14:26:58Z'
taggable_type: Vendor
taggable_id: 1
name: tag_name
value: tag_value
schema:
type: object
properties:
id:
type: integer
description: Unique identifier of this record.
created_at:
type: string
format: date-time
description: Date and time when record was created.
updated_at:
type: string
format: date-time
description: Date and time when record was last updated.
name:
type: string
description: Vendor name.
phone:
type: string
description: Vendor phone.
nullable: true
account_number:
type: string
description: Account number.
nullable: true
info:
type: string
description: Vendor information.
nullable: true
notes:
type: text
description: Notes.
nullable: true
website:
type: string
description: Vendor website.
nullable: true
shop_id:
type: integer
description: A foreign key that points to the Shop that this Vendor belongs to.
active:
type: boolean
description: True if the vendor is still active and in use, false if the vendor has been archived.
preferred:
type: boolean
description: True if the user has marked this vendor as a frequently-used vendor.
integrator_tags:
type: array
items:
type: object
properties:
id:
type: integer
description: The tag primary key.
taggable_type:
type: string
description: Entity type the tag attached to.
taggable_id:
type: integer
description: Entity identifier the tag attached to.
name:
type: string
description: Tag Name.
value:
type: string
description: Tag Value.
created_at:
type: string
format: date-time
description: The date and time when tag was created.
updated_at:
type: string
format: date-time
description: The date and time when tag was last updated.
components:
securitySchemes:
api_partner_id:
type: apiKey
name: X-Api-Partner-Id
in: header
api_secret:
type: apiKey
name: X-Api-Secret
in: header