Product

Last modified by Gerrit Hellwig on 21.03.2022, 17:50

Endpoints

Note:

  • The search endpoint only exports basic produict fields like ID and description
  • The other endpoints export the full product with all information
  • Variants are part of the master product, they are not treated as single/standalone product entities.

/catalogs/{catalogId}/products

Get products with catalogId by filter parameters

Parameters:

  • Mandatory
    • catalogId
  • Optional
    • classificationId
    • classificationGroupClassificationId
    • classificationGroupId
    • contractId
    • statusId
    • changedOn
    • createdOn
    • languageId
    • sorting
    • page
    • pageSize

/catalogs/{catalogId}/products/search

Search products with catalogId by filter parameters

Parameters:

  • Mandatory
    • catalogId
  • Optional
    • classificationId
    • classificationGroupClassificationId
    • classificationGroupId
    • languageId
    • sorting
    • page
    • pageSize

Example response

https://example.eu.prodexa.com:8086/pxm/pimapi/v1/catalogs/MasterCatalog/products/search?classificationGroupClassificationId=MasterClassification&classificationGroupId=Tablets&languageId=de

{
 "status": 200,
 "meta": {
   "languageId": "de",
   "paging": {
     "per_page": 5,
     "page": 0,
     "total_pages": 4,
     "total_items": 17
    },
   "contentType": "application/json"
  },
 "data": [
    {
     "productId": "SM-W708NZKAITV",
     "catalogId": "MasterCatalog",
     "_objectPreviewURI": "https://ga822.eu.prodexa.com/pim/api/files/suppliers/Demo_Supplier/documents/SM-W708NZKAITV.jpg",
     "_objectName": "Samsung Galaxy TabPro S LTE 128GB 4G Schwarz Tablet"
    },
    {
     "productId": "SM-T580NZKAXAR",
     "catalogId": "MasterCatalog",
     "_objectPreviewURI": "https://ga822.eu.prodexa.com/pim/api/files/suppliers/Demo_Supplier/documents/SM-T580NZKAXAR.jpg",
     "_objectName": "Samsung Galaxy Tab A SM-T580N 16GB Schwarz Tablet"
    },
    {
     "productId": "90XB015P-BSL3H0",
     "catalogId": "MasterCatalog",
     "_objectPreviewURI": "https://ga822.eu.prodexa.com/pim/api/files/suppliers/Demo_Supplier/documents/asus-ZenPad-case1.jpg",
     "_objectName": "ASUS Front cover 8''",
     "_objectDescription": "<b>Vibrant Colors for Your Unique Style</b><br /> - Impact-resistant hardened plastic protective cover with a stylish embossed leather motif helps protect your ASUS ZenPad 8.0 against bumps and scratches.<br /> - Easily personalize your ZenPad 8.0 to fit your current style.<br /> - Available in 5 vibrant colors<br /><br />  ASUS Zen Case is a beautifully-designed protective case with elegant clean lines and embossed leather patterns to match the premium look and feel of your ZenPad. This interchangeable case is available in Black, White, Aurora Metallic, Blue, and Orange – so you can choose one that suits your unique style.<br /><br />  <b>Embossed leather-patterned design</b><br /> Hardened plastic cover provides stylish protection for your ASUS ZenPad 8.0.<br /><br />  <b>A quick snap for different styles</b><br /> Zen Case has a snap-on design, so just pick your color to suit the day your look for the day. ZenPad 8.0 Zen Case is now available in 5 vibrant colors<br /><br />"
    },
    {
     "productId": "SM-T350NZAAXAR",
     "catalogId": "MasterCatalog",
     "_objectPreviewURI": "https://ga822.eu.prodexa.com/pim/api/files/suppliers/Demo_Supplier/documents/SM-T350NZAAXAR.jpg",
     "_objectName": "Samsung Galaxy Tab A 8.0 16GB Titan Tablet"
    },
    {
     "productId": "90-XB3TOKSL001E0",
     "catalogId": "MasterCatalog",
     "_objectPreviewURI": "https://ga822.eu.prodexa.com/pim/api/files/suppliers/Demo_Supplier/documents/asus-ZenPad-case2.jpg",
     "_objectName": "Asus MeMO Pad ME172"
    }
  ]
}

/catalogs/{catalogId}/products/{productId}

Get a product by catalogId and productId

Parameters:

  • Mandatory
    • catalogId
    • productId
  • Optional
    • languageId

Example response

https://example.eu.prodexa.com:8086/pimapi/v1/catalogs/MasterCatalog/products/LH95MECPLBC

