Catalogs resource (Data API 19.5)

Summary

Http Method Resource Description
GET /catalogs Action to get all the catalogs with no filtering.
GET /catalogs/{catalog_id} Gets catalog information by catalog Id. Expansion "stats" can be used to retrieved some expensive statistic data, such as assigned_product_count and owned_product_count. Example: /s/-/dw/data/v99_9/catalogs/my-catalog?expand=stats
PATCH /catalogs/{catalog_id} Updates the catalog with the specified information.
POST /catalogs/{catalog_id}/category_search

Searches for catalog categories in the scope of catalog

By default, the server also returns the first level of subcategories, but you can specify another level by setting the levels parameter. Please note, using a large value for levels may cause performance issues in case of a large and deep category tree.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

  • id - String
  • name - String
  • description - String
  • creation_date - DateTime
  • online - Boolean
  • parent_category_id - String

The output of the query can also be sorted. These are the list of sortable attributes:

  • id - String
  • name - String
  • description - String
  • creation_date - DateTime
  • online - Boolean
  • position - Double
GET /catalogs/{catalog_id}/shared_product_options Read shared product options in a catalog.
GET /catalogs/{catalog_id}/shared_product_options/{id} Read a shared product option in a catalog.
PUT /catalogs/{catalog_id}/shared_product_options/{id} Creates a shared product option using the information provided.
DELETE /catalogs/{catalog_id}/shared_product_options/{id} Deletes a shared product option by ID.
PATCH /catalogs/{catalog_id}/shared_product_options/{id} Updates a shared product option with the information provided.
GET /catalogs/{catalog_id}/shared_product_options/{option_id}/values Read shared product option values of a shared product option in a catalog.
GET /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Read a shared product option value of a shared product option in a catalog.
PUT /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Creates a shared product option value using the information provided.
DELETE /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Deletes a shared product option value by ID.
PATCH /catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id} Updates a shared product option value with the information provided.
GET /catalogs/{catalog_id}/shared_variation_attributes Reads variation attributes of a Domain.
GET /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values Reads variation attribute values of a variation attribute of a catalog.
GET /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Action to get Shared Variation Attribute value information.
PUT /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Action to create a Shared Variation Attribute value.
PATCH /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Updates the variation attribute value of a variation attribute of a catalog.
DELETE /catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id} Deletes the variation attribute value of a variation attribute bound to a catalog
GET /catalogs/{catalog_id}/shared_variation_attributes/{id} Action to get shared variation attribute information only for master Catalog.
PUT /catalogs/{catalog_id}/shared_variation_attributes/{id} Creates a variation attribute using the information provided.
DELETE /catalogs/{catalog_id}/shared_variation_attributes/{id} Deletes the variation attribute by ID
PATCH /catalogs/{catalog_id}/shared_variation_attributes/{id} Updates the variation attribute with the specified information.
  • name
  • slicing

Get Catalogs

Action to get all the catalogs with no filtering.

Url

GET https://hostname:port/dw/data/v19_5/catalogs?start={Integer}&count={Integer}&select={String}&expand={String}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

Catalogs

Query Parameters

Parameter Type Description Constraints
count Integer Optional count for retrieving only a subset of the items (default is 25).  
expand String    
select String The property selector.  
start Integer Optional start index for retrieving the items from a given index (default 0).  

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
Content-Type: application/json; charset=UTF-8

# in case of success:
 
RESPONSE:
HTTP/1.1 200 OK
Content-Length: 67
Content-Type: application/json; charset=UTF-8
{
  "_v" : "19.5",
  "count" : 2,
  "data" : [
    {
       "_v" : "19.5",
       "_resource_state" : "860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5",
       "id" : "my-catalog1",
       "name" : {
          "default" : "my-name",
          "en" : "An English my-name",
          "de" : "A German my-name"
       },
       "description" : {
          "default" : "my-description",
          "en" : "An English my-description",
          "de" : "A German my-description"
       },
       "online" : true,
       "start_maintenance" : 2015-7-22T05:00:00.000Z,
       "end_maintenance" : 2015-9-20T05:00:00.000Z,
       "creation_date" : 2015-11-18T05:00:00.000Z,
       "is_master_catalog" : false,
       "is_storefront_catalog" : false,
       "root_category" : "my-root_category",
       "category_count" : 14,
       "owned_product_count" : 19,
       "assigned_product_count" : 22,
       "recommendation_count" : 20,
       "assigned_sites" :
       [
           {
               "_type" : "site",
               "customer_list_link" :
               {
                  "_type" : "customer_list_link",
                  "customer_list_id" : "list1"
               },
               "description" : "Site's site used for test.",
               "display_name" : "Test site 1",
               "id" : "site-1"
            },
            {
               "_type" : "site",
               "customer_list_link" :
               {
                  "_type" : "customer_list_link",
                  "customer_list_id" : "list2"
               },
               "description" : "Site's site used for test 2.",
               "display_name" : "Test site 2",
               "id" : "site-2"
            }
       ],
       "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog1",
    },
    {
       "_v" : "19.5",
       "_resource_state":"gv094jt4rfnc983rchj39d",
       "id" : "my-catalog2",
       "name" : {
          "default" : "my-name",
          "en" : "An English my-name",
          "de" : "A German my-name"
       },
       "description" : {
          "default" : "my-description",
          "en" : "An English my-description",
          "de" : "A German my-description"
       },
       "online" : true,
       "start_maintenance" : 2015-7-22T05:00:00.000Z,
       "end_maintenance" : 2015-9-20T05:00:00.000Z,
       "creation_date" : 2015-11-18T05:00:00.000Z,
       "is_master_catalog" : false,
       "is_storefront_catalog" : false,
       "root_category" : "my-root_category",
       "category_count" : 14,
       "owned_product_count" : 19,
       "assigned_product_count" : 22,
       "recommendation_count" : 20,
       "assigned_sites" : [],
       "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog1",
    }
  ],
  "select": "**",
  "start" : 0,
  "total" : 2
}

