API Resources

  • Products
    • GET /products List / filter collection of products
    • (this can be filtered by the “category”, "status" and “q” url params)

    • GET /products/:id Retrieve data on a specific product
    • POST /products Batch insert or update products
    • POST /products/:id Update a specific product
    • DELETE /products Batch delete products
    • DELETE /products/:id Delete a specific product
    • GET /products/filter/size,med/color,red,blue Filter products retruned with filter params

      (These all also support the following "identifier" url params: id, code, name)

  • Options
    • GET /options List / filter collection of options
    • GET /options/:id Retrieve data on a specific option
    • POST /options Batch insert or update options
    • POST /options/:id Update a specific option
    • DELETE /options Batch delete options
    • DELETE /options/:id Delete a specific option

      (These all also support the following "identifier" url params: id, code, name)

  • Product Filter Blocks
    • GET /product-filter-blocks List collection of product-filter-blocks
    • GET /product-filter-blocks/:idRetrieve data on a specific product-filter-blocks
    • GET /products/filter/size,med/color,red,blue Filter the blocks retruned with filter params
  • Gallery
    • GET /gallery List of gallery images
    • GET /gallery/:id Retrieve data on a specific gallery image (such as date added, comment/description etc.)
  • Blog posts
    • GET /blog-posts List of blog posts
    • GET /blog-posts/:id Each specific blog post
  • Downloads
    • GET /downloads List collection of downloads
    • GET /downloads/:id Retrieve data on a specific download
  • Download categories
    • GET /download-categories List collection of downloads categories
    • GET /download-categories/:id Retrieve data on a specific download category
  • Categories
    • GET /categories List collection of categories
    • GET /categories/:id Retrieve data on a specific category
  • Users
    • GET /users List collection of users
    • GET /users/:id Retrieve data on a specific user
    • POST /users Batch insert or update users
    • POST /users/:id Update a specific user

      (These all also support the following "identifier" url params: id, membership_code, email)

  • User Groups
    • GET /user-groups List collection of user groups
    • GET /user-groups/:id Retrieve data on a specific user group

      (These all also support the following "identifier" url params: id, name)

  • Regions
    • GET /regions List collection of categories
    • GET /regions/:id Retrieve data on a specific category
  • VAT Types
    • GET /vat-types List collection of vat types
    • GET /vat-types/:id Retrieve specific vat type
  • Manufacturers
    • GET /manufacturers List collection of manufacturers
    • GET /manufacturers/:id Retrieve specific manufacturer
  • Departments
    • GET /departments List collection of departments
    • GET /departments/:id Retrieve specific department
  • Orders
    • GET /orders List collection of orders
    • GET /orders/:id Retrieve data on a specific order
    • POST /orders Batch update orders
    • POST /orders/:id Update a specific order

      (These all also support the following "identifier" url params: id, invoice_id)

  • Delivery Methods
    • GET /delivery-methods List collection of delivery methods
    • GET /delivery-methods/:id Retrieve a specific delivery method
  • Payment Methods
    • GET /payment-methods List collection of payment methods
    • GET /payment-methods/:id Retrieve a specific payment method
  • Coupons
    • GET /coupons List collection of coupons
    • GET /coupons/:id Retrieve a specific coupon
  • Pages
    • GET /pages List collection of pages
    • GET /pages/:idRetrieve a specific page

      (These all also support the following "identifier" url params: id, slug)

  • Sliders
    • GET /slidersList collection of sliders
    • GET /sliders/:idRetrieve a specific slider
  • Newsletters
    • GET /newslettersList collection of newsletters
    • GET /newsletters/:idRetrieve a specific newsletter
  • Testimonials
    • GET /testimonials List collection of testimonials
    • GET /testimonials/:idRetrieve a specific testimonial
  • Product Reviews
    • GET /product-reviews List collection of product reviews
    • (this can be filtered by the “product_id”, "featured" and “score_over” url params)

    • GET /product-reviews/:idRetrieve a specific product review


Params

All resources support "limit" and "offset" which case be used to page results, generally the default on lists is 25.

Also most resources should support the "fields=*" url param, which allows full data on each views to be pulled back instead of just the basic data. 


Examples


e.g. via HTTP

   

http://www.site.com/api/v1/products.json?fields=*&limit=50&api_key=xxxxxx

   

Will return more into on each product than without it.
also the above will limit to the latest 50 results.


e.g. via api() twig template function

 

{% set testimonials = api('testimonials', { fields: '*', limit: 50 }) %}
{% for testimonial in testimonials %}
  <li> Lets see what we have: {{ dump(testimonial) }} </li>
{% endfor %}

 


Remember in the twig templates you can use {{ dump() }} to find all template keys available, or {{ dump(something) }} to find all sub keys of a variable such as an array or object.