{
   "status": 200,
   "meta": {
       "languageId": null,
       "contentType": "application/json"
    },
   "data": {
       "productId": "LH95MECPLBC",
       "catalogId": "MasterCatalog",
       "supplierId": "demo_Supplier",
       "statusId": "100",
       "mfgProductId": null,
       "manufacturerId": "Samsung",
       "manufacturerName": null,
       "extProductId": null,
       "productIdExtension": null,
       "unitOfMeasureId": "PCE",
       "salesUnitOfMeasureId": "PCE",
       "keywords": "TV, Fernseher, LED, Full HD, Ultra HD, UHD, Bildschirm, Monitor",
       "isMainProdLine": null,
       "isPunchout": null,
       "isConfigurable": null,
       "validFrom": null,
       "validTo": null,
       "supplierId.description": "Demo Supplier",
       "manufacturerId.description": null,
       "catalogId.description": "Master Catalog",
       "statusId.description": [
            {
               "languageId": "de-DE",
               "value": "neu"
            },
            {
               "languageId": "en-GB",
               "value": "new"
            }
        ],
       "unitOfMeasureId.description": [
            {
               "languageId": "de-DE",
               "value": "Stück"
            },
            {
               "languageId": "en-GB",
               "value": "piece"
            }
        ],
       "variants": [],
       "classificationGroupAssociations": [
            {
               "classificationId": "basic",
               "classificationGroupId": "text",
               "orderNo": null,
               "variant": null,
               "classificationGroupId.description": [
                    {
                       "languageId": "de-DE",
                       "value": "Text"
                    },
                    {
                       "languageId": "en-GB",
                       "value": "Text"
                    }
                ],
               "createdOn": "2020-12-01T10:59:45.000+00:00",
               "createdBy": "prodexa",
               "changedOn": "2020-12-01T10:59:45.000+00:00",
               "changedBy": "prodexa"
            }
        ],
       "attributeValues": [
            {
               "attributeId": "ProductEnrichmentLevelTranslation_de-DE",
               "status": null,
               "variant": null,
               "languageId": null,
               "expression": null,
               "values": [
                   "0"
                ],
               "tags": null,
               "attribute.description": [
                    {
                       "languageId": "de-DE",
                       "value": "Übersetzungen de-DE"
                    },
                    {
                       "languageId": "en-GB",
                       "value": "Translation de-DE"
                    }
                ]
            },
            {
               "attributeId": "ProductEnrichmentLevelTranslation_en-GB",
               "status": null,
               "variant": null,
               "languageId": null,
               "expression": null,
               "values": [
                   "0"
                ],
               "tags": null,
               "attribute.description": [
                    {
                       "languageId": "de-DE",
                       "value": "Übersetzungen (en-GB)"
                    },
                    {
                       "languageId": "en-GB",
                       "value": "Translation (en-GB)"
                    }
                ]
            }
        ],
       "compatibilities": [],
       "docAssociations": [
            {
               "path": "suppliers/OC_Supplier/documents/LH95MECPLBC.jpg",
               "documentViewTypeId": "preview",
               "orderNo": null,
               "palanguageIdth": "de-DE",
               "description": null,
               "validFrom": null,
               "validTo": null,
               "status": "400",
               "variant": null,
               "tags": null,
               "extDocumentId": null,
               "udxText1": null,
               "udxText2": null,
               "udxText3": null,
               "udxNum1": null,
               "udxNum2": null,
               "udxNum3": null,
               "udxSortKey1": null,
               "udxSortKey2": null,
               "udxSortKey3": null,
               "documentViewTypeId.name": "Preview",
               "createdOn": "2020-12-01T10:59:45.000+00:00",
               "createdBy": "prodexa",
               "changedOn": "2020-12-01T10:59:45.000+00:00",
               "changedBy": "prodexa"
            }
        ],
       "prices": [
            {
               "contractId": "MC_ListPrice",
               "statusId": "400",
               "variant": null,
               "currencyId": "EUR",
               "priceTypeId": "list",
               "price": 1299,
               "validFromQuantity": 1,
               "validFrom": null,
               "validTo": null,
               "priceUnit": 1,
               "description": null,
               "vatPercentage": null,
               "isPreferred": null,
               "unitOfMeasureId": "PCE",
               "productIdExtensionForUom": null,
               "contractId.description": [],
               "statusId.description": [
                    {
                       "languageId": "de-DE",
                       "value": "bestätigt"
                    },
                    {
                       "languageId": "en-GB",
                       "value": "confirmed"
                    }
                ],
               "priceTypeId.description": [
                    {
                       "languageId": "de-DE",
                       "value": "Liste"
                    },
                    {
                       "languageId": "en-GB",
                       "value": "The list price of the product"
                    }
                ],
               "createdOn": "2020-12-01T10:59:45.000+00:00",
               "createdBy": "prodexa",
               "changedOn": "2020-12-01T10:59:45.000+00:00",
               "changedBy": "prodexa"
            }
        ],
       "contractedProducts": [
            {
               "contractId": "MC_ListPrice",
               "statusId": null,
               "variant": null,
               "extProductId": null,
               "altExtProductId": null,
               "extClassificationId": null,
               "extClassificationGroupId": null,
               "descShort": null,
               "descLong": null,
               "extGlAccountId": null,
               "priceQuantity": null,
               "quantityInterval": null,
               "maxQuantity": null,
               "minQuantity": null,
               "leadtimeInDays": null,
               "salesUnitOfMeasureId": null,
               "timePeriod": null,
               "visibility": 1,
               "unitOfMeasureId": null,
               "cost": null,
               "currencyId": null,
               "amount": null,
               "statusDate": null,
               "discount": null,
               "contractId.description": [],
               "createdOn": "2020-12-01T10:59:45.000+00:00",
               "createdBy": "prodexa",
               "changedOn": "2020-12-01T10:59:45.000+00:00",
               "changedBy": "prodexa"
            }
        ],
       "relations": [],
       "reverseRelations": [],
       "createdOn": "2019-02-06T14:02:46.000+00:00",
       "createdBy": "prodexa",
       "changedOn": "2019-08-28T16:33:21.000+00:00",
       "changedBy": "prodexa"
    }
}
Tags:
Created by Uwe S. on 08.12.2020, 14:27