UltraCartRestApiV2.ItemApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method	HTTP request	Description
deleteDigitalItem	DELETE /item/digital_library/{digital_item_oid}	Delete a digital item, which is a file within the digital library, not an actual merchant item
deleteItem	DELETE /item/items/{merchant_item_oid}	Delete an item
deleteReview	DELETE /item/items/{merchant_item_oid}/reviews/{review_oid}	Delete a review
getDigitalItem	GET /item/digital_library/{digital_item_oid}	Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
getDigitalItems	GET /item/digital_library	Retrieve digital items from the digital library which are digital files that may be attached to normal items
getDigitalItemsByExternalId	GET /item/digital_library/by_external/{external_id}	Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
getItem	GET /item/items/{merchant_item_oid}	Retrieve an item
getItemByMerchantItemId	GET /item/items/merchant_item_id/{merchant_item_id}	Retrieve an item by item id
getItems	GET /item/items	Retrieve items
getPricingTiers	GET /item/pricing_tiers	Retrieve pricing tiers
getReview	GET /item/items/{merchant_item_oid}/reviews/{review_oid}	Get a review
getReviews	GET /item/items/{merchant_item_oid}/reviews	Get reviews for an item
getUnassociatedDigitalItems	GET /item/digital_library/unassociated	Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
insertDigitalItem	POST /item/digital_library	Create a file within the digital library
insertItem	POST /item/items	Create an item
insertReview	POST /item/items/{merchant_item_oid}/reviews	Insert a review
insertUpdateItemContentAttribute	POST /item/items/{merchant_item_oid}/content/attributes	Upsert an item content attribute
updateDigitalItem	PUT /item/digital_library/{digital_item_oid}	Updates a file within the digital library
updateItem	PUT /item/items/{merchant_item_oid}	Update an item
updateItems	PUT /item/items/batch	Update multiple items
updateReview	PUT /item/items/{merchant_item_oid}/reviews/{review_oid}	Update a review
uploadTemporaryMultimedia	POST /item/temp_multimedia	Upload an image to the temporary multimedia.

deleteDigitalItem

deleteDigitalItem(digital_item_oid)

Delete a digital item, which is a file within the digital library, not an actual merchant item

Delete a digital item on the UltraCart account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var digital_item_oid = 56; // Number | The digital item oid to delete.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteDigitalItem(digital_item_oid, callback);

Parameters

Name	Type	Description	Notes
digital_item_oid	Number	The digital item oid to delete.

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

deleteItem

deleteItem(merchant_item_oid)

Delete an item

Delete an item on the UltraCart account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var merchant_item_oid = 56; // Number | The item oid to delete.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteItem(merchant_item_oid, callback);

Parameters

Name	Type	Description	Notes
merchant_item_oid	Number	The item oid to delete.

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

deleteReview

deleteReview(review_oid, merchant_item_oid)

Delete a review

Delete an item review.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var review_oid = 56; // Number | The review oid to delete.

var merchant_item_oid = 56; // Number | The item oid the review is associated with.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteReview(review_oid, merchant_item_oid, callback);

Parameters

Name	Type	Description	Notes
review_oid	Number	The review oid to delete.
merchant_item_oid	Number	The item oid the review is associated with.

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

getDigitalItem

ItemDigitalItemResponse getDigitalItem(digital_item_oid)

Retrieve a digital item from the digital library, which are digital files that may be attached to normal items

Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var digital_item_oid = 56; // Number | The digital item oid to retrieve.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDigitalItem(digital_item_oid, callback);

Parameters

Name	Type	Description	Notes
digital_item_oid	Number	The digital item oid to retrieve.

Return type

ItemDigitalItemResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getDigitalItems

ItemDigitalItemsResponse getDigitalItems(opts)

Retrieve digital items from the digital library which are digital files that may be attached to normal items

Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var opts = { 
  '_limit': 100, // Number | The maximum number of records to return on this one API call. (Default 100, Max 2000)
  '_offset': 0, // Number | Pagination of the record set.  Offset is a zero based index.
  '_since': "_since_example", // String | Fetch items that have been created/modified since this date/time.
  '_sort': "_sort_example", // String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
  '_expand': "_expand_example", // String | The object expansion to perform on the result.  See documentation for examples
  '_placeholders': true // Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDigitalItems(opts, callback);

Parameters

Name	Type	Description	Notes
_limit	Number	The maximum number of records to return on this one API call. (Default 100, Max 2000)	[optional] [default to 100]
_offset	Number	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_since	String	Fetch items that have been created/modified since this date/time.	[optional]
_sort	String	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]
_expand	String	The object expansion to perform on the result. See documentation for examples	[optional]
_placeholders	Boolean	Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.	[optional]

