Collections

(ms.collections)

It contains product collections that group products which have some common features so that it’s easier for customers to find the specific product that they are searching.

Fields

EndPoints

Fields

Value Description

name

Type: string

Required

Name of the collection.

Latest Trends

alias

Type: string

Aliases are the unique collection URL on storefront. It is automatically generated from the name of collection.

latest-trends

type

Type: string

Type of collection. Choose type as "dynamic" if you want to show products according to filters set for individual collection otherwise choose "manual".

dynamic

filters

Type: array

A rule type for which specific collection is created. According to the rule defined, products matching the rule will be shown in that collection set on storefront.

{
"filters": [
  {
    "field": "price",
    "operator": "equals",
    "value": "4000"
  }
 ]
}

field Type: string Required	It holds the field value. It can be Price or Brand. `Price`
operator Type: string	It holds the operator condition.
operator Type: string	It holds the operator condition.
value Type: string	It holds the value of the field.
value Type: string	It holds the value of the field.
value Type: number Required	It holds the value of the field.
name Type: string Required
value Type: string Required	It holds the value of the field.
value Type: string	It holds the value of the field.
value Type: array Required	It holds the value of the field.

images

Type: array

Images for collections.

{
  "image": "ms.collections/5ad88c2a569500abbd5745d2/5ad88c21f25c2cabbca59daf.png"
  "_metadata": {
    "image": {
      "name": "Screenshot from 2017-11-02 16-34-51.png",
      "type": "image/png"
    }
  }
}

image Type: file	Single image related to the collection. `{ "image": { "name": "Screenshot from 2017-11-02 16-34-51.png", "type": "image/png" } }`
caption Type: string

description

Type: string

Brief description about the collection.

Buy all the latest trends here.

count

Type: string

It stores the count of products of a collection.

SEO

Type: object

SEO contains data that affects the online visibility of a collection on search engine.

{
  "SEO": {
    "title": "Get latest trends on unbelievable dicounted price ",
    "description": "Latest trendy dresses starting from INR 1150. Buy New Designer dresses and gown. ✯ 100% Authentic Products ✯ COD.",
     "keywords": "Dresses, Trendy, Designer, Latest", 
       }
}

title Type: string	The title of the category to specify a custom title for the collection page for SEO. `Get latest trends on unbelievable dicounted price`
description Type: string	Specify a custom meta description for the collection page for SEO. `Latest trendy dresses starting from INR 1150. Buy New Designer dresses and gown. ✯ 100% Authentic Products ✯ COD.`
keywords Type: string	Keywords are used to specify a custom meta keywords for the collection page for SEO. `Dresses, Trendy, Designer, Latest`
canonical_url Type: string	The canonical URL is used to declare a single page as its source or for duplicate pages to reference their source/originating page.
sitemap_priority Type: string	Defines the priority of the particular page in your store.
sitemap_frequency Type: string

default_sort_order

Type: string

Select sort order from pre-defined values in which you want products of your collection to be displayed.

By date: Newest to oldest

Commands (Endpoints)

POST /api/1.1/entity/ms.collections

Creates a new collection

DEL /api/1.1/entity/ms.collections/{resource_id}

Deletes a collection

PUT /api/1.1/entity/ms.collections/{resource_id}

Updates an existing collection

GET /api/1.1/entity/ms.collections/{resource_id}

Retrieves a single collection

GET /api/1.1/entity/ms.collections

Retrieves a list of collections

Introduction

API Reference

Collections

(ms.collections)

Fields

Commands (Endpoints)