Getting Started with our Application

Getting Started with our APIs

To begin using the Mattermaps API, follow these steps:

1. Request Mattermaps API access from the Mattermaps team via support@mattermaps.com
2. After our approval process you will get Client ID and a Client Secret.
3. Make a request against our identity provider MattermapsID to receive a JWT by using Client ID and Client Secret provided by Mattermaps team.
4. Include the JWT Token Authorization header of your HTTP requests.

Request a Token

curl https://mattermaps.eu.auth0.com/oauth/token/ \ <-- Please reference to the table above regarding different environments
https://uat-mattermaps.eu.auth0.com/oauth/token/
  -H 'content-type: application/json' \
  -d "{
            \"client_id\":\"$CLIENT_ID\",
            \"client_secret\":\"$CLIENT_SECRET\",
            \"audience\":\"https://app.mattermaps.com/\",
            \"grant_type\":\"client_credentials\"
      }" 

Example response

{
  "access_token": "jwtHeader.jwtPayload.jwtSignature",
  "token_type": "Bearer",
  "expires_in": 1800
}

Example request to Mattermaps APIs

curl --request POST \
  --url https://app.Mattermaps.com/api/products/factoryEmissions/42564 \
  --header 'Authorization: Bearer jwtHeader.jwtPayload.jwtSignature'

Concepts and Glossary

Validation Errors

Validation Errors

Business Errors

Contact

For any inquiries, whether organizational matters like the procurement of API credentials or technical questions about the Mattermaps API, please direct your communication to the following email: support@mattermaps.com

Quick Start

For getting started with our Application and our APIs, kindly refer to Getting Started.

Concepts and Glossary

For detailed information about the concepts and terminology, please refer to Concepts and Glossary.

PCF API

The PCF APIs are used for creating the Product Carbon Footprint (PCF) of any product via the Mattermaps application. With the available PCF APIs, you can perform the following operations:

1. Create the TFS standard credential for a specific product of a company in Mattermaps.
2. Create the PACT standard credential for a specific product of a company in Mattermaps.
3. Create an ISO standard credential for a specific product of a company in Mattermaps.
4. Create the CatenaX standard credential for a specific product of a company in Mattermaps.
5. Fetch the status of a job. It is to know whether a credential has been created or not.

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under PCF API(s).

PCF API — API reference

Changelog

Quick Start

For getting started with our Application and our APIs, kindly refer to Getting Started.

For general information about the Product Portfolio functionality, refer to the respective section in the Mattermaps Help: Product Portfolio.

Concepts and Glossary

For detailed information about the concepts and terminology, please refer to Concepts and Glossary.

Product API

The Product API, part of Mattermaps's suite of APIs, offers users a streamlined solution for managing products and BOM. With endpoints including POST Product and GET Product, users can seamlessly add and retrieve data related to products.

Prerequisite: In order to create a product, it is mandatory to create the product identifier type first.

Getting started with the Product APIs involves the following steps:

1. Create a product identifier type for a company in Mattermaps. The identifier type created initially in the beginning acts as the main identifier type. Example Request

   curl --location 'https://app.Mattermaps.com/api/products/identifierTypes' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Bearer TOKEN' \
   --data '{
       "idType": "Product ID"
   }'
   ```Upload factory emissions for a product in Mattermaps.
   
   Example Response
   
   ```bash
   {
       "id": "01908d72-9005-7241-8f5c-37dcf1e65b5f"
   }
   

2. Get product identifier types for a company in Mattermaps.

   Example Request

   curl --location 'https://app.Mattermaps.com/api/products/identifierTypes?size=100'
   --header 'Authorization: Bearer TOKEN' \
   

   Example Response

   {
       "items": [
           {
               "id": "01908d72-9005-7241-8f5c-37dcf1e65b5f",
               "idType": "Product ID",
               "isMainIdentifierType": true
           }
       ],
       "hasNext": true,
       "hasPrev": false,
       "page": 0,
       "pageNumber": 1,
       "size": 1,
       "totalPages": 1,
       "totalRecords": 1
   }
   