Return type

ItemDigitalItemsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getDigitalItemsByExternalId

ItemDigitalItemsResponse getDigitalItemsByExternalId(external_id)

Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id

Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var external_id = "external_id_example"; // String | The external id to match against.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDigitalItemsByExternalId(external_id, callback);

Parameters

Name	Type	Description	Notes
external_id	String	The external id to match against.

Return type

ItemDigitalItemsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getItem

ItemResponse getItem(merchant_item_oid, opts)

Retrieve an item

Retrieves a single item using the specified item oid.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var merchant_item_oid = 56; // Number | The item oid to retrieve.

var opts = { 
  '_expand': "_expand_example", // String | The object expansion to perform on the result.  See documentation for examples
  '_placeholders': true // Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getItem(merchant_item_oid, opts, callback);

Parameters

Name	Type	Description	Notes
merchant_item_oid	Number	The item oid to retrieve.
_expand	String	The object expansion to perform on the result. See documentation for examples	[optional]
_placeholders	Boolean	Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.	[optional]

Return type

ItemResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getItemByMerchantItemId

ItemResponse getItemByMerchantItemId(merchant_item_id, opts)

Retrieve an item by item id

Retrieves a single item using the specified item id.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var merchant_item_id = "merchant_item_id_example"; // String | The item id to retrieve.

var opts = { 
  '_expand': "_expand_example", // String | The object expansion to perform on the result.  See documentation for examples
  '_placeholders': true // Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getItemByMerchantItemId(merchant_item_id, opts, callback);

Parameters

Name	Type	Description	Notes
merchant_item_id	String	The item id to retrieve.
_expand	String	The object expansion to perform on the result. See documentation for examples	[optional]
_placeholders	Boolean	Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.	[optional]

Return type

ItemResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getItems

ItemsResponse getItems(opts)

Retrieve items

Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var opts = { 
  'parent_category_id': 56, // Number | The parent category object id to retrieve items for.  Unspecified means all items on the account.  0 = root
  'parent_category_path': "parent_category_path_example", // String | The parent category path to retrieve items for.  Unspecified means all items on the account.  / = root
  '_limit': 100, // Number | The maximum number of records to return on this one API call. (Default 100, Max 2000)
  '_offset': 0, // Number | Pagination of the record set.  Offset is a zero based index.
  '_since': "_since_example", // String | Fetch items that have been created/modified since this date/time.
  '_sort': "_sort_example", // String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
  '_expand': "_expand_example", // String | The object expansion to perform on the result.  See documentation for examples
  '_placeholders': true // Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getItems(opts, callback);

Parameters

Name	Type	Description	Notes
parent_category_id	Number	The parent category object id to retrieve items for. Unspecified means all items on the account. 0 = root	[optional]
parent_category_path	String	The parent category path to retrieve items for. Unspecified means all items on the account. / = root	[optional]
_limit	Number	The maximum number of records to return on this one API call. (Default 100, Max 2000)	[optional] [default to 100]
_offset	Number	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_since	String	Fetch items that have been created/modified since this date/time.	[optional]
_sort	String	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]
_expand	String	The object expansion to perform on the result. See documentation for examples	[optional]
_placeholders	Boolean	Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.	[optional]

Return type

ItemsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getPricingTiers

PricingTiersResponse getPricingTiers(opts)

Retrieve pricing tiers

Retrieves the pricing tiers

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var opts = { 
  '_expand': "_expand_example" // String | The object expansion to perform on the result.  See documentation for examples
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getPricingTiers(opts, callback);

Parameters

Name	Type	Description	Notes
_expand	String	The object expansion to perform on the result. See documentation for examples	[optional]

Return type

PricingTiersResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getReview

ItemReviewResponse getReview(review_oid, merchant_item_oid)

Get a review

Retrieve an item review.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var review_oid = 56; // Number | The review oid to retrieve.

var merchant_item_oid = 56; // Number | The item oid the review is associated with.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getReview(review_oid, merchant_item_oid, callback);

Parameters

Name	Type	Description	Notes
review_oid	Number	The review oid to retrieve.
merchant_item_oid	Number	The item oid the review is associated with.

Return type

ItemReviewResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

getReviews

ItemReviewsResponse getReviews(merchant_item_oid)

Get reviews for an item

Retrieve item reviews.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var merchant_item_oid = 56; // Number | The item oid the review is associated with.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getReviews(merchant_item_oid, callback);

Parameters

Name	Type	Description	Notes
merchant_item_oid	Number	The item oid the review is associated with.

Return type

ItemReviewsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

getUnassociatedDigitalItems

ItemDigitalItemsResponse getUnassociatedDigitalItems(opts)

Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items

Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var opts = { 
  '_limit': 100, // Number | The maximum number of records to return on this one API call. (Default 100, Max 2000)
  '_offset': 0, // Number | Pagination of the record set.  Offset is a zero based index.
  '_since': "_since_example", // String | Fetch items that have been created/modified since this date/time.
  '_sort': "_sort_example", // String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
  '_expand': "_expand_example", // String | The object expansion to perform on the result.  See documentation for examples
  '_placeholders': true // Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getUnassociatedDigitalItems(opts, callback);

Parameters

Name	Type	Description	Notes
_limit	Number	The maximum number of records to return on this one API call. (Default 100, Max 2000)	[optional] [default to 100]
_offset	Number	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
_since	String	Fetch items that have been created/modified since this date/time.	[optional]
_sort	String	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]
_expand	String	The object expansion to perform on the result. See documentation for examples	[optional]
_placeholders	Boolean	Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.	[optional]

Return type

ItemDigitalItemsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

insertDigitalItem

ItemDigitalItemResponse insertDigitalItem(digital_item)

Create a file within the digital library

Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var digital_item = new UltraCartRestApiV2.ItemDigitalItem(); // ItemDigitalItem | Digital item to create


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.insertDigitalItem(digital_item, callback);

Parameters

Name	Type	Description	Notes
digital_item	ItemDigitalItem	Digital item to create

Return type

ItemDigitalItemResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

insertItem

ItemResponse insertItem(item, opts)

Create an item

Create a new item on the UltraCart account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var item = new UltraCartRestApiV2.Item(); // Item | Item to create

var opts = { 
  '_expand': "_expand_example", // String | The object expansion to perform on the result.  See documentation for examples
  '_placeholders': true // Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.insertItem(item, opts, callback);

Parameters

Name	Type	Description	Notes
item	Item	Item to create
_expand	String	The object expansion to perform on the result. See documentation for examples	[optional]
_placeholders	Boolean	Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.	[optional]

Return type

ItemResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

insertReview

ItemReviewResponse insertReview(review, merchant_item_oid)

Insert a review

Insert a item review.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var review = new UltraCartRestApiV2.ItemReview(); // ItemReview | Review to insert

var merchant_item_oid = 56; // Number | The item oid the review is associated with.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.insertReview(review, merchant_item_oid, callback);

Parameters

Name	Type	Description	Notes
review	ItemReview	Review to insert
merchant_item_oid	Number	The item oid the review is associated with.

Return type

ItemReviewResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

insertUpdateItemContentAttribute

insertUpdateItemContentAttribute(item_attribute, merchant_item_oid)

Upsert an item content attribute

Update an item content attribute, creating it new if it does not yet exist.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var item_attribute = new UltraCartRestApiV2.ItemContentAttribute(); // ItemContentAttribute | Item content attribute to upsert

var merchant_item_oid = 56; // Number | The item oid to modify.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.insertUpdateItemContentAttribute(item_attribute, merchant_item_oid, callback);

Parameters

Name	Type	Description	Notes
item_attribute	ItemContentAttribute	Item content attribute to upsert
merchant_item_oid	Number	The item oid to modify.

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

updateDigitalItem

ItemDigitalItemResponse updateDigitalItem(digital_item_oid, digital_item)

Updates a file within the digital library

Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var digital_item_oid = 56; // Number | The digital item oid to update.

var digital_item = new UltraCartRestApiV2.ItemDigitalItem(); // ItemDigitalItem | Digital item to update


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateDigitalItem(digital_item_oid, digital_item, callback);

Parameters

Name	Type	Description	Notes
digital_item_oid	Number	The digital item oid to update.
digital_item	ItemDigitalItem	Digital item to update

Return type

ItemDigitalItemResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

updateItem

ItemResponse updateItem(item, merchant_item_oid, opts)

Update an item

Update a new item on the UltraCart account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var item = new UltraCartRestApiV2.Item(); // Item | Item to update

var merchant_item_oid = 56; // Number | The item oid to update.

var opts = { 
  '_expand': "_expand_example", // String | The object expansion to perform on the result.  See documentation for examples
  '_placeholders': true // Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateItem(item, merchant_item_oid, opts, callback);

Parameters

Name	Type	Description	Notes
item	Item	Item to update
merchant_item_oid	Number	The item oid to update.
_expand	String	The object expansion to perform on the result. See documentation for examples	[optional]
_placeholders	Boolean	Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.	[optional]

Return type

ItemResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

updateItems

ItemsResponse updateItems(items_request, opts)

Update multiple items

Update multiple item on the UltraCart account.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var items_request = new UltraCartRestApiV2.ItemsRequest(); // ItemsRequest | Items to update (synchronous maximum 20 / asynchronous maximum 100)

var opts = { 
  '_expand': "_expand_example", // String | The object expansion to perform on the result.  See documentation for examples
  '_placeholders': true, // Boolean | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
  '_async': true // Boolean | True if the operation should be run async.  No result returned
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateItems(items_request, opts, callback);

Parameters

Name	Type	Description	Notes
items_request	ItemsRequest	Items to update (synchronous maximum 20 / asynchronous maximum 100)
_expand	String	The object expansion to perform on the result. See documentation for examples	[optional]
_placeholders	Boolean	Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.	[optional]
_async	Boolean	True if the operation should be run async. No result returned	[optional]

Return type

ItemsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

updateReview

ItemReviewResponse updateReview(review, review_oid, merchant_item_oid)

Update a review

Update an item review.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var review = new UltraCartRestApiV2.ItemReview(); // ItemReview | Review to update

var review_oid = 56; // Number | The review oid to update.

var merchant_item_oid = 56; // Number | The item oid the review is associated with.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateReview(review, review_oid, merchant_item_oid, callback);

Parameters

Name	Type	Description
review	ItemReview	Review to update
review_oid	Number	The review oid to update.
merchant_item_oid	Number	The item oid the review is associated with.

Return type

ItemReviewResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: application/json; charset=UTF-8
Accept: application/json

uploadTemporaryMultimedia

TempMultimediaResponse uploadTemporaryMultimedia(file)

Upload an image to the temporary multimedia.

Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.

Example

var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');

// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.ItemApi();


var file = "/path/to/file.txt"; // File | File to upload


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.uploadTemporaryMultimedia(file, callback);

Parameters

Name	Type	Description	Notes
file	File	File to upload

Return type

TempMultimediaResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

Files

ItemApi.md

Latest commit

History

ItemApi.md

File metadata and controls

UltraCartRestApiV2.ItemApi

deleteDigitalItem

Example

Parameters

Return type

Authorization

HTTP request headers

deleteItem

Example

Parameters

Return type

Authorization

HTTP request headers

deleteReview

Example

Parameters

Return type

Authorization

HTTP request headers

getDigitalItem

Example

Parameters

Return type

Authorization

HTTP request headers

getDigitalItems

Example

Parameters

Return type

Authorization

HTTP request headers

getDigitalItemsByExternalId

Example

Parameters

Return type

Authorization

HTTP request headers

getItem

Example

Parameters

Return type

Authorization

HTTP request headers

getItemByMerchantItemId

Example

Parameters

Return type

Authorization

HTTP request headers

getItems

Example

Parameters

Return type

Authorization

HTTP request headers

getPricingTiers

Example

Parameters

Return type

Authorization

HTTP request headers

getReview

Example

Parameters

Return type

Authorization

HTTP request headers

getReviews

Example

Parameters

Return type

Authorization

HTTP request headers

getUnassociatedDigitalItems