Get Catalog

Gets catalog information by catalog Id. Expansion "stats" can be used to retrieved some expensive statistic data, such as assigned_product_count and owned_product_count. Example: /s/-/dw/data/v99_9/catalogs/my-catalog?expand=stats

Url

GET https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}?expand={String}&select={String}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

Catalog

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the requested catalog. minLength=1

Query Parameters

Parameter Type Description Constraints
expand String    
select String the selector for the get. If not passed, the defaultSelector will be used instead.  

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Thrown in case the catalog does not exist matching the given id or the catalog identified was already in deletion.

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs/my-catalog?expand=stats HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
Content-Type: application/json; charset=UTF-8

# in case of success:
 
RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Aug-2014 00:00:00 GMT
{
   "_v" : "19.5",
   "_resource_state" : "860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5",
   "_type" : "catalog",
   "assigned_product_count" : 96,
   "assigned_sites" : 
   [
           {
               "_type" : "site",
               "customer_list_link" : 
               {
                  "_type" : "customer_list_link",
                  "customer_list_id" : "list1"
               },
               "description" : "Site's site used for test.",
               "display_name" : "Test site 1",
               "id" : "site-1"
            },
            
            {
               "_type" : "site",
               "customer_list_link" : 
               {
                  "_type" : "customer_list_link",
                  "customer_list_id" : "list2"
               },
               "description" : "Site's site used for test 2.",
               "display_name" : "Test site 2",
               "id" : "site-2"
            }

   ],
   "category_count" : 37,
   "creation_date" : "2015-10-02T14:16:08.000Z",
   "description" : "My catalog.",
   "id" : "my-catalog",
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog",
   "name" : "My Catalog",
   "online" : true,
   "owned_product_count" : 148,
   "recommendation_count" : 5,
   "root_category" : "root"
}
# in case of failure:
 
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
  "_v":"19.5",
  "fault":{
    "type":"CatalogNotFoundException",
    "message":"No catalog with ID 'my-catalog' was found."
  }
}

Update Catalog

Updates the catalog with the specified information.

Url

PATCH https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

Catalog

Response Document

Catalog

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the requested catalog. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Thrown in case the catalog id is unknown.

Sample

REQUEST:
PATCH  /s/-/dw/data/v19_5/catalogs/my-catalog HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
{
   "_resource_state" : "860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5",
   "id" : "my-catalog",
   "name" : "my-name",
   "description" : "my-description"
}
# in case of success:

RESPONSE:
}
HTTP/1.1 200 OK
Content-Length: 67
Content-Type: application/json; charset=UTF-8


{
   "_resource_state" : "045f07bb655171dc37d8eb8bf4b0db7ac1fb3a160002eb96fbe6e2f95aa4b6cc",
   "assigned_product_count" : 96,
   "assigned_sites" :
   [
      "Site-1",
      "Site-2",
      "Site-3"
   ],
   "category_count" : 37,
   "creation_date" : "2015-10-02T14:16:08.000Z",
   "description" : "my-description",
   "id" : "my-catalog",
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog",
   "name" : "my-name",
   "online" : true,
   "owned_product_count" : 148,
   "recommendation_count" : 5,
   "root_category" : "root"
}

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
  "_v":"19.5",
  "fault":{
    "type":"CatalogNotFoundException",
    "message":"No catalog with ID 'my-catalog' was found."
  }
}

Search Categories within a Catalog

Searches for catalog categories in the scope of catalog

By default, the server also returns the first level of subcategories, but you can specify another level by setting the levels parameter. Please note, using a large value for levels may cause performance issues in case of a large and deep category tree.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

The output of the query can also be sorted. These are the list of sortable attributes:

Url

POST https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/category_search?levels={Integer}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

SearchRequest

Response Document

CategorySearchResult

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. maxLength=256, minLength=1, nullable=false

Query Parameters

Parameter Type Description Constraints
levels Integer   minIntegerValue=0

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
400 MalformedSearchParameterException   Thrown if the query is ill-formed.
404 CatalogNotFoundException

catalogId (String)

Thrown if the specified catalog does not exist.

Sample

REQUEST:
POST /s/-/dw/data/v19_5/catalogs/main-catalog/category_search HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
Accept: application/json

{   "query" : { 
        "term_query": { 
            "fields" : ["online"], 
            "operator" : "is",
            "values" : [false] 
        }
    },
    "select" : "(**)" 
}

RESPONSE:
HTTP/1.1 200 OK
Content-Length: 367
Content-Type: application/json; charset=UTF-8

{
  "_v" : "19.5",
   "_resource_state" : "860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5",
  "_type": "category_search_result",
  "count" : 1,
  "hits" : [
    {
        "_type": "category",
        "_resource_state" : "43c2d7a118bd0a4034399ed86c86654b40c198ea64fd3195e5587d9211d10d7e",
        "creation_date" : "2015-12-15T18:46:09.000Z",
        "description" : 
        {
            "default" : "category 1.1 description\n        "
        },
        "id" : "my-category1",
        "image" : "https://www.example.com/on/demandware.static/-/Sites-WapiCatalog/default/v1450204042887/category%201.1%20image",
        "link" : "https://www.example.com/s/-/dw/data/v19_5/catalogs/WapiCatalog/categories/my-category1",
        "name" : 
        {
            "default" : "Category 1"
        },
        "online" : false,
        "parent_category_id" : "root",
        "position" : 1.0,
        "thumbnail" : "https://www.example.com/on/demandware.static/-/Sites-WapiCatalog/default/v1450204042887/category%201.1%20thumbnail"
     }
  ],
  "query" : 
  { 
      "term_query": 
      { 
         "fields" : ["online"], 
         "operator" : "is",
         "values" : [false]
      } 
  },
  "select": "**",
  "start" : 0,
  "total" : 1
}

Get Shared Product Options

Read shared product options in a catalog.

Url

GET https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options?start={Integer}&count={Integer}&select={String}&currency={String}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

