Erply Brand API
The Brand API from Erply — 5 operation(s) for brand.
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 Brand API
contact: {}
version: 2.36.5
host: ''
basePath: ''
schemes: []
tags:
- name: Brand
paths:
/v1/brand:
get:
security:
- sk: []
- cc: []
- jwt: []
description: Get brands
consumes:
- application/json
produces:
- application/json
tags:
- Brand
summary: Get brands
parameters:
- 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
- type: boolean
description: optionally return total number of records in the X-Total-Count response header
name: withTotalCount
in: query
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/brandmodels.Response'
headers:
X-Total-Count:
type: uint
description: total number of records (ignores skip & take parameters)
'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 brand
consumes:
- application/json
produces:
- application/json
tags:
- Brand
summary: Create brand
parameters:
- description: Name
name: brandRequest
in: body
required: true
schema:
$ref: '#/definitions/brandmodels.Request'
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/brand/bulk:
post:
security:
- sk: []
- cc: []
- jwt: []
description: each request contains only the brand's name
consumes:
- application/json
produces:
- application/json
tags:
- Brand
summary: Create brands in bulk
parameters:
- description: bulk create request
name: request
in: body
required: true
schema:
$ref: '#/definitions/brandmodels.BulkCreateRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/responses.BulkResponseWithResults'
/v1/brand/bulk/get:
post:
security:
- sk: []
- cc: []
- jwt: []
consumes:
- application/json
produces:
- application/json
tags:
- Brand
summary: Get brands 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/parammodels.BulkReadRequestNoTotalCount'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/brandmodels.BulkResponse'
/v1/brand/{ids}:
delete:
security:
- sk: []
- cc: []
- jwt: []
consumes:
- application/json
produces:
- application/json
tags:
- Brand
summary: Delete brands
parameters:
- type: string
description: up to 100 semicolon delimited brand IDs
name: ids
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'
/v1/brand/{id}:
put:
security:
- sk: []
- cc: []
- jwt: []
description: Update brand
consumes:
- application/json
produces:
- application/json
tags:
- Brand
summary: Update brand
parameters:
- description: brandRequest
name: brandRequest
in: body
required: true
schema:
$ref: '#/definitions/brandmodels.Request'
- type: integer
description: brand 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:
parammodels.ReadRequest:
type: object
properties:
filters:
type: array
items:
$ref: '#/definitions/parammodels.FilterJSON'
paginationParameters:
$ref: '#/definitions/parammodels.PaginationParameters'
sortingParameters:
$ref: '#/definitions/parammodels.SortRequest'
brandmodels.BulkResponse:
type: object
properties:
results:
type: array
items:
$ref: '#/definitions/brandmodels.BulkResponseItem'
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
responses.Response:
type: object
properties:
id:
type: integer
example: 73
brandmodels.BulkCreateRequest:
type: object
properties:
requests:
type: array
items:
$ref: '#/definitions/brandmodels.Request'
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
responses.MessageResponse:
type: object
properties:
message:
type: string
example: some message
parammodels.PaginationParameters:
type: object
properties:
skip:
type: integer
take:
type: integer
brandmodels.BulkResponseItem:
type: object
properties:
brands:
type: array
items:
$ref: '#/definitions/brandmodels.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
brandmodels.Request:
type: object
properties:
description:
$ref: '#/definitions/Translatable'
name:
type: string
Translatable:
type: object
properties:
en:
description: This field supports more languages. Please read Translatable names and descriptions block in the documentation.
type: string
brandmodels.Response:
type: object
properties:
added:
description: Unix timestamp
type: integer
example: 1595230999
addedby:
description: username
type: string
example: k@erp.xyz
changed:
description: Unix timestamp
type: integer
example: 1595230999
changedby:
description: username
type: string
example: k@erp.xyz
description:
$ref: '#/definitions/Translatable'
id:
type: integer
name:
type: string
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
parammodels.BulkReadRequestNoTotalCount:
type: object
properties:
requests:
type: array
items:
$ref: '#/definitions/parammodels.ReadRequest'
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