3. Create a factory for a company in Mattermaps (Optional).

   Example Request

   curl --location 'app.Mattermaps.com/api/factories' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Bearer TOKEN' \
   --data '{
       "factory": "Munich factory"
   }'
   

   Example Response

   {
     "id": "974ca1b0-7088-4f5f-97e6-1d44fa18f694"
   }
   

4. Get list of factories in a company in Mattermaps.

   Example Request

   curl --location 'https://app.Mattermaps.com/api/factories' \
   --header 'Authorization: Bearer TOKEN' \
   --data ''
   

   Example Response

   {
       "items": [
           {
               "id": "974ca1b0-7088-4f5f-97e6-1d44fa18f694",
               "factory": "Munich factory"
           }
       ],
       "hasNext": true,
       "hasPrev": false,
       "page": 0,
       "pageNumber": 1,
       "size": 1,
       "totalPages": 1,
       "totalRecords": 1
   }
   

5. Create a product.

   Example Request

   curl --location 'https://app.Mattermaps.com/api/products' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Bearer TOKEN' \
   --data '{
     "name": "mattermatics PL7",
     "family": "Controls E1456",
     "identifiers": [
       {
         "value": "UPC-1",
         "idType": "Product ID",
         "default": true
       }
     ],
     "description": "Your product description",
     "weight": "1.533",
     "quantity": "5",
     "unitType": "kg",
     "factoryIds": [
       "974ca1b0-7088-4f5f-97e6-1d44fa18f694"
     ]
   }'
   

   Example Response

   {
     "id": "0190771f-2363-7de3-839f-df9131b93f37"
   }
   

6. Get product details by id in Mattermaps.

   Example Request

   curl --location --request GET 'https://app.Mattermaps.com/api/products/0190771f-2363-7de3-839f-df9131b93f37' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Bearer TOKEN' \
   --data ''
   

   Example Response

   {
       "id": "0190771f-2363-7de3-839f-df9131b93f37",
       "name": "mattermatics PL7",
       "family": "Controls E1456",
       "identifiers": [
           {
               "value": "UPC-1",
               "idType": "Product ID",
               "default": true
           }
       ],
       "description": "Your product description",
       "weight": "1.533",
       "quantity": "5.0",
       "unitType": "kg",
       "factoryIds": [
           "974ca1b0-7088-4f5f-97e6-1d44fa18f694"
       ],
       "createdOn": "2022-11-20T08:30:00.000Z",
       "updatedOn": "2022-11-21T10:30:00.000Z"
   }      
   

With the other available Product APIs, you can perform the following operations:

1. Update a product identifier type for a company in Mattermaps.
2. Delete an unused product identifier type for a company in Mattermaps.
3. Update product details by id in Mattermaps.
4. Get all product details for a company in Mattermaps.
5. Delete a product in Mattermaps.
6. Upload factory emissions for a product in Mattermaps.
7. Get the PCF data for your products in Mattermaps.
8. Offset the emissions of a product in Mattermaps.

Factory API(s)

With the other available Factory APIs, you can perform the following operations:

1. Update a factory for a company in Mattermaps.
2. Delete an unused factory of a company in Mattermaps.

Bill of Material API(s)

With the available Bill of Material APIs, you can perform the following operations:

1. Get a list of Bill of Material entries for a product version in Mattermaps.
2. Add items (Groups, Components, Products) to a BOM version.
3. Save upstream emissions for a BOM version.
4. Update metadata of a BOM item.
5. Delete a BOM item from a BOM version.

The Bill of Materials (BOM) functionality has evolved from a simple read-only feature to a fully interactive and powerful BOM management system. This enhancement allows users to perform full Create, Read, Update, and Delete (CRUD) operations on both BOM versions and their associated items, bringing flexibility and control to how product structures are defined, maintained, and tracked.

At the core of this functionality is support for a wide range of BOM entities:

