API Product - Revision history

Admin: /* Product Properties */

2020-05-19T23:36:30Z

Product Properties

2018-08-22T00:21:37Z

Optional Parameters

2018-08-22T00:21:21Z

Optional Parameters

2018-06-13T04:11:11Z

Optional Parameters

2018-06-13T04:10:36Z

Optional Parameters

2018-06-12T03:41:23Z

GET /api/products/count.json

2018-06-12T03:40:01Z

GET /api/products.jsonGET /api/standard_collections/(STANDARD_COLLECTION_ID|STANDARD_COLLECTION_HANDLE)/products.json

2018-06-12T03:37:46Z

GET /api/products.json

2018-06-12T02:00:32Z

PUT /api/products/PRODUCT_ID.json

2018-06-12T01:59:08Z

DELETE /api/products/(OBJECT_ID|OBJECT_HANDLE).json

@@ Line 133: / Line 133: @@
      "position": 1,
      "sku": "",
      "barcode": "",
      "price": 15,

@@ Line 391: / Line 391: @@
 {| class="reference"
 !fields
-|A comma-separated list of fields to return in the response.
+|A comma-separated list of fields to return in the response. If a list of fields is provided, then the <code>images</code> and <code>variants</code> fields will always be excluded.
 |}

@@ Line 225: / Line 225: @@
 |-
 !fields
-|A comma-separated list of fields to return in the response.
+|A comma-separated list of fields to return in the response. If a list of fields is provided, then the <code>images</code> and <code>variants</code> fields will always be excluded.
 |}

@@ Line 336: / Line 336: @@
 |-
 !collection_id
-|Return only the products that belong to the given collection.
+|Return only the products that belong to the given collection. Either a unique collection id or handle may be specified.
 |-
 !created_at_min

@@ Line 194: / Line 194: @@
 |-
 !collection_id
-|Return only the products that belong to the given collection.
+|Return only the products that belong to the given collection. Either a unique collection id or handle may be specified.
 |-
 !created_at_min

@@ Line 316: / Line 316: @@
 </pre>
-=== <code>GET /api/products/count.json</code> ===
+=== <code>GET /api/products/count.json<br>GET /api/standard_collections/(STANDARD_COLLECTION_ID|STANDARD_COLLECTION_HANDLE)/products/count.json<br>GET /api/super_collections/(SUPER_COLLECTION_ID|SUPER_COLLECTION_HANDLE)/products/count.json</code> ===
 Return a count of products.

@@ Line 165: / Line 165: @@
 == Endpoints ==
-=== <code>GET /api/products.json<br>GET /api/standard_collections/(STANDARD_COLLECTION_ID|STANDARD_COLLECTION_HANDLE)/products.json</code> ===
+=== <code>GET /api/products.json<br>GET /api/standard_collections/(STANDARD_COLLECTION_ID|STANDARD_COLLECTION_HANDLE)/products.json<br>GET /api/super_collections/(SUPER_COLLECTION_ID|SUPER_COLLECTION_HANDLE)/products.json</code> ===
-Return a list of products.
+Return a list of products. A standard collection or a super collection may be specified to return only the products belonging to that collection.
 ==== Optional Parameters ====

@@ Line 517: / Line 517: @@
 </pre>
-=== <code>PUT /api/products/PRODUCT_ID.json</code> ===
+=== <code>PUT /api/products/(PRODUCT_ID|PRODUCT_HANDLE).json</code> ===
 Update a product and associated images and variations.

@@ Line 568: / Line 568: @@
 </pre>
-=== <code>DELETE /api/products/(OBJECT_ID|OBJECT_HANDLE).json</code> ===
+=== <code>DELETE /api/products/(PRODUCT_ID|PRODUCT_HANDLE).json</code> ===
 Delete a product and all associated images and variations.