EN
Español
English
Português
    Get Catalog Values, List, and Tree

    Petition Details

    • URL Base: {host}/ASMSAPI/
    • URI: /api/v9/catalog/type={type}
    • Guy:GET

    • Required Headers:

    • content-type: application/json
    • X-Authorization: Bearer {token}

    ## URL Description

    • {host}: It represents the domain of the environment in which the API is located.
    • ASMSAPI/: Fixed API prefix.
    • URI: Specific endpoint for the request.


    ⚐ EXAMPLE URL:

    https://{host}/ASMSAPI/api/v9/catalog/type=0
https://{host}/ASMSAPI/api/v9/catalog/type=1
https://{host}/ASMSAPI/api/v9/catalog/type=2


    Parameters

    Name Data type Obligatory Description
    type Number Yes Value: 0 shows the tree and list catalogs
    Value: 1 Shows Catalog List
    Value: 2 Show Tree Catalog
    ParentId Number NO  

    Body of the petition

    {
  "Value": "Colombia",
  "ParentId": "217122"
}

    Answer

    {
  "totalItems": 3,
  "content": [
    {
      "description": "",
      "id": 12,
      "isBuiltIn": true,
      "name": "BRAND",
      "parentId": null,
      "status": 1,
      "type": "N"
    },
    {
      "description": "Descripción del segundo elemento",
      "id": 13,
      "isBuiltIn": false,
      "name": "CATEGORY",
      "parentId": 12,
      "status": 1,
      "type": "T"
    },
    {
      "description": "Otro elemento de ejemplo",
      "id": 14,
      "isBuiltIn": false,
      "name": "PRODUCT",
      "parentId": null,
      "status": 1,
      "type": "N"
    }
  ]
}

    Response Parameters

    Name Data type Description
    result Boolean Indicates whether the operation was successful

    Error Messages

    Code HTTP status Error Message
    403 Unauthorized DoNotHavePermissionForThisAction
    400 Bad Request FailureAddCatalogValue