ultracart.ItemApi

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

Method	HTTP request	Description
delete_digital_item	DELETE /item/digital_library/{digital_item_oid}	Delete a digital item, which is a file within the digital library, not an actual merchant item
delete_item	DELETE /item/items/{merchant_item_oid}	Delete an item
delete_review	DELETE /item/items/{merchant_item_oid}/reviews/{review_oid}	Delete a review
get_digital_item	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
get_digital_items	GET /item/digital_library	Retrieve digital items from the digital library which are digital files that may be attached to normal items
get_digital_items_by_external_id	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
get_item	GET /item/items/{merchant_item_oid}	Retrieve an item
get_item_by_merchant_item_id	GET /item/items/merchant_item_id/{merchant_item_id}	Retrieve an item by item id
get_items	GET /item/items	Retrieve items
get_pricing_tiers	GET /item/pricing_tiers	Retrieve pricing tiers
get_review	GET /item/items/{merchant_item_oid}/reviews/{review_oid}	Get a review
get_reviews	GET /item/items/{merchant_item_oid}/reviews	Get reviews for an item
get_unassociated_digital_items	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
insert_digital_item	POST /item/digital_library	Create a file within the digital library
insert_item	POST /item/items	Create an item
insert_review	POST /item/items/{merchant_item_oid}/reviews	Insert a review
insert_update_item_content_attribute	POST /item/items/{merchant_item_oid}/content/attributes	Upsert an item content attribute
update_digital_item	PUT /item/digital_library/{digital_item_oid}	Updates a file within the digital library
update_item	PUT /item/items/{merchant_item_oid}	Update an item
update_items	PUT /item/items/batch	Update multiple items
update_review	PUT /item/items/{merchant_item_oid}/reviews/{review_oid}	Update a review
upload_temporary_multimedia	POST /item/temp_multimedia	Upload an image to the temporary multimedia.

delete_digital_item

