Response [200 Ok]
| Uri | /api/v2/catalog/sku/2540078!batchadd |
|---|---|
| UriDescription | Batch Add Catalog Sku |
| EndpointType | CatalogSkuBatchAdd |
| Locator | CatalogSkuBatchAdd |
| LocatorType | Object |
CatalogSkuBatchAdd [1 of 1]
/api/v2/catalog/sku/2540078!batchadd
| Uri | /api/v2/catalog/sku/2540078!batchadd |
|---|---|
| UriDescription | Batch Add Catalog Sku |
Request
| Uri | /api/v2/catalog/sku/2540078!batchadd |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
POST
| Permissions |
|
|---|
Output Fields
| FailedImages | array | Array of AlbumImage URIs that were not added to the cart |
|---|---|---|
| ImagesOverTheCartItemLimit | array | Array of AlbumImage URIs that are over the cart item limit and were not added to the cart |
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/catalog/sku/2540078!batchadd"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"POST": {
"Permissions": [
"Read"
]
}
},
"Methods": [
"OPTIONS",
"GET",
"POST"
],
"ParameterDescription": {
"Array": "An indexed array of values with a length in the range MIN_COUNT to MAX_COUNT, inclusive.",
"Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive",
"Boolean": "For true return type true or 1, for false type false or 0"
},
"Parameters": {
"POST": [
{
"Name": "Images",
"Required": true,
"ReadOnly": false,
"Default": null,
"Description": "Array of AlbumImage URIs",
"Type": "Array",
"ITEM_TYPE": "Uri",
"MIN_COUNT": 0,
"MAX_COUNT": 50
},
{
"Name": "Quantity",
"Required": true,
"ReadOnly": false,
"Default": 1,
"Description": "Quantity for each AlbumImage",
"Type": "Integer",
"MIN_VALUE": 1,
"MAX_VALUE": 32767
},
{
"Name": "FilterImagesOverTheCartItemLimit",
"Required": false,
"ReadOnly": false,
"Default": false,
"Description": "Filter images that have reached the cart item limit for the Sku",
"Type": "Boolean"
}
]
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Output": [
{
"Name": "FailedImages",
"Description": "Array of AlbumImage URIs that were not added to the cart",
"Type": "Array",
"ITEM_TYPE": "Uri",
"MIN_COUNT": 0,
"MAX_COUNT": 50
},
{
"Name": "ImagesOverTheCartItemLimit",
"Description": "Array of AlbumImage URIs that are over the cart item limit and were not added to the cart",
"Type": "Array",
"ITEM_TYPE": "Uri",
"MIN_COUNT": 0,
"MAX_COUNT": 50
}
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "catalog"
},
{
"type": "path",
"text": "sku"
},
{
"type": "singleparam",
"param_name": "SkuID",
"param_value": "2540078",
"param_validator": {}
},
{
"type": "action",
"text": "batchadd"
}
]
},
"Response": {
"Uri": "/api/v2/catalog/sku/2540078!batchadd",
"Locator": "CatalogSkuBatchAdd",
"LocatorType": "Object",
"CatalogSkuBatchAdd": {
"Uri": "/api/v2/catalog/sku/2540078!batchadd",
"UriDescription": "Batch Add Catalog Sku"
},
"UriDescription": "Batch Add Catalog Sku",
"EndpointType": "CatalogSkuBatchAdd",
"Timing": {
"Total": {
"time": 0.02975,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}