GET products

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of NopProductEx

Name	Type	Additional information
id	integer	None.
visible_individually	boolean	None.
name	string	None.
localized_names	Collection of NameLocalizedNameEx	None.
short_description	string	None.
full_description	string	None.
show_on_home_page	boolean	None.
meta_keywords	string	None.
sku	string	None.
price	decimal number	None.
old_price	decimal number	None.
product_cost	decimal number	None.
special_price	decimal number	None.
meta_description	string	None.
meta_title	string	None.
gtin	string	None.
published	boolean	None.
order_minimum_quantity	integer	None.
order_maximum_quantity	integer	None.
baseprice_amount	decimal number	None.
BasepriceUnitId	integer	None.
baseprice_base_amount	decimal number	None.
weight	decimal number	None.
attributes	Collection of NopProductAttributesEX	None.
images	Collection of NopProductImageEx	None.
product_specification_attributes	Collection of NopProductSpecificationAttributeEx	None.
url	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "visible_individually": true,
    "name": "sample string 3",
    "localized_names": [
      {
        "language_id": 1,
        "localized_name": "sample string 2"
      },
      {
        "language_id": 1,
        "localized_name": "sample string 2"
      }
    ],
    "short_description": "sample string 4",
    "full_description": "sample string 5",
    "show_on_home_page": true,
    "meta_keywords": "sample string 6",
    "sku": "sample string 7",
    "price": 8.0,
    "old_price": 9.0,
    "product_cost": 10.0,
    "special_price": 1.0,
    "meta_description": "sample string 11",
    "meta_title": "sample string 12",
    "gtin": "sample string 13",
    "published": true,
    "order_minimum_quantity": 1,
    "order_maximum_quantity": 1,
    "baseprice_amount": 1.0,
    "BasepriceUnitId": 14,
    "baseprice_base_amount": 1.0,
    "weight": 1.0,
    "attributes": [
      {
        "guid": "sample string 1",
        "id": 2,
        "product_attribute_id": 3,
        "product_attribute_name": "sample string 4",
        "text_prompt": "sample string 5",
        "is_required": true,
        "attribute_control_type_id": 7,
        "display_order": 8,
        "default_value": "sample string 9",
        "attribute_control_type_name": "sample string 10",
        "attribute_values": [
          {
            "id": 1,
            "type_id": 2,
            "associated_product_id": 1,
            "name": "sample string 3",
            "color_squares_rgb": "sample string 4",
            "price_adjustment": 1.0,
            "weight_adjustment": 1.0,
            "cost": 1.0,
            "quantity": 1,
            "is_pre_selected": true,
            "display_order": 1,
            "product_image_id": 1
          },
          {
            "id": 1,
            "type_id": 2,
            "associated_product_id": 1,
            "name": "sample string 3",
            "color_squares_rgb": "sample string 4",
            "price_adjustment": 1.0,
            "weight_adjustment": 1.0,
            "cost": 1.0,
            "quantity": 1,
            "is_pre_selected": true,
            "display_order": 1,
            "product_image_id": 1
          }
        ]
      },
      {
        "guid": "sample string 1",
        "id": 2,
        "product_attribute_id": 3,
        "product_attribute_name": "sample string 4",
        "text_prompt": "sample string 5",
        "is_required": true,
        "attribute_control_type_id": 7,
        "display_order": 8,
        "default_value": "sample string 9",
        "attribute_control_type_name": "sample string 10",
        "attribute_values": [
          {
            "id": 1,
            "type_id": 2,
            "associated_product_id": 1,
            "name": "sample string 3",
            "color_squares_rgb": "sample string 4",
            "price_adjustment": 1.0,
            "weight_adjustment": 1.0,
            "cost": 1.0,
            "quantity": 1,
            "is_pre_selected": true,
            "display_order": 1,
            "product_image_id": 1
          },
          {
            "id": 1,
            "type_id": 2,
            "associated_product_id": 1,
            "name": "sample string 3",
            "color_squares_rgb": "sample string 4",
            "price_adjustment": 1.0,
            "weight_adjustment": 1.0,
            "cost": 1.0,
            "quantity": 1,
            "is_pre_selected": true,
            "display_order": 1,
            "product_image_id": 1
          }
        ]
      }
    ],
    "images": [
      {
        "src": "sample string 1",
        "attachment": "sample string 2",
        "se_name": "sample string 3",
        "seofilename": "sample string 4"
      },
      {
        "src": "sample string 1",
        "attachment": "sample string 2",
        "se_name": "sample string 3",
        "seofilename": "sample string 4"
      }
    ],
    "product_specification_attributes": [
      {
        "id": 1,
        "product_id": 2,
        "attribute_type_id": 3,
        "specification_attribute_option_id": 4,
        "custom_value": "sample string 5",
        "allow_filtering": true,
        "show_on_product_page": true,
        "display_order": 8,
        "attribute_type": "sample string 9"
      },
      {
        "id": 1,
        "product_id": 2,
        "attribute_type_id": 3,
        "specification_attribute_option_id": 4,
        "custom_value": "sample string 5",
        "allow_filtering": true,
        "show_on_product_page": true,
        "display_order": 8,
        "attribute_type": "sample string 9"
      }
    ],
    "url": "sample string 15"
  },
  {
    "id": 1,
    "visible_individually": true,
    "name": "sample string 3",
    "localized_names": [
      {
        "language_id": 1,
        "localized_name": "sample string 2"
      },
      {
        "language_id": 1,
        "localized_name": "sample string 2"
      }
    ],
    "short_description": "sample string 4",
    "full_description": "sample string 5",
    "show_on_home_page": true,
    "meta_keywords": "sample string 6",
    "sku": "sample string 7",
    "price": 8.0,
    "old_price": 9.0,
    "product_cost": 10.0,
    "special_price": 1.0,
    "meta_description": "sample string 11",
    "meta_title": "sample string 12",
    "gtin": "sample string 13",
    "published": true,
    "order_minimum_quantity": 1,
    "order_maximum_quantity": 1,
    "baseprice_amount": 1.0,
    "BasepriceUnitId": 14,
    "baseprice_base_amount": 1.0,
    "weight": 1.0,
    "attributes": [
      {
        "guid": "sample string 1",
        "id": 2,
        "product_attribute_id": 3,
        "product_attribute_name": "sample string 4",
        "text_prompt": "sample string 5",
        "is_required": true,
        "attribute_control_type_id": 7,
        "display_order": 8,
        "default_value": "sample string 9",
        "attribute_control_type_name": "sample string 10",
        "attribute_values": [
          {
            "id": 1,
            "type_id": 2,
            "associated_product_id": 1,
            "name": "sample string 3",
            "color_squares_rgb": "sample string 4",
            "price_adjustment": 1.0,
            "weight_adjustment": 1.0,
            "cost": 1.0,
            "quantity": 1,
            "is_pre_selected": true,
            "display_order": 1,
            "product_image_id": 1
          },
          {
            "id": 1,
            "type_id": 2,
            "associated_product_id": 1,
            "name": "sample string 3",
            "color_squares_rgb": "sample string 4",
            "price_adjustment": 1.0,
            "weight_adjustment": 1.0,
            "cost": 1.0,
            "quantity": 1,
            "is_pre_selected": true,
            "display_order": 1,
            "product_image_id": 1
          }
        ]
      },
      {
        "guid": "sample string 1",
        "id": 2,
        "product_attribute_id": 3,
        "product_attribute_name": "sample string 4",
        "text_prompt": "sample string 5",
        "is_required": true,
        "attribute_control_type_id": 7,
        "display_order": 8,
        "default_value": "sample string 9",
        "attribute_control_type_name": "sample string 10",
        "attribute_values": [
          {
            "id": 1,
            "type_id": 2,
            "associated_product_id": 1,
            "name": "sample string 3",
            "color_squares_rgb": "sample string 4",
            "price_adjustment": 1.0,
            "weight_adjustment": 1.0,
            "cost": 1.0,
            "quantity": 1,
            "is_pre_selected": true,
            "display_order": 1,
            "product_image_id": 1
          },
          {
            "id": 1,
            "type_id": 2,
            "associated_product_id": 1,
            "name": "sample string 3",
            "color_squares_rgb": "sample string 4",
            "price_adjustment": 1.0,
            "weight_adjustment": 1.0,
            "cost": 1.0,
            "quantity": 1,
            "is_pre_selected": true,
            "display_order": 1,
            "product_image_id": 1
          }
        ]
      }
    ],
    "images": [
      {
        "src": "sample string 1",
        "attachment": "sample string 2",
        "se_name": "sample string 3",
        "seofilename": "sample string 4"
      },
      {
        "src": "sample string 1",
        "attachment": "sample string 2",
        "se_name": "sample string 3",
        "seofilename": "sample string 4"
      }
    ],
    "product_specification_attributes": [
      {
        "id": 1,
        "product_id": 2,
        "attribute_type_id": 3,
        "specification_attribute_option_id": 4,
        "custom_value": "sample string 5",
        "allow_filtering": true,
        "show_on_product_page": true,
        "display_order": 8,
        "attribute_type": "sample string 9"
      },
      {
        "id": 1,
        "product_id": 2,
        "attribute_type_id": 3,
        "specification_attribute_option_id": 4,
        "custom_value": "sample string 5",
        "allow_filtering": true,
        "show_on_product_page": true,
        "display_order": 8,
        "attribute_type": "sample string 9"
      }
    ],
    "url": "sample string 15"
  }
]