• Groups: Logical containers that can represent modules or assemblies. Groups support multi-level nesting, enabling the modeling of complex, hierarchical product structures.
• Components: Physical parts sourced from procurement systems. Users can define quantities for components but cannot alter core metadata sourced externally.
• Products: Internal products that can be linked to Product Carbon Footprint (PCF) data. For these, users can manage quantity, link PCF IDs, and toggle emission-related flags like includeDistributionStage.

Users can now create and manage multiple BOM versions for a single product. Each version can carry its own identifier (e.g., "v1.0", "prototype-3"), metadata (e.g., comments, timestamps), and emissions tracking data. This versioning system enables iterative product design, version comparison, and historical tracking — essential for sustainability compliance and audit readiness.

The API also supports granular operations:

• Add or remove individual BOM items (Groups, Components, Products)
• Update specific metadata fields (e.g., group name, component quantity, product PCF ID)
• Delete entire subtrees of items if needed

A crucial addition is the upstream emissions finalization feature. Once a BOM version is fully assembled, users can finalize it by saving upstream emissions. This operation locks the BOM, preventing further changes. Locking ensures data consistency for environmental reporting and downstream calculations, protecting against accidental edits.

To aid traceability, the API offers detailed retrieval capabilities, such as:

• Listing all BOM versions for a product
• Tracking timestamps like createdOn, updatedOn, and latestSync
• Accessing emissions metadata including upstream values and lifecycle footprints

These features make Mattermaps’s BOM API not just a tool for structuring product data but a robust platform for version control, emissions accountability, and supply chain integration. It empowers product teams, sustainability officers, and procurement engineers to collaborate more effectively with full visibility into both the structure and environmental impact of their products.

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under Product API(s).

Product API — API reference

Changelog

Quick Start

For getting started with our Application and our APIs, kindly refer to Getting Started.

For general information about the Procurement functionality, refer to the respective section in the Mattermaps Help: Procurement made easy.

Concepts and Glossary

For detailed information about the concepts and terminology, please refer to Concepts and Glossary.

Procurement API

The Procurement API, part of Mattermaps's suite of APIs, offers a streamlined solution for managing component-level emissions within procurement processes. With various endpoints mentioned below, users can efficiently access and analyze crucial data related to components and suppliers.

Suppliers

Prerequisite: In order to create a supplier, it is mandatory to create the supplier identifier type first.

Getting started with the Procurement APIs involves the following steps with respect to the Suppliers:

1. Create a supplier identifier type for a company in Mattermaps. The identifier type created initially in the beginning acts as the main identifier type.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/suppliers/identifierTypes' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '{
         "idType": "Supplier ID"
     }'
   

   Example Response

     {
         "id": "0190832b-b69b-778f-a843-a2a787a0827d"
     }
   

2. Get supplier identifier types for a company in Mattermaps.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/suppliers/identifierTypes' \
     --header 'Authorization: Bearer TOKEN' \
   

   Example Response

     {
         "items": [
   
             {
                 "id": "0190832b-b69b-778f-a843-a2a787a0827d",
                 "idType": "Supplier ID",
                 "isMainIdentifierType": true
             }
         ],
         "hasNext": false,
         "hasPrev": false,
         "page": 0,
         "pageNumber": 1,
         "size": 1,
         "totalPages": 1
     }
   

3. Create a supplier in Mattermaps.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/suppliers' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data-raw '{
         "name": "Supplier Company Limited",
         "identifiers": [
             {
                 "idType": "Supplier ID",
                 "value": "SUP-123",
                 "default": true
             }
         ],
         "email": "demo@demo.com",
         "contactNumber": "+91 234-234-2445",
         "website": "www.demo.com",
         "locations": [
             "12459 Berlin, Makersitestraße 42"
         ],
         "comment": "Proc Supplier"
     }'
   

   Example Response

     {
         "id": "01908348-1ade-718b-9895-0b53c9e4a4f9"
     }
   

