Product filtering | ePIM.one API: products

https://epim.one/api/XYZ/products/filter?wildcards={false/true}&as-supplier={identifier}

Method: GET

The request is sent by an external system. ePIM.one responds by sending IDs of the products that meet the filter conditions and their last modification dates (according to specified limit and page). In case of incorrect filter parameters, basic information about the detected errors is returned.

Query string parameters:

• wildcards (default is "false") - specifies whether wildcards are disabled or enabled in filtering ("false"/"true")
• as-supplier (optional; only for accounts with suppliers; not for supplier users) - possibility to read product information "as a supplier", so that the products are accessed on the basis of the pair: "supplier"-"supplierPid", instead of on the basis of the "productId" (for details see "Get product data as supplier" section)

Example of a request (curl):

The filterData.json file example (UTF-8 encoded):

Description of filter fields:

• productId - filter by product ID
• gtin - filter by GTIN
• altPid - filter by alternative product ID
• upc - filter by UPC
• descriptionShort - filter by product name (language field)
• descriptionLong - filter by product long description (language field)
• descriptionVeryShort - filter by product invoice description (language field)
• tenderText - filter by product markieting text (language field)
• supplier - filter by supplier identifier
• supplierPid - filter by supplier product ID
• supplierDescriptionShort - filter by supplier product name (language field)
• supplierAltPid - filter by supplier alternative product ID
• manufacturerName - filter by manufacturer name
• manufacturerPid - filter by manufacturer product ID
• manufacturerTypeDesc - filter by manufacturer type description (language field)
• manufacturerAltPid - filter by manufacturer alternative product ID
• brandName - filter by brand name
• productSeries - filter by product series (language field)
• productVariation - filter by product variation (language field)
• shelfLifePeriod - filter by shelf life
• batteryContained - filter by indicating whether product contains an included battery (true/false field)
• ceMarking - filter by indicating whether product has the CE mark (true/false field)
• countryOfOrigin - filter by product country of origin
• validFrom - filter by validity starting date of the product (date field)
• expirationDate - filter by validity expiration date of the product (date field)
• deliveryTime - filter by product delivery time
• discountGroupSupplier - filter by discount group of the supplier
• unNumber - filter by UN number
• liIonTested - filter by indicating whether the Li-ion cell has been tested (true/false field)
• reachInfo - filter by REACH info (reachInfo field)
• scipNumber - filter by SCIP number
• customsNumber - filter by customs number
• classId - filter by ETIM class ID
• attributes - filter by values of global attributes (the keys are attribute identifiers)
• categoryTreeIdentifier - filter by identifier of category tree
• categoryIdentifier - filter by identifier of category
• labels - filter by labels:
  • identifiers - array of label identifiers
  • selection type - one of the following values:
    • at_least_one (default value)
    • at_least_selected
    • only_selected
