1.1 Description

 
pathhttp://www.your_website_domain.com/FeiEditor/api_v1/shop/products
methodGET/POST
illustrateObtain a product list based on query conditions.
  

1.2 parameters

 
namemusttypedescribe
filter[]noarrayfilter. Click here for how to use .
filter[limit]nointThe number of items returned by a query, the default is 10. The valid range is 1 to 1000.
pagenointThe number of pages currently queried, used in conjunction with filter[limit]. Used to implement paging queries.
  

1.3 return result

 
correct result
Return format: JSON
{
  "products" : [
    {
      "related_ids" : [
        1,
        2
      ],
      "variations" : [],
      "categories" : [
        "DEMO_CATEGORY_1",
        "DEMO_CATEGORY_2"
      ],
      "shipping_required" : true,
      "id" : 1001,
      "parent" : [],
      "regular_price" : "100.00",
      "weight" : null,
      "total_sales" : 0,
      "sku" : "",
      "rating_count" : 2,
      "managing_stock" : false,
      "title" : "DEMO PRODUCT 01",
      "backordered" : false,
      "on_sale" : true,
      "status" : "publish",
      "download_limit" : 0,
      "taxable" : false,
      "reviews_allowed" : true,
      "description" : "This is a demo product",
      "purchaseable" : true,
      "sale_price" : "2.00 ",
      "type" : "simple",
      "permalink" : "https://www.example.com/product/demo_product_01",
      "catalog_visibility" : "visible",
      "download_expiry" : 0,
      "dimensions" : {
        " length" : "",
        "height" : "",
        "unit" : "in",
        "width" : ""
      },
      "cross_sell_ids" : [],
      "price" : "50.00",
      "updated_at" : "2017-10-01T10:30:10Z",
      "attributes" : [],
      "shipping_class" : "",
      "virtual" : false,
      "downloadable" : false,
      "upsell_ids" : [],
      " created_at" : "2017-10-01T10:30:10Z",
      "tax_class" : "",
      "tags" : [],
      "price_html" : "<del><span class=\"amount\">$ ;100</span></del> <ins><span class=\"amount\">$50</span></ins>",
      "in_stock" : true,
      "sold_individually" : false,
      "short_description" : "This is a short product description.",
      "downloads" : [],
      "tax_status" : "taxable",
      "average_rating" : "4.50",
      "download_type" : "",
      "shipping_taxable" : true,
      "purchase_note" : "",
      "shipping_class_id" : null,
      "visible" : true,
      "backorders_allowed" : false,
      "images" : [
        {
          "position" : 0,
          "id" : 100,
          " created_at" : "2017-10-01T10:30:10Z",
          "src" : "https://www.example.com/qf-content/uploads/2017/10/001.jpg",
          "title" : " 001",
          "alt" : "",
          "updated_at" : "2017-10-01T10:30:10Z"
        },
        {
          "position" : 1,
          "id" : 101,
          "created_at" : "2017-10-01T10:30:10Z",
          "src" : "https://www.example.com/qf-content/uploads/2017/10/002.jpg",
          "title" : "002",
          "alt" : "",
          "updated_at" : " 2017-10-01T10:30:10Z"
        }
      ],
      "stock_quantity" : 0,
      "featured" : false
    }
  ]
}