Erply Product Parameter API

openapi: 3.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 API
  contact: {}
  version: 2.36.5
tags:
- name: Product Parameter
paths:
  /v1/product/parameter:
    get:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: 'Get Product ReadParameters `NB: filtering and sorting does not apply to the parameter''s name`'
      tags:
      - Product Parameter
      summary: Get Product Parameters
      parameters:
      - description: skip n records
        name: skip
        in: query
        schema:
          type: integer
      - description: 'items to take, default: 20, max: 100000'
        name: take
        in: query
        schema:
          type: integer
      - description: the sort parameter is explained in the `Filtering & Sorting` section on top of the Swagger documentation
        name: sort
        in: query
        schema:
          type: string
      - description: the filter parameter is explained in the `Filtering & Sorting` section on top of the Swagger documentation
        name: filter
        in: query
        schema:
          type: string
      - description: optionally return total number of records in the X-Total-Count response header
        name: withTotalCount
        in: query
        schema:
          type: boolean
      - description: set to 1 return parameters with all their options
        name: withOptions
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/parametermodels.ParameterWithOptionsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
    post:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: 'The type can be one of the following: `TEXT, INTEGER, DECIMAL, BOOLEAN, LIST, MULTILIST`. After created parameter type can''t be changed and parameter can''t be reattached to a different dataset. Only parameter name can be adjusted.'
      tags:
      - Product Parameter
      summary: A parameter always belongs to exactly one data set (not multiple data sets at the same time, and a parameter cannot exist without a set). A parameter has a name and a type.
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.Response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/requests.ParameterRequest'
        description: Parameter
        required: true
  /v1/product/parameter/{ids}:
    delete:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: Deleting a parameter will delete it's options and values.
      tags:
      - Product Parameter
      summary: Delete Product Parameters
      parameters:
      - description: Parameter IDs
        name: ids
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.Response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
  /v1/product/parameter/{id}:
    put:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: Parameter's name can be updated.
      tags:
      - Product Parameter
      summary: Update Product Parameter
      parameters:
      - description: Parameter ID
        name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.Response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/requests.Request'
        description: Name
        required: true
  /v1/product/parameter/{id}/products:
    get:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: Get products that have values for this parameter
      tags:
      - Product Parameter
      summary: Get products that have values for this parameter
      parameters:
      - description: Parameter ID
        name: id
        in: path
        required: true
        schema:
          type: integer
      - description: skip n records
        name: skip
        in: query
        schema:
          type: integer
      - description: 'items to take, default: 20, max: 100000'
        name: take
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/parametermodels.ParameterResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
  /v1/product/{id}/parameters:
    get:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: 'API reads product group and it''s parents, fetches all the parameter sets associated with those groups

        (product can have values for parameters that are associated with it''s linked group''s parent group of that group''s parent and so on),

        and fetches all parameters from all the fetched sets.'
      tags:
      - Product Parameter
      summary: Get All Parameters for the Product by ID
      parameters:
      - description: product ID
        name: id
        in: path
        required: true
        schema:
          type: integer
      - description: skip n records
        name: skip
        in: query
        schema:
          type: integer
      - description: 'items to take, default: 20, max: 100000'
        name: take
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/products.ProductResponseWithParameters'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.MessageResponse'
components:
  schemas:
    products.ProductResponseWithParametersRecord:
      type: object
      properties:
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/parametermodels.ParameterResponse'
        product:
          $ref: '#/components/schemas/products.ProductResponse'
    requests.Request:
      type: object
      properties:
        name:
          description: Names translations
          $ref: '#/components/schemas/Translatable'
    parametermodels.OptionResponse:
      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
        name:
          description: /This field supports more languages. Please read Translatable names and descriptions block in the documentation.
          $ref: '#/components/schemas/Translatable'
        parameter_id:
          type: integer
    responses.Response:
      type: object
      properties:
        id:
          type: integer
          example: 73
    Description:
      type: object
      properties:
        en:
          description: Description supports more languages. Please read Translatable names and descriptions block in the documentation.
          $ref: '#/components/schemas/ProductDescription'
    products.ProductResponse:
      type: object
      properties:
        added:
          description: Unix timestamp
          type: integer
          example: 1595230999
        addedby:
          description: username
          type: string
          example: k@erp.xyz
        age_restriction:
          type: integer
        alcohol_percentage:
          type: string
        alcohol_registry_number:
          type: string
        batches:
          type: string
        brand_id:
          type: integer
        cashier_must_enter_price:
          description: boolean flag 0 or 1
          type: integer
        category_id:
          type: integer
        changed:
          description: Unix timestamp
          type: integer
          example: 1595230999
        changedby:
          description: username
          type: string
          example: k@erp.xyz
        code:
          type: string
        code2:
          type: string
        code3:
          type: string
        code5:
          type: string
        code6:
          type: string
        code7:
          type: string
        code8:
          type: string
        cost:
          type: number
        country_of_origin_id:
          type: integer
        delivery_time:
          type: string
        deposit_fee_amount:
          type: integer
        deposit_fee_id:
          type: integer
        description:
          $ref: '#/components/schemas/Description'
        displayed_in_webshop:
          description: 0 or 1
          type: integer
        excise_declaration_number:
          type: string
        extra_field1_id:
          type: integer
        extra_field2_id:
          type: integer
        extra_field3_id:
          type: integer
        extra_field4_id:
          type: integer
        family_id:
          type: integer
        formula_identifier:
          type: string
        gross_weight:
          description: GrossWeight is Item's gross weight (with packaging). Unit depends on region, check your Erply account (typically lbs or kg).
          type: number
        group_id:
          type: integer
        group_package_ferrous_metal:
          type: number
        group_package_metal:
          type: number
        group_package_non_ferrous_metal:
          type: number
        group_package_paper:
          type: number
        group_package_plastic:
          type: number
        group_package_wood:
          type: number
        has_serial_numbers:
          type: integer
        height:
          type: number
        id:
          type: integer
        is_gift_card:
          description: 0 or 1
          type: integer
        is_lot_product:
          type: boolean
        is_regular_gift_card:
          description: boolean flag 0 or 1
          type: integer
        is_used_product:
          type: boolean
        labels_not_needed:
          description: boolean flag 0 or 1
          type: integer
        length:
          description: Length is Item's physical dimensions.
          type: number
        location_in_warehouse_id:
          type: integer
        location_in_warehouse_text:
          type: string
        manufacturer_name:
          type: string
        name:
          description: /This field supports more languages. Please read Translatable names and descriptions block in the documentation.
          $ref: '#/components/schemas/Translatable'
        net_weight:
          type: number
        non_discountable:
          description: 0 or 1
          type: integer
        non_refundable:
          description: 0 or 1
          type: integer
        non_stock_product:
          description: boolean flag 0 or 1
          type: integer
        packaging_type:
          type: string
        packing_not_required:
          type: integer
        parent_product_id:
          type: integer
        price:
          type: number
        price_with_tax:
          type: number
        priority_group_id:
          type: integer
        product_item_level_promotions_disabled:
          type: integer
        product_reorder_multiples:
          type: integer
        revenue_account:
          type: string
        reward_points_not_allowed:
          description: boolean flag 0 or 1
          type: integer
        sales_package_cardboard:
          type: number
        sales_package_clear_brown_glass:
          type: number
        sales_package_green_other_glass:
          type: number
        sales_package_metal_al:
          type: number
        sales_package_metal_fe:
          type: number
        sales_package_other_metal:
          type: number
        sales_package_paper_and_cardboard_mono:
          description: Product package materials
          type: number
        sales_package_plastic_pet:
          type: number
        sales_package_plastic_pp_pe:
          type: number
        sales_package_wood:
          type: number
        serial_number:
          type: string
        shelf_life_days:
          type: integer
        sold_in_packages:
          type: integer
        status:
          description: 'Status is a classifier with four possible values: ''ACTIVE'' (DEFAULT), ''NO_LONGER_ORDERED'', ''NOT_FOR_SALE'' and ''ARCHIVED''.'
          type: string
          example: ACTIVE
        suggested_retail_price:
          type: number
        supplier_code:
          type: string
        supplier_id:
          type: integer
        tax_free:
          description: boolean flag 0 or 1
          type: integer
        tax_rate_id:
          type: integer
        transport_package_cardboard:
          type: number
        transport_package_ferrous_metal:
          type: number
        transport_package_non_ferrous_metal:
          type: number
        transport_package_plastic:
          type: number
        transport_package_wood:
          type: number
        type:
          type: string
        unit_id:
          type: integer
        volume:
          type: number
        webshop_description:
          type: string
        webshop_keywords:
          type: string
        webshop_title:
          type: string
        webshop_url_slug:
          type: string
        width:
          type: number
    parametermodels.ParameterWithOptionsResponse:
      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
        dataset_id:
          type: integer
        id:
          type: integer
        name:
          description: /This field supports more languages. Please read Translatable names and descriptions block in the documentation.
          $ref: '#/components/schemas/Translatable'
        options:
          type: array
          items:
            $ref: '#/components/schemas/parametermodels.OptionResponse'
        type:
          type: string
        type_id:
          type: integer
        value: {}
        value_id:
          type: integer
    responses.MessageResponse:
      type: object
      properties:
        message:
          type: string
          example: some message
    parametermodels.ParameterResponse:
      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
        dataset_id:
          type: integer
        id:
          type: integer
        name:
          description: /This field supports more languages. Please read Translatable names and descriptions block in the documentation.
          $ref: '#/components/schemas/Translatable'
        type:
          type: string
        type_id:
          type: integer
        value: {}
        value_id:
          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
    products.ProductResponseWithParameters:
      type: object
      properties:
        result:
          $ref: '#/components/schemas/products.ProductResponseWithParametersRecord'
    requests.ParameterRequest:
      type: object
      properties:
        name:
          description: Names translations
          $ref: '#/components/schemas/Translatable'
        set_id:
          type: integer
          example: 1
        type:
          description: for parameters
          type: string
          example: TEXT
    ProductDescription:
      type: object
      properties:
        html:
          description: Description supports more languages. Please read Translatable names and descriptions block in the documentation.
          type: string
          example: <b>Very good product!</b>
        plain_text:
          description: Description supports more languages. Please read Translatable names and descriptions block in the documentation.
          type: string
          example: Very good product!
  securitySchemes:
    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