4. Get supplier details by ID for a company in Mattermaps.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/suppliers/01908348-1ade-718b-9895-0b53c9e4a4f9' \
     --header 'Authorization: Bearer TOKEN' \
     --data ''
   

   Example Response

     {
         "id": "01908348-1ade-718b-9895-0b53c9e4a4f9",
         "name": "Supplier Company Limited",
         "identifiers": [
             {
                 "idType": "Supplier ID",
                 "value": "SUP-123",
                 "default": true
             }
         ],
         "email": "demo@demo.com",
         "contactNumber": "+49 911 2155- 4444",
         "website": "www.demo.com",
         "locations": [
         "12459 Berlin, Makersitestraße 42"
         ],
         "comment": "Proc Supplier",
         "status": "ACTIVE",
         "createdOn": "2023-01-01T12:00:00",
         "updatedOn": "2023-01-02T12:00:00"
     }
   

With the other available Supplier APIs, you can perform the following operations:

1. Update supplier identifier type for a company in Mattermaps.
2. Update a supplier by supplier ID in Mattermaps.
3. Delete a supplier by supplier ID in Mattermaps.
4. Invite a supplier to Mattermaps.
5. Cancel a supplier invite to Mattermaps.
6. Get all suppliers for one company in Mattermaps.
7. Delete an unused supplier identifier type for a company in Mattermaps.

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under Procurement API(s).

Components

Prerequisite: In order to create a component, it is mandatory to create the component identifier type first.

Getting started with the Procurement APIs involves the following steps with respect to the Components:

1. Create a component identifier type for a company in Mattermaps. The identifier type created initially in the beginning acts as the main identifier type.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/identifierTypes' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '{
         "idType": "SKU"
     }'
   

   Example Response

     {
         "id": "0190835f-f167-7a6c-b8ab-2d5cb2c1d7e8"
     }
   

2. Get component identifier types for a company in Mattermaps.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/identifierTypes?size=1' \
     --header 'Authorization: Bearer TOKEN' \
   

   Example Response

     {
         "items": [
             {
                 "id": "0190835f-f167-7a6c-b8ab-2d5cb2c1d7e8",
                 "idType": "SKU",
                 "isMainIdentifierType": true
             }
         ],
         "hasNext": false,
         "hasPrev": false,
         "page": 0,
         "pageNumber": 1,
         "size": 1,
         "totalPages": 1
     }
   

3. Create a component in Mattermaps.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '{
         "name": "Frames",
         "materialCategory": "Electronics",
         "unit": "piece",
         "weight": "3.5",
         "identifiers": [
             {
                 "idType": "SKU",
                 "value": "FRM1234",
                 "default": true
             }
         ]
     }'
   

   Example Response

     {
         "id": "0190838b-4469-76fc-b4bc-414c71526f2f"
     }
   

4. Get component details by ID.

   Example Request

     curl --location --request GET 'https://app.Mattermaps.com/api/components/0190838b-4469-76fc-b4bc-414c71526f2f' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data ''
   

   Example Response

     {
         "id": "0190838b-4469-76fc-b4bc-414c71526f2f",
         "name": "Frames",
         "materialCategory": "Electronics",
         "unit": "piece",
         "weight": "3.5",
         "identifiers": [
             {
                 "idType": "SKU",
                 "value": "FRM1234",
                 "default": true
             },
         ],
         "createdOn": "2024-04-19T00:00:00.000Z",
         "updatedOn": "2024-04-19T00:00:00.000Z"
     }
   

5. Create secondary data with component. Either totalInclBio or totalExclBio mandatory.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/0190838b-4469-76fc-b4bc-414c71526f2f/secondaryData' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data-raw '{
         "email": "abc@testing.com",
         "productionStage": {
         "pcfIncludingBiogenic": "79.86801562912491",
         "pcfExcludingBiogenic": "79.86801562912432",
         "fossilGhgEmissions": "79.86801562912497",
         "biogenic": "79.86801562912497",
         "luGhgEmissions": "79.86801562912497",
         "aircraftGhgEmissions": "79.86801562912497",
         "dLucGhgEmissions": "79.86801562912497"
       },
       "distributionStage": {
         "pcfIncludingBiogenic": "79.86801562912494",
         "pcfExcludingBiogenic": "79.8680156291287",
         "fossilGhgEmissions": "79.86801562912497",
         "biogenic": "79.86801562912497",
         "luGhgEmissions": "79.86801562912497",
         "aircraftGhgEmissions": "79.86801562912497",
         "dLucGhgEmissions": "79.86801562912497"
       },
         "quantity": 1,
         "validityPeriodStart": "2024-06-04T08:30:00.000Z",
         "region": "Europe",
         "comment": "No Comments",
         "dataSource": "Database",
         "dataVerification": "Proxy data"
     }'
   

   Example Response

     {
         "secondaryDataId": "0190839e-1255-753b-8c52-a3202978a983"
     }
   