ProductOptions

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1

Query Parameters

Parameter Type Description Constraints
count Integer Optional count for retrieving only a subset of the items (default is 25).  
currency String The currency mnemonic for retrieving the product option values according to the sorting mode.ex:'USD'  
select String The property selector.  
start Integer Optional start index for retrieving the items from a given index (default 0).  

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options?count=5&currency=USD HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
Content-Type: application/json; charset=UTF-8

# in case of success:
 
RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Aug-2014 00:00:00 GMT
{
   "_v" : "19.5",
   "_type" : "product_options",
   "count" : 2,
   "data" : 
   [
      
      {
         "_type" : "product_option",
         "custom_name" : 
         {
            "default" : "Shared Service"
         },
         "default_product_option_value" : "S00",
         "description" : 
         {
            "default" : "Service description"
         },
         "id" : "service",
         "image" : 
         {
            "_type" : "media_file",
            "abs_url" : "https://example.com/on/demandware.static/-/Sites-my-catalog/default/vc8f08a6edba0d7c8e1dec6c535661e44154b54b4/Desert.jpg",
            "dis_base_url" : "https://example.com/dw/image/v2/zzzz_s01/on/demandware.static/-/Sites-my-catalog/default/vc8f08a6edba0d7c8e1dec6c535661e44154b54b4/Desert.jpg",
            "path" : "Desert.jpg"
         },
         "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/service",
         "name" : "Shared Service",
         "shared" : true,
         "sorting_mode" : "byexplicitorder",
         "values" : 
         [
            
            {
               "_type" : "product_option_value",
               "id" : "S00",
               "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/service/Values/S00",
               "sku_extension" : "S00",
               "value" : 
               {
                  "default" : "None"
               }
            },
            
            {
               "_type" : "product_option_value",
               "id" : "S01",
               "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/service/Values/S01",
               "option_price" : 
               {
                  "USD" : "9.99"
               },
               "sku_extension" : "S01",
               "value" : 
               {
                  "default" : "1-year"
               }
            },
            
            {
               "_type" : "product_option_value",
               "id" : "S02",
               "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/service/Values/S02",
               "option_price" : 
               {
                  "USD" : "19.99"
               },
               "sku_extension" : "S02",
               "value" : 
               {
                  "default" : "2-year"
               }
            }
         ]
      },
      
      {
         "_type" : "product_option",
         "custom_name" : 
         {
            "default" : "Extended Warranty"
         },
         "default_product_option_value" : "000",
         "id" : "warranty",
         "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/warranty",
         "name" : "Extended Warranty",
         "shared" : true,
         "sorting_mode" : "byoptionprice",
         "values" : 
         [
            
            {
               "_type" : "product_option_value",
               "id" : "001",
               "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/warranty/Values/001",
               "option_price" : 
               {
                  "USD" : "9.99"
               },
               "value" : 
               {
                  "default" : "1 Year Warranty"
               }
            },
            
            {
               "_type" : "product_option_value",
               "id" : "003",
               "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/warranty/Values/003",
               "option_price" : 
               {
                  "USD" : "29.99"
               },
               "value" : 
               {
                  "default" : "5 Year Warranty"
               }
            },
            
            {
               "_type" : "product_option_value",
               "id" : "000",
               "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/warranty/Values/000",
               "option_price" : 
               {
                 "USD" : "39.99"
               },
               "value" : 
               {
                  "default" : "None"
               }
            },
            
            {
               "_type" : "product_option_value",
               "id" : "002",
               "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/warranty/Values/002",
               "option_price" : 
               {
                  "USD" : "49.99"
               },
               "value" : 
               {
                  "default" : "3 Year Warranty"
               }
            }
         ]
      }
   ],
   "select" : "(**)",
   "start" : 0,
   "total" : 2
}
# in case of failure:
 
RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

Get Product option

Read a shared product option in a catalog.

Url

GET https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options/{id}?currency={String}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

ProductOption

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the shared product option. minLength=1

Query Parameters

Parameter Type Description Constraints
currency String The currency mnemonic for retrieving the product option values according to the sorting mode.ex:'USD'  

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 ProductOptionNotFoundException

productOptionID (String)

id (String)

Indicates the shared product option is not found.
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/option15&currency=USD HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
Content-Type: application/json; charset=UTF-8

# in case of success:
 
RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Aug-2014 00:00:00 GMT

{
   "_v" : "19.5",
   "_type" : "product_option",
   "_resource_state" : "a12bf03699b41b44ef3491dc40ada6b1f67dd6da3f5f15ecbba3a80018ccc0ba",
   "custom_name" : 
   {
      "default" : "Option 15"
   },
   "description" : 
   {
      "default" : "Description for Option 15"
   },
   "id" : "option15",
   "image" : 
   {
      "_type" : "media_file",
      "abs_url" : "https://example.com/on/demandware.static/-/Sites-my-catalog/default/vc8f08a6edba0d7c8e1dec6c535661e44154b54b4/Desert.jpg",
      "dis_base_url" : "https://example.com/dw/image/v2/zzzz_s01/on/demandware.static/-/Sites-my-catalog/default/vc8f08a6edba0d7c8e1dec6c535661e44154b54b4/Desert.jpg",
      "path" : "Desert.jpg"
   },
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/option15",
   "name" : "15",
   "shared" : true,
   "sorting_mode" : "byoptionprice",
   "values" : 
   [
      
      {
         "_type" : "product_option_value",
         "id" : "10",
         "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/option15/Values/10",
         "option_price" : 
         {
           "USD" : "9.99"
         },
         "sku_extension" : "12",
         "value" : 
         {
            "default" : "12"
         }
      },
      
      {
         "_type" : "product_option_value",
         "id" : "121",
         "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/option15/Values/121",
         "option_price" : 
         {
           "USD" : "19.99"
         },
         "sku_extension" : "12",
         "value" : 
         {
            "default" : "12"
         }
      }
   ]
}

# in case of failure:
 
RESPONSE:

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
  "_v":"19.5",
  "fault":{
    "type":"ProductOptionNotFoundException",
    "message":"Can't find product option with option id 'option15' in 'my-catalog'."
  }
}

Create Shared Product Option

Creates a shared product option using the information provided.

Url

PUT https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

ProductOption

Response Document

ProductOption

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the shared product option. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
400 ProductOptionDuplicateException

attrId (String)

Indicates the shared product option is a duplicate.
404 AttributeDefinitionNotFoundException

attributeDefinitionId (String)

objectDefinitionId (String)

Indicates the id specified is not a valid attribute definition.
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.

Sample

REQUEST:
PUT /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/option16 HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
{
   "id":"option16",
   "custom_name" : 
   {
      "default" : "Option 16"
   },
   "description" : 
   {
      "default" : "Description for Option 16"
   },
   "image" : 
   {
      "_type" : "media_file",
      "path" : "Desert.jpg"
   }
}

# in case of success:

RESPONSE:
HTTP/1.1 201 CREATED
Content-Length: 67
Content-Type: application/json; charset=UTF-8
{
   "_v" : "19.5",
   "_type" : "product_option",
   "_resource_state" : "89c79bffb963ddf3a9b8e0df18.7195b1e4d68f33192fceac7aedaea149dbcfd",
   "custom_name" : 
   {
      "default" : "Option 16"
   },
   "description" : 
   {
      "default" : "Description for Option 16"
   },
   "id" : "option16",
   "image" : 
   {
      "_type" : "media_file",
      "abs_url" : "https://example.com/on/demandware.static/-/Sites-XMaster/default/vc8f08a6edba0d7c8e1dec6c535661e44154b54b4/Desert.jpg",
      "dis_base_url" : "https://example.com/dw/image/v2/zzzz_s01/on/demandware.static/-/Sites-XMaster/default/vc8f08a6edba0d7c8e1dec6c535661e44154b54b4/Desert.jpg",
      "path" : "Desert.jpg"
   },
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/option16",
   "name" : "16",
   "shared" : true,
   "sorting_mode" : "byoptionprice"
}

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

HTTP/1.1 400 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionDuplicateException",
        "message":"Could not create Product Option: duplicate id 'option16'."
    }
}

HTTP/1.1 400 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"AttributeDefinitionNotFoundException",
        "message":"No attribute definition with id 'option16"' for object 'Attribute Definition ID' found."
    }
}

Delete Shared Product Option

Deletes a shared product option by ID.

Url

DELETE https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the shared product option.  

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 ProductOptionNotFoundException

productOptionID (String)

id (String)

Indicates the shared product option is not found.
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.

Sample

REQUEST:
DELETE /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/service HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
x-dw-resource-state: 860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5

# in case of success:

RESPONSE:
HTTP/1.1 204 No Content

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionNotFoundException",
        "message":"Can't find product option with option id 'service' in 'my-catalog'."
    }
}

Update Shared Product Option

Updates a shared product option with the information provided.

Url

PATCH https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

ProductOption

Response Document

ProductOption

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the shared product option. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.
404 ProductOptionNotFoundException

productOptionID (String)

id (String)

Indicates the shared product option is not found.

Sample

REQUEST:
PATCH /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/option16 HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
{
   "id" : "option16",
   "custom_name" : 
   {
      "default" : "12831431794"
   },
   "description" : 
   {
      "default" : "1267136813791"
   },
   "sorting_mode":"byexplicitorder",
   "image" : 
   {
      "_type" : "media_file",
      "path" : "Desert21312.jpg"
   }
   
}

# in case of success:

RESPONSE:
HTTP/1.1 201 CREATED
Content-Length: 67
Content-Type: application/json; charset=UTF-8
{
   "_v" : "19.5",
   "_type" : "product_option",
   "_resource_state" : "b40050fbf5f2dd5e997a110bfc9e893326daed8dc7a1ad7010c81ee513a33134",
   "custom_name" : 
   {
      "default" : "12831431794"
   },
   "description" : 
   {
      "default" : "1267136813791"
   },
   "id" : "option16",
   "image" : 
   {
      "_type" : "media_file",
      "abs_url" : "https://example.com/on/demandware.static/-/Sites-my-catalog/default/vc8f08a6edba0d7c8e1dec6c535661e44154b54b4/Desert21312.jpg",
      "dis_base_url" : "https://example.com/dw/image/v2/zzzz_s01/on/demandware.static/-/Sites-my-catalog/default/vc8f08a6edba0d7c8e1dec6c535661e44154b54b4/Desert21312.jpg",
      "path" : "Desert21312.jpg"
   },
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/option16",
   "name" : "12831431794",
   "shared" : true,
   "sorting_mode" : "byexplicitorder"
}

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionNotFoundException",
        "message":"Can't find product option with option id 'option16' in 'my-catalog'."
    }
}

Get Shared Product Option Values

Read shared product option values of a shared product option in a catalog.

Url

GET https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options/{option_id}/values?start={Integer}&count={Integer}&select={String}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

ProductOptionValues

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
option_id String The id of the shared product option. minLength=1

Query Parameters

Parameter Type Description Constraints
count Integer Optional count for retrieving only a subset of the items (default is 25).  
select String The property selector.  
start Integer Optional start index for retrieving the items from a given index (default 0).  

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.
404 ProductOptionNotFoundException

productOptionID (String)

id (String)

Indicates the shared product option is not found.

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values?count=5 HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
Content-Type: application/json; charset=UTF-8

# in case of success:

RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Aug-2014 00:00:00 GMT
{
    "_v": "19.5",
    "_type": "product_option_values",
    "count": 3,
    "data": [
        {
            "_type": "product_option_value",
            "default_product_option_value": true,
            "id": "value1",
            "link": "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/S00",
            "sku_extension": "S00",
            "value": {
                "default": "None",
                "en": "None (en)"
            }
        },
        {
            "_type": "product_option_value",
            "default_product_option_value": false,
            "id": "value2",
            "link": "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/S01",
            "option_prices": [
                {
                    "_type": "money",
                    "currency_mnemonic": "USD",
                    "value": 9.99
                }
            ],
            "sku_extension": "S01",
            "value": {
                "default": "1-year",
                "en": "1-year (en)"
            }
        },
        {
            "_type": "product_option_value",
            "default_product_option_value": false,
            "id": "value3",
            "link": "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/S02",
            "option_prices": [
                {
                    "_type": "money",
                    "currency_mnemonic": "USD",
                    "value": 19.99
                }
            ],
            "sku_extension": "S02",
            "value": {
                "default": "2-year",
                "en": "2-year (en)"
            }
        }
    ],
    "select": "(**)",
    "start": 0,
    "total": 3
}
# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionNotFoundException",
        "message":"Can't find product option with option id 'my-option' in 'my-catalog'."
    }
}

Get Shared Product Option Value

Read a shared product option value of a shared product option in a catalog.

Url

GET https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

ProductOptionValue

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String the id of shared product option value. minLength=1
option_id String The id of the shared product option. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.
404 ProductOptionNotFoundException

productOptionID (String)

id (String)

Indicates the shared product option is not found.
404 ProductOptionValueNotFoundException

productOptionID (String)

productOptionValueID (String)

Indicates the shared product option value is not found.

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/value1 HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
Content-Type: application/json; charset=UTF-8

# in case of success:

RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Aug-2014 00:00:00 GMT

{
    "_v": "19.5",
    "_type": "product_option_value",
    "default_product_option_value": false,
    "id": "value1",
    "link": "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/value1",
    "option_prices": [
        {
            "_type": "money",
            "currency_mnemonic": "USD",
            "value": 9.99
        }
    ],
    "sku_extension": "S01",
    "value": {
        "default": "1-year",
        "en": "1-year (en)"
    }
}

# in case of failure:

RESPONSE:

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
  "_v":"19.5",
  "fault":{
    "type":"ProductOptionNotFoundException",
    "message":"Can't find product option with option id 'my-option' in 'my-catalog'."
  }
}

HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionValueNotFoundException",
        "message":"Can't find product option value with id 'value1' in product option id 'my-option'."
    }
}

Create Shared Product Option Value

Creates a shared product option value using the information provided.

Url

PUT https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

ProductOptionValue

Response Document

ProductOptionValue

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the shared product option value. minLength=1
option_id String The id of the shared product option. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.
404 ProductOptionNotFoundException

productOptionID (String)

id (String)

Indicates the shared product option is not found.

Sample

REQUEST:
PUT /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/value1 HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
{
    "value": {
        "default": "value 1",
        "en": "value 1(en)",
        "en-US": "value 1(en-US)"
    },
    "option_price": {
        "currency_mnemonic": "USD",
        "value": 100
    },
    "sku_extension": "s10"
}

# in case of success:

RESPONSE:
HTTP/1.1 201 CREATED
Content-Length: 67
Content-Type: application/json; charset=UTF-8
{
    "_v": "19.5",
    "_type": "product_option_value",
    "default_product_option_value": false,
    "id": "value1",
    "link": "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/value1",
    "option_prices": [
        {
            "_type": "money",
            "currency_mnemonic": "USD",
            "value": 100.00
        }
    ],
    "sku_extension": "s10",
    "value": {
        "default": "value 1",
        "en-US": "value 1(en-US)",
        "en": "value 1(en)"
    }
}

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionNotFoundException",
        "message":"Can't find product option with option id 'my-option' in 'my-catalog'."
    }
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CurrencyNotFoundException",
        "message":"No currency with mnemonic 'AAA' was found."
    }
}

Delete Shared Product Option Value

Deletes a shared product option value by ID.

Url

DELETE https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the shared product option value.  
option_id String The id of the shared product option. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.
404 ProductOptionNotFoundException

productOptionID (String)

id (String)

Indicates the shared product option is not found.
404 ProductOptionValueNotFoundException

productOptionID (String)

productOptionValueID (String)

Indicates the shared product option value is not found.

Sample

REQUEST:
DELETE /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/value1 HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
x-dw-resource-state: 860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5

# in case of success:

RESPONSE:
HTTP/1.1 204 No Content

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionNotFoundException",
        "message":"Can't find product option with option id 'my-option' in 'my-catalog'."
    }
}

HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionValueNotFoundException",
        "message":"Can't find product option value with id 'value1' in product option id 'my-option.'"
    }
}

Update Shared Product Option Value

Updates a shared product option value with the information provided.

Url

PATCH https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_product_options/{option_id}/values/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

ProductOptionValue

Response Document

ProductOptionValue

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the shared product option value. minLength=1
option_id String The id of the shared product option. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.
404 ProductOptionNotFoundException

productOptionID (String)

id (String)

Indicates the shared product option is not found.
404 ProductOptionValueNotFoundException

productOptionID (String)

productOptionValueID (String)

Indicates the shared product option value is not found.

Sample

REQUEST:
PATCH /s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/value1 HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaaa-dddd-cccc-eeee-aaaaaaaa
{
    "value": {
        "default": "value 10",
        "en": "value 10(en)",
        "en-US": "value 10(en-US)"
    },
    "option_price": {
        "currency_mnemonic": "AFN",
        "value": 100
    },
    "sku_extension": "s10"
}

# in case of success:

RESPONSE:
HTTP/1.1 200 OK
Content-Length: 67
Content-Type: application/json; charset=UTF-8
{
    "_v": "19.5",
    "_type": "product_option_value",
    "default_product_option_value": false,
    "id": "my-option",
    "link": "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_product_options/my-option/values/value1",
    "option_prices": [
        {
            "_type": "money",
            "currency_mnemonic": "AFN",
            "value": 100.00
        }
    ],
    "sku_extension": "s10",
    "value": {
        "default": "value 10",
        "en-US": "value 10(en-US)",
        "en": "value 10(en)"
    }
}

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'my-catalog' found."
    }
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionNotFoundException",
        "message":"Can't find product option with option id 'my-option' in 'my-catalog'."
    }
}

HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"ProductOptionValueNotFoundException",
        "message":"Can't find product option value with id 'value1' in product option id 'my-option'.
        "
    }
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CurrencyNotFoundException",
        "message":"No currency with mnemonic 'AAA' was found."
    }
}

Get Variation Attributes

Reads variation attributes of a Domain.

Url

GET https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes?start={Integer}&count={Integer}&select={String}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

VariationAttributes

Path Parameters

Parameter Type Description Constraints
catalog_id String id of the catalog minLength=1

Query Parameters

Parameter Type Description Constraints
count Integer    
select String    
start Integer    

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs/my-catalog/shared_variation_attributes?count=20 HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
Content-Type: application/json; charset=UTF-8

# in case of success:
 
RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Aug-2014 00:00:00 GMT
{
   "_v" : "19.5",
   "_type" : "variation_attributes",
   "count" : 2,
   "data" : 
   [
      
      {
         "_type" : "variation_attribute",
         "attribute_definition_id" : "TestStringAttribute1",
         "default_value" : "red",
         "display_name" : 
         {
            "default" : "Test String Attribute 1 (definition)"
         },
         "id" : "color",
         "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalog/shared_variation_attributes/color",
         "name" : 
         {
            "default" : "Color"
         },
         "shared" : true,
         "slicing" : false,
         "values" : 
         [
            
            {
               "_type" : "variation_attribute_value",
               "description" : 
               {
                  "default" : "Reeed"
               },
               "name" : 
               {
                  "default" : "Red"
               },
               "value" : "red"
            },
            
            {
               "_type" : "variation_attribute_value",
               "description" : 
               {
                  "default" : "Bluuue"
               },
               "name" : 
               {
                  "default" : "Blue"
               },
               "value" : "blue"
            },
            
            {
               "_type" : "variation_attribute_value",
               "description" : 
               {
                  "default" : "Blaaack"
               },
               "name" : 
               {
                  "default" : "Black"
               },
               "value" : "black"
            }
         ]
      },
      
      {
         "_type" : "variation_attribute",
         "attribute_definition_id" : "TestString",
         "default_value" : "S",
         "display_name" : 
         {
            "default" : "Test String (definition)"
         },
         "id" : "size",
         "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/my-catalogs/shared_variation_attributes/size",
         "name" : 
         {
            "default" : "Size"
         },
         "shared" : true,
         "slicing" : false,
         "values" : 
         [
            
            {
               "_type" : "variation_attribute_value",
               "description" : 
               {
                  "default" : "Smaaall"
               },
               "name" : 
               {
                  "default" : "Small"
               },
               "value" : "S"
            },
            
            {
               "_type" : "variation_attribute_value",
               "description" : 
               {
                  "default" : "Meeedium"
               },
               "name" : 
               {
                  "default" : "Medium"
               },
               "value" : "M"
            },
            
            {
               "_type" : "variation_attribute_value",
               "description" : 
               {
                  "default" : "Laaarge"
               },
               "name" : 
               {
                  "default" : "Large"
               },
               "value" : "L"
            }
         ]
      }
   ],
   "start" : 0,
   "total" : 2
}

# in case of failure:
 
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
  "_v":"19.5",
  "fault":{
    "type":"CatalogNotFoundException",
    "message":"No catalog with id 'my-catalogs' found."
  }
}

Get Shared Variation Attribute Values

Reads variation attribute values of a variation attribute of a catalog.

Url

GET https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values?start={Integer}&count={Integer}&select={String}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

VariationAttributeValues

Path Parameters

Parameter Type Description Constraints
attribute_id String The variation attribute ID that contains the values. minLength=1
catalog_id String id of the owning catalog. minLength=1

Query Parameters

Parameter Type Description Constraints
count Integer the number of records to get  
select String a string that specifies which fields to return (default is all).  
start Integer the first record to get in the page  

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.
404 VariationAttributeNotFoundException

attrId (String)

Indicate the variation attribute is not found

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs/catalog1/shared_variation_attributes/color/values HTTP/1.1
Host: example.com
Authorization: Bearer cccccccc-dddd-aaaa-ffff-2c53c4507367
Content-Type: application/json; charset=UTF-8

# in case of success:
 
RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Aug-2014 00:00:00 GMT
{
   "_v" : "19.5",
   "_type" : "variation_attribute_values",
   "count" : 3,
   "data" : 
   [ 
      {
         "_type" : "variation_attribute_value",
         "value" : "red",
         "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/catalog1/variation_attributes/color/values/red"
      },
      
      {
         "_type" : "variation_attribute_value",
         "value" : "blue",
         "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/catalog1/variation_attributes/color/values/blue"
      },
      
      {
         "_type" : "variation_attribute_value",
         "value" : "black",
         "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/catalog1/variation_attributes/color/values/black"
      }
   ],
   "select" : "(*,data.(value,link))",
   "start" : 0,
   "total" : 3
}

# in case of failure:
 
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type”:”CatalogtNotFoundException",
        "message":"No catalog with id ‘catalog1’ found."
    }
}

Get Shared Variation Attribute Value

Action to get Shared Variation Attribute value information.

Url

GET https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

VariationAttributeValue

Path Parameters

Parameter Type Description Constraints
attribute_id String The variation attribute custom ID minLength=1
catalog_id String The owning catalog ID. minLength=1
id String The id of the variation attribute value minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.
404 VariationAttributeNotFoundException

attrId (String)

Indicate the variation attribute is not found
404 VariationAttributeValueNotFoundException

attrId (String)

value (String)

Indicate the variation attribute value is not found

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs/catalog1/shared_variation_attributes/color/values/white HTTP/1.1
Host: example.com
Authorization: Bearer aaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
Content-Type: application/json; charset=UTF-8

# in case of success:
 
RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Aug-2014 00:00:00 GMT
x-dw-resource-state: 43c2d7a118bd0a4034399ed86c86654b40c198ea64fd3195e5587d9211d10d7e
{
   "_v" : "19.5",
   "_type" : "variation_attribute_value",
   "_resource_state" : "01301d081252298f275d8fff7d87e89c0feadf5a3ad910ebd6a43ed496dab8da",
   "name" : 
   {
      "it-IT" : "Bianco",
      "default" : "White",
      "fr-FR" : "Blanc"
   },
   "position" : 1.0,
   "value" : "white",
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/catalog1/shared_variation_attributes/color/values/white"
}

# in case of failure:
 
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
  "_v":"19.5",
  "fault":{
    "type":"CatalogNotFoundException",
    "message":"No catalog with id 'catalog1' found."
  }
}

Put Shared Variation Attribute Value

Action to create a Shared Variation Attribute value.

Url

PUT https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

VariationAttributeValue

Response Document

VariationAttributeValue

Path Parameters

Parameter Type Description Constraints
attribute_id String The variation attribute ID minLength=1
catalog_id String The owning catalog ID. minLength=1
id String The id of the variation attribute value minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.
404 VariationAttributeNotFoundException

attrId (String)

Indicate the variation attribute is not found
404 VariationAttributeValueNotFoundException

attrId (String)

value (String)

Indicate the variation attribute value is not found

Sample

REQUEST:
PUT  /s/-/dw/data/v19_5/catalogs/catalog1/shared_variation_attributes/color/values/purple HTTP/1.1
Host: example.com
Authorization: Bearer cccccccc-dddd-aaaa-ffff-2c53c4507367
Content-Type: application/json; charset=UTF-8
{
   "value":"purple" ,
   "description": {
        "default" : "desc of purple (default)",
        "en": "desc of purple (en)",
        "en-US": "desc of purple (en-US)"
        }
}

# in case of success:
 
RESPONSE:
HTTP/1.1 201 CREATED
Expires: Thu, 01-Aug-2014 00:00:00 GMT
{
   "_v" : "19.5",
   "_type" : "variation_attribute_value",
   "_resource_state" : "7a5d17d07f87784fd24999520856c58211bd90027074094d5bbfba784e01374b",
   "description" : 
   {
      "default" : "desc of purple (default)",
      "en-US" : "desc of purple (en-US)",
      "en" : "desc of purple (en)"
   },
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/catalog1/shared_variation_attributes/color/values/purple",
   "position" : 4.0,
   "value" : "purple"
}

# in case of failure:
 
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'catalog1' found."
    }
}

Update Shared Variation Attribute Value

Updates the variation attribute value of a variation attribute of a catalog.

Url

PATCH https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

VariationAttributeValue

Response Document

VariationAttributeValue

Path Parameters

Parameter Type Description Constraints
attribute_id String The id of the requested variation attribute. minLength=1
catalog_id String The id of the catalog. minLength=1
id String The id of the variation value. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

if the catalog id specified cannot be found
404 VariationAttributeNotFoundException

attrId (String)

if the attribute id specified is not a valid variation attribute
404 VariationAttributeValueNotFoundException

attrId (String)

value (String)

if the value id specified does not a valid value id

Sample

REQUEST:
PATCH  /s/-/dw/data/v19_5/catalogs/catalog1/shared_variation_attributes/color/values/purple HTTP/1.1
Host: example.com
Authorization: Bearer cccccccc-dddd-aaaa-ffff-2c53c4507367
Content-Type: application/json; charset=UTF-8
{
   "value":"purple" ,
   "name": {
        "default" : "purple (default)",
        "en": "purple (en)",
        "en-US": "purple (en-US)"
        }
}

# in case of success:
 
RESPONSE:
HTTP/1.1 201 CREATED
Expires: Thu, 01-Aug-2014 00:00:00 GMT
{
   "_v" : "19.5",
   "_type" : "variation_attribute_value",
   "_resource_state" : "7a5d17d07f87784fd24999520856c58211bd90027074094d5bbfba784e01374b",
   "description" : 
   {
      "default" : "desc of purple (default)",
      "en-US" : "desc of purple (en-US)",
      "en" : "desc of purple (en)"
   },
   "name": 
   {
        "default" : "purple (default)",
        "en": "purple (en)",
        "en-US": "purple (en-US)"
   },
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/catalog1/shared_variation_attributes/color/values/purple",
   "position" : 4.0,
   "value" : "purple"
}

# in case of failure:
 
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No Catalog with id 'catalog1' found."
    }
}

Delete Shared Variation Attribute Value

Deletes the variation attribute value of a variation attribute bound to a catalog

Url

DELETE https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes/{attribute_id}/values/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Path Parameters

Parameter Type Description Constraints
attribute_id String The id of the variation attribute that contains the value. minLength=1
catalog_id String The id of the catalog. minLength=1
id String The id of one value to remove  

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

if the catalog id specified cannot be found
404 VariationAttributeNotFoundException

attrId (String)

if the attribute id specified is not a valid variation attribute
404 VariationAttributeValueNotFoundException

attrId (String)

value (String)

if the value id specified does not a valid value id

Sample

REQUEST:
DELETE  /s/-/dw/data/v19_5/catalogs/catalog1/shared_variation_attributes/color/values/purple HTTP/1.1
Host: example.com
Authorization: Bearer cccccccc-dddd-aaaa-ffff-2c53c4507367
Content-Type: application/json; charset=UTF-8

# in case of success:
 
RESPONSE:
HTTP/1.1 204 NO CONTENT

# in case of failure:
 
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'catalog1' found."
    }
}

Get VariationAttribute

Action to get shared variation attribute information only for master Catalog.

Url

GET https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Response Document

VariationAttribute

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the requested variation attribute. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 VariationAttributeNotFoundException

attrId (String)

Thrown in case the variation attribute does not exist matching the given id
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.

Sample

REQUEST:
GET  /s/-/dw/data/v19_5/catalogs/mastercatalogid/shared_variation_attributes/color HTTP/1.1
Host: example.com
Authorization: Bearer cccccccc-dddd-aaaa-ffff-2c53c4507367
Content-Type: application/json; charset=UTF-8

# in case of success:
 
RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Aug-2014 00:00:00 GMT
{
   "_v" : "19.5",
   "_type" : "variation_attribute",
   "_resource_state": "43c2d7a118bd0a4034399ed86c86654b40c198ea64fd3195e5587d9211d10d7e",
   "id" : "color",
   "attribute_definition_id" : "Test_String",
   "name" : {
      "default" : "color",
      "en" : "color",
      "de" : "Farbe"
   },
   "display_name" : {
      "default" : "Test_String",
      "en" : "Test_String",
      "de" : "Test_String"
   },
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/mastercatalogid/shared_variation_attributes/color",
   "shared":true,
   "slicing": false,
   "values" : 
         [
            
            {
               "_type" : "variation_attribute_value",
               "description" : 
               {
                  "default" : "Reeed"
               },
               "name" : 
               {
                  "default" : "Red"
               },
               "value" : "red"
            },
            
            {
               "_type" : "variation_attribute_value",
               "description" : 
               {
                  "default" : "Bluuue"
               },
               "name" : 
               {
                  "default" : "Blue"
               },
               "value" : "blue"
            },
            
            {
               "_type" : "variation_attribute_value",
               "description" : 
               {
                  "default" : "Blaaack"
               },
               "name" : 
               {
                  "default" : "Black"
               },
               "value" : "black"
            }
         ]
}

# in case of failure:
 
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
  "_v":"19.5",
  "fault":{
    "type":"VariationAttributeNotFoundException",
    "message":"No variation attribute with id 'color' found."
  }
}

Create VariationAttribute

Creates a variation attribute using the information provided.

Url

PUT https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

VariationAttribute

Response Document

VariationAttribute

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the variation attribute to create. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
400 SharedVariationAttributeIDNotUniqueException

attrId (String)

 
404 AttributeDefinitionNotFoundException

attributeDefinitionId (String)

objectDefinitionId (String)

if attribute definition supplied is not a product attribute
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.

Sample

REQUEST:
PUT /s/-/dw/data/v19_5/catalogs/XMaster/shared_variation_attributes/481897091358 HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
{
   "id":"481897091358" ,
   "attribute_definition_id":"wapi-option15"
}

# in case of success:

RESPONSE:
HTTP/1.1 201 CREATED
Content-Length: 67
Content-Type: application/json; charset=UTF-8
{
   "_v" : "19.5",
   "_type" : "variation_attribute",
   "_resource_state" : "bf3a5a9e01f83d64c1ed8669804d443e0f643da7a4a035617d75f8db52cf6861",
   "attribute_definition_id" : "wapi-option15",
   "attribute_definition_name" : 
   {
      "default" : "WAPI Option String Value"
   },
   "id" : "481897091358",
   "link" : "https://example.com/s/-/dw/data/v19_5/products/WapiMaster/variation_attributes/481897091358",
   "name" : 
   {
      "default" : "WAPI Option String Value"
   },
   "shared" : true,
   "slicing" : false
}

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"CatalogNotFoundException",
        "message":"No catalog with id 'XMaster' found."
    }
}

Delete VariationAttribute

Deletes the variation attribute by ID

Url

DELETE https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String One variation attribute id to remove  

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 VariationAttributeNotFoundException

attrId (String)

Thrown in case the variation attribute does not exist matching item
404 CatalogNotFoundException

catalogId (String)

Indicates the catalog is not found.

Sample

REQUEST:
DELETE /s/-/dw/data/v19_5/catalogs/WapiXXCatalog/shared_variation_attributes/Slicing_1481897715042 HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
x-dw-resource-state: 860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5

# in case of success:

RESPONSE:
HTTP/1.1 204 No Content

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"VariationAttributeNotFoundException",
        "message":"Can''t find variation attribute for attribute id Slicing_1481897715042."
    }
}

Update VariationAttribute

Updates the variation attribute with the specified information.

Url

PATCH https://hostname:port/dw/data/v19_5/catalogs/{catalog_id}/shared_variation_attributes/{id}

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

VariationAttribute

Response Document

VariationAttribute

Path Parameters

Parameter Type Description Constraints
catalog_id String The id of the catalog. minLength=1
id String The id of the requested variation attribute. minLength=1

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
404 CatalogNotFoundException

catalogId (String)

if the catalog id specified cannot be found

Sample

REQUEST:
PATCH /s/-/dw/data/v19_5/catalogs/WapiTest/shared_variation_attributes/Test_1481897519218 HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
{
   "id" : "Test_1481897519218",
   "attribute_definition_id":"wapi-option17",
   "name" : 
   {
      "default" : "Red Color"
   } 
}

# in case of success:

RESPONSE:
HTTP/1.1 201 CREATED
Content-Length: 67
Content-Type: application/json; charset=UTF-8
x-dw-resource-state: 860cde3040519cce439cd99e209f8a87c3ad0b7e2813edbf6f5501f763b73bd5
{
   "_v" : "19.5",
   "_type" : "variation_attribute",
   "_resource_state" : "f90f0b8e0cc9c3890400e868d5947f1cfd550d4be9e5cc6aabee565eb3e9cbe4",
   "attribute_definition_id" : "wapi-option17",
   "attribute_definition_name" : 
   {
      "default" : "WAPI Option String Value"
   },
   "id" : "Test_1481897519218",
   "link" : "https://example.com/s/-/dw/data/v19_5/catalogs/WapiTest/shared_variation_attributes/Test_1481897519218",
   "name" : 
   {
      "default" : "Red Color"
   },
   "shared" : true,
   "slicing" : false
}

# in case of failure:

RESPONSE:
HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-attribute,must-revalidate
{
    "_v":"19.5",
    "fault":{
        "type":"VariationAttributeNotFoundException",
        "message":"Can''t find variation attribute for attribute id '481897091358'."
    }
}