Erply Matrix Product API
The Matrix Product API from Erply — 7 operation(s) for matrix product.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/erply-matrix-product-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
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 Matrix Product API
contact: {}
version: 2.36.5
tags:
- name: Matrix Product
paths:
/v1/matrix/product:
get:
security:
- sk: []
- cc: []
- jwt: []
description: Products are returned from the request only if they are a matrix variation. As an input there are 2 options. You can provide One or more product IDs, or one or more matrix product IDs.
tags:
- Matrix Product
summary: API call for retrieving matrix variations
parameters:
- description: 'Limit: 1500 ids. Expected usage: API client has a matrix product ID and wants to get a complete list of variations. Format: 1 or many comma separated matrix product IDs.'
name: matrixProductIDs
in: query
schema:
type: array
items:
type: integer
- description: 'Limit: 1500 ids. Expected usage: API client will get a bunch of products from GET /v1/product and will want to fetch variation descriptions for the same items. Format: 1 or many comma separated product IDs.'
name: productIDs
in: query
schema:
type: array
items:
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/matrixmodels.ProductVariationJSON'
'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: 'Matrix items have 1...3 dimensions - color, size etc. Matrix dimensions can be defined in Erply backend A dimension has a name (eg. "Letter Sizes" or Spring 2013 Colors") and a list of possible values (eg. S, M, L or Lime, Yellow, Fuchsia).
To create a matrix product, first pick the dimension(s) that apply to this particular product, eg "Waist Size" and "Length" for jeans. A matrix can have up to 3 dimensions.'
tags:
- Matrix Product
summary: Create Matrix Product
parameters:
- description: generate code automatically based on the preconfigured starting code or based on a generated code. If the code is not blank in the request, will override.
name: generateCodeAutomatically
in: query
required: true
schema:
type: boolean
- description: generate code2 (UPC/EAN automatically based on the preconfigured starting code + user's country or based on a generated code. If the code is not blank in the request, will override.
name: generateCode2Automatically
in: query
required: true
schema:
type: boolean
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.CreateProductRequest'
description: Product info & matrix dimension IDs
required: true
/v1/matrix/product/bulk:
post:
security:
- sk: []
- cc: []
- jwt: []
description: 'Matrix items have 1...3 dimensions - color, size etc. Matrix dimensions can be defined in Erply backend A dimension has a name (eg. "Letter Sizes" or Spring 2013 Colors") and a list of possible values (eg. S, M, L or Lime, Yellow, Fuchsia).
To create a matrix product, first pick the dimension(s) that apply to this particular product, eg "Waist Size" and "Length" for jeans. A matrix can have up to 3 dimensions.
Each request contains the created resource data. The parameters to generate the product code/code2 automatically is embedded into the request body as the `generateCodeAutomatically` & `generateCode2Automatically` fields.'
tags:
- Matrix Product
summary: Create matrix products in bulk
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/responses.BulkResponseWithResults'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/matrixmodels.ProductBulkCreateRequest'
description: bulk request
required: true
/v1/matrix/product/bulk/get:
post:
security:
- sk: []
- cc: []
- jwt: []
tags:
- Matrix Product
summary: Get matrix variations in bulk
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/matrixmodels.ProductBulkReadResponse'
'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.ProductBulkReadRequest'
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
/v1/matrix/product/dimensions/bulk:
put:
security:
- sk: []
- cc: []
- jwt: []
description: each request contains the updated resource data
tags:
- Matrix Product
summary: Update matrix products 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.DimensionsBulkUpdateRequest'
description: bulk request
required: true
/v1/matrix/product/dimensions/bulk/get:
post:
security:
- sk: []
- cc: []
- jwt: []
description: each request contains the matrix product ID
tags:
- Matrix Product
summary: Read matrix products dimensions in bulk
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/matrixmodels.DimensionsByMatrixProductIDBulkReadResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/matrixmodels.DimensionsBulkReadRequest'
description: bulk request
required: true
/v1/matrix/product/with-variations:
get:
security:
- sk: []
- cc: []
- jwt: []
tags:
- Matrix Product
summary: API call for retrieving matrix products with variations
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: Sorting is applied to the matrix products only. The sort parameter is explained in the `Filtering & Sorting` section on top of the Swagger documentation
name: sort
in: query
schema:
type: string
- description: Filtering is applied to the matrix products only. 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.ProductWithVariations'
'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/matrix/product/{id}/dimensions:
get:
security:
- sk: []
- cc: []
- jwt: []
description: Matrix items have 1...3 dimensions - color, size etc. Matrix dimensions can be defined in Erply backend A dimension has a name (eg. "Letter Sizes" or Spring 2013 Colors") and a list of possible values (eg. S, M, L or Lime, Yellow, Fuchsia).
tags:
- Matrix Product
summary: Read Matrix Product Dimensions
parameters:
- description: matrix 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/matrixmodels.DimensionIDs'
'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'
put:
security:
- sk: []
- cc: []
- jwt: []
description: 'Matrix items have 1...3 dimensions - color, size etc. Matrix dimensions can be defined in Erply backend.
A dimension has a name (eg. "Letter Sizes" or Spring 2013 Colors") and a list of possible values (eg. S, M, L or Lime, Yellow, Fuchsia).
To update the matrix product dimensions, first pick the dimension(s) that apply to this particular product, eg "Waist Size" and "Length" for jeans and pass them to the request body.
A matrix can have up to 3 dimensions'
tags:
- Matrix Product
summary: Update Matrix Product Dimensions
parameters:
- description: matrix product 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.UpdateProductDimensionsRequest'
description: matrix dimension IDs
required: true
components:
schemas:
matrixmodels.UpdateProductDimensionsRequest:
type: object
properties:
dimension_ids:
description: up to 3 dimensions. If you want to specify only 2nd or 3rd dimension, leave the first and/or second as 0
type: array
items:
type: integer
example:
- 1
- 2
- 3
matrixmodels.ProductBulkReadRequestItem:
type: object
properties:
matrix_product_ids:
description: 'Expected usage: API client has a matrix product ID and wants to get a complete list of variations. Format: 1 or many matrix product IDs.'
type: array
items:
type: integer
paginationParameters:
$ref: '#/components/schemas/parammodels.PaginationParameters'
product_ids:
description: 'Expected usage: API client will get a bunch of products from GET /v1/product and will want to fetch variation descriptions for the same items. Format: 1 or many product IDs.'
type: array
items:
type: integer
responses.Response:
type: object
properties:
id:
type: integer
example: 73
matrixmodels.ProductWithVariations:
type: object
properties:
product:
$ref: '#/components/schemas/products.ProductResponse'
variations:
type: array
items:
$ref: '#/components/schemas/matrixmodels.ProductVariationJSON'
matrixmodels.ProductBulkReadResponseItem:
type: object
properties:
message:
type: string
example: some message
resultId:
type: integer
variations:
type: array
items:
$ref: '#/components/schemas/matrixmodels.ProductVariationJSON'
matrixmodels.DimensionsByMatrixProductIDBulkReadResponseItem:
type: object
properties:
dimension_ids:
type: array
items:
type: integer
example:
- 1
- 2
- 3
message:
type: string
example: some message
resourceId:
description: matrix product ID
type: integer
resultId:
type: integer
matrixmodels.DimensionIDs:
type: object
properties:
dimension_ids:
description: up to 3 dimensions. If you want to specify only 2nd or 3rd dimension, leave the first and/or second as 0
type: array
items:
type: integer
example:
- 1
- 2
- 3
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.DimensionsByMatrixProductIDBulkReadResponse:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/matrixmodels.DimensionsByMatrixProductIDBulkReadResponseItem'
matrixmodels.ProductBulkReadResponse:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/matrixmodels.ProductBulkReadResponseItem'
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
matrixmodels.ProductBulkCreateRequest:
type: object
properties:
requests:
type: array
items:
$ref: '#/components/schemas/matrixmodels.ProductBulkCreateRequestItem'
matrixmodels.CreateProductRequest:
type: object
properties:
dimension_ids:
description: up to 3 dimensions. If you want to specify only 2nd or 3rd dimension, leave the first and/or second as 0
type: array
items:
type: integer
example:
- 1
- 2
- 3
matrix_product:
description: Matrix product can have up to 3 dimensions
$ref: '#/components/schemas/products.ProductRequest'
responses.MessageResponse:
type: object
properties:
message:
type: string
example: some message
Translatable:
type: object
properties:
en:
description: This field supports more languages. Please read Translatable names and descriptions block in the documentation.
type: string
matrixmodels.DimensionsBulkUpdateRequest:
type: object
properties:
requests:
type: array
items:
$ref: '#/components/schemas/matrixmodels.DimensionsBulkUpdateRequestItem'
Description:
type: object
properties:
en:
description: Description supports more languages. Please read Translatable names and descriptions block in the documentation.
$ref: '#/components/schemas/ProductDescription'
matrixmodels.ProductVariationJSON:
type: object
properties:
code:
type: string
code2:
type: string
code3:
type: string
code5:
type: string
code6:
type: string
code7:
type: string
code8:
type: string
displayed_in_webshop:
description: 0 or 1
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'
parent_product_id:
type: integer
parent_product_name:
$ref: '#/components/schemas/Translatable'
price:
type: number
price_with_tax:
type: number
status:
type: string
tax_rate_id:
type: integer
variation_description:
type: array
items:
$ref: '#/components/schemas/matrixmodels.VariationDescription'
products.ProductRequest:
type: object
properties:
age_restriction:
type: integer
alcohol_percentage:
type: string
alcohol_registry_number:
type: string
backup_id:
type: integer
batches:
type: string
brand_id:
description: ID of product brand. To get the list of brandmodels, use getBrands.
type: integer
cashier_must_enter_price:
description: boolean flag 0 or 1
type: integer
category_id:
type: integer
code:
description: Product's code. Must be UNIQUE, unless the account is configured otherwise.
type: string
code2:
description: Product's second code (by convention, EAN barcode). Must be UNIQUE, unless the account is configured otherwise.
type: string
code3:
description: Third code of the item (note that this field may not be visible on product card by default).
type: string
code5:
type: string
code6:
type: string
code7:
type: string
code8:
type: string
cost:
description: Cost is Product cost
type: number
country_of_origin_id:
type: integer
delivery_time:
type: string
deposit_fee_amount:
type: integer
deposit_fee_id:
description: ContainerID is ID of another product, a beverage container that is always sold together with this item.
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:
description: ID of product group. To get the list of product groups, use getProductGroups.
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
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:
description: LocationInWarehouseID is ID of selected location in warehouse.
type: integer
location_in_warehouse_text:
description: LocationInWarehouseText is Product's specific text added to location in warehouse.
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:
description: NetWeight is Item's net weight. Unit depends on region, check your Erply account (typically lbs or kg).
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:
description: Parent product ID. Only for matrix variations (specific colors/sizes of a matrix item). See guidelines below.
type: integer
price:
description: 'Price is just the default price of a product and the actual price applied in a particular location, to a particular customer, depends on price lists and promotions: https://learn-api.erply.com/concepts/pricing'
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:
description: Supplier's product code
type: string
supplier_id:
type: integer
tax_free:
description: boolean flag 0 or 1
type: integer
tax_rate_id:
description: 'TaxRateID is just the default tax rate of a product and the actual tax applied in a particular location depends on multiple rules: https://learn-api.erply.com/concepts/taxes.'
type: integer
transport_package_cardboard:
type: number
transport_package_ferrous_metal:
type: number
transport_package_non_ferrous_metal:
type: number
transport_package_plastic:
type: numb
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/erply/refs/heads/main/openapi/erply-matrix-product-api-openapi.yml