v2 > Services > MaterialsSearch

Search one or more materials in Origin. The search result is organized in pages.

  • URL

    /connect/v2/materials/search

  • Method:

    POST

  • URL Params

    none

  • Request :

Field Type Required Description Domain of value
locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
pageNumber number Yes The page number the search result will start from Positive integer greater than 0
pageSize number Yes The maximum number of result by page Integer between 1 and 100
searchCriteria[] array of object Yes The list of search criteria SearchCriteria object array
searchCriteria[].name string Yes A criterion code supported by the search See the reference
searchCriteria[].value variable Yes The value to search See the reference
  • Sample Request :

This sample request could be translated as : "Search the material with ORIGINID value of db65ac6b-5850-11e8-803c-8c16451835eb starting from page 1 with 10 results by page."

{
    "locale": "en",
    "pageNumber": "1",
    "pageSize": "10",
    "searchCriteria": [
        {
            "name": "ORIGINID",
            "value": "db65ac6b-5850-11e8-803c-8c16451835eb"
        }
    ]
}
  • Response :
Field Type Presence Description Domain of value
status object Always The execution status A status object
status.state string Always The state of execution 'SUCCESS' or 'ERROR'
status.code string On error The general error code and message See Errors reference
status.messages[] array of string On error List of error causes A validation message or other causes
result object On success The execution result A result object
result.entityType string On success The type of entity this result is about 'MATERIAL'
result.searchInfo object On success Informations about the search result pages A searchInfo object
result.searchInfo.numberOfElements object On success The total number of elements found A positive integer
result.searchInfo.numberOfPages object On success The total number of pages NumberOfElements / pageSize
result.data[] array of object On success The actual search result : a list of materials Array of material object
result.data[].locale string On success An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
result.data[].originId string On success The material unique origin ID A UUID
result.data[].externalId string On success The material unique ID in your system Any string
result.data[].productId string On success An identification code (ex: a catalog id, SKU code) Any string
result.data[].managementPermission string On success The access permission profile Any string
result.data[].name string On success The material name Any string
result.data[].description string On success The material description Any string
result.data[].contentManagedBy string On success The material content manager name Any string
result.data[].lastUpdated date On success The material last update date A ISO-8601 date
result.data[].brand object On success The material brand Brand object
result.data[].brand.originId string On success The brand unique origin ID A UUID
result.data[].brand.name string On success The brand name Any string
result.data[].brand.website string On success The brand website A valid public facing URL
result.data[].logoUrl object On success The material logo URL. In Origin, It refers to the material thumbnail image and the first image of the material. This image can be also set in Origin Website -> Material edit page -> Image Section -> Featured Image checkbox. A logoUrl object
result.data[].logoUrl.originalUrl string On success The material logo original URL A public facing URL
result.data[].logoUrl.referenceUrl string On success The material logo reference URL A public facing URL
result.data[].company object On success The company owner of the material A company object
result.data[].company.originId string On success The company unique origin ID A UUID
result.data[].company.name string On success The company name Any string
result.data[].company.companyType string On success The company type (related with Data Source) MANUFACTURER, REPORTING_BODY
result.data[].collection object On success The Material collection (ex: winter collection) A collection object
result.data[].collection.name string On success The collection name Any string
result.data[].libraries[] array of object On success The list of libraries for the material Library object(s)
result.data[].libraries[].originId string On success The library unique origin ID A UUID
result.data[].libraries[].name string On success The library name Any string
result.data[].category object On success The category for the material A Category object
result.data[].category.name string On success The category name data[].name in CategoriesLookup
result.data[].category.code string On success The category code data[].code in CategoriesLookup
result.data[].csiDivisions[] array of object On success The CSI Divisions for the material CsiDivision object(s)
result.data[].csiDivisions[].code string On success The CSI Division code data[].code in CsiDivisionsLookup
result.data[].csiDivisions[].name string On success The CSI Division name data[].name in CsiDivisionsLookup
result.data[].images[] array On success The list of images for the material Array of image
result.data[].images[].originalUrl string On success The original image URL A public facing URL
result.data[].images[].referenceUrl string On success The image URL A public facing URL
result.data[].additionalsDocuments[] array of object On success The list of document for the material Document object(s)
result.data[].additionalsDocuments[].originalUrl string On success The original URL of a document related to the material A valid public facing URL
result.data[].additionalsDocuments[].referenceUrl string On success URL of a document related to the material A valid public facing URL
result.data[].contacts[] array of object On success The related contacts Contact object(s)
result.data[].contacts[].externalId string On success A unique identifier of your choosing that serves as a unique key for the contact Any string
result.data[].contacts[].type string On success The contact type MANUFACTURER, AUDITOR or VENDOR
result.data[].contacts[].companyName string On success The contact company name Any string
result.data[].contacts[].name string On success The contact name Any string
result.data[].contacts[].website string On success The contact website A valid public facing URL
result.data[].contacts[].postalAddress string On success The contact postal address Any string
result.data[].contacts[].phone string On success The contact phone Any string
result.data[].contacts[].email string On success The contact email A valid email
result.data[].contacts[].location object On success The contact location Location object
result.data[].contacts[].location.city string On success The contact location city Any string
result.data[].contacts[].location.region string On success The contact location region Any string
result.data[].contacts[].location.country string On success The contact location country Any string
result.data[].featuresCustoms[] array of object On success The Custom features for the material Custom feature object(s)
result.data[].featuresCustoms[].originId string On success The custom feature unique origin ID A UUID
result.data[].featuresCustoms[].name string On success The custom feature name Any string
result.data[].featuresCustoms[].code string On success The custom feature property code data[].code prefixed with CUSTOM in PropertiesLookup
result.data[].featuresCustoms[].value object On success The custom feature value Value object
result.data[].featuresCustoms[].value.code string On success The custom feature value reference code possibleValues[].code in PropertyDetailsLookup
result.data[].featuresCustoms[].value.content string On success The custom feature value content Any string
result.data[].featuresProperties[] array of object On success The feature properties for the material Feature property object(s)
result.data[].featuresProperties[].originId string On success The property feature unique origin ID A UUID
result.data[].featuresProperties[].code string On success The property feature code data[].code NOT prefixed with CUSTOM in PropertiesLookup
result.data[].featuresProperties[].name string On success The property feature name data[].name in PropertiesLookup
result.data[].featuresProperties[].value object On success The property feature value Value object
result.data[].featuresProperties[].value.code string On success The property feature value reference code possibleValues[].code in PropertyDetailsLookup
result.data[].featuresProperties[].value.content string On success The property feature value content Any string
result.data[].featuresProperties[].unit string On success The property feature unit Unit object
result.data[].featuresProperties[].unit.code string On success The property feature unit code possibleUnits[].code in PropertyDetailsLookup
result.data[].featuresProperties[].unit.name string On success The property feature unit name possibleUnits[].name in PropertyDetailsLookup
result.data[].tags[] array of object On success The list of tags for the material Tag object(s)
result.data[].tags[].name string On success The tag name Any string
result.data[].skus[] array of object On success The list of SKUs for the material Sku object(s)
result.data[].skus[].name string On success The SKU name Any string
result.data[].skus[].productId string On success An identification code (ex: a catalog id, SKU code) Any string
result.data[].skus[].images[] array of object On success The list of images for the SKU Image object(s)
result.data[].skus[].images[].originalUrl string On success URL of an image related to the SKU A valid public facing URL
result.data[].skus[].images[].referenceUrl string On success URL of an image related to the SKU A valid public facing URL
result.data[].skus[].additionalsDocuments[] array of object On success The list of document for the SKU Document object(s)
result.data[].skus[].additionalsDocuments[].originalUrl string On success URL of a document related to the SKU A valid public facing URL
result.data[].skus[].additionalsDocuments[].referenceUrl string On success URL of a document related to the SKU A valid public facing URL
result.data[].skus[].featuresCustoms[] array of object On success The Custom features for the sku Custom feature object(s)
result.data[].skus[].featuresCustoms[].originId string On success The custom feature unique origin ID A UUID
result.data[].skus[].featuresCustoms[].name string On success The custom feature name Any string
result.data[].skus[].featuresCustoms[].code string On success The custom feature property code data[].code prefixed with CUSTOM in PropertiesLookup
result.data[].skus[].featuresCustoms[].value object On success The custom feature value Value object
result.data[].skus[].featuresCustoms[].value.code string On success The custom feature value reference code possibleValues[].code in PropertyDetailsLookup
result.data[].skus[].featuresCustoms[].value.content string On success The custom feature value content Any string
result.data[].skus[].featuresProperties[] array of object On success The feature properties for the sku Feature property object(s)
result.data[].skus[].featuresProperties[].originId string On success The property feature unique origin ID A UUID
result.data[].skus[].featuresProperties[].code string On success The property feature code data[].code NOT prefixed with CUSTOM in PropertiesLookup
result.data[].skus[].featuresProperties[].name string On success The property feature name data[].name in PropertiesLookup
result.data[].skus[].featuresProperties[].value object On success The property feature value Value object
result.data[].skus[].featuresProperties[].value.code string On success The property feature value reference code possibleValues[].code in PropertyDetailsLookup
result.data[].skus[].featuresProperties[].value.content string On success The property feature value content Any string
result.data[].skus[].featuresProperties[].unit string On success The property feature unit Unit object
result.data[].skus[].featuresProperties[].unit.code string On success The property feature unit code possibleUnits[].code in PropertyDetailsLookup
result.data[].skus[].featuresProperties[].unit.name string On success The property feature unit name possibleUnits[].name in PropertyDetailsLookup
result.data[].connectedCertifications[] array of object On success The list of certifications connected to the material Certification object(s)
result.data[].connectedCertifications[].originId string On success The certification unique origin ID Any string
result.data[].connectedDeclarations[] array of object On success The list of declarations connected to the material Declaration object(s)
result.data[].connectedDeclarations[].originId string On success The declaration unique origin ID Any string
result.data[].connectedTestReports[] array of object On success The list of test reports connected to the material Declaration object(s)
result.data[].connectedTestReports[].originId string On success The test report unique origin ID Any string
result.data[].url string On success The material URL A public facing URL
result.data[].originUrl string On success The link to the material in the Origin Data hub A public facing URL
result.data[].materialSample string On success The material sample for the material MaterialSample object
result.data[].materialSample.originId string On success The material sample originId A UUID
result.data[].materialSample.sampleUrl string On success The link to the material sample A public facing URL
result.data[].materialFilterScores[] Array of object If the material has any material filter score The list of material filter scores for the material MaterialFilterScore object(s)
result.data[].materialFilterScores[].score object On success The score Score object
result.data[].materialFilterScores[].score.scorePercentage string On success The score writen in percentage form (i.e "50") Any string
result.data[].materialFilterScores[].score.scoreFractional string On success The score writen in fractional form (i.e "24/48") Any string
result.data[].materialFilterScores[].score.status string On success The score status 'READY' or 'TO_RECOMPUTE'
result.data[].materialFilterScores[].materialFilter object On success The material filter MaterialFilter object
result.data[].materialFilterScores[].materialFilter.originId string On success The material filter unique origin ID A UUID
result.data[].materialFilterScores[].materialFilter.name string On success The material filter name Any string
result.data[].materialFilterScores[].materialFilter.description string On success The material filter description Any string
result.data[].materialFilterScores[].materialFilter.minimalScore string On success The material filter minimal score Any string
result.data[].materialFilterScores[].materialFilter.maximalScore string On success The material filter maximal score Any string
connectRequest object Always The exact request sent that produced this response A MaterialsSearch request

  • Sample Response (Success):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"MATERIAL",
    "searchInfo":{
      "numberOfElements":"1",
      "numberOfPages":"1"
    },
    "data":[
      {
        "locale":"en",
        "originId":"93bcbf18-51fb-11e8-8716-8c16451835eb",
        "externalId":"00006060-8ebf-4a0f-94a5-de7c949a1a28",
        "productId":"refcode001",
        "managementPermission":"COMPANY_READONLY",
        "name":"XYZ Modular",
        "description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut tincidunt orci eget lacus dignissim bibendum.",
        "contentManagedBy":"John Smith",
        "lastUpdated":"2018-11-06T13:20:30Z",
        "brand":{
          "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
          "name":"XYZ Modular Furniture",
          "website":"https://www.xyzmodfurniture.tld"
        },
        "logoUrl":{
          "originalUrl":"https://www.xyzmodfurniture.tld/public/img/xyzmod/XYZ-asset-image-0-4444.jpeg",
          "referenceUrl":"https://origin.build/equinox/storage/public/XYZ-asset-image-0-4444.jpeg"
        },
        "company":{
          "originId":"101dd127-90d0-4123-9981-37998ceaa317",
          "name":"GIGA",
          "companyType":"MANUFACTURER"
        },
        "collection":{
          "name":"My fall collection"
        },
        "libraries":[
          {
            "originId":"c254638f-1fde-4ca8-ae1f-8fb5abbfe8dd",
            "name":"My library"
          }
        ],
        "category":{
          "name":"Seating",
          "code": "gc_3"
        },
        "csiDivisions":[
          {
            "code":"12 58 29",
            "name":"Beds"
          }
        ],
        "images":[
          {
            "originalUrl":"https://www.xyzmodfurniture.tld/public/img/xyzmod/XYZ-asset-image-0-4444.jpeg",
            "referenceUrl":"https://origin.build/equinox/storage/public/XYZ-asset-image-0-4444.jpeg"
          }
        ],
        "additionalsDocuments":[
          {
            "originalUrl":"https://www.xyzmodfurniture.tld/public/doc/xyzmod/xyzmod001.txt",
            "referenceUrl":"https://origin.build/equinox/storage/public/xyzmod001.txt"
          },
          {
            "originalUrl":"https://www.xyzmodfurniture.tld/public/doc/xyzmod/xyzmod002.txt",
            "referenceUrl":"https://origin.build/equinox/storage/public/xyzmod002.txt"
          }
        ],
        "contacts":[
          {
            "externalId":"JOHNSMITHVENDOR1",
            "type":"VENDOR",
            "name":"John Smith",
            "companyName":"ACME Inc.",
            "website":"https://www.acme.com/",
            "postalAddress":"2500 Street Avenues",
            "phone":"1-999-123-1234",
            "email":"salesrep@acme.com",
            "location": {
              "city": "Aix-en-Provence",
              "region": "Provence-Alpes-Côte d'Azur",
              "country": "France"
            }
          }
        ],
        "featuresCustoms":[
          {
            "originId":"ff4170d9-2ed0-4bec-b2c9-8585b21963c0",
            "code":"CUSTOM_TEXT_ATTRIBUTE",
            "name":"Supported temperature",
            "value":{
              "content":"1550C"
            }
          },
          {
            "originId":"0507108d-521d-4199-ae5e-2a049797af4f",
            "code":"CUSTOM_NUMERIC_ATTRIBUTE",
            "name":"Rank",
            "value":{
              "content":"28"
            }
          },
          {
            "originId":"9a68f134-825d-45ec-a740-64197b1ce07b",
            "code":"CUSTOM_DATE_ATTRIBUTE",
            "name":"Date of production",
            "value":{
              "content":"2010-10-20"
            }
          },
          {
            "originId":"5ba5a531-a4a6-4c02-9973-cce60182fbc5",
            "code":"CUSTOM_COLOR_ATTRIBUTE",
            "name":"Table top color",
            "value":{
              "code":"RED#ff0000",
              "content":"Cherry red"
            }
          }
        ],
        "featuresProperties":[
          {
            "originId":"1372d906-c44b-43d2-a418-d9da81bcb15b",
            "code":"IDEALPROJECTS",
            "name":"Ideal Projects",
            "value":{
              "code":"COMMERCIAL",
              "name":"Commercial"
            }
          },
          {
            "originId":"5ce86441-cbcd-47f8-a4cc-b197f3256b9e",
            "code":"IDEALPROJECTS",
            "name": "Ideal Projects",
            "value":{
              "code":"RESIDENTIAL",
              "name":"Residential"
            }
          },
          {
            "originId":"3ddd8147-d668-404a-a09a-d9c9a5a2a59d",
            "code":"LENGTH",
            "name":"Length",
            "value":{
              "content":"120"
            },
            "unit":{
              "code":"CENTIMETER",
              "name":"cm"
            }
          },
          {
            "originId":"45f19ffc-660b-4444-9857-fda91d262a92",
            "code":"AVAILABILITY",
            "name":"Regional Availability",
            "value":{
              "code":"ASIA",
              "content":"Asia"
            }
          },
          {
            "originId":"599a2acd-0340-4d9b-a8da-df0e87866a1b",
            "code":"WARRANTY",
            "name":"Warranty",
            "value":{
              "content":"3"
            },
            "unit":{
              "code":"YEAR",
              "name": "Years"
            }
          },
          {
            "originId":"dff1eb6f-6274-49b7-9e60-599c00e1efba",
            "code":"FIRERATING",
            "name":"Fire Rating",
            "value":{
              "content":"A1"
            }
          }
        ],
        "tags":[
          {
            "name":"xyz"
          }
        ],
        "skus":[
          {
            "originId":"b99020d1-6924-42aa-9f7a-7534848d210d",
            "name":"My Sku",
            "productId":"MY-SKU-001",
            "images":[
              {
                "originalUrl":"https://public.facing.url/image.jpg",
                "referenceUrl":"https://public.facing.url/image.jpg"
              }
            ],
            "additionalsDocuments":[
              {
                "originalUrl":"https://public.facing.url/document.pdf",
                "referenceUrl":"https://public.facing.url/image.jpg"
              }
            ],
            "featuresCustoms":[
              {
                "originId":"cab4f3ec-7fdc-42ec-8fa2-10e44f24c971",
                "code":"CUSTOM_NUMERIC_ATTRIBUTE",
                "name":"Rank",
                "value":{
                  "content":"42"
                }
              },
              {
                "originId":"17f7a609-0ba9-4041-8a50-6c8974ebb1e9",
                "code":"CUSTOM_TEXT_ATTRIBUTE",
                "name":"Supported temperature",
                "value":{
                  "content":"1550C"
                }
              },
              {
                "originId":"062da43b-a7ad-491b-848c-2c614854878b",
                "code":"CUSTOM_COLOR_ATTRIBUTE",
                "name":"Table top color",
                "value":{
                  "code":"AZURE#007fff",
                  "content":"Summer sky"
                }
              },
              {
                "originId":"1639cbd5-8c4c-4e09-a1e7-966fe1c5cb7f",
                "code":"CUSTOM_DATE_ATTRIBUTE",
                "name":"Date of production",
                "value":{
                  "content":"2010-10-20T04:00:00Z"
                }
              }
            ],
            "featuresProperties":[
              {
                "originId":"c3156ab2-f3ee-4d8f-a323-a216a400ea5d",
                "code":"FIRERATING",
                "name":"Fire Rating",
                "value":{
                  "content":"A2"
                }
              },
              {
                "originId":"1a3c5e8e-a36d-4bae-981e-4e166acb1b68",
                "code":"WARRANTY",
                "name":"Warranty",
                "value":{
                  "content":"1"
                },
                "unit":{
                  "code":"YEAR",
                  "name":"Years"
                }
              },
              {
                "originId":"ff9acdaf-49e0-4f31-8193-d998191c56c0",
                "code":"LENGTH",
                "name":"Length",
                "value":{
                  "content":"600"
                },
                "unit":{
                  "code":"MILLIMETER",
                  "name":"mm"
                }
              },
              {
                "originId":"a89b2782-fbd0-41b6-817a-6625521a69bb",
                "code":"LENGTH",
                "name":"Length",
                "value":{
                  "content":"1200"
                },
                "unit":{
                  "code":"MILLIMETER",
                  "name":"mm"
                }
              },
              {
                "originId":"a89b2782-fbd0-41b6-817a-6625521a69bb",
                "code":"MATERIAL_TYPE",
                "name":"Material Composition",
                "value":{
                  "code":"GLASS",
                  "content":"Glass"
                }
              },
              {
                "originId":"51a63aa7-8f61-4b51-93b2-cbe9bec7246e",
                "code":"AVAILABILITY",
                "name":"Regional Availability",
                "value":{
                  "code":"ASIA",
                  "content":"Asia"
                }
              },
              {
                "originId":"a62ec10d-701a-45cd-9afe-af93c90425b0",
                "code":"AVAILABILITY",
                "name":"Regional Availability",
                "value":{
                  "code":"EUROPE",
                  "content":"Europe"
                }
              }
            ]
          }
        ],
        "connectedCertifications":[
          {
            "originId":"6e7bcbfe-4d82-42ad-aa62-6c8d9b142a73"
          },
          {
            "originId":"a78a0a24-5829-4723-bde6-0ccf565a6f3c"
          },
          {
            "originId":"e7917326-1055-460a-8118-1bc0c48121bd"
          }
        ],
        "connectedDeclarations":[
          {
            "originId":"4184443c-0c0d-405c-9a5e-125256b62afe"
          },
          {
            "originId":"5d29b08c-2174-499a-a752-463a9c60d9bf"
          }
        ],
        "connectedTestReports":[
          {
            "originId":"71072fb6-6616-4658-b440-beeac537a97b"
          }
        ],
        "url":"https://www.xyzmodfurniture.tld/xyzmod.html",
        "originUrl":"https://origin.build/#/material/93bcbf18-51fb-11e8-8716-8c16451835eb?locale=en",
        "materialSample": {
          "originId": "3acb009c-8be0-4557-aef2-c01e79116caf",
          "sampleUrl": "https://material-sample.tld/xyz-modular"
        },
        "materialFilterScores": [
          {
            "score": {
              "scorePercentage": "90",
              "scoreFractional": "359/400",
              "status": "READY"
            },
            "materialFilter": {
              "originId": "216fe576-9324-4e11-a68c-d673644c05a6",
              "name": "My Material filter",
              "description": "A description for My Material filter",
              "minimalScore": "0",
              "maximalScore": "400"
            }
          }
        ]
      }
    ]
  },
  "connectRequest":{
    "locale":"en",
    "pageNumber":"1",
    "pageSize":"100",
    "searchCriteria":[
      {
        "name":"ORIGINID",
        "value":"93bcbf18-51fb-11e8-8716-8c16451835eb"
      }
    ]
  }
}

  • Sample Response (Error):

    HTTP Code : 400, 500

{
    "status": {
        "state": "ERROR",
        "code": "CE00001 - Connect request failed validation. Refer to provided messages for details.",
        "messages": [
            "Request has invalid value '0' for field pageNumber. Allowed value(s) : [positive integer not equal zero]",
            "searchCriteria[1] has invalid value 'ORIGIN_IDENT' for field name. Allowed value(s) : [COMPANYID,LIBRARYID,KEYWORD,EXTERNALID,ORIGINID,MODIFIEDSINCE]"
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "0",
        "pageSize": "1",
        "searchCriteria": [
            {
                "name": "ORIGIN_IDENT",
                "value": "93bcbf18-51fb-11e8-8716-8c16451835eb"
            }
        ]
    }
}

results matching ""

    No results matching ""