delete_digital_item(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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

digital_item_oid = 56 # int | The digital item oid to delete.

try:
    # Delete a digital item, which is a file within the digital library, not an actual merchant item
    api_instance.delete_digital_item(digital_item_oid)
except ApiException as e:
    print("Exception when calling ItemApi->delete_digital_item: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_item

delete_item(merchant_item_oid)

Delete an item

Delete an item on the UltraCart account.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

merchant_item_oid = 56 # int | The item oid to delete.

try:
    # Delete an item
    api_instance.delete_item(merchant_item_oid)
except ApiException as e:
    print("Exception when calling ItemApi->delete_item: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_review

delete_review(review_oid, merchant_item_oid)

Delete a review

Delete an item review.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

review_oid = 56 # int | The review oid to delete.
merchant_item_oid = 56 # int | The item oid the review is associated with.

try:
    # Delete a review
    api_instance.delete_review(review_oid, merchant_item_oid)
except ApiException as e:
    print("Exception when calling ItemApi->delete_review: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_digital_item

ItemDigitalItemResponse get_digital_item(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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

digital_item_oid = 56 # int | The digital item oid to retrieve.

try:
    # Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
    api_response = api_instance.get_digital_item(digital_item_oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_digital_item: %s\n" % e)

Parameters

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

Return type

ItemDigitalItemResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_digital_items

ItemDigitalItemsResponse get_digital_items(limit=limit, offset=offset, since=since, sort=sort, expand=expand, placeholders=placeholders)

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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

limit = 100 # int | The maximum number of records to return on this one API call. (Default 100, Max 2000) (optional) (default to 100)
offset = 0 # int | Pagination of the record set.  Offset is a zero based index. (optional) (default to 0)
since = 'since_example' # str | Fetch items that have been created/modified since this date/time. (optional)
sort = 'sort_example' # str | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. (optional)
expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)
placeholders = true # bool | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. (optional)

try:
    # Retrieve digital items from the digital library which are digital files that may be attached to normal items
    api_response = api_instance.get_digital_items(limit=limit, offset=offset, since=since, sort=sort, expand=expand, placeholders=placeholders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_digital_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	The maximum number of records to return on this one API call. (Default 100, Max 2000)	[optional] [default to 100]
offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
since	str	Fetch items that have been created/modified since this date/time.	[optional]
sort	str	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]
placeholders	bool	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_digital_items_by_external_id

ItemDigitalItemsResponse get_digital_items_by_external_id(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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

external_id = 'external_id_example' # str | The external id to match against.

try:
    # Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
    api_response = api_instance.get_digital_items_by_external_id(external_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_digital_items_by_external_id: %s\n" % e)

Parameters

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

Return type

ItemDigitalItemsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_item

ItemResponse get_item(merchant_item_oid, expand=expand, placeholders=placeholders)

Retrieve an item

Retrieves a single item using the specified item oid.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

merchant_item_oid = 56 # int | The item oid to retrieve.
expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)
placeholders = true # bool | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. (optional)

try:
    # Retrieve an item
    api_response = api_instance.get_item(merchant_item_oid, expand=expand, placeholders=placeholders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_item_oid	int	The item oid to retrieve.
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]
placeholders	bool	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_item_by_merchant_item_id

ItemResponse get_item_by_merchant_item_id(merchant_item_id, expand=expand, placeholders=placeholders)

Retrieve an item by item id

Retrieves a single item using the specified item id.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

merchant_item_id = 'merchant_item_id_example' # str | The item id to retrieve.
expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)
placeholders = true # bool | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. (optional)

try:
    # Retrieve an item by item id
    api_response = api_instance.get_item_by_merchant_item_id(merchant_item_id, expand=expand, placeholders=placeholders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_item_by_merchant_item_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_item_id	str	The item id to retrieve.
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]
placeholders	bool	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_items

ItemsResponse get_items(parent_category_id=parent_category_id, parent_category_path=parent_category_path, limit=limit, offset=offset, since=since, sort=sort, expand=expand, placeholders=placeholders)

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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

parent_category_id = 56 # int | The parent category object id to retrieve items for.  Unspecified means all items on the account.  0 = root (optional)
parent_category_path = 'parent_category_path_example' # str | The parent category path to retrieve items for.  Unspecified means all items on the account.  / = root (optional)
limit = 100 # int | The maximum number of records to return on this one API call. (Default 100, Max 2000) (optional) (default to 100)
offset = 0 # int | Pagination of the record set.  Offset is a zero based index. (optional) (default to 0)
since = 'since_example' # str | Fetch items that have been created/modified since this date/time. (optional)
sort = 'sort_example' # str | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. (optional)
expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)
placeholders = true # bool | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. (optional)

try:
    # Retrieve items
    api_response = api_instance.get_items(parent_category_id=parent_category_id, parent_category_path=parent_category_path, limit=limit, offset=offset, since=since, sort=sort, expand=expand, placeholders=placeholders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
parent_category_id	int	The parent category object id to retrieve items for. Unspecified means all items on the account. 0 = root	[optional]
parent_category_path	str	The parent category path to retrieve items for. Unspecified means all items on the account. / = root	[optional]
limit	int	The maximum number of records to return on this one API call. (Default 100, Max 2000)	[optional] [default to 100]
offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
since	str	Fetch items that have been created/modified since this date/time.	[optional]
sort	str	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]
placeholders	bool	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_pricing_tiers

PricingTiersResponse get_pricing_tiers(expand=expand)

Retrieve pricing tiers

Retrieves the pricing tiers

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)

try:
    # Retrieve pricing tiers
    api_response = api_instance.get_pricing_tiers(expand=expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_pricing_tiers: %s\n" % e)

Parameters

Name	Type	Description	Notes
expand	str	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_review

ItemReviewResponse get_review(review_oid, merchant_item_oid)

Get a review

Retrieve an item review.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

review_oid = 56 # int | The review oid to retrieve.
merchant_item_oid = 56 # int | The item oid the review is associated with.

try:
    # Get a review
    api_response = api_instance.get_review(review_oid, merchant_item_oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
review_oid	int	The review oid to retrieve.
merchant_item_oid	int	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_reviews

ItemReviewsResponse get_reviews(merchant_item_oid)

Get reviews for an item

Retrieve item reviews.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

merchant_item_oid = 56 # int | The item oid the review is associated with.

try:
    # Get reviews for an item
    api_response = api_instance.get_reviews(merchant_item_oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_reviews: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_item_oid	int	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_unassociated_digital_items

ItemDigitalItemsResponse get_unassociated_digital_items(limit=limit, offset=offset, since=since, sort=sort, expand=expand, placeholders=placeholders)

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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

limit = 100 # int | The maximum number of records to return on this one API call. (Default 100, Max 2000) (optional) (default to 100)
offset = 0 # int | Pagination of the record set.  Offset is a zero based index. (optional) (default to 0)
since = 'since_example' # str | Fetch items that have been created/modified since this date/time. (optional)
sort = 'sort_example' # str | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. (optional)
expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)
placeholders = true # bool | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. (optional)

try:
    # Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
    api_response = api_instance.get_unassociated_digital_items(limit=limit, offset=offset, since=since, sort=sort, expand=expand, placeholders=placeholders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->get_unassociated_digital_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	The maximum number of records to return on this one API call. (Default 100, Max 2000)	[optional] [default to 100]
offset	int	Pagination of the record set. Offset is a zero based index.	[optional] [default to 0]
since	str	Fetch items that have been created/modified since this date/time.	[optional]
sort	str	The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.	[optional]
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]
placeholders	bool	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insert_digital_item

ItemDigitalItemResponse insert_digital_item(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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

digital_item = ultracart.ItemDigitalItem() # ItemDigitalItem | Digital item to create

try:
    # Create a file within the digital library
    api_response = api_instance.insert_digital_item(digital_item)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->insert_digital_item: %s\n" % e)

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insert_item

ItemResponse insert_item(item, expand=expand, placeholders=placeholders)

Create an item

Create a new item on the UltraCart account.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

item = ultracart.Item() # Item | Item to create
expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)
placeholders = true # bool | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. (optional)

try:
    # Create an item
    api_response = api_instance.insert_item(item, expand=expand, placeholders=placeholders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->insert_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
item	Item	Item to create
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]
placeholders	bool	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insert_review

ItemReviewResponse insert_review(review, merchant_item_oid)

Insert a review

Insert a item review.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

review = ultracart.ItemReview() # ItemReview | Review to insert
merchant_item_oid = 56 # int | The item oid the review is associated with.

try:
    # Insert a review
    api_response = api_instance.insert_review(review, merchant_item_oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->insert_review: %s\n" % e)

Parameters

Name	Type	Description	Notes
review	ItemReview	Review to insert
merchant_item_oid	int	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

insert_update_item_content_attribute

insert_update_item_content_attribute(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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

item_attribute = ultracart.ItemContentAttribute() # ItemContentAttribute | Item content attribute to upsert
merchant_item_oid = 56 # int | The item oid to modify.

try:
    # Upsert an item content attribute
    api_instance.insert_update_item_content_attribute(item_attribute, merchant_item_oid)
except ApiException as e:
    print("Exception when calling ItemApi->insert_update_item_content_attribute: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_digital_item

ItemDigitalItemResponse update_digital_item(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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

digital_item_oid = 56 # int | The digital item oid to update.
digital_item = ultracart.ItemDigitalItem() # ItemDigitalItem | Digital item to update

try:
    # Updates a file within the digital library
    api_response = api_instance.update_digital_item(digital_item_oid, digital_item)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->update_digital_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
digital_item_oid	int	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_item

ItemResponse update_item(item, merchant_item_oid, expand=expand, placeholders=placeholders)

Update an item

Update a new item on the UltraCart account.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

item = ultracart.Item() # Item | Item to update
merchant_item_oid = 56 # int | The item oid to update.
expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)
placeholders = true # bool | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. (optional)

try:
    # Update an item
    api_response = api_instance.update_item(item, merchant_item_oid, expand=expand, placeholders=placeholders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->update_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
item	Item	Item to update
merchant_item_oid	int	The item oid to update.
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]
placeholders	bool	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_items

ItemsResponse update_items(items_request, expand=expand, placeholders=placeholders, _async=_async)

Update multiple items

Update multiple item on the UltraCart account.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

items_request = ultracart.ItemsRequest() # ItemsRequest | Items to update (synchronous maximum 20 / asynchronous maximum 100)
expand = 'expand_example' # str | The object expansion to perform on the result.  See documentation for examples (optional)
placeholders = true # bool | Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API. (optional)
_async = true # bool | True if the operation should be run async.  No result returned (optional)

try:
    # Update multiple items
    api_response = api_instance.update_items(items_request, expand=expand, placeholders=placeholders, _async=_async)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->update_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
items_request	ItemsRequest	Items to update (synchronous maximum 20 / asynchronous maximum 100)
expand	str	The object expansion to perform on the result. See documentation for examples	[optional]
placeholders	bool	Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.	[optional]
_async	bool	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_review

ItemReviewResponse update_review(review, review_oid, merchant_item_oid)

Update a review

Update an item review.

Example

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

review = ultracart.ItemReview() # ItemReview | Review to update
review_oid = 56 # int | The review oid to update.
merchant_item_oid = 56 # int | The item oid the review is associated with.

try:
    # Update a review
    api_response = api_instance.update_review(review, review_oid, merchant_item_oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->update_review: %s\n" % e)

Parameters

Name	Type	Description
review	ItemReview	Review to update
review_oid	int	The review oid to update.
merchant_item_oid	int	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_temporary_multimedia

TempMultimediaResponse upload_temporary_multimedia(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

from __future__ import print_function
import time
import ultracart
from ultracart.rest import ApiException
from pprint import pprint

# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
api_instance = ultracart.ItemApi.fromApiKey(simple_key, False, True)

file = '/path/to/file.txt' # file | File to upload

try:
    # Upload an image to the temporary multimedia.
    api_response = api_instance.upload_temporary_multimedia(file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ItemApi->upload_temporary_multimedia: %s\n" % e)

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ItemApi.md

Latest commit

History

ItemApi.md

File metadata and controls

ultracart.ItemApi

delete_digital_item

Example

Parameters

Return type

Authorization

HTTP request headers

delete_item

Example

Parameters

Return type

Authorization

HTTP request headers

delete_review

Example

Parameters

Return type

Authorization

HTTP request headers

get_digital_item

Example

Parameters

Return type

Authorization

HTTP request headers

get_digital_items

Example

Parameters

Return type

Authorization

HTTP request headers

get_digital_items_by_external_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_item

Example

Parameters

Return type

Authorization

HTTP request headers

get_item_by_merchant_item_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_items

Example

Parameters

Return type

Authorization

HTTP request headers

get_pricing_tiers

Example

Parameters

Return type

Authorization

HTTP request headers

get_review

Example

Parameters

Return type

Authorization

HTTP request headers

get_reviews

Example

Parameters

Return type

Authorization

HTTP request headers

get_unassociated_digital_items