Erply Product Parameter Value API

The Product Parameter Value API from Erply — 4 operation(s) for product parameter value.

OpenAPI Specification

erply-product-parameter-value-api-openapi.yml Raw ↑
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 Parameter Value API
  contact: {}
  version: 2.36.5
host: ''
basePath: ''
schemes: []
tags:
- name: Product Parameter Value
paths:
  /v1/product/parameter/value/{ids}:
    delete:
      security:
      - sk: []
      - cc: []
      - jwt: []
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Product Parameter Value
      summary: Delete product parameter values
      parameters:
      - type: string
        description: up to 100 semicolon delimited value 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/product/parameter/value/{id}:
    put:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: Update Product Parameter Value
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Product Parameter Value
      summary: Update Product Parameter Value
      parameters:
      - description: Parameter Value
        name: value
        in: body
        required: true
        schema:
          $ref: '#/definitions/requests.ValueRequest'
      - type: integer
        description: value ID
        name: id
        in: path
        required: true
      - type: boolean
        description: Apply-Validation-Rules flag
        name: Apply-Validation-Rules
        in: header
        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/product/{ids}/parameter/value:
    get:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: Get Product Parameter Values by Product IDs (ids parameter)
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Product Parameter Value
      summary: Get Product Parameter Values by Product IDs
      parameters:
      - type: string
        description: can contain semicolon delimited IDs.
        name: ids
        in: path
        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
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/parametermodels.ValueResponse'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/responses.MessageResponse'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/responses.MessageResponse'
  /v1/product/{productId}/parameter/{parameterId}/value:
    post:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: 'Type `TEXT`: "value":"your_text"

        Type `BOOLEAN` : "value":true

        Type `INTEGER`: "value":1

        Type `DECIMAL`: "value": 1.01

        Type `LIST`: "value": 1 (1 is option ID)

        Type `MULTILIST`: "value": [1,2,3] (arrray of option IDs)'
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Product Parameter Value
      summary: Assign Value to Product's Parameter
      parameters:
      - type: integer
        description: product ID
        name: productId
        in: path
        required: true
      - type: integer
        description: parameter ID
        name: parameterId
        in: path
        required: true
      - description: Value
        name: value
        in: body
        required: true
        schema:
          $ref: '#/definitions/requests.ValueRequest'
      - type: boolean
        description: Apply-Validation-Rules flag
        name: Apply-Validation-Rules
        in: header
        required: true
      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'
definitions:
  responses.Response:
    type: object
    properties:
      id:
        type: integer
        example: 73
  requests.ValueRequest:
    type: object
    properties:
      value: {}
  responses.MessageResponse:
    type: object
    properties:
      message:
        type: string
        example: some message
  parametermodels.ValueResponse:
    type: object
    properties:
      added:
        description: Unix timestamp
        type: integer
        example: 1595230999
      addedby_id:
        description: user ID
        type: integer
        example: 1
      changed:
        description: Unix timestamp
        type: integer
        example: 1595230999
      changedby_id:
        description: user ID
        type: integer
        example: 1
      id:
        type: integer
      parameter_id:
        type: integer
      product_id:
        type: integer
      value:
        description: can be any type. Can be parameter option also
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