POST api/Listrak/PostListrakProduct?type={type}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
type

string

Required

Body Parameters

BCProductDetail
NameDescriptionTypeAdditional information
data

BCProductData

None.

variants

BCProductVariantDetail

None.

Request Formats

application/json, text/json

Sample:
{
  "data": {
    "id": 1,
    "custom_url": {
      "url": "sample string 1",
      "is_customized": true
    },
    "price": "sample string 2",
    "product_images": [
      {
        "id": 1,
        "product_id": 2,
        "is_thumbnail": true,
        "sort_order": 4,
        "description": "sample string 5",
        "image_file": "sample string 6",
        "zoom_url": "sample string 7",
        "standard_url": "sample string 8",
        "thumbnail_url": "sample string 9",
        "tiny_url": "sample string 10",
        "date_created": "2024-09-12T02:05:00.2625857+00:00"
      },
      {
        "id": 1,
        "product_id": 2,
        "is_thumbnail": true,
        "sort_order": 4,
        "description": "sample string 5",
        "image_file": "sample string 6",
        "zoom_url": "sample string 7",
        "standard_url": "sample string 8",
        "thumbnail_url": "sample string 9",
        "tiny_url": "sample string 10",
        "date_created": "2024-09-12T02:05:00.2625857+00:00"
      }
    ],
    "name": "sample string 3",
    "type": "sample string 4",
    "sku": "sample string 5",
    "description": "sample string 6",
    "weight": "sample string 7",
    "width": "sample string 8",
    "depth": "sample string 9",
    "height": "sample string 10",
    "cost_price": 11.1,
    "retail_price": 12.1,
    "sale_price": 13.1,
    "map_price": 14.1,
    "tax_class_id": 15,
    "product_tax_code": "sample string 16",
    "calculated_price": 17.1,
    "categories": [
      1,
      2
    ],
    "brand_id": 18,
    "brand_name": "sample string 19",
    "option_set_id": {},
    "option_set_display": "sample string 21",
    "inventory_level": 22,
    "inventory_warning_level": 23,
    "inventory_tracking": "sample string 24",
    "reviews_rating_sum": 25,
    "reviews_count": 26,
    "total_sold": 27,
    "is_free_shipping": true,
    "is_visible": true,
    "is_featured": true,
    "related_products": [
      1,
      2
    ],
    "warranty": "sample string 31",
    "bin_picking_number": "sample string 32",
    "layout_file": "sample string 33",
    "upc": "sample string 34",
    "mpn": "sample string 35",
    "gtin": "sample string 36",
    "search_keywords": "sample string 37",
    "availability": "sample string 38",
    "availability_description": "sample string 39",
    "gift_wrapping_options_type": "sample string 40",
    "gift_wrapping_options_list": [
      {},
      {}
    ],
    "sort_order": 41,
    "condition": "sample string 42",
    "is_condition_shown": true,
    "order_quantity_minimum": 44,
    "order_quantity_maximum": 45,
    "page_title": "sample string 46",
    "meta_keywords": [
      "sample string 1",
      "sample string 2"
    ],
    "meta_description": "sample string 47",
    "date_created": "2024-09-12T02:05:00.2782128+00:00",
    "date_modified": "2024-09-12T02:05:00.2782128+00:00",
    "view_count": 50,
    "preorder_message": "sample string 51",
    "is_preorder_only": true,
    "is_price_hidden": true,
    "price_hidden_label": "sample string 54",
    "base_variant_id": "sample string 55",
    "open_graph_type": "sample string 56",
    "open_graph_title": "sample string 57",
    "open_graph_description": "sample string 58",
    "open_graph_use_meta_description": true,
    "open_graph_use_product_name": true,
    "open_graph_use_image": true,
    "category_name": "sample string 62",
    "subcategory_name": "sample string 63",
    "custom_fields": [
      {
        "id": 1,
        "name": "sample string 2",
        "value": "sample string 3"
      },
      {
        "id": 1,
        "name": "sample string 2",
        "value": "sample string 3"
      }
    ]
  },
  "variants": {
    "data": [
      {
        "id": 1,
        "product_id": 2,
        "sku": "sample string 3",
        "sku_id": "sample string 4",
        "price": 5.1,
        "calculated_price": 6.1,
        "sale_price": 7.1,
        "retail_price": 8.1,
        "map_price": {},
        "weight": 10.1,
        "calculated_weight": 11.1,
        "width": {},
        "height": {},
        "depth": {},
        "is_free_shipping": true,
        "fixed_cost_shipping_price": 16,
        "purchasing_disabled": true,
        "purchasing_disabled_message": "sample string 18",
        "image_url": "sample string 19",
        "cost_price": 20.1,
        "upc": "sample string 21",
        "mpn": "sample string 22",
        "gtin": "sample string 23",
        "inventory_level": 24,
        "inventory_warning_level": 25,
        "bin_picking_number": "sample string 26",
        "option_values": [
          {
            "id": 1,
            "option_id": 2,
            "order_product_id": 3,
            "product_option_id": 4,
            "display_name": "sample string 5",
            "display_value": "sample string 6",
            "value": "sample string 7",
            "type": "sample string 8",
            "name": "sample string 9",
            "display_style": "sample string 10"
          },
          {
            "id": 1,
            "option_id": 2,
            "order_product_id": 3,
            "product_option_id": 4,
            "display_name": "sample string 5",
            "display_value": "sample string 6",
            "value": "sample string 7",
            "type": "sample string 8",
            "name": "sample string 9",
            "display_style": "sample string 10"
          }
        ],
        "custom_url": {
          "url": "sample string 1",
          "is_customized": true
        }
      },
      {
        "id": 1,
        "product_id": 2,
        "sku": "sample string 3",
        "sku_id": "sample string 4",
        "price": 5.1,
        "calculated_price": 6.1,
        "sale_price": 7.1,
        "retail_price": 8.1,
        "map_price": {},
        "weight": 10.1,
        "calculated_weight": 11.1,
        "width": {},
        "height": {},
        "depth": {},
        "is_free_shipping": true,
        "fixed_cost_shipping_price": 16,
        "purchasing_disabled": true,
        "purchasing_disabled_message": "sample string 18",
        "image_url": "sample string 19",
        "cost_price": 20.1,
        "upc": "sample string 21",
        "mpn": "sample string 22",
        "gtin": "sample string 23",
        "inventory_level": 24,
        "inventory_warning_level": 25,
        "bin_picking_number": "sample string 26",
        "option_values": [
          {
            "id": 1,
            "option_id": 2,
            "order_product_id": 3,
            "product_option_id": 4,
            "display_name": "sample string 5",
            "display_value": "sample string 6",
            "value": "sample string 7",
            "type": "sample string 8",
            "name": "sample string 9",
            "display_style": "sample string 10"
          },
          {
            "id": 1,
            "option_id": 2,
            "order_product_id": 3,
            "product_option_id": 4,
            "display_name": "sample string 5",
            "display_value": "sample string 6",
            "value": "sample string 7",
            "type": "sample string 8",
            "name": "sample string 9",
            "display_style": "sample string 10"
          }
        ],
        "custom_url": {
          "url": "sample string 1",
          "is_customized": true
        }
      }
    ]
  }
}

