resource.rst

Resource

Represents particular resource.

resources

resource/about_page resource/additional_field resource/application_lock resource/application_config resource/application_version resource/attribute_group resource/attribute resource/auction resource/auction_house resource/auction_order resource/availability resource/category resource/categories_tree resource/currency resource/dashboard_activity resource/dashboard_stat resource/delivery resource/gauge resource/geolocation_country resource/geolocation_region resource/geolocation_subregion resource/language resource/metafield resource/metafield_value resource/object_mtime resource/option_group resource/option resource/option_value resource/order_product resource/order resource/parcel resource/payment resource/producer resource/product resource/product_file resource/product_image resource/product_stock resource/shipping resource/status resource/subscriber_group resource/subscriber resource/tax resource/unit resource/user_address resource/user_group resource/user resource/webhook resource/zone

resource	description
resource/about_page	About page
resource/additional_field	Additional field
resource/application_lock	Administrator panel lock
resource/application_config	Application config
resource/application_version	Application config
resource/attribute_group	Attributes group
resource/attribute	Attribute
resource/auction	Auction
resource/auction_house	Auction house
resource/auction_order	Auction order
resource/availability	Product availability
resource/category	Category
resource/categories_tree	Category tree
resource/currency	Currency
resource/dashboard_activity	Dashboard activity
resource/dashboard_stat	Sales stats
resource/delivery	Delivery
resource/gauge	Gauge
resource/geolocation_country	Geolocation country
resource/geolocation_region	Geolocation region
resource/geolocation_subregion	Geolocation subregion
resource/language	Language
resource/metafield	Metafield
resource/metafield_value	Metafield Value
resource/object_mtime	Modification timestamp of object
resource/option_group	Option group
resource/option	Variant
resource/option_value	Variant value
resource/order_product	Product of order
resource/order	Order
resource/parcel	Parcel
resource/payment	Payment method
resource/producer	Producer
resource/product	Product
resource/product_file	Product file
resource/product_image	Photo of product
resource/product_stock	Product stock
resource/shipping	Shipping method
resource/status	Order status
resource/subscriber_group	Subscriber group
resource/subscriber	Subscriber
resource/tax	Tax value
resource/unit	Unit of measurement
resource/user_address	Shipping address
resource/user_group	User group
resource/user	User
resource/webhook	Webhook
resource/zone	Zone

constants

HTTP_ERROR_OBJECT_READONLY

object is marked as read-only and cannot be altered

HTTP_ERROR_CANNOT_DELETE_INTERNAL_OBJECT

object is considered as pre-installed or internal and cannot be deleted

exceptions

resource/exception/resource_exception resource/exception/communication_exception resource/exception/not_found_exception resource/exception/object_locked_exception resource/exception/permissions_exception resource/exception/validation_exception

exception	description
resource/exception/communication_exception	Server communication problem
resource/exception/not_found_exception	Object not found
resource/exception/object_locked_exception	Object is locked for editing
resource/exception/permissions_exception	Insufficient permissions for object
resource/exception/resource_exception	Base class for exceptions
resource/exception/validation_exception	Supplied data is invalid

static methods

methods