Shop-Ware Notes API
The Notes API from Shop-Ware — 2 operation(s) for notes.
OpenAPI Specification
openapi: 3.0.1
info:
title: API V1 API Partners Notes API
version: v1
contact:
name: API Support
email: support@shop-ware.com
security:
- api_partner_id: []
api_secret: []
tags:
- name: Notes
paths:
/api/v1/tenants/{tenant_id}/notes:
parameters:
- name: tenant_id
in: path
required: true
example: '1'
schema:
type: integer
get:
summary: Get a list of all notes
tags:
- Notes
parameters:
- name: page
in: query
required: false
example: '1'
schema:
type: integer
- name: per_page
in: query
required: false
example: '30'
schema:
type: integer
- 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: repair_order_id
in: query
required: false
description: Filter response to include only notes related to specified repair order.
example: '1'
schema:
type: integer
responses:
'200':
description: successful
content:
application/json:
examples:
successful:
value:
results:
- id: 1
created_at: '2026-06-09T14:23:35Z'
updated_at: '2026-06-09T14:23:35Z'
description: This is a test note
repair_order_id: 1
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.
description:
type: text
description: The description of the note.
repair_order_id:
type: integer
description: A foreign key that points to the RepairOrder that this Note belongs to.
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.
limit:
type: integer
limited:
type: boolean
total_count:
type: integer
current_page:
type: integer
total_pages:
type: integer
post:
summary: Create a note
tags:
- Notes
parameters: []
responses:
'201':
description: successful
content:
application/json:
examples:
successful:
value:
id: 1
created_at: '2026-06-09T14:23:38Z'
updated_at: '2026-06-09T14:23:38Z'
description: New Comment
repair_order_id: 1
schema:
type: object
properties:
id:
type: integer
description: Unique identifier of this record.
description:
type: text
description: The description of the note.
repair_order_id:
type: integer
description: A foreign key that points to the RepairOrder that this Note belongs to.
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.
requestBody:
content:
application/json:
schema:
type: object
properties:
repair_order_id:
type: number
description: A foreign key which points to a RepairOrder.id. Represents the repair order related to this note.
description:
type: string
minLength: 1
description: The description of the note.
required:
- repair_order_id
- description
example:
repair_order_id: 1
description: New Comment
/api/v1/tenants/{tenant_id}/notes/{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 specific note by ID
tags:
- Notes
responses:
'200':
description: successful
content:
application/json:
examples:
successful:
value:
id: 1
created_at: '2026-06-09T14:23:41Z'
updated_at: '2026-06-09T14:23:41Z'
description: This is a test note
repair_order_id: 1
schema:
type: object
properties:
id:
type: integer
description: Unique identifier of this record.
description:
type: text
description: The description of the note.
repair_order_id:
type: integer
description: A foreign key that points to the RepairOrder that this Note belongs to.
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.
put:
summary: Update a specific note
tags:
- Notes
parameters: []
responses:
'200':
description: successful
content:
application/json:
examples:
successful:
value:
id: 1
created_at: '2026-06-09T14:23:44Z'
updated_at: '2022-10-23T02:05:00Z'
description: Updated comment
repair_order_id: 2
schema:
type: object
properties:
id:
type: integer
description: Unique identifier of this record.
description:
type: text
description: The description of the note.
repair_order_id:
type: integer
description: A foreign key that points to the RepairOrder that this Note belongs to.
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.
requestBody:
content:
application/json:
schema:
type: object
properties:
repair_order_id:
type: number
description: A foreign key which points to a RepairOrder.id. Represents the repair order related to this note.
description:
type: string
minLength: 1
description: The description of the note.
example:
description: Updated comment
repair_order_id: 2
components:
securitySchemes:
api_partner_id:
type: apiKey
name: X-Api-Partner-Id
in: header
api_secret:
type: apiKey
name: X-Api-Secret
in: header