6. Get component secondary data by secondary data ID.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/0190838b-4469-76fc-b4bc-414c71526f2f/secondaryData/0190839e-1255-753b-8c52-a3202978a983' \
     --header 'Authorization: Bearer TOKEN' \
     --data ''
   

   Example Response

     {
         "quantity": "1.0",
         "dataSource": "Database",
         "dataVerification": "Proxy data",
         "region": "Europe",
         "validityPeriodStart": "2024-06-04 08:30:00.0",
         "comment": "No Comments",
         "secondaryDataId": "0190839e-1255-753b-8c52-a3202978a983",
         "email": "abc@testing.com"
         "productionStage": {
         "pcfIncludingBiogenic": "79.86801562912491",
         "pcfExcludingBiogenic": "79.86801562912432",
         "fossilGhgEmissions": "79.86801562912497",
         "biogenic": "79.86801562912497",
         "luGhgEmissions": "79.86801562912497",
         "aircraftGhgEmissions": "79.86801562912497",
         "dLucGhgEmissions": "79.86801562912497"
       },
       "distributionStage": {
         "pcfIncludingBiogenic": "79.86801562912494",
         "pcfExcludingBiogenic": "79.8680156291287",
         "fossilGhgEmissions": "79.86801562912497",
         "biogenic": "79.86801562912497",
         "luGhgEmissions": "79.86801562912497",
         "aircraftGhgEmissions": "79.86801562912497",
         "dLucGhgEmissions": "79.86801562912497"
       },
     }
   

7. Link suppliers and secondary data with component.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/0190838b-4469-76fc-b4bc-414c71526f2f/linkSuppliers' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '[
         {
             "supplierId": "01908348-1ade-718b-9895-0b53c9e4a4f9",
             "supplierLocation": "12459 Berlin, Makersitesstraße 42",
             "share": 100,
             "supplierProductId": "SUPCOMP1",
             "secondaryDataId": "018fe8a5-349f-7e94-8032-d57f9420e2a4"
         }
     ]'
   

   Example Response

     [
         {
             "supplierLocation": "12459 Berlin, Makersitestraße 42",
             "share": "100.0",
             "supplierProductId": "SUPCOMP1",
             "supplierId": "01908348-1ade-718b-9895-0b53c9e4a4f9",
             "secondaryDataId": "018fe8a5-349f-7e94-8032-d57f9420e2a4"
         }
     ]
   

8. Send pcf request to suppliers in Mattermaps.

   The PCF Request API allows you to send a Product Carbon Footprint (PCF) request to suppliers within your supply chain, helping track and report the carbon footprint of specific components. This is essential for maintaining transparency and sustainability in the supply chain.

   This API sends a request to the supplier to provide the carbon footprint information for a specific component. The request is based on the unique identifiers for both the component and the supplier.

   On a successful request, the supplier is notified via email and also via the standard Mattermaps notification in the application. The supplier will then be responsible for responding with the PCF information.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/019228f3-8d22-73f7-a8a9-673996b71326/suppliers/cb688ef3-a61f-455f-b308-4c80f87e8db6/pcfRequest' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '{
         "pcfStandard": "TFS V2",
         "location": "Mumbai",
         "message": "PCF request message",
         "identifiers": [
             {
                 "idType": "ean",
                 "value": "4667"
             }
         ]
     }'
   

   Example Response

      {
         "taskId": "T0247",                
      }
   

