Products API
API change historyAdd relations between documents and products
Add one or multiple relations between products and documents. A necessary condition is that the products are owned by the user.
Try itRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
List of DocumentProductRelationRequestModel.
[
{
"productId": 0,
"documentId": 0
}
]{
"type": "array",
"items": {
"type": "object",
"required": [
"productId",
"documentId"
],
"properties": {
"productId": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "integer",
"format": "int32"
}
}
}
}[
{
"productId": 0,
"documentId": 0
}
]{
"type": "array",
"items": {
"type": "object",
"required": [
"productId",
"documentId"
],
"properties": {
"productId": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "integer",
"format": "int32"
}
}
}
}[
{
"productId": 0,
"documentId": 0
}
]{
"type": "array",
"items": {
"type": "object",
"required": [
"productId",
"documentId"
],
"properties": {
"productId": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "integer",
"format": "int32"
}
}
}
}Responses
204 No Content
No content if successful.
Representations
400 Bad Request
Representations
{
"type": "array",
"items": {
"type": "object",
"required": [
"errorCode"
],
"properties": {
"relation": {
"type": "object",
"required": [
"productId",
"documentId"
],
"properties": {
"productId": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "integer",
"format": "int32"
}
}
},
"errorCode": {
"type": "integer",
"description": "",
"x-enumNames": [
"GtinAlreadyUsedInSupplier",
"SpnAlreadyUsedInSupplier",
"Identifier1AlreadyUsed",
"Identifier2AlreadyUsed",
"Identifier3AlreadyUsed",
"AccountDoesNotExists",
"CountryIndexDoesNotExist",
"DifferentCountryIndexes",
"InvalidProductType",
"FailedToCreateProduct",
"FailedToCreateProductToProductType",
"ManufacturerNameRequired",
"ParentManufacturedProductIdRequired",
"ProductNotFound",
"ProductTypeAlreadyAssinged",
"ProductWithoutProductType",
"FailedToRemoveProductToProductTypeRelation",
"ParentProductMustBeProductLine",
"InvalidProductLineChildSpecificType",
"ProductCanOnlyHaveOneParentOfProductLine",
"ProductLineParentAndChildDifferentProductType",
"FailedToRemoveProductFromProductLine",
"InvalidProductLineChild",
"NotAllProductsHaveTheSameAccount",
"TheProductIsNotProductLine",
"ProductHasAssignedChildren",
"ProductHasAssignedParent",
"ParentProductNotFound",
"ProductLineHierarhyDepthReached",
"ProductLineNotAllowDirectParentProduct",
"DocumentNotFound",
"ProductToDocumentRelationNotFound",
"ProductToDocumentRelationExist",
"TemplateNotRelatedToConstructionObject",
"TemplateAlreadyAssigned",
"FailedToCreateProductToTemplate",
"DuplicatedParameter",
"ProductWithoutTemplate",
"FailedToRemoveProductToTemplateRelation",
"InvalidSpecificProductType",
"NoConstructionObjectRelatedToProduct",
"NoTemplateRelatedToConstructionObject",
"TemplateNotRelatedToProduct",
"ProductLineParentAndChildDifferentTemplate",
"ProductLineParentAndChildDifferentTemplateVersion",
"ProductLineTemplateUpdateNotAllowed"
],
"enum": [
9,
10,
11,
12,
13,
24,
33,
34,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87
]
},
"errorName": {
"type": "string"
}
}
}
}[
{
"relation": {
"productId": 0,
"documentId": 0
},
"errorCode": 9,
"errorName": "string"
}
]{
"type": "array",
"items": {
"type": "object",
"required": [
"errorCode"
],
"properties": {
"relation": {
"type": "object",
"required": [
"productId",
"documentId"
],
"properties": {
"productId": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "integer",
"format": "int32"
}
}
},
"errorCode": {
"type": "integer",
"description": "",
"x-enumNames": [
"GtinAlreadyUsedInSupplier",
"SpnAlreadyUsedInSupplier",
"Identifier1AlreadyUsed",
"Identifier2AlreadyUsed",
"Identifier3AlreadyUsed",
"AccountDoesNotExists",
"CountryIndexDoesNotExist",
"DifferentCountryIndexes",
"InvalidProductType",
"FailedToCreateProduct",
"FailedToCreateProductToProductType",
"ManufacturerNameRequired",
"ParentManufacturedProductIdRequired",
"ProductNotFound",
"ProductTypeAlreadyAssinged",
"ProductWithoutProductType",
"FailedToRemoveProductToProductTypeRelation",
"ParentProductMustBeProductLine",
"InvalidProductLineChildSpecificType",
"ProductCanOnlyHaveOneParentOfProductLine",
"ProductLineParentAndChildDifferentProductType",
"FailedToRemoveProductFromProductLine",
"InvalidProductLineChild",
"NotAllProductsHaveTheSameAccount",
"TheProductIsNotProductLine",
"ProductHasAssignedChildren",
"ProductHasAssignedParent",
"ParentProductNotFound",
"ProductLineHierarhyDepthReached",
"ProductLineNotAllowDirectParentProduct",
"DocumentNotFound",
"ProductToDocumentRelationNotFound",
"ProductToDocumentRelationExist",
"TemplateNotRelatedToConstructionObject",
"TemplateAlreadyAssigned",
"FailedToCreateProductToTemplate",
"DuplicatedParameter",
"ProductWithoutTemplate",
"FailedToRemoveProductToTemplateRelation",
"InvalidSpecificProductType",
"NoConstructionObjectRelatedToProduct",
"NoTemplateRelatedToConstructionObject",
"TemplateNotRelatedToProduct",
"ProductLineParentAndChildDifferentTemplate",
"ProductLineParentAndChildDifferentTemplateVersion",
"ProductLineTemplateUpdateNotAllowed"
],
"enum": [
9,
10,
11,
12,
13,
24,
33,
34,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87
]
},
"errorName": {
"type": "string"
}
}
}
}[
{
"relation": {
"productId": 0,
"documentId": 0
},
"errorCode": 9,
"errorName": "string"
}
]{
"type": "array",
"items": {
"type": "object",
"required": [
"errorCode"
],
"properties": {
"relation": {
"type": "object",
"required": [
"productId",
"documentId"
],
"properties": {
"productId": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "integer",
"format": "int32"
}
}
},
"errorCode": {
"type": "integer",
"description": "",
"x-enumNames": [
"GtinAlreadyUsedInSupplier",
"SpnAlreadyUsedInSupplier",
"Identifier1AlreadyUsed",
"Identifier2AlreadyUsed",
"Identifier3AlreadyUsed",
"AccountDoesNotExists",
"CountryIndexDoesNotExist",
"DifferentCountryIndexes",
"InvalidProductType",
"FailedToCreateProduct",
"FailedToCreateProductToProductType",
"ManufacturerNameRequired",
"ParentManufacturedProductIdRequired",
"ProductNotFound",
"ProductTypeAlreadyAssinged",
"ProductWithoutProductType",
"FailedToRemoveProductToProductTypeRelation",
"ParentProductMustBeProductLine",
"InvalidProductLineChildSpecificType",
"ProductCanOnlyHaveOneParentOfProductLine",
"ProductLineParentAndChildDifferentProductType",
"FailedToRemoveProductFromProductLine",
"InvalidProductLineChild",
"NotAllProductsHaveTheSameAccount",
"TheProductIsNotProductLine",
"ProductHasAssignedChildren",
"ProductHasAssignedParent",
"ParentProductNotFound",
"ProductLineHierarhyDepthReached",
"ProductLineNotAllowDirectParentProduct",
"DocumentNotFound",
"ProductToDocumentRelationNotFound",
"ProductToDocumentRelationExist",
"TemplateNotRelatedToConstructionObject",
"TemplateAlreadyAssigned",
"FailedToCreateProductToTemplate",
"DuplicatedParameter",
"ProductWithoutTemplate",
"FailedToRemoveProductToTemplateRelation",
"InvalidSpecificProductType",
"NoConstructionObjectRelatedToProduct",
"NoTemplateRelatedToConstructionObject",
"TemplateNotRelatedToProduct",
"ProductLineParentAndChildDifferentTemplate",
"ProductLineParentAndChildDifferentTemplateVersion",
"ProductLineTemplateUpdateNotAllowed"
],
"enum": [
9,
10,
11,
12,
13,
24,
33,
34,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87
]
},
"errorName": {
"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"
}
}
}{
"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"
}
}
}{
"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"
}
}
}{
"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"
}
}
}{
"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/v2/documents/products/relations"
-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/v2/documents/products/relations?" + 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/v2/documents/products/relations");
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/v2/documents/products/relations?" + $.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/v2/documents/products/relations";
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/v2/documents/products/relations');
$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/v2/documents/products/relations?%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/v2/documents/products/relations?%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/v2/documents/products/relations')
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