application/xml, text/xml

Sample:
<BCProductDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <data>
    <id>1</id>
    <custom_url>
      <url>sample string 1</url>
      <is_customized>true</is_customized>
    </custom_url>
    <price>sample string 2</price>
    <product_images>
      <BCImage>
        <id>1</id>
        <product_id>2</product_id>
        <is_thumbnail>true</is_thumbnail>
        <sort_order>4</sort_order>
        <description>sample string 5</description>
        <image_file>sample string 6</image_file>
        <zoom_url>sample string 7</zoom_url>
        <standard_url>sample string 8</standard_url>
        <thumbnail_url>sample string 9</thumbnail_url>
        <tiny_url>sample string 10</tiny_url>
        <date_created>2024-09-12T02:05:00.2625857+00:00</date_created>
      </BCImage>
      <BCImage>
        <id>1</id>
        <product_id>2</product_id>
        <is_thumbnail>true</is_thumbnail>
        <sort_order>4</sort_order>
        <description>sample string 5</description>
        <image_file>sample string 6</image_file>
        <zoom_url>sample string 7</zoom_url>
        <standard_url>sample string 8</standard_url>
        <thumbnail_url>sample string 9</thumbnail_url>
        <tiny_url>sample string 10</tiny_url>
        <date_created>2024-09-12T02:05:00.2625857+00:00</date_created>
      </BCImage>
    </product_images>
    <name>sample string 3</name>
    <type>sample string 4</type>
    <sku>sample string 5</sku>
    <description>sample string 6</description>
    <weight>sample string 7</weight>
    <width>sample string 8</width>
    <depth>sample string 9</depth>
    <height>sample string 10</height>
    <cost_price>11.1</cost_price>
    <retail_price>12.1</retail_price>
    <sale_price>13.1</sale_price>
    <map_price>14.1</map_price>
    <tax_class_id>15</tax_class_id>
    <product_tax_code>sample string 16</product_tax_code>
    <calculated_price>17.1</calculated_price>
    <categories>
      <int>1</int>
      <int>2</int>
    </categories>
    <brand_id>18</brand_id>
    <brand_name>sample string 19</brand_name>
    <option_set_id />
    <option_set_display>sample string 21</option_set_display>
    <inventory_level>22</inventory_level>
    <inventory_warning_level>23</inventory_warning_level>
    <inventory_tracking>sample string 24</inventory_tracking>
    <reviews_rating_sum>25</reviews_rating_sum>
    <reviews_count>26</reviews_count>
    <total_sold>27</total_sold>
    <is_free_shipping>true</is_free_shipping>
    <is_visible>true</is_visible>
    <is_featured>true</is_featured>
    <related_products>
      <int>1</int>
      <int>2</int>
    </related_products>
    <warranty>sample string 31</warranty>
    <bin_picking_number>sample string 32</bin_picking_number>
    <layout_file>sample string 33</layout_file>
    <upc>sample string 34</upc>
    <mpn>sample string 35</mpn>
    <gtin>sample string 36</gtin>
    <search_keywords>sample string 37</search_keywords>
    <availability>sample string 38</availability>
    <availability_description>sample string 39</availability_description>
    <gift_wrapping_options_type>sample string 40</gift_wrapping_options_type>
    <gift_wrapping_options_list>
      <anyType />
      <anyType />
    </gift_wrapping_options_list>
    <sort_order>41</sort_order>
    <condition>sample string 42</condition>
    <is_condition_shown>true</is_condition_shown>
    <order_quantity_minimum>44</order_quantity_minimum>
    <order_quantity_maximum>45</order_quantity_maximum>
    <page_title>sample string 46</page_title>
    <meta_keywords>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </meta_keywords>
    <meta_description>sample string 47</meta_description>
    <date_created>2024-09-12T02:05:00.2782128+00:00</date_created>
    <date_modified>2024-09-12T02:05:00.2782128+00:00</date_modified>
    <view_count>50</view_count>
    <preorder_message>sample string 51</preorder_message>
    <is_preorder_only>true</is_preorder_only>
    <is_price_hidden>true</is_price_hidden>
    <price_hidden_label>sample string 54</price_hidden_label>
    <base_variant_id>sample string 55</base_variant_id>
    <open_graph_type>sample string 56</open_graph_type>
    <open_graph_title>sample string 57</open_graph_title>
    <open_graph_description>sample string 58</open_graph_description>
    <open_graph_use_meta_description>true</open_graph_use_meta_description>
    <open_graph_use_product_name>true</open_graph_use_product_name>
    <open_graph_use_image>true</open_graph_use_image>
    <category_name>sample string 62</category_name>
    <subcategory_name>sample string 63</subcategory_name>
    <custom_fields>
      <BCCustomFieldDetails>
        <id>1</id>
        <name>sample string 2</name>
        <value>sample string 3</value>
      </BCCustomFieldDetails>
      <BCCustomFieldDetails>
        <id>1</id>
        <name>sample string 2</name>
        <value>sample string 3</value>
      </BCCustomFieldDetails>
    </custom_fields>
  </data>
  <variants>
    <data>
      <BCProductVariantData>
        <id>1</id>
        <product_id>2</product_id>
        <sku>sample string 3</sku>
        <sku_id>sample string 4</sku_id>
        <price>5.1</price>
        <calculated_price>6.1</calculated_price>
        <sale_price>7.1</sale_price>
        <retail_price>8.1</retail_price>
        <map_price />
        <weight>10.1</weight>
        <calculated_weight>11.1</calculated_weight>
        <width />
        <height />
        <depth />
        <is_free_shipping>true</is_free_shipping>
        <fixed_cost_shipping_price>16</fixed_cost_shipping_price>
        <purchasing_disabled>true</purchasing_disabled>
        <purchasing_disabled_message>sample string 18</purchasing_disabled_message>
        <image_url>sample string 19</image_url>
        <cost_price>20.1</cost_price>
        <upc>sample string 21</upc>
        <mpn>sample string 22</mpn>
        <gtin>sample string 23</gtin>
        <inventory_level>24</inventory_level>
        <inventory_warning_level>25</inventory_warning_level>
        <bin_picking_number>sample string 26</bin_picking_number>
        <option_values>
          <BCProductOption>
            <id>1</id>
            <option_id>2</option_id>
            <order_product_id>3</order_product_id>
            <product_option_id>4</product_option_id>
            <display_name>sample string 5</display_name>
            <display_value>sample string 6</display_value>
            <value>sample string 7</value>
            <type>sample string 8</type>
            <name>sample string 9</name>
            <display_style>sample string 10</display_style>
          </BCProductOption>
          <BCProductOption>
            <id>1</id>
            <option_id>2</option_id>
            <order_product_id>3</order_product_id>
            <product_option_id>4</product_option_id>
            <display_name>sample string 5</display_name>
            <display_value>sample string 6</display_value>
            <value>sample string 7</value>
            <type>sample string 8</type>
            <name>sample string 9</name>
            <display_style>sample string 10</display_style>
          </BCProductOption>
        </option_values>
        <custom_url>
          <url>sample string 1</url>
          <is_customized>true</is_customized>
        </custom_url>
      </BCProductVariantData>
      <BCProductVariantData>
        <id>1</id>
        <product_id>2</product_id>
        <sku>sample string 3</sku>
        <sku_id>sample string 4</sku_id>
        <price>5.1</price>
        <calculated_price>6.1</calculated_price>
        <sale_price>7.1</sale_price>
        <retail_price>8.1</retail_price>
        <map_price />
        <weight>10.1</weight>
        <calculated_weight>11.1</calculated_weight>
        <width />
        <height />
        <depth />
        <is_free_shipping>true</is_free_shipping>
        <fixed_cost_shipping_price>16</fixed_cost_shipping_price>
        <purchasing_disabled>true</purchasing_disabled>
        <purchasing_disabled_message>sample string 18</purchasing_disabled_message>
        <image_url>sample string 19</image_url>
        <cost_price>20.1</cost_price>
        <upc>sample string 21</upc>
        <mpn>sample string 22</mpn>
        <gtin>sample string 23</gtin>
        <inventory_level>24</inventory_level>
        <inventory_warning_level>25</inventory_warning_level>
        <bin_picking_number>sample string 26</bin_picking_number>
        <option_values>
          <BCProductOption>
            <id>1</id>
            <option_id>2</option_id>
            <order_product_id>3</order_product_id>
            <product_option_id>4</product_option_id>
            <display_name>sample string 5</display_name>
            <display_value>sample string 6</display_value>
            <value>sample string 7</value>
            <type>sample string 8</type>
            <name>sample string 9</name>
            <display_style>sample string 10</display_style>
          </BCProductOption>
          <BCProductOption>
            <id>1</id>
            <option_id>2</option_id>
            <order_product_id>3</order_product_id>
            <product_option_id>4</product_option_id>
            <display_name>sample string 5</display_name>
            <display_value>sample string 6</display_value>
            <value>sample string 7</value>
            <type>sample string 8</type>
            <name>sample string 9</name>
            <display_style>sample string 10</display_style>
          </BCProductOption>
        </option_values>
        <custom_url>
          <url>sample string 1</url>
          <is_customized>true</is_customized>
        </custom_url>
      </BCProductVariantData>
    </data>
  </variants>
</BCProductDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.