With the other available Component APIs, you can perform the following operations:

1. Update a component identifier type for a company in Mattermaps.
2. Get all components for one company in Mattermaps.
3. Delete a component by ID for a company in Mattermaps.
4. Get all component secondary data for component in Mattermaps.
5. Update component secondary data by secondary data ID.
6. Get all linked suppliers with component.
7. Get linked suppliers by componentSupplierLinkId with component.
8. Update location/share/secondary data/supplier product ID by component supplier ID.
9. Delete an unused component identifier type for a company in Mattermaps.
10. Delete link between component and supplier. Deletion of records supports only soft delete.

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under Procurement API(s).

Components PCF

With the available Components PCF APIs, you can perform the following operations:

1. Get an aggregated export of a PCF of a component.
2. Get an export of a PCF of a component.
3. Get the average emissions for components across your company.

4. GET the PCF data for your components in Mattermaps.

   With this API, you can retrieve the PCF data for your components shared by the supplier in different scenarios:

   You can retrieve the PCF data for all the components available in Mattermaps for your respective company.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/pcfData' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   You can retrieve the PCF data shared by the supplier in a specific time range.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/pcfData?from=2024-01-03T00%3A00%3A00.000Z&%20to=2024-12-31T23%3A59%3A59.999Z' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   You can retrieve the PCF data shared by a specific supplier.

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/pcfData?from=2024-01-03T00%3A00%3A00.000Z&%20to=2024-12-31T23%3A59%3A59.999Z&supplierId=0192416b-087d-7b2d-82b4-e08ad5da65db' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   You can retrieve the PCF data shared by the supplier wherein the PCF data is in any of the following state:

   Accepted

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/pcfData?supplierId=0192416b-087d-7b2d-82b4-e08ad5da65db&accepted=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Rejected

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/pcfData?supplierId=019232dd-8e5d-72bf-9ed1-01fbf137cf6b&rejected=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Withdrawn

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/pcfData?supplierId=019232dd-8e5d-72bf-9ed1-01fbf137cf6b&withdrawn=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Active

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/pcfData?supplierId=0192416b-087d-7b2d-82b4-e08ad5da65db&active=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Expired

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/pcfData?supplierId=01924911-87ea-7918-a753-9e3602c7d285&expired=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Revoked

   Example Request

     curl --location 'https://app.Mattermaps.com/api/components/pcfData?supplierId=019232dd-8e5d-72bf-9ed1-01fbf137cf6b&revoked=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under Procurement API(s).

Material Category

With the available Material Category APIs, you can perform the following operations:

1. Get Material Category details by ID.
2. Update Material Categories details by ID.
3. Delete Material Categories details by ID.
4. Get Material Category image by ID.
5. Update Material Category image by ID.
6. Delete Material Category image by ID.
7. Get all Material Categories for one company in Mattermaps.
8. Create Material Category to Mattermaps.

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under Procurement API(s).

Procurement API — API reference

Changelog

Quick Start

For getting started with our Application and our APIs, kindly refer to Getting Started.

For general information about the My Tasks functionality, refer to the respective section in the Mattermaps Help: My Tasks.

Concepts and Glossary

For detailed information about the concepts and terminology, please refer to Concepts and Glossary.

My Tasks API

With the available Components part of My Tasks APIs, you can perform the following operations:

Product Tasks:

1. GET the incoming pcf requests received for a company in Mattermaps.
2. Share the pcf data for the given task with a linked product.
3. Link an existing Product to the given task.
4. Delete the link between a product and the task. It is possible only before the task status is changed to PCF Shared.

Component Tasks:

1. GET the outbound requests sent for a company in Mattermaps.
2. Reject proof received by the task in Mattermaps.
3. Accept proof received by the task in Mattermaps.

Task Comments:

1. Get comments for the given task in Mattermaps.
2. Add a comment to the given task in Mattermaps.
3. Update a comment to the given task in Mattermaps.
4. Delete a comment to the given task in Mattermaps.

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under My Tasks API(s).

My Tasks API — API reference

Changelog