Erply Product Family API
The Product Family API from Erply — 4 operation(s) for product family.
OpenAPI Specification
swagger: '2.0'
info:
description: "\n\n## Overview\n\n\n\nThis application offers an API for managing assignments and tasks.\n\n\n\nGraphQL endpoint for the same API is [also available](/graph)\n\n\n\n<details><summary>Authentication</summary>\n\n\n\n> \n\n> Authenticate using your Erply credentials and get a sessionKey. This sessionKey and your Erply clientCode must be provided in the HTTP headers of every request. You do not have to authenticate against this API - valid Erply sessionKey-s from other sources are also acceptable. To authenticate using this API, use the `POST /api/v1/auth` endpoint.\n\n>\n\n</details>\n\n"
title: assignments Assortment Product Family API
contact: {}
version: 2.36.5
host: ''
basePath: ''
schemes: []
tags:
- name: Product Family
paths:
/v1/product/family:
get:
security:
- sk: []
- cc: []
- jwt: []
description: Get Product Family
consumes:
- application/json
produces:
- application/json
tags:
- Product Family
summary: Get Families
parameters:
- type: boolean
description: show archived families?
name: withArchived
in: query
required: true
- type: integer
description: skip n records
name: skip
in: query
- type: integer
description: 'items to take, default: 20, max: 100000'
name: take
in: query
- type: string
description: the sort parameter is explained in the `Filtering & Sorting` section on top of the Swagger documentation
name: sort
in: query
- type: string
description: the filter parameter is explained in the `Filtering & Sorting` section on top of the Swagger documentation
name: filter
in: query
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/familymodels.Response'
'400':
description: Bad Request
schema:
$ref: '#/definitions/responses.MessageResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/responses.MessageResponse'
post:
security:
- sk: []
- cc: []
- jwt: []
description: Create Product Family
consumes:
- application/json
produces:
- application/json
tags:
- Product Family
summary: Create Family
parameters:
- description: Name
name: name
in: body
required: true
schema:
$ref: '#/definitions/requests.Archivable'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/responses.Response'
'400':
description: Bad Request
schema:
$ref: '#/definitions/responses.MessageResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/responses.MessageResponse'
/v1/product/family/bulk:
post:
security:
- sk: []
- cc: []
- jwt: []
description: each request contains the created resource data
consumes:
- application/json
produces:
- application/json
tags:
- Product Family
summary: Create families in bulk
parameters:
- description: bulk create request
name: request
in: body
required: true
schema:
$ref: '#/definitions/familymodels.BulkCreateRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/responses.BulkResponseWithResults'
/v1/product/family/bulk/get:
post:
security:
- sk: []
- cc: []
- jwt: []
consumes:
- application/json
produces:
- application/json
tags:
- Product Family
summary: Get families in bulk
parameters:
- description: requests have the parameters that the original get request has, but in json format. This way you can apply the parameters to each request separately.
name: request
in: body
required: true
schema:
$ref: '#/definitions/familymodels.BulkReadRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/familymodels.BulkReadResponse'
/v1/product/family/{id}:
put:
security:
- sk: []
- cc: []
- jwt: []
description: By updating a product family you can "delete" it by archiving
consumes:
- application/json
produces:
- application/json
tags:
- Product Family
summary: Update Family
parameters:
- description: Name
name: name
in: body
required: true
schema:
$ref: '#/definitions/requests.Archivable'
- type: integer
description: family ID
name: id
in: path
required: true
responses:
'200':
description: OK
schema:
$ref: '#/definitions/responses.Response'
'400':
description: Bad Request
schema:
$ref: '#/definitions/responses.MessageResponse'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/responses.MessageResponse'
definitions:
responses.Response:
type: object
properties:
id:
type: integer
example: 73
familymodels.BulkReadResponseItem:
type: object
properties:
families:
type: array
items:
$ref: '#/definitions/familymodels.Response'
message:
type: string
example: some message
resultId:
description: id of the response, if requested 3 read requests each ID represents 1 response item
type: integer
parammodels.FilterJSON:
type: object
properties:
fieldName:
type: string
example: group_id
operandBefore:
description: supported values are "and", "or"
type: string
example: or
operator:
type: string
example: '='
sliceValue:
description: to be used if the value is a slice
type: array
items: {}
value:
type: object
familymodels.Response:
type: object
properties:
added:
description: Unix timestamp
type: integer
example: 1595230999
addedby_id:
description: user ID
type: integer
example: 1
archived:
type: integer
changed:
description: Unix timestamp
type: integer
example: 1595230999
changedby_id:
description: user ID
type: integer
example: 1
id:
type: integer
name:
description: /This field supports more languages. Please read Translatable names and descriptions block in the documentation.
$ref: '#/definitions/Translatable'
familymodels.BulkReadRequest:
type: object
properties:
requests:
type: array
items:
$ref: '#/definitions/familymodels.ReadRequest'
responses.MessageResponse:
type: object
properties:
message:
type: string
example: some message
familymodels.BulkReadResponse:
type: object
properties:
results:
type: array
items:
$ref: '#/definitions/familymodels.BulkReadResponseItem'
parammodels.SortRequest:
type: object
properties:
desc:
description: If true - descending, if false - ascending
type: boolean
language:
description: Language in ISO 639-1 standard. Is needed only for translatable properties like description and name.
type: string
example: en
selector:
description: 'JSON field. For description: description_plain or description_html'
type: string
example: name
parammodels.PaginationParameters:
type: object
properties:
skip:
type: integer
take:
type: integer
Translatable:
type: object
properties:
en:
description: This field supports more languages. Please read Translatable names and descriptions block in the documentation.
type: string
requests.Archivable:
type: object
properties:
archived:
description: Archived ..
type: boolean
example: false
name:
description: Names translations
$ref: '#/definitions/Translatable'
familymodels.BulkCreateRequest:
type: object
properties:
requests:
type: array
items:
$ref: '#/definitions/requests.Archivable'
responses.BulkResult:
type: object
properties:
message:
type: string
example: some message
resourceId:
description: identifier of the REST-ful response
type: integer
example: 2
resultId:
description: identifier of the result item
type: integer
example: 2
familymodels.ReadRequest:
type: object
properties:
filters:
type: array
items:
$ref: '#/definitions/parammodels.FilterJSON'
paginationParameters:
$ref: '#/definitions/parammodels.PaginationParameters'
sortingParameters:
$ref: '#/definitions/parammodels.SortRequest'
withArchived:
type: boolean
responses.BulkResponseWithResults:
type: object
properties:
results:
type: array
items:
$ref: '#/definitions/responses.BulkResult'
securityDefinitions:
AccessToken:
type: apiKey
name: accessToken
in: header
ErplyClientCode:
type: apiKey
name: clientCode
in: header
ErplyJWT:
type: apiKey
name: jwt
in: header
ErplySession:
type: apiKey
name: sessionKey
in: header
RequestKey:
type: apiKey
name: requestKey
in: header