Erply Matrix Dimension API
The Matrix Dimension API from Erply — 6 operation(s) for matrix dimension.
The Matrix Dimension API from Erply — 6 operation(s) for matrix dimension.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/erply-matrix-dimension-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: 'Product information management API
-------
Summary
It is built top of Erply''s current product database.'
title: PIM Matrix Dimension API
contact:
email: david.zingerman@erply.com
version: 1.143.20
tags:
- name: Matrix Dimension
paths:
/v1/matrix/dimension:
get:
security:
- sk: []
- cc: []
- jwt: []
description: Get Matrix Dimension
tags:
- Matrix Dimension
summary: Get Matrix Dimensions
parameters:
- description: skip n records
name: skip
in: query
schema:
type: integer
- description: amount to take
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
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/matrixmodels.DimensionResponse'
'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'
operationId: getV1MatrixDimension
x-operation-id-source: derived
post:
security:
- sk: []
- cc: []
- jwt: []
tags:
- Matrix Dimension
summary: Create Matrix Dimension
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/matrixmodels.DimensionRequest'
description: matrixDimensionRequest
required: true
operationId: postV1MatrixDimension
x-operation-id-source: derived
/v1/matrix/dimension/bulk:
post:
security:
- sk: []
- cc: []
- jwt: []
description: each request contains the created resource data
tags:
- Matrix Dimension
summary: Create dimensions in bulk
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responses.BulkResponseWithResults'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/matrixmodels.DimensionBulkCreateRequest'
description: bulk create request
required: true
operationId: postV1MatrixDimensionBulk
x-operation-id-source: derived
/v1/matrix/dimension/bulk/get:
post:
security:
- sk: []
- cc: []
- jwt: []
tags:
- Matrix Dimension
summary: Get dimensions in bulk
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/matrixmodels.DimensionBulkReadResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/parammodels.BulkReadRequestNoTotalCount'
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.
required: true
operationId: postV1MatrixDimensionBulkGet
x-operation-id-source: derived
/v1/matrix/dimension/{ids}:
delete:
security:
- sk: []
- cc: []
- jwt: []
description: 'Deleting a matrix dimension is not allowed if there are products using that dimension.
Deleting a matrix dimension will also delete all the values of that dimension.'
tags:
- Matrix Dimension
summary: Delete Matrix Dimensions
parameters:
- description: semicolon delimited 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'
operationId: deleteV1MatrixDimensionByIds
x-operation-id-source: derived
/v1/matrix/dimension/{id}:
put:
security:
- sk: []
- cc: []
- jwt: []
tags:
- Matrix Dimension
summary: Update Matrix Dimension
parameters:
- description: dimension 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/matrixmodels.DimensionRequest'
description: DimensionRequest
required: true
operationId: putV1MatrixDimensionById
x-operation-id-source: derived
/v1/matrix/dimension/{id}/move:
put:
security:
- sk: []
- cc: []
- jwt: []
description: 'position has to be one of the following: `before` | `after`'
tags:
- Matrix Dimension
summary: Move Dimension
parameters:
- description: 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/models.MoveRequest'
description: moveRequest
required: true
operationId: putV1MatrixDimensionByIdMove
x-operation-id-source: derived
components:
schemas:
matrixmodels.DimensionRequest:
type: object
properties:
dimension_name:
$ref: '#/components/schemas/Translatable'
status:
description: 'Status is a classifier with four possible values: ''ACTIVE'' (DEFAULT), ''NO_LONGER_ORDERED'', ''NOT_FOR_SALE'' and ''ARCHIVED''.'
type: string
example: ACTIVE
matrixmodels.DimensionBulkReadResponse:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/matrixmodels.DimensionBulkReadResponseItem'
models.MoveRequest:
type: object
properties:
position:
description: Position has to be lastChild | before | after
type: string
example: after
target_id:
description: Target ID represents the object that the requested object is put after, or before, or becomes the last child of
type: integer
responses.MessageResponse:
type: object
properties:
message:
type: string
example: some message
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.BulkReadRequestNoTotalCount:
type: object
properties:
requests:
type: array
items:
$ref: '#/components/schemas/parammodels.ReadRequest'
responses.BulkResponseWithResults:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/responses.BulkResult'
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
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
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
matrixmodels.DimensionBulkReadResponseItem:
type: object
properties:
dimensions:
type: array
items:
$ref: '#/components/schemas/matrixmodels.DimensionResponse'
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.ReadRequest:
type: object
properties:
filters:
type: array
items:
$ref: '#/components/schemas/parammodels.FilterJSON'
paginationParameters:
$ref: '#/components/schemas/parammodels.PaginationParameters'
sortingParameters:
$ref: '#/components/schemas/parammodels.SortRequest'
matrixmodels.DimensionBulkCreateRequest:
type: object
properties:
requests:
type: array
items:
$ref: '#/components/schemas/matrixmodels.DimensionRequest'
responses.Response:
type: object
properties:
id:
type: integer
example: 73
matrixmodels.DimensionResponse:
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
dimension_id:
type: integer
dimension_name:
$ref: '#/components/schemas/Translatable'
dimension_order:
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
securitySchemes:
cc:
type: apiKey
name: clientCode
in: header
jwt:
type: apiKey
name: jwt
in: header
sk:
type: apiKey
name: sessionKey
in: header