With the /bundle endpoint user can manage bundles. User can add, edit or delete a bundle.
Also user can get the bundle info and image.
POST
api/Bundle/Create
Create Bundle
Model Request Example
{
"BundleLocations": [
{
"BundlePersonalizations": [
{
"Text": "string",
"TextColour": "string",
"FontOverride": "string",
"HeightOverride": 0,
"ElementName": "string",
"IsText": true,
"Palette": [
{
"ReplacementName": "string",
"NeedleIndex": 0
}
]
}
],
"LocationName": "string",
"TemplateName": "string"
}
],
"BundleUniqueIdentifier": "string",
"ProductSKU": "string",
"ExpiryDate": "2017-11-13T08:09:21.555Z",
"NeverExpire": true
}
Response Example
If the operation is successful the response will be empty with status code 201
Possible error codes:
100 - Blacklist Violation
1201 - Bundle with such unique identifier already exists.
1202 - Bundle unique identifier is not provided
1007 - Text is too long
1001 - Product was not found
1013 - Personalization has empty text
1012 - Template file not found
1004 - Colour was not found in the database
1016 - Font was not found in the database
1022 - Height Overright can not be zero
1023 - text is shorter than minimum number of characters for font rule
1024 - Text is too long for font rule
1301 - Design file was not found
1017 - Colour is not configured for this template
1018 - Font is not configured for this template
1019 - Design is not configured for this template
2000 - Location name is required
2001 - Image is too big, can not fit into the location
4001 - Bad Api Key
5001 - Generated image width and height must be above 10px. Adjust your DPI and/or Padding setting
5002 - Can not add template on product
5004 - Font rule was not found
5005 - Product SKU was not found
PUT
api/Bundle/Put
Modifies an existing bundle
Model Request Example
{
"BundleLocations": [
{
"BundlePersonalizations": [
{
"Text": "string",
"TextColour": "string",
"FontOverride": "string",
"HeightOverride": 0,
"ElementName": "string",
"IsText": true,
"Palette": [
{
"ReplacementName": "string",
"NeedleIndex": 0
}
]
}
],
"LocationName": "string",
"TemplateName": "string"
}
],
"BundleUniqueIdentifier": "string",
"ProductSKU": "string",
"ExpiryDate": "2017-11-13T08:09:21.567Z",
"NeverExpire": true
}
Response Example
If the operation is successful the response will be empty with status code 200
Possible error codes:
1200 - Bundle does not exist
100 - Blacklist Violation
1007 - Text is too long
1001 - Product was not found
2000 - Location name is required
1013 - Personalization has empty text
1012 - Template file not found
1004 - Colour was not found in the database
1016 - Font was not found in the database
1022 - Height Overright can not be zero
1023 - text is shorter than minimum number of characters for font rule
1024 - Text is too long for font rule
1301 - Design file was not found
1017 - Colour is not configured for this template
1018 - Font is not configured for this template
1019 - Design is not configured for this template
2001 - Image is too big, can not fit into the location
4001 - Bad Api Key
5001 - Generated image width and height must be above 10px. Adjust your DPI and/or Padding setting
5002 - Can not add template on product
5004 - Font rule was not found
5005 - Product SKU was not found
DELETE
/api/Bundle/DeleteBundles
Removes a location configuration from a bundle
Model Request Example
/api/Bundle/DeleteBundles?bundleUniqueIdentifires[0]=bundle1&bundleUniqueIdentifires[1]=bundle2
Response Example
If the operation is successful the response will be empty with status code 200
Possible error codes:
1202 - Files for bundle do not exist in the directory
403 - Api key is not valid.
409 - Exception occurred. Check the detailed errors message.
GET
/api/Bundle/GetBundleInfo
Returns information about a specified bundle
Request Example
/api/Bundle/GetBundleInfo?uniqueidentifier=bundle1
Response Example
{
"BundleLocations": [
{
"BundlePersonalizations": [
{
"Text": "string",
"TextColour": "string",
"FontOverride": "string",
"HeightOverride": 1,
"ElementName": "string",
"IsText": true,
"Palette": [
{
"ReplacementName": "string",
"NeedleIndex": 0
}
]
}
],
"LocationName": "string",
"TemplateName": "string"
}
],
"BundleUniqueIdentifier": "string",
"ProductSKU": "string",
"ExpiryDate": "2018-11-13T08:09:22",
"NeverExpire": false,
"BundleInfo": {
...
},
"CompanyId": 0,
"Id": 165
}
GET
/api/Bundle/GetThumbnaiL
Returns an icon of a template for a specific location
Request Example
api/Bundle/GetThumbnail?uniqueidentifier=BUNDLE1&location=location&isRenderOnProduct=false
JSON Response Example
URL for thumbnail
/GetTumbnail/66/66_notproduct_Location_Loc-11132017122138PM.png