v1 > Lookups > CategoriesLookup

Lookup Origin categories.

  • URL

    /connect/v1/categories

  • Method:

    GET

  • URL Params

Param 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

  • Sample URL

    /connect/v1/categories?locale=en&pageNumber=1&pageSize=10

  • Request :

    The request has no body.

  • 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 errors 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 'CATEGORY'
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 categories Array of category object
result.data[].locale string On success An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
result.data[].name string On success The name of this category A string
result.data[].code string On success The unique category code A string

  • Sample Response (Success):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"CATEGORY",
    "searchInfo":{
      "numberOfElements":"2",
      "numberOfPages":"1"
    },
    "data":[
      {
        "locale":"en",
        "name": "Wood",
        "code": "WOOD"
      },
      {
        "locale":"en",
        "name": "Wallcoverings",
        "code": "WALLCOVERING"
      }
    ]
  },
  "connectRequest":{
    "locale":"en"
  }
}

  • 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 'es' for field locale. Allowed value(s) : [de, es_MX, en, fr, zh_CN]"
        ]
    },
    "connectRequest": {
        "locale": "es"
    }
}

results matching ""

    No results matching ""