application/xml, text/xml

Sample:

<ArrayOfNopProductEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EliteWeb.NopCommerce.Common">
  <NopProductEx>
    <BasepriceUnitId>14</BasepriceUnitId>
    <attributes>
      <NopProductAttributesEX>
        <attribute_control_type_id>7</attribute_control_type_id>
        <attribute_control_type_name>sample string 10</attribute_control_type_name>
        <attribute_values>
          <NopAttributeValueEx>
            <associated_product_id>1</associated_product_id>
            <color_squares_rgb>sample string 4</color_squares_rgb>
            <cost>1</cost>
            <display_order>1</display_order>
            <id>1</id>
            <is_pre_selected>true</is_pre_selected>
            <name>sample string 3</name>
            <price_adjustment>1</price_adjustment>
            <product_image_id>1</product_image_id>
            <quantity>1</quantity>
            <type_id>2</type_id>
            <weight_adjustment>1</weight_adjustment>
          </NopAttributeValueEx>
          <NopAttributeValueEx>
            <associated_product_id>1</associated_product_id>
            <color_squares_rgb>sample string 4</color_squares_rgb>
            <cost>1</cost>
            <display_order>1</display_order>
            <id>1</id>
            <is_pre_selected>true</is_pre_selected>
            <name>sample string 3</name>
            <price_adjustment>1</price_adjustment>
            <product_image_id>1</product_image_id>
            <quantity>1</quantity>
            <type_id>2</type_id>
            <weight_adjustment>1</weight_adjustment>
          </NopAttributeValueEx>
        </attribute_values>
        <default_value>sample string 9</default_value>
        <display_order>8</display_order>
        <guid>sample string 1</guid>
        <id>2</id>
        <is_required>true</is_required>
        <product_attribute_id>3</product_attribute_id>
        <product_attribute_name>sample string 4</product_attribute_name>
        <text_prompt>sample string 5</text_prompt>
      </NopProductAttributesEX>
      <NopProductAttributesEX>
        <attribute_control_type_id>7</attribute_control_type_id>
        <attribute_control_type_name>sample string 10</attribute_control_type_name>
        <attribute_values>
          <NopAttributeValueEx>
            <associated_product_id>1</associated_product_id>
            <color_squares_rgb>sample string 4</color_squares_rgb>
            <cost>1</cost>
            <display_order>1</display_order>
            <id>1</id>
            <is_pre_selected>true</is_pre_selected>
            <name>sample string 3</name>
            <price_adjustment>1</price_adjustment>
            <product_image_id>1</product_image_id>
            <quantity>1</quantity>
            <type_id>2</type_id>
            <weight_adjustment>1</weight_adjustment>
          </NopAttributeValueEx>
          <NopAttributeValueEx>
            <associated_product_id>1</associated_product_id>
            <color_squares_rgb>sample string 4</color_squares_rgb>
            <cost>1</cost>
            <display_order>1</display_order>
            <id>1</id>
            <is_pre_selected>true</is_pre_selected>
            <name>sample string 3</name>
            <price_adjustment>1</price_adjustment>
            <product_image_id>1</product_image_id>
            <quantity>1</quantity>
            <type_id>2</type_id>
            <weight_adjustment>1</weight_adjustment>
          </NopAttributeValueEx>
        </attribute_values>
        <default_value>sample string 9</default_value>
        <display_order>8</display_order>
        <guid>sample string 1</guid>
        <id>2</id>
        <is_required>true</is_required>
        <product_attribute_id>3</product_attribute_id>
        <product_attribute_name>sample string 4</product_attribute_name>
        <text_prompt>sample string 5</text_prompt>
      </NopProductAttributesEX>
    </attributes>
    <baseprice_amount>1</baseprice_amount>
    <baseprice_base_amount>1</baseprice_base_amount>
    <full_description>sample string 5</full_description>
    <gtin>sample string 13</gtin>
    <id>1</id>
    <images>
      <NopProductImageEx>
        <attachment>sample string 2</attachment>
        <se_name>sample string 3</se_name>
        <seofilename>sample string 4</seofilename>
        <src>sample string 1</src>
      </NopProductImageEx>
      <NopProductImageEx>
        <attachment>sample string 2</attachment>
        <se_name>sample string 3</se_name>
        <seofilename>sample string 4</seofilename>
        <src>sample string 1</src>
      </NopProductImageEx>
    </images>
    <localized_names>
      <NameLocalizedNameEx>
        <language_id>1</language_id>
        <localized_name>sample string 2</localized_name>
      </NameLocalizedNameEx>
      <NameLocalizedNameEx>
        <language_id>1</language_id>
        <localized_name>sample string 2</localized_name>
      </NameLocalizedNameEx>
    </localized_names>
    <meta_description>sample string 11</meta_description>
    <meta_keywords>sample string 6</meta_keywords>
    <meta_title>sample string 12</meta_title>
    <name>sample string 3</name>
    <old_price>9</old_price>
    <order_maximum_quantity>1</order_maximum_quantity>
    <order_minimum_quantity>1</order_minimum_quantity>
    <price>8</price>
    <product_cost>10</product_cost>
    <product_specification_attributes>
      <NopProductSpecificationAttributeEx>
        <allow_filtering>true</allow_filtering>
        <attribute_type>sample string 9</attribute_type>
        <attribute_type_id>3</attribute_type_id>
        <custom_value>sample string 5</custom_value>
        <display_order>8</display_order>
        <id>1</id>
        <product_id>2</product_id>
        <show_on_product_page>true</show_on_product_page>
        <specification_attribute_option_id>4</specification_attribute_option_id>
      </NopProductSpecificationAttributeEx>
      <NopProductSpecificationAttributeEx>
        <allow_filtering>true</allow_filtering>
        <attribute_type>sample string 9</attribute_type>
        <attribute_type_id>3</attribute_type_id>
        <custom_value>sample string 5</custom_value>
        <display_order>8</display_order>
        <id>1</id>
        <product_id>2</product_id>
        <show_on_product_page>true</show_on_product_page>
        <specification_attribute_option_id>4</specification_attribute_option_id>
      </NopProductSpecificationAttributeEx>
    </product_specification_attributes>
    <published>true</published>
    <short_description>sample string 4</short_description>
    <show_on_home_page>true</show_on_home_page>
    <sku>sample string 7</sku>
    <special_price>1</special_price>
    <url>sample string 15</url>
    <visible_individually>true</visible_individually>
    <weight>1</weight>
  </NopProductEx>
  <NopProductEx>
    <BasepriceUnitId>14</BasepriceUnitId>
    <attributes>
      <NopProductAttributesEX>
        <attribute_control_type_id>7</attribute_control_type_id>
        <attribute_control_type_name>sample string 10</attribute_control_type_name>
        <attribute_values>
          <NopAttributeValueEx>
            <associated_product_id>1</associated_product_id>
            <color_squares_rgb>sample string 4</color_squares_rgb>
            <cost>1</cost>
            <display_order>1</display_order>
            <id>1</id>
            <is_pre_selected>true</is_pre_selected>
            <name>sample string 3</name>
            <price_adjustment>1</price_adjustment>
            <product_image_id>1</product_image_id>
            <quantity>1</quantity>
            <type_id>2</type_id>
            <weight_adjustment>1</weight_adjustment>
          </NopAttributeValueEx>
          <NopAttributeValueEx>
            <associated_product_id>1</associated_product_id>
            <color_squares_rgb>sample string 4</color_squares_rgb>
            <cost>1</cost>
            <display_order>1</display_order>
            <id>1</id>
            <is_pre_selected>true</is_pre_selected>
            <name>sample string 3</name>
            <price_adjustment>1</price_adjustment>
            <product_image_id>1</product_image_id>
            <quantity>1</quantity>
            <type_id>2</type_id>
            <weight_adjustment>1</weight_adjustment>
          </NopAttributeValueEx>
        </attribute_values>
        <default_value>sample string 9</default_value>
        <display_order>8</display_order>
        <guid>sample string 1</guid>
        <id>2</id>
        <is_required>true</is_required>
        <product_attribute_id>3</product_attribute_id>
        <product_attribute_name>sample string 4</product_attribute_name>
        <text_prompt>sample string 5</text_prompt>
      </NopProductAttributesEX>
      <NopProductAttributesEX>
        <attribute_control_type_id>7</attribute_control_type_id>
        <attribute_control_type_name>sample string 10</attribute_control_type_name>
        <attribute_values>
          <NopAttributeValueEx>
            <associated_product_id>1</associated_product_id>
            <color_squares_rgb>sample string 4</color_squares_rgb>
            <cost>1</cost>
            <display_order>1</display_order>
            <id>1</id>
            <is_pre_selected>true</is_pre_selected>
            <name>sample string 3</name>
            <price_adjustment>1</price_adjustment>
            <product_image_id>1</product_image_id>
            <quantity>1</quantity>
            <type_id>2</type_id>
            <weight_adjustment>1</weight_adjustment>
          </NopAttributeValueEx>
          <NopAttributeValueEx>
            <associated_product_id>1</associated_product_id>
            <color_squares_rgb>sample string 4</color_squares_rgb>
            <cost>1</cost>
            <display_order>1</display_order>
            <id>1</id>
            <is_pre_selected>true</is_pre_selected>
            <name>sample string 3</name>
            <price_adjustment>1</price_adjustment>
            <product_image_id>1</product_image_id>
            <quantity>1</quantity>
            <type_id>2</type_id>
            <weight_adjustment>1</weight_adjustment>
          </NopAttributeValueEx>
        </attribute_values>
        <default_value>sample string 9</default_value>
        <display_order>8</display_order>
        <guid>sample string 1</guid>
        <id>2</id>
        <is_required>true</is_required>
        <product_attribute_id>3</product_attribute_id>
        <product_attribute_name>sample string 4</product_attribute_name>
        <text_prompt>sample string 5</text_prompt>
      </NopProductAttributesEX>
    </attributes>
    <baseprice_amount>1</baseprice_amount>
    <baseprice_base_amount>1</baseprice_base_amount>
    <full_description>sample string 5</full_description>
    <gtin>sample string 13</gtin>
    <id>1</id>
    <images>
      <NopProductImageEx>
        <attachment>sample string 2</attachment>
        <se_name>sample string 3</se_name>
        <seofilename>sample string 4</seofilename>
        <src>sample string 1</src>
      </NopProductImageEx>
      <NopProductImageEx>
        <attachment>sample string 2</attachment>
        <se_name>sample string 3</se_name>
        <seofilename>sample string 4</seofilename>
        <src>sample string 1</src>
      </NopProductImageEx>
    </images>
    <localized_names>
      <NameLocalizedNameEx>
        <language_id>1</language_id>
        <localized_name>sample string 2</localized_name>
      </NameLocalizedNameEx>
      <NameLocalizedNameEx>
        <language_id>1</language_id>
        <localized_name>sample string 2</localized_name>
      </NameLocalizedNameEx>
    </localized_names>
    <meta_description>sample string 11</meta_description>
    <meta_keywords>sample string 6</meta_keywords>
    <meta_title>sample string 12</meta_title>
    <name>sample string 3</name>
    <old_price>9</old_price>
    <order_maximum_quantity>1</order_maximum_quantity>
    <order_minimum_quantity>1</order_minimum_quantity>
    <price>8</price>
    <product_cost>10</product_cost>
    <product_specification_attributes>
      <NopProductSpecificationAttributeEx>
        <allow_filtering>true</allow_filtering>
        <attribute_type>sample string 9</attribute_type>
        <attribute_type_id>3</attribute_type_id>
        <custom_value>sample string 5</custom_value>
        <display_order>8</display_order>
        <id>1</id>
        <product_id>2</product_id>
        <show_on_product_page>true</show_on_product_page>
        <specification_attribute_option_id>4</specification_attribute_option_id>
      </NopProductSpecificationAttributeEx>
      <NopProductSpecificationAttributeEx>
        <allow_filtering>true</allow_filtering>
        <attribute_type>sample string 9</attribute_type>
        <attribute_type_id>3</attribute_type_id>
        <custom_value>sample string 5</custom_value>
        <display_order>8</display_order>
        <id>1</id>
        <product_id>2</product_id>
        <show_on_product_page>true</show_on_product_page>
        <specification_attribute_option_id>4</specification_attribute_option_id>
      </NopProductSpecificationAttributeEx>
    </product_specification_attributes>
    <published>true</published>
    <short_description>sample string 4</short_description>
    <show_on_home_page>true</show_on_home_page>
    <sku>sample string 7</sku>
    <special_price>1</special_price>
    <url>sample string 15</url>
    <visible_individually>true</visible_individually>
    <weight>1</weight>
  </NopProductEx>
</ArrayOfNopProductEx>