API StandardCollection - Revision history

Admin: /* Optional Parameters */

2018-08-22T00:24:25Z

Optional Parameters

Admin: /* Optional Parameters */

2018-08-22T00:24:02Z

Optional Parameters

Admin: /* Accessing a Standard Collection */

2018-06-12T02:11:59Z

Accessing a Standard Collection

Admin: /* DELETE /api/standard_collections/STANDARD_COLLECTION_ID.json */

2018-06-12T02:06:49Z

DELETE /api/standard_collections/STANDARD_COLLECTION_ID.json

Admin: /* PUT /api/standard_collections/STANDARD_COLLECTION_ID.json */

2018-06-12T02:06:22Z

PUT /api/standard_collections/STANDARD_COLLECTION_ID.json

Admin: /* GET /api/standard_collections/STANDARD_COLLECTION_ID.json */

2018-06-12T02:05:58Z

GET /api/standard_collections/STANDARD_COLLECTION_ID.json

Admin at 02:04, 12 June 2018

2018-06-12T02:04:55Z

Admin: /* DELETE /api/standard collections/STANDARD_COLLECTION_ID.json */

2018-06-07T03:08:24Z

DELETE /api/standard collections/STANDARD_COLLECTION_ID.json

Admin: /* PUT /api/standard collections/STANDARD_COLLECTION_ID.json */

2018-06-07T03:08:06Z

PUT /api/standard collections/STANDARD_COLLECTION_ID.json

Admin: /* POST /api/standard collections.json */

2018-06-07T03:07:42Z

POST /api/standard collections.json

@@ Line 247: / Line 247: @@
 {| 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> field will always be excluded.
 |}

@@ Line 138: / Line 138: @@
 |-
 !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> field will always be excluded.
 |}

@@ Line 21: / Line 21: @@
 </pre>
-The advantage of using the handle form of the request is that you don't need to search all the standard collections first in order to determine the standard collection id, as you will already know what the handle is. This will reduce the number of API calls that you need to make and greatly simplifies the amount of coding that is needed to manage your standard collection.
+The advantage of using the handle form of the request is that you don't need to search all the standard collections first in order to determine the standard collection id, as you will already know what the handle is. This will reduce the number of API calls that you need to make and greatly simplifies the amount of coding that is needed to manage your standard collections.
 == Standard Collection Properties ==

@@ Line 364: / Line 364: @@
 </pre>
-=== <code>DELETE /api/standard_collections/STANDARD_COLLECTION_ID.json</code> ===
+=== <code>DELETE /api/standard_collections/(STANDARD_COLLECTION_ID|STANDARD_COLLECTION_HANDLE).json</code> ===
 Deletes a standard collection.

@@ Line 345: / Line 345: @@
 </pre>
-=== <code>PUT /api/standard_collections/STANDARD_COLLECTION_ID.json</code> ===
+=== <code>PUT /api/standard_collections/(STANDARD_COLLECTION_ID||STANDARD_COLLECTION_HANDLE).json</code> ===
 Updates a standard collection.

@@ Line 239: / Line 239: @@
 </pre>
-=== <code>GET /api/standard_collections/STANDARD_COLLECTION_ID.json</code> ===
+=== <code>GET /api/standard_collections/(STANDARD_COLLECTION_ID|STANDARD_COLLECTION_HANDLE).json</code> ===
-Retrieves a single standard collection by ID.
+Retrieves a single standard collection by ID or handle.
 ==== Optional Parameters ====

← Older revision		Revision as of 02:04, 12 June 2018
Line 2:		Line 2:

	There are also super collections, which contain products based on selection conditions rather than been included in the collection manually. For more information, see [[API SuperCollection\|SuperCollection]].		There are also super collections, which contain products based on selection conditions rather than been included in the collection manually. For more information, see [[API SuperCollection\|SuperCollection]].
		+
		+	=== Accessing a Standard Collection ===
		+
		+	If you want to refer to a single Standard Collection, then you will need to use the unique standard collection id that has been assigned to that collection. These collection ids are returned when you request a list of the standard collections that belong to your store.
		+
		+	The standard collection ids are internally generated by the software and cannot be created or assigned.
		+
		+	Alternatively, you may specify the standard collection handle in place of the standard collection id when requesting access to a collection. The standard collection handle is the unique character string that is assigned to every collection when it is created. The handle is used in the URL to display the collection page.
		+
		+	For example, you may retrieve a standard collection in two ways.
		+
		+	<pre>
		+	GET /api/standard_collections/12345678.json
		+
		+	or
		+
		+	GET /api/standard_collections/green-things.json
		+	</pre>
		+
		+	The advantage of using the handle form of the request is that you don't need to search all the standard collections first in order to determine the standard collection id, as you will already know what the handle is. This will reduce the number of API calls that you need to make and greatly simplifies the amount of coding that is needed to manage your standard collection.

	== Standard Collection Properties ==		== Standard Collection Properties ==

@@ Line 344: / Line 344: @@
 </pre>
-=== <code>DELETE /api/standard collections/STANDARD_COLLECTION_ID.json</code> ===
+=== <code>DELETE /api/standard_collections/STANDARD_COLLECTION_ID.json</code> ===
 Deletes a standard collection.
@@ Line 351: / Line 351: @@
 <pre>
-DELETE /api/standard collections/248.json
+DELETE /api/standard_collections/248.json
 HTTP/1.1 200 OK

@@ Line 325: / Line 325: @@
 </pre>
-=== <code>PUT /api/standard collections/STANDARD_COLLECTION_ID.json</code> ===
+=== <code>PUT /api/standard_collections/STANDARD_COLLECTION_ID.json</code> ===
 Updates a standard collection.
@@ Line 332: / Line 332: @@
 <pre>
-PUT /api/standard collections/248.json
+PUT /api/standard_collections/248.json
+{
-   "standard collection": {
+   "standard_collection": {
      "id": 248,
      "published": false

@@ Line 273: / Line 273: @@
 </pre>
-=== <code>POST /api/standard collections.json</code> ===
+=== <code>POST /api/standard_collections.json</code> ===
 Create a standard collection.
@@ Line 280: / Line 280: @@
 <pre>
-POST /api/standard collections.json
+POST /api/standard_collections.json
+{
-   "standard collection": {
+   "standard_collection": {
      "title": "My Latest Standard Collection",
      "body": "Buy these products. They're great!",
@@ Line 298: / Line 298: @@
+{
-   "standard collection": {
+   "standard_collection": {
      "id": 123490,
      "title": "My Latest Standard Collection",