• totalDescriptionCompleteness - filter by total completeness of product description according to default completeness mask (PDC field)
• generalDescriptionCompleteness - filter by completeness of product overall information (default completeness mask (PDC field)
• etimDescriptionCompleteness - filter by completeness of ETIM description according to default completeness mask (PDC field)
• orderDescriptionCompleteness - filter by completeness of product order information according to default completeness mask (PDC field)
• packingDescriptionCompleteness - filter by completeness of product packing information according to default completeness mask (PDC field)
• priceDescriptionCompleteness - filter by completeness of product price information according to default completeness mask (PDC field)
• mimeDescriptionCompleteness - filter by completeness of product MIME information according to default completeness mask (PDC field)
• attributesDescriptionCompleteness - filter by completeness of product attribute values according to default completeness mask (PDC field)
• totalDescriptionCompletenessUserDefined - filter by total completeness of product description according to user-defined completeness mask (PDC field)
• generalDescriptionCompletenessUserDefined - filter by completeness of product overall information according to user-defined completeness mask (PDC field)
• etimDescriptionCompletenessUserDefined - filter by completeness of ETIM description according to user-defined completeness mask (PDC field)
• orderDescriptionCompletenessUserDefined - filter by completeness of product order information according to user-defined completeness mask (PDC field)
• packingDescriptionCompletenessUserDefined - filter by completeness of product packing information according to user-defined completeness mask (PDC field)
• priceDescriptionCompletenessUserDefined - filter by completeness of product price information according to user-defined completeness mask (PDC field)
• mimeDescriptionCompletenessUserDefined - filter by completeness of product MIME information according to user-defined completeness mask (PDC field)
• attributesDescriptionCompletenessUserDefined - filter by completeness of product attribute values according to user-defined completeness mask (PDC field)
• lastModifiedDate - filter by last modified date of the products (datetime field)
• generalLastModifiedDate - filter by last modified date of product overall information (datetime field)
• etimLastModifiedDate - filter by last modified date of ETIM description (datetime field)
• orderLastModifiedDate - filter by last modified date of product order information (datetime field)
• packingLastModifiedDate - filter by last modified date of product packing information (datetime field)
• priceLastModifiedDate - filter by last modified date of product price information (datetime field)
• mimeLastModifiedDate - filter by last modified date of product MIME information (datetime field)
• attributesLastModifiedDate - filter by last modified date of product attribute values (datetime field)
• additionalTechnicalDescriptionLastModifiedDate - filter by last modified date of product additional technical description (datetime field)
• seoLastModifiedDate - filter by last modified date of product SEO information (datetime field)
• wwwLastModifiedDate - filter by last modified date of product WWW information (datetime field)
• relatedProductsLastModifiedDate - filter by last modified date of related products (datetime field)
• relationsByAttributeLastModifiedDate - filter by last modified date of product relations by attribute (datetime field)
• categoriesLastModifiedDate - filter by last modified date of product categories (datetime field)
• labelsLastModifiedDate - filter by last modified date of product labels (datetime field)
• creationDate - filter by creation date of the products (datetime field)
• modifiedBy - filter by user name who last modified a product
• generalModifiedBy - filter by user name who last modified product overall information
• etimModifiedBy - filter by user name who last modified ETIM description
• orderModifiedBy - filter by user name who last modified product order information
• packingModifiedBy - filter by user name who last modified product packing information
• priceModifiedBy - filter by user name who last modified product price information
• mimeModifiedBy - filter by user name who last modified product MIME information
• attributesModifiedBy - filter by user name who last modified product attribute values
• additionalTechnicalDescriptionModifiedBy - filter by user name who last modified product additional technical description
• seoModifiedBy - filter by user name who last modified product SEO information
• wwwModifiedBy - filter by user name who last modified product WWW information
• relatedProductsModifiedBy - filter by user name who last modified related products
• relationsByAttributeModifiedBy - filter by user name who last modified product relations by attribute
• categoriesModifiedBy - filter by user name who last modified product categories
• labelsModifiedBy - filter by user name who last modified product labels
• createdBy - filter by user name who created a product

Remarks:

• "language field" has keys corresponding to the two-letter language abbreviations, for example: "en", "pl"
• "true/false field" has the following filter values:
  • true - meaning "yes"
  • false - meaning "no"
• "reachInfo field" has the following filter values:
  • no data
  • true - meaning "contains a SVHC in excess of 0.1% product weight"
  • false - meaning "does not contain any SVHC in excess of 0.1% product weight"
• "date field" has the following filter keys:
  • type - possible values:
  • last - filtering by relative dates ("in the last n days/weeks/months" etc.)
  • range - filtering by "range" of dates (from-to)
  • number (filter "last") - number of last hours/days/weeks covering the filtered dates [1-999]
  • unit (filter "last") - possible values:
  • day - full calendar day
  • week - full calendar week
  • month - full calendar month
  • year - full calendar year
  • includingCurrent (filter "last") - possible values:
  • false (default value) - the current day/week/month/year is not included/counted in the indicated "last" period
  • true - the current day/week/month/year is included/counted in the indicated "last" period
  • from (filter "range") - from specified date in format YYYY-MM-DD
  • to (only for "range" type filter) - to specified date in format YYYY-MM-DD
• "datetime field" has the following filter keys:
  • type - possible values:
  • last - filtering by relative dates ("in the last n days/weeks/months" etc.)
  • range - filtering by "range" of dates (from-to)
  • number (filter "last") - number of last hours/days/weeks covering the filtered dates [1-999]
  • unit (filter "last") - possible values:
  • minute - 60 seconds
  • hour - 60 minutes
  • day - full calendar day
  • week - full calendar week
  • month - full calendar month
  • year - full calendar year
  • includingCurrent (filter "last" and not for minute/hour unit) - possible values:
  • false (default value) - the current day/week/month/year is not included/counted in the indicated "last" period
  • true - the current day/week/month/year is included/counted in the indicated "last" period
  • from (filter "range") - from specified date in format YYYY-MM-DD HH:MM:SS
  • to (filter "range") - to specified date in format YYYY-MM-DD HH:MM:SS
• "PDC field" has the following filter keys:
  • from - from specified integer value [0-100]
  • to - to specified integer value [0-100]
• If you want to use the logical operator "OR" for:
  • the filter group "lastModifiedDate" add to the filterData.json the entry "lastModifiedDateLogicalOperator":"OR"
  • the filter group "descriptionCompleteness" add to the filterData.json the entry "descriptionCompletenessLogicalOperator":"OR"

Example of a response (JSON):

Fields description:

• productIds - all IDs of products that meet the filter conditions
• total - number of all products that meet the filter conditions
• parameters - correct/default query string parameters

Example of error response:

Get product data | ePIM.one API: products

https://epim.one/api/XYZ/products?etim-version={number}&na-values={false/true}&as-supplier={identifier}&with-keys={false/true}

Method: GET

Request is sent by an external system. ePIM.one responds with the detailed information of the specified product(s). It is necessary to send the list of product IDs (as a JSON data) that you want to get.

You can get by default up to 100 products in one GET request.

Query string parameters:

• etim-version (default is "9") - specified the version of ETIM classification ("9", "8", "7" or "6")
• na-values (default is "false") - specifies whether "not applicable" values (other than ETIM values) are to be included in the response ("false"/"true")
• as-supplier (optional; only for accounts with suppliers; not for supplier users) - possibility to read product information "as a supplier", so that the products are accessed on the basis of the pair: "supplier"-"supplierPid", instead of on the basis of the "productId" (for details see "Get product data as supplier" section)
• with-keys (default is "false") - specifies whether to add the "products" and "parameters" keys in the response ("false"/"true")

Example of a request (curl):

The productsIDs.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• products - detailed information of the specified product(s):
  • productId - unique identifier of product
  • lastModifiedDate - date of the last modification in the format: YYYY-MM-DD HH:MM:SS
  • modifiedBy - name of the user who made the last modification of the product
  • creationDate - date of the creation in the format: YYYY-MM-DD HH:MM:SS
  • createdBy - name of the user who created the product
  • overallInformation - part of the general product information
  • etimDescription - part of the ETIM description
  • orderInformation - part of the product order information
  • packingInformation - part of the product packaging information
  • priceInformation - part of the product price information
  • mime - part of the product MIME information
  • attributes - values of product attributes
  • additionalTechnicalDescription - additional technical features of the product (they can be used in automatic classification of products)
  • seo - data to improve the positioning in search engines results
  • www - information to facilitate and enrich the presentation of product information on websites
  • relatedProducts - part of the related products information
  • relationsByAttribute - product relations by attribute
  • categories - product categories
  • descriptionCompleteness - part with the completeness indicators (given as a percentage) of the ETIM/product description (conform to default or user-defined completeness mask)
  • labels - product labels
  • lastModifiedDateByType - list of the last modification dates by product information type
• parameters - correct/default query string parameters

Example of a request in a deprecated version (curl):

The productsIDs.json file example (UTF-8 encoded):

Example of a response in a deprecated version (JSON):

Get product data in a language-dependent version | ePIM.one API: products

https://epim.one/api/XYZ/products?lang={code}&etim-version={number}&na-values={false/true}&as-supplier={identifier}&with-keys={false/true}

Method: GET

Request is sent by an external system. ePIM.one responds with the detailed information of the specified product(s). All the coded information is sent in the requested language. It is necessary to send the list of product IDs (as a JSON data) that you want to get.

You can get by default up to 100 products in one GET request.

Query string parameters:

• lang - required language code acc. to ISO 639-1 (2 letter language code, for example, "en" for English, "pl" for Polish etc.)
• etim-version (default is "9") - specified the version of ETIM classification ("9", "8", "7" or "6")
• na-values (default is "false") - specifies whether "not applicable" values (other than ETIM values) are to be included in the response ("false"/"true")
• as-supplier (optional; only for accounts with suppliers; not for supplier users) - possibility to read product information "as a supplier", so that the products are accessed on the basis of the pair: "supplier"-"supplierPid", instead of on the basis of the "productId" (for details see "Get product data as supplier" section)
• with-keys (default is "false") - specifies whether to add the "products" and "parameters" keys in the response ("false"/"true")

Example of a request (curl):

The productsIDs.json file example (UTF-8 encoded):

Example of a response (JSON):

Example of a request in a deprecated version (curl):

The productsIDs.json file example (UTF-8 encoded):

Example of a response in a deprecated version (JSON):

Get product data as supplier | ePIM.one API: products

When accessing a product, the primary product identifier ("productId") is usually used. However, for accounts using supplier management capabilities, it is sometimes convenient to refer to a product based on supplier information and use the supplier product identifier ("supplierPid"). This mode of access is enabled by the "as supplier" parameter. It gives the possibility to retrieve product information "as supplier". In this case, the product is accessed based on the pair: "supplier"-"supplierPid", instead of the main product identifier ("productId"). This allows retrieving the product information as if it was generated from a supplier account, i.e. where the main product identifier is "supplierPid". This way of accessing data forces the substitution of certain fields.

If the parameter "as-supplier" is used (i.e. a supplier identifier is specified as the value of the parameter "as-supplier"), the following fields of the downloaded product information are treated differently:

• "supplierPid" overwrites "productId"
• "supplierAltPid" overwrites "altPid"
• "supplierDescriptionShort" (if exists) overwrites "descriptionShort"
• "supplier", "supplierPid", "supplierDescriptionShort" and "supplierAltPid" (if exist) are skipped

Lack of access rights to the listed fields will restrict or prevent the retrieval of product information.

Put product data | ePIM.one API: products

https://epim.one/api/XYZ/products?new={add/skip}&existing={merge/complete/skip}&empty={false/true}&as-supplier={identifier}

Method: PUT

Request is sent by an external system. ePIM.one writes the received information in its database and responds with a short report. Only string values (delimited by double quotes) are accepted. Also numbers should be transfered as strings delimited by quotations marks. Strings should not contain spaces at the beginning and at the end (such spaces will be anyway skiped/trimmed when importing).

You can send by default up to 16 MB data in one PUT request.

Query string parameters:

• new - one of the following values:
  • "add" (default value) - in the case of a new product, it will be added
  • "skip" - in the case of a new product, it will be skipped
• existing - one of the following values:
  • "merge" (default value) - in the case of an existing product, imported fields will be overwritten, others will remain unchanged
  • "complete" - in the case of an existing product, imported fields will be used to complete the product information (already existing product fields will remain unchanged)
  • "skip" - in the case of an existing product, it will be skipped
• empty (only for "merge" mode) - one of the following values:
  • "false" (default value) - empty strings do not overwrite existing field values
  • "true" - empty strings overwrite existing field values
• as-supplier (optional; only for accounts with suppliers; not for supplier users) - possibility to deliver product information "as a supplier", so that the products are accessed on the basis of the pair: "supplier"-"supplierPid", instead of on the basis of the "productId" (for details see "Put product data as supplier" section)

Example of a request (curl):

The productsData.json file example (UTF-8 encoded):

Fields description:

• productId - unique identifier of product
• overallInformation - part of the general product information
• etimDescription - part of the ETIM description
• orderInformation - part of the product order information
• packingInformation - part of the product packaging information
• priceInformation - part of the product price information
• mime - part of the product MIME information
• attributes - values of product attributes
• additionalTechnicalDescription - additional technical features of the product (they can be used in automatic classification of products)
• seo - data to improve the positioning in search engines results
• www - information to facilitate and enrich the presentation of product information on websites
• relatedProducts - part of the related products information
• relationsByAttribute - product relations by attribute
• categories - product categories
• labels - product labels

Example of a response (JSON):

Fields description:

• all - number of all products in the request
• rejected - number of products that can not be properly handled (with the list of up to 4 first occurrences)
• unique - number of unique (relative to "productId") products in the request
• new - number of products that have been added to the database
• modified - number of products that have been modified in the database
• classified - number of products that have been classified (ETIM)
• reclassified - number of products that have been reclassified (ETIM)
• deletedClassifications - number of products with deleted class (ETIM)
• deletedRelatedProducts - number of deleted related products
• createdRelatedProducts - number of created related products
• limitExceeded - number of new products for which the limit has been exceeded
• parameters - correct/default query string parameters

Put product data as supplier | ePIM.one API: products

When accessing a product, the primary product identifier ("productId") is usually used. However, for accounts using supplier management capabilities, it is sometimes convenient to refer to a product based on supplier information and use the supplier product identifier ("supplierPid"). This mode of access is enabled by the "as supplier" parameter. It gives the possibility to deliver product information "as supplier". In this case, the product is accessed based on the pair: "supplier"-"supplierPid", instead of the main product identifier ("productId"). This allows to delivery of product information where the main product identifier is "supplierPid". This way of accessing data forces the substitution of certain fields.

If the parameter "as-supplier" is used (i.e. a supplier identifier is specified as the value of the parameter "as-supplier"), the following fields of the imported product(s) are treated differently:

• "productId" is saved as "supplierPid"
• "altPid" is saved as "supplierAltPid"
• "descriptionShort" is saved as "supplierDescriptionShort" and "descriptionShort"
• "supplier", "supplierPid", "supplierDescriptionShort" and "supplierAltPid" (if exist) are skipped

In the case of duplicate values of the "supplierPid" field, the application merges products. In the case of new products, the value of the "productId" field is automatically generated as a concatenation of supplier identifier, "_" (underscore) and "supplierPid" (the application ensures that there are no duplicates of the "productId" field).

Lack of access rights to the fields listed above will restrict or prevent the saving of product information.

You can send by default up to 16 MB data in one PUT request.

Delete products | ePIM.one API: products

https://epim.one/api/XYZ/products

Method: DELETE

The request is sent by an external system. It is necessary to send a list of product IDs (as a JSON data) that you want to delete. ePIM.one deletes the product(s) in its database and responds with a short report.

Example of a request (curl):

The productsIDs.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• deletedProducts - number of deleted products
• parameters - correct/default query string parameters

Get label data | ePIM.one API: labels

https://epim.one/api/XYZ/labels?with-keys={false/true}

Method: GET

Request is sent by an external system. ePIM.one responds with the detailed information of the specified label(s). It is necessary to send the list of label identifiers (as a JSON data) that you want to get.

Query string parameters:

• with-keys (default is "false") - specifies whether to add the "labels" key in the response ("false"/"true")

Example of a request (curl):

The labelIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• labels - detailed information of the specified label(s):
  • identifier - unique identifier of label
  • permanent - indication whether the label is permanent (you can not edit or delete permanent labels)
  • letter - letter in the label icon
  • color - color of the label icon
  • description - description of the label
• parameters - correct/default query string parameters

Example of a request in a deprecated version (curl):

The labelIdentifiers.json file example (UTF-8 encoded):

Example of a response in a deprecated version (JSON):

Put label data | ePIM.one API: labels

https://epim.one/api/XYZ/labels

Method: PUT

Request is sent by an external system. ePIM.one writes the received information in its database and responds with a short report. Only string values (delimited by double quotes) are accepted. Also numbers should be transfered as strings delimited by quotations marks. Strings should not contain spaces at the beginning and at the end (such spaces will be anyway skiped/trimmed when importing).

You can send by default up to 16 MB data in one PUT request.

Example of a request (curl):

The labelsData.json file example (UTF-8 encoded):

Fields description:

• identifier - unique identifier of label (max. 16 characters, allowed characters: A-Za-z0-9_-)
• letter (default is "A") - letter of the label icon (acceptable values: "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z")
• color (default is "blue") - color of the label icon (acceptable values: "blue", "brown", "green", "grey", "yellow", "red", "violet")
• description - description of the label

Fields with the indicated default value can be omitted. Label(s) with the incorrect value(s) will be rejected.

Example of a response (JSON):

Fields description:

• all - number of all labels in the request
• rejected - number of labels that can not be properly handled
• unique - number of unique (relative to identifier) labels in the request
• replaced - number of labels that have been replaced in the database
• new - number of labels that have been added to the database
• parameters - correct/default query string parameters

Delete labels | ePIM.one API: labels

https://epim.one/api/XYZ/labels

Method: DELETE

The request is sent by an external system. It is necessary to send a list of label identifiers (as a JSON data) that you want to delete. ePIM.one deletes the label(s) in its database and responds with a short report.

Example of a request (curl):

The labelIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• deletedLabels - number of deleted labels
• parameters - correct/default query string parameters

Get attribute data | ePIM.one API: attributes

https://epim.one/api/XYZ/attributes?with-keys={false/true}

Method: GET

Request is sent by an external system. ePIM.one responds with the detailed information of the specified attribute(s). It is necessary to send the list of attributes identifiers (as a JSON data) that you want to get.

Query string parameters:

• with-keys (default is "false") - specifies whether to add the "attributes" key in the response ("false"/"true")

Example of a request (curl):

The attributeIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• attributes - detailed information of the specified attribute(s):
  • identifier - unique identifier of attribute
  • type - attribute type:
    • M - multilingual text
    • T - text
    • N - numeric
    • R - range
    • L - logical
    • S - select
  • permanent - indication whether the attribute is permanent (you can not edit or delete permanent attributes)
  • global - indication whether the attribute is global
  • productCharacteristic - indication whether the attribute is used as a product characteristic in BMEcat
  • forSynch - indication whether the attribute is subject to synchronization
  • importance - importance of the attribute (from "0" to "15")
  • name - names of the attribute in various languages
  • values - values of the attribute (only for select attribtues)
  • inCompletenessMask - indication whether the attribute is in user-defined completeness mask (only additional and global attributes can be in user-defined completeness mask)
• parameters - correct/default query string parameters

Example of a request in a deprecated version (curl):

The attributeIdentifiers.json file example (UTF-8 encoded):

Example of a response in a deprecated version (JSON):

Put attribute data | ePIM.one API: attributes

https://epim.one/api/XYZ/attributes

Method: PUT

Request is sent by an external system. ePIM.one writes the received information in its database and responds with a short report. Only string values (delimited by double quotes) are accepted. Also numbers should be transfered as strings delimited by quotations marks. Strings should not contain spaces at the beginning and at the end (such spaces will be anyway skiped/trimmed when importing).

You can send by default up to 16 MB data in one PUT request.

Example of a request (curl):

The attributesData.json file example (UTF-8 encoded):

Fields description:

• identifier - unique identifier of attribute (max. 60 characters)
• type (default is "M") - attribute type:
  • M - multilingual text
  • T - text
  • N - numeric
  • R - range
  • L - logical
  • S - select
• global (default is "true") - indication whether the attribute is global
• productCharacteristic (default is "false") - indication whether the attribute is used as a product characteristic in BMEcat
• forSynch (default is "false") - indication whether the attribute is subject to synchronization (you can set it to "true" only for additional and global attributes)
• importance (default is "0") - importance of the attribute (from "0" to "15")
• name - names of the attribute in various languages
• values - values of the attribute (only for select attribtues)

Fields with the indicated default value can be omitted. Attribute(s) with the incorrect value(s) will be rejected.

For attributes that are used in a user-defined completeness mask, you cannot:

• change the type
• change the globality
• delete the value(s) of a select attribute

To make this possible, you must first remove these attributes from the completeness mask.

Example of a response (JSON):

Fields description:

• all - number of all attributes in the request
• rejected - number of attributes that can not be properly handled
• unique - number of unique (relative to identifier) attributes in the request
• replaced - number of attributes that have been replaced in the database
• new - number of attributes that have been added to the database
• parameters - correct/default query string parameters

Delete attributes | ePIM.one API: attributes

https://epim.one/api/XYZ/attributes

Method: DELETE

The request is sent by an external system. It is necessary to send a list of attribute identifiers (as a JSON data) that you want to delete. ePIM.one deletes the attribute(s) in its database and responds with a short report.

Example of a request (curl):

The attributeIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• deletedAttributes - number of deleted attributes
• parameters - correct/default query string parameters

You cannot delete attributes that are used in a user-defined completeness mask. To make this possible, you must first remove these attributes from the completeness mask.

Get relation by attribute data | ePIM.one API: relations by attribute

https://epim.one/api/XYZ/relations-by-attribute?with-keys={false/true}

Method: GET

Request is sent by an external system. ePIM.one responds with the detailed information of the specified relation(s) by attribute. It is necessary to send the list of relation identifiers (as a JSON data) that you want to get.

Query string parameters:

• with-keys (default is "false") - specifies whether to add the "relationsByAttribute" key in the response ("false"/"true")

Example of a request (curl):

The relationByAttributeIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• relationsByAttribute - detailed information of the specified relation(s) by attribute:
  • identifier - unique identifier of relation by attribute
  • attribute - unique identifier of grouping attribute
  • name - names of the relation by attribute in various languages
  • products - identifiers of all products which are in the relation by attribute
  • productValues - product values of the grouping attribute
  • virtualProducts - identifiers of virtual products
• parameters - correct/default query string parameters

Example of a request in a deprecated version (curl):

The relationByAttributeIdentifiers.json file example (UTF-8 encoded):

Example of a response in a deprecated version (JSON):

Get relation by attribute data in a language-dependent version | ePIM.one API: relations by attribute

https://epim.one/api/XYZ/relations-by-attribute?lang={code}&with-keys={false/true}

Method: GET

Request is sent by an external system. ePIM.one responds with the detailed information of the specified relation(s) by attribute. All the coded information is sent in the requested language. It is necessary to send the list of relation identifiers (as a JSON data) that you want to get.

Query string parameters:

• lang - required language code acc. to ISO 639-1 (2 letter language code, for example, "en" for English, "pl" for Polish etc.)
• with-keys (default is "false") - specifies whether to add the "relationsByAttribute" and "parameters" keys in the response ("false"/"true")

Example of a request (curl):

The relationByAttributeIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Example of a request in a deprecated version (curl):

The relationByAttributeIdentifiers.json file example (UTF-8 encoded):

Example of a response in a deprecated version (JSON):

Put relation by attribute data | ePIM.one API: relations by attribute

https://epim.one/api/XYZ/relations-by-attribute

Method: PUT

Request is sent by an external system. ePIM.one writes the received information in its database and responds with a short report. Only string values (delimited by double quotes) are accepted. Also numbers should be transfered as strings delimited by quotations marks. Strings should not contain spaces at the beginning and at the end (such spaces will be anyway skiped/trimmed when importing).

You can send by default up to 16 MB data in one PUT request.

Example of a request (curl):

The relationsData.json file example (UTF-8 encoded):

Fields description:

• identifier - unique identifier of relation by attribute (max. 16 characters, allowed characters: A-Za-z0-9_-)
• attribute - unique identifier of grouping attribute
• name - names of the relation by attribute in various languages
• products - identifiers of all products which are in the relation by attribute

Example of a response (JSON):

Fields description:

• all - number of all relations by attribute in the request
• rejected - number of relations by attribute that can not be properly handled
• unique - number of unique (relative to identifier) relations by attribute in the request
• replaced - number of relations by attribute that have been replaced in the database
• new - number of relations by attribute that have been added to the database
• parameters - correct/default query string parameters

Delete relations by attribute | ePIM.one API: relations by attribute

https://epim.one/api/XYZ/relations-by-attribute

Method: DELETE

The request is sent by an external system. It is necessary to send a list of relation identifiers (as a JSON data) that you want to delete. ePIM.one deletes the relation(s) by attribute in its database and responds with a short report.

Example of a request (curl):

The relationByAttributeIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• deletedRelationsByAttribute - number of deleted relations by attribute
• parameters - correct/default query string parameters

Get supplier data | ePIM.one API: suppliers

https://epim.one/api/XYZ/suppliers?with-keys={false/true}

Method: GET

Request is sent by an external system. ePIM.one responds with the detailed information of the specified supplier(s). It is necessary to send the list of supplier identifiers (as a JSON data) that you want to get.

Query string parameters:

• with-keys (default is "false") - specifies whether to add the "suppliers" key in the response ("false"/"true")

Example of a request (curl):

The supplierIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• suppliers - detailed information of the specified supplier(s):
  • identifier - unique supplier identifier
  • name - supplier name
  • manufacturer - indication whether the supplier is manufacturer
  • vatId - supplier VAT-ID
  • gln - supplier GLN number
  • duns - supplier DUNS number
  • street - supplier's address: street name and house number
  • postalCode - supplier's address: postal code
  • city - supplier's address: city
  • country - supplier's address: country
  • contactPerson - contact person of the supplier
  • phone - the phone of the supplier
  • email - the main email of the supplier
  • website - supplier's website
  • logo - supplier's logo URL
• parameters - correct/default query string parameters

Example of a request in a deprecated version (curl):

The supplierIdentifiers.json file example (UTF-8 encoded):

Example of a response in a deprecated version (JSON):

Put supplier data | ePIM.one API: suppliers

https://epim.one/api/XYZ/suppliers

Method: PUT

Request is sent by an external system. ePIM.one writes the received information in its database and responds with a short report. Only string values (delimited by double quotes) are accepted. Also numbers should be transfered as strings delimited by quotations marks. Strings should not contain spaces at the beginning and at the end (such spaces will be anyway skiped/trimmed when importing).

You can send by default up to 16 MB data in one PUT request.

Example of a request (curl):

The suppliersData.json file example (UTF-8 encoded):

Fields description:

• identifier - unique identifier of supplier (max. 16 characters, allowed characters: A-Za-z0-9_-)
• name - supplier name (mandatory field)
• manufacturer (default is "false") - indication whether the supplier is manufacturer
• vatId - supplier VAT-ID
• gln - supplier GLN number
• duns - supplier DUNS number
• street - supplier's address: street name and house number
• postalCode - supplier's address: postal code
• city - supplier's address: city
• country - supplier's address: country (country code acc. to ISO 3166-1)
• contactPerson - contact person of the supplier
• phone - the phone of the supplier
• email - the main email of the supplier
• website - supplier's website
• logo - supplier's logo URL

Fields with the indicated default value can be omitted. Supplier(s) with the incorrect value(s) will be rejected.

Example of a response (JSON):

Fields description:

• all - number of all suppliers in the request
• rejected - number of suppliers that can not be properly handled
• unique - number of unique (relative to identifier) suppliers in the request
• replaced - number of suppliers that have been replaced in the database
• new - number of suppliers that have been added to the database
• parameters - correct/default query string parameters

Delete suppliers | ePIM.one API: suppliers

https://epim.one/api/XYZ/suppliers?delete-products={false/true}

Method: DELETE

The request is sent by an external system. It is necessary to send a list of supplier identifiers (as a JSON data) that you want to delete. ePIM.one deletes the supplier(s) in its database and responds with a short report.

Query string parameters:

• delete-products (default is "false") - specifies whether to delete products whose suppliers are deleted ("false"/"true")

Example of a request (curl):

The supplierIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• deletedSuppliers - number of deleted suppliers
• parameters - correct/default query string parameters

Get buyer data | ePIM.one API: buyers

https://epim.one/api/XYZ/buyers?with-keys={false/true}

Method: GET

Request is sent by an external system. ePIM.one responds with the detailed information of the specified buyer(s). It is necessary to send the list of buyer identifiers (as a JSON data) that you want to get.

Query string parameters:

• with-keys (default is "false") - specifies whether to add the "buyers" key in the response ("false"/"true")

Example of a request (curl):

The buyerIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• buyers - detailed information of the specified buyer(s):
  • identifier - unique buyer identifier
  • name - buyer name
  • gln - buyer GLN number
• parameters - correct/default query string parameters

Example of a request in a deprecated version (curl):

The buyerIdentifiers.json file example (UTF-8 encoded):

Example of a response in a deprecated version (JSON):

Put buyer data | ePIM.one API: buyers

https://epim.one/api/XYZ/buyers

Method: PUT

Request is sent by an external system. ePIM.one writes the received information in its database and responds with a short report. Only string values (delimited by double quotes) are accepted. Also numbers should be transfered as strings delimited by quotations marks. Strings should not contain spaces at the beginning and at the end (such spaces will be anyway skiped/trimmed when importing).

You can send by default up to 16 MB data in one PUT request.

Example of a request (curl):

The buyersData.json file example (UTF-8 encoded):

Fields description:

• identifier - unique identifier of buyer (max. 16 characters, allowed characters: A-Za-z0-9_-)
• name - buyer name (mandatory field)
• gln - buyer GLN number

Buyer(s) with the incorrect value(s) will be rejected.

Example of a response (JSON):

Fields description:

• all - number of all buyers in the request
• rejected - number of buyers that can not be properly handled
• unique - number of unique (relative to identifier) buyers in the request
• replaced - number of buyers that have been replaced in the database
• new - number of buyers that have been added to the database
• parameters - correct/default query string parameters

Delete buyers | ePIM.one API: buyers

https://epim.one/api/XYZ/buyers

Method: DELETE

The request is sent by an external system. It is necessary to send a list of buyer identifiers (as a JSON data) that you want to delete. ePIM.one deletes the buyer(s) in its database and responds with a short report.

Example of a request (curl):

The buyerIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• deletedBuyers - number of deleted buyers
• parameters - correct/default query string parameters

Get category tree data | ePIM.one API: categories

https://epim.one/api/XYZ/categories?with-keys={false/true}

Method: GET

Request is sent by an external system. ePIM.one responds with the detailed information of the specified category tree(s). It is necessary to send the list of category trees identifiers (as a JSON data) that you want to get.

Query string parameters:

• with-keys (default is "false") - specifies whether to add the "categoryTrees" key in the response ("false"/"true")

Example of a request (curl):

The categoryTreeIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• categoryTrees - detailed information of the specified category tree(s):
  • categoryTreeIdentifier - unique identifier of the category tree
  • categoryTreeName - names of category tree in various languages
  • categoryTreeAttributes - identifiers of the product attributes assigned to the whole category tree (as required for products in each category of the category tree)
  • categories - part of the categories information
  • identifier - unique (within the category tree) category identifier
  • parent - parent category identifier (if there is no "parent" key, the category is the main category)
  • name - names of the category in various languages
  • attributes - identifiers of the product attributes assigned to the category (as required for products in this category)
  • seo - data to improve the positioning in search engines results
  • www - information to facilitate and enrich the presentation of category information on websites
• parameters - correct/default query string parameters

Example of a request in a deprecated version (curl):

The categoryTreeIdentifiers.json file example (UTF-8 encoded):

Example of a response in a deprecated version (JSON):

Put category tree data | ePIM.one API: categories

https://epim.one/api/XYZ/categories

Method: PUT

Request is sent by an external system. ePIM.one writes the received information in its database and responds with a short report. Only string values (delimited by double quotes) are accepted. Also numbers should be transfered as strings delimited by quotations marks. Strings should not contain spaces at the beginning and at the end (such spaces will be anyway skiped/trimmed when importing).

You can send by default up to 16 MB data in one PUT request.

Example of a request (curl):

The categoryTreesData.json file example (UTF-8 encoded):

Fields description:

• categoryTreeIdentifier - unique identifier of the category tree (max. 16 characters, allowed characters: A-Za-z0-9_-)
• categoryTreeName - names of category tree in various languages
• categoryTreeAttributes - identifiers of the product attributes assigned to the whole category tree (as required for products in each category of the category tree)
• categories - part of the categories information
• identifier - unique (within the category tree) category identifier (max. 16 characters, allowed characters: A-Za-z0-9_-)
• parent - parent category identifier (if empty or there is no "parent" key, the category is the main category)
• name - names of the category in various languages
• attributes - identifiers of the product attributes assigned to the category (as required for products in this category)
• seo - data to improve the positioning in search engines results
• www - information to facilitate and enrich the presentation of category information on websites

Example of a response (JSON):

Fields description:

• all - number of all category trees in the request
• rejected - number of category trees that can not be properly handled
• unique - number of unique (relative to category tree identifier) category trees in the request
• replaced - number of category trees that have been replaced in the database
• new - number of category trees that have been added to the database
• parameters - correct/default query string parameters

Delete category trees | ePIM.one API: categories

https://epim.one/api/XYZ/categories

Method: DELETE

The request is sent by an external system. It is necessary to send a list of category trees identifiers (as a JSON data) that you want to delete. ePIM.one deletes the category tree(s) in its database and responds with a short report.

Example of a request (curl):

The categoryTreeIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• deletedCategoryTrees - number of deleted category trees
• parameters - correct/default query string parameters

Delete categories | ePIM.one API: categories

https://epim.one/api/XYZ/categories?category-tree-identifier={identifier}

Method: DELETE

The request is sent by an external system. It is necessary to send a list of category identifiers (as a JSON data) that you want to delete and specify their category tree in the "category-tree-identifier" parameter. ePIM.one deletes the categories in its database and responds with a short report.

Query string parameters:

• category-tree-identifier - identifier of the category tree containing the categories to be deleted

Example of a request (curl):

The categoryIdentifiers.json file example (UTF-8 encoded):

Example of a response (JSON):

Fields description:

• deletedCategories - number of deleted categories
• parameters - correct/default query string parameters

Check status of synchronization trigger | ePIM.one API: synchronization triggers

https://epim.one/api/XYZ/synchronizations/check/{progress-id}

Method: GET

The request is sent by an external system. ePIM.one responds with the current status of the running synchronization. The synchronization process is identified by "progress-id", returned by the system when the synchronization is run (see "Run synchronization trigger" section).

Query string parameters:

• progress-id - the progress identifier of the synchronization trigger, returned by the system when the synchronization is run (the "progress-id" field in the response with the status "in progress")

Example of a request (curl):

Example of a response (JSON):

• response with "in progress" status - the percentage progress of the triggered synchronization is given:{ "status":"in progress", "trigger-identifier":"tr67", "starting-time":"2021-04-15 10:20:03", "info":"87.10%", "progress-id":"sskYwG9068tDoSy7nfD7Dbzxj6iUSo9g" }
• response with "done" status - means that the synchronization has already finished and the statistics of the completed synchronization are provided in the "info" field:{ "status":"done", "trigger-identifier":"tr67", "starting-time":"2021-04-15 10:20:03", "info":"Source: CompanyXYZ | Target: CompanyABC | Creation of new products: yes | Deletion of products: yes | Overwriting of additional global attributes: yes | Selected products: 1000 | Created products: 0 | Modified products: 1000 | Deleted products: 0 | Classified products: 0 | Reclassified products: 0 | Products with deleted class: 0 | Overwritten additional global attributes: 0 | Created additional global attributes: 0" }
• response with "error" status - means that the synchronization has ended with an error provided in the "info" field:{ "status":"error", "trigger-identifier":"tr67", "starting-time":"2021-04-15 10:20:03", "info":"Attributes conflicted: Attr1: attribute (logical) vs. attribute (numeric)" }