Category

collapse allexpand all

{
  "id": "MLM3239",
  "name": "Otros",
  "picture": null,
  "permalink": null,
  "total_items_in_this_category": 25872,
  "path_from_root": [
    {
      "id": "MLM1574",
      "name": "Hogar, Muebles y Jardín"
    },
    {
      "id": "MLM436380",
      "name": "Muebles para el Hogar"
    },
    {
      "id": "MLM3236",
      "name": "Muebles para Salas"
    },
    {
      "id": "MLM3239",
      "name": "Otros"
    }
  ],
  "children_categories": [
  ],
  "attribute_types": "attributes",
  "settings": {
    "adult_content": false,
    "buying_allowed": true,
    "buying_modes": [
      "auction",
      "buy_it_now"
    ],
    "catalog_domain": "MLM-HOME_FURNITURE",
    "coverage_areas": "not_allowed",
    "currencies": [
      "MXN",
      "USD"
    ],
    "fragile": false,
    "immediate_payment": "required",
    "item_conditions": [
      "new",
      "used",
      "not_specified"
    ],
    "items_reviews_allowed": false,
    "listing_allowed": true,
    "max_description_length": 50000,
    "max_pictures_per_item": 12,
    "max_pictures_per_item_var": 10,
    "max_sub_title_length": 70,
    "max_title_length": 120,
    "maximum_price": null,
    "minimum_price": null,
    "mirror_category": null,
    "mirror_master_category": null,
    "mirror_slave_categories": [
    ],
    "price": "required",
    "reservation_allowed": "not_allowed",
    "restrictions": [
    ],
    "rounded_address": false,
    "seller_contact": "not_allowed",
    "shipping_modes": [
      "not_specified",
      "me1",
      "custom"
    ],
    "shipping_options": [
      "custom",
      "carrier"
    ],
    "shipping_profile": "optional",
    "show_contact_information": false,
    "simple_shipping": "optional",
    "stock": "required",
    "sub_vertical": null,
    "subscribable": false,
    "tags": [
      "others"
    ],
    "vertical": null,
    "vip_subdomain": "articulo"
  },
  "meta_categ_id": null,
  "attributable": false
}

Allowed methods

Retrieves information of a category and its configuration.

GET

/categories/:id

Attributes

attribute_types

Possible values: variations|attributes|none

children_categories

List of subcategories that depends on this category

id

ID

name

Name of the category

path_from_root

Path of categories from this level up to the root category

permalink

PermaLink

picture

Category picture url

settings

Configuration for this category.

Attributes

adult_content

Indicate if this category contains adult content

buying_allowed

Indicate if it is possible to buy an item that belongs to this category

buying_modes

Buying modes allowed in this category

Attributes

auction

Auction

buy_it_now

Buy it now

classified

Classified

coverage_areas

Indicates if it is possible to set coverage areas for the items that belong to this category

Attributes

not_allowed

Not allowed

optional

Optional

immediate_payment

Indicates if online payment is mandatory for the items that belong to this category

item_conditions

Item conditions allowed for items that belongs to this category

Attributes

new

New

not_especified

Not specified

used

Used

item_reviews_allowed

Indicates if reviews can be made for items that belong to this category

listing_allowed

Indicates if items can be listed in this category

max_pictures_per_item

Maximum number of pictures that can have an item listed in this category

max_pictures_per_item_var

Maximum number of pictures per variation that can have an item listed in this category. This setting overrides max_pictures_per_item

mirror_category

Indicates if there is a mirror category for this category

mirror_master_category

Indicates which is the mirror master category of this mirror slave category. Mirror categories are equivalent categories, with the same configurations, structure and items. Mirror master categories are the ones that receive changes in their configurations.

mirror_slave_categories

Indicates which are the mirror slave categories of this mirror master category. Mirror categories are equivalent categories, with the same configurations, structure and items. Mirror slave categories are copies of a mirror master category in other category trees.

price

Indicates if price is mandatory for the items that belong to this category

Attributes

optional

Optional

required

Required

seller_contact

Indicates if seller contact information is mandatory for the items that belong to this category

Attributes

now_allowed

Not allowed

optional

Optional

required

Required

shipping_modes

Shipping modes available for items that belong to this category

Attributes

carrier

me2

custom

not_especified

shipping_options

Shipping options available for items that belong to this category

Attributes

carrier

Set by carrier

custom

Set by seller

shipping_profile

Indicates if items that belong to this category have a shipping profile associated

Attributes

now_allowed

Not allowed

optional

Optional

show_contact_information

Indicates if seller contact information must be shown for items that belong to this category

simple_shipping

Indicates if the seller can add shipping information for posible locations

Attributes

now_allowed

Not allowed

optional

Optional

stock

Indicates if items that belong to this category can handle stock

Attributes

optional

Optional

required

Required

tags

Tags for this category

vip_subdomain

Subdomain for this category

total_items_in_this_category

Number of active items listed in this category or in one of his subcategories

Related resources

attributes

categories

shipping