GET api/magento/catalog/products/{sku}

Gets a product by sku

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sku

sku

string

Required

Body Parameters

None.

Response Information

Resource Description

Product

SuiteBridge.MagentoWebService.catalogProductReturnEntity
NameDescriptionTypeAdditional information
product_id

string

None.

sku

string

None.

set

string

None.

type

string

None.

categories

Collection of string

None.

websites

Collection of string

None.

created_at

string

None.

updated_at

string

None.

type_id

string

None.

name

string

None.

description

string

None.

short_description

string

None.

weight

string

None.

status

string

None.

url_key

string

None.

url_path

string

None.

visibility

string

None.

category_ids

Collection of string

None.

website_ids

Collection of string

None.

has_options

string

None.

gift_message_available

string

None.

price

string

None.

special_price

string

None.

special_from_date

string

None.

special_to_date

string

None.

tax_class_id

string

None.

tier_price

Collection of SuiteBridge.MagentoWebService.catalogProductTierPriceEntity

None.

meta_title

string

None.

meta_keyword

string

None.

meta_description

string

None.

custom_design

string

None.

custom_layout_update

string

None.

options_container

string

None.

additional_attributes

Collection of SuiteBridge.MagentoWebService.associativeEntity

None.

Response Formats

application/json, text/json

Sample:
{
  "product_id": "sample string 1",
  "sku": "sample string 2",
  "set": "sample string 3",
  "type": "sample string 4",
  "categories": [
    "sample string 1",
    "sample string 2"
  ],
  "websites": [
    "sample string 1",
    "sample string 2"
  ],
  "created_at": "sample string 5",
  "updated_at": "sample string 6",
  "type_id": "sample string 7",
  "name": "sample string 8",
  "description": "sample string 9",
  "short_description": "sample string 10",
  "weight": "sample string 11",
  "status": "sample string 12",
  "url_key": "sample string 13",
  "url_path": "sample string 14",
  "visibility": "sample string 15",
  "category_ids": [
    "sample string 1",
    "sample string 2"
  ],
  "website_ids": [
    "sample string 1",
    "sample string 2"
  ],
  "has_options": "sample string 16",
  "gift_message_available": "sample string 17",
  "price": "sample string 18",
  "special_price": "sample string 19",
  "special_from_date": "sample string 20",
  "special_to_date": "sample string 21",
  "tax_class_id": "sample string 22",
  "tier_price": [
    {
      "customer_group_id": "sample string 1",
      "website": "sample string 2",
      "qty": 3,
      "qtySpecified": true,
      "price": 5.1,
      "priceSpecified": true
    },
    {
      "customer_group_id": "sample string 1",
      "website": "sample string 2",
      "qty": 3,
      "qtySpecified": true,
      "price": 5.1,
      "priceSpecified": true
    }
  ],
  "meta_title": "sample string 23",
  "meta_keyword": "sample string 24",
  "meta_description": "sample string 25",
  "custom_design": "sample string 26",
  "custom_layout_update": "sample string 27",
  "options_container": "sample string 28",
  "additional_attributes": [
    {
      "key": "sample string 1",
      "value": "sample string 2"
    },
    {
      "key": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<catalogProductReturnEntity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <product_id>sample string 1</product_id>
  <sku>sample string 2</sku>
  <set>sample string 3</set>
  <type>sample string 4</type>
  <categories>
    <complexObjectArray>sample string 1</complexObjectArray>
    <complexObjectArray>sample string 2</complexObjectArray>
  </categories>
  <websites>
    <complexObjectArray>sample string 1</complexObjectArray>
    <complexObjectArray>sample string 2</complexObjectArray>
  </websites>
  <created_at>sample string 5</created_at>
  <updated_at>sample string 6</updated_at>
  <type_id>sample string 7</type_id>
  <name>sample string 8</name>
  <description>sample string 9</description>
  <short_description>sample string 10</short_description>
  <weight>sample string 11</weight>
  <status>sample string 12</status>
  <url_key>sample string 13</url_key>
  <url_path>sample string 14</url_path>
  <visibility>sample string 15</visibility>
  <category_ids>
    <complexObjectArray>sample string 1</complexObjectArray>
    <complexObjectArray>sample string 2</complexObjectArray>
  </category_ids>
  <website_ids>
    <complexObjectArray>sample string 1</complexObjectArray>
    <complexObjectArray>sample string 2</complexObjectArray>
  </website_ids>
  <has_options>sample string 16</has_options>
  <gift_message_available>sample string 17</gift_message_available>
  <price>sample string 18</price>
  <special_price>sample string 19</special_price>
  <special_from_date>sample string 20</special_from_date>
  <special_to_date>sample string 21</special_to_date>
  <tax_class_id>sample string 22</tax_class_id>
  <tier_price>
    <complexObjectArray>
      <customer_group_id>sample string 1</customer_group_id>
      <website>sample string 2</website>
      <qty>3</qty>
      <price>5.1</price>
    </complexObjectArray>
    <complexObjectArray>
      <customer_group_id>sample string 1</customer_group_id>
      <website>sample string 2</website>
      <qty>3</qty>
      <price>5.1</price>
    </complexObjectArray>
  </tier_price>
  <meta_title>sample string 23</meta_title>
  <meta_keyword>sample string 24</meta_keyword>
  <meta_description>sample string 25</meta_description>
  <custom_design>sample string 26</custom_design>
  <custom_layout_update>sample string 27</custom_layout_update>
  <options_container>sample string 28</options_container>
  <additional_attributes>
    <complexObjectArray>
      <key>sample string 1</key>
      <value>sample string 2</value>
    </complexObjectArray>
    <complexObjectArray>
      <key>sample string 1</key>
      <value>sample string 2</value>
    </complexObjectArray>
  </additional_attributes>
</catalogProductReturnEntity>