Products API

Create property values.

Adds values to the properties of an already created product. The properties and the allowed data type for their values depend on the data template for the product’s construction object.

Try it

Request

Request URL

https://api.cobuilder.com/products-management/api/v3/products/{id}/properties/values/create

Request parameters

id

integer

Format - int32. The product id.

Request headers

Content-Type (optional)

string

Media type of the body sent to the API.

Request body

A ProductPropertyValueUpdateRequestModel.

Sample
Schema

{
  "properties": [
    {
      "propertyGuid": "string",
      "unitGuid": "string",
      "values": [
        {
          "value": "string",
          "operator": "string",
          "ifdValues": [
            {
              "valueGuid": "string",
              "title": "string",
              "defaultTitle": "string"
            }
          ],
          "lowerValue": "string",
          "lowerOperator": "string",
          "upperValue": "string",
          "upperOperator": "string",
          "valueTranslations": [
            {
              "text": "string",
              "languageCode": "string"
            }
          ]
        }
      ]
    }
  ]
}

{
  "type": "object",
  "required": [
    "properties"
  ],
  "properties": {
    "properties": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "required": [
              "propertyGuid",
              "unitGuid"
            ],
            "properties": {
              "propertyGuid": {
                "type": "string",
                "minLength": 1,
                "pattern": "^[\\S]{22}$"
              },
              "unitGuid": {
                "type": "string",
                "minLength": 1,
                "pattern": "^[\\S]{22}$"
              }
            }
          },
          {
            "type": "object",
            "required": [
              "values"
            ],
            "properties": {
              "values": {
                "type": "array",
                "items": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "value": {
                          "type": "string",
                          "maxLength": 2000
                        },
                        "operator": {
                          "type": "string"
                        },
                        "ifdValues": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "valueGuid": {
                                "type": "string",
                                "pattern": "^[\\S]{22}$"
                              },
                              "title": {
                                "type": "string"
                              },
                              "defaultTitle": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "lowerValue": {
                          "type": "string",
                          "maxLength": 2000
                        },
                        "lowerOperator": {
                          "type": "string"
                        },
                        "upperValue": {
                          "type": "string",
                          "maxLength": 2000
                        },
                        "upperOperator": {
                          "type": "string"
                        },
                        "valueTranslations": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "text": {
                                "type": "string"
                              },
                              "languageCode": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object"
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

Sample
Schema

{
  "properties": [
    {
      "propertyGuid": "string",
      "unitGuid": "string",
      "values": [
        {
          "value": "string",
          "operator": "string",
          "ifdValues": [
            {
              "valueGuid": "string",
              "title": "string",
              "defaultTitle": "string"
            }
          ],
          "lowerValue": "string",
          "lowerOperator": "string",
          "upperValue": "string",
          "upperOperator": "string",
          "valueTranslations": [
            {
              "text": "string",
              "languageCode": "string"
            }
          ]
        }
      ]
    }
  ]
}

{
  "type": "object",
  "required": [
    "properties"
  ],
  "properties": {
    "properties": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "required": [
              "propertyGuid",
              "unitGuid"
            ],
            "properties": {
              "propertyGuid": {
                "type": "string",
                "minLength": 1,
                "pattern": "^[\\S]{22}$"
              },
              "unitGuid": {
                "type": "string",
                "minLength": 1,
                "pattern": "^[\\S]{22}$"
              }
            }
          },
          {
            "type": "object",
            "required": [
              "values"
            ],
            "properties": {
              "values": {
                "type": "array",
                "items": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "value": {
                          "type": "string",
                          "maxLength": 2000
                        },
                        "operator": {
                          "type": "string"
                        },
                        "ifdValues": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "valueGuid": {
                                "type": "string",
                                "pattern": "^[\\S]{22}$"
                              },
                              "title": {
                                "type": "string"
                              },
                              "defaultTitle": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "lowerValue": {
                          "type": "string",
                          "maxLength": 2000
                        },
                        "lowerOperator": {
                          "type": "string"
                        },
                        "upperValue": {
                          "type": "string",
                          "maxLength": 2000
                        },
                        "upperOperator": {
                          "type": "string"
                        },
                        "valueTranslations": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "text": {
                                "type": "string"
                              },
                              "languageCode": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object"
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

Sample
Schema

{
  "properties": [
    {
      "propertyGuid": "string",
      "unitGuid": "string",
      "values": [
        {
          "value": "string",
          "operator": "string",
          "ifdValues": [
            {
              "valueGuid": "string",
              "title": "string",
              "defaultTitle": "string"
            }
          ],
          "lowerValue": "string",
          "lowerOperator": "string",
          "upperValue": "string",
          "upperOperator": "string",
          "valueTranslations": [
            {
              "text": "string",
              "languageCode": "string"
            }
          ]
        }
      ]
    }
  ]
}

{
  "type": "object",
  "required": [
    "properties"
  ],
  "properties": {
    "properties": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "required": [
              "propertyGuid",
              "unitGuid"
            ],
            "properties": {
              "propertyGuid": {
                "type": "string",
                "minLength": 1,
                "pattern": "^[\\S]{22}$"
              },
              "unitGuid": {
                "type": "string",
                "minLength": 1,
                "pattern": "^[\\S]{22}$"
              }
            }
          },
          {
            "type": "object",
            "required": [
              "values"
            ],
            "properties": {
              "values": {
                "type": "array",
                "items": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "value": {
                          "type": "string",
                          "maxLength": 2000
                        },
                        "operator": {
                          "type": "string"
                        },
                        "ifdValues": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "valueGuid": {
                                "type": "string",
                                "pattern": "^[\\S]{22}$"
                              },
                              "title": {
                                "type": "string"
                              },
                              "defaultTitle": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "lowerValue": {
                          "type": "string",
                          "maxLength": 2000
                        },
                        "lowerOperator": {
                          "type": "string"
                        },
                        "upperValue": {
                          "type": "string",
                          "maxLength": 2000
                        },
                        "upperOperator": {
                          "type": "string"
                        },
                        "valueTranslations": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "text": {
                                "type": "string"
                              },
                              "languageCode": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object"
                    }
                  ]
                }
              }
            }
          }
        ]
      }
    }
  }
}

Responses

201 Created

No content.

Representations

400 Bad Request

Representations

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

401 Unauthorized

Representations

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

403 Forbidden

Representations

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

404 Not Found

Representations

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "object",
  "additionalProperties": {},
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "format": "int32"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.cobuilder.com/products-management/api/v3/products/{id}/properties/values/create"
-H "Content-Type: application/json"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers

            var uri = "https://api.cobuilder.com/products-management/api/v3/products/{id}/properties/values/create?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.cobuilder.com/products-management/api/v3/products/{id}/properties/values/create");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.cobuilder.com/products-management/api/v3/products/{id}/properties/values/create?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.cobuilder.com/products-management/api/v3/products/{id}/properties/values/create";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.cobuilder.com/products-management/api/v3/products/{id}/properties/values/create');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.cobuilder.com')
    conn.request("POST", "/products-management/api/v3/products/{id}/properties/values/create?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.cobuilder.com')
    conn.request("POST", "/products-management/api/v3/products/{id}/properties/values/create?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://api.cobuilder.com/products-management/api/v3/products/{id}/properties/values/create')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body