Shop Model [read-only]

The Shop model represents your shop. Note that this model is read-only. You can retrieve your Shop's model to access the information assigned to your shop, but the API does not provide any means for updating the Shop, or to create a new one.

Model Attributes

id

Unique numeric ID of the shop.

Methods:

integer getId()

code

The code assigned to the shop by MyCloud. This field is read-only, you cannot change it via the API. New values will be ignored.

Methods:

string getCode()

name

The name of the shop.

Methods:

string getName()

address

The address of the shop.

Methods:

string getAddress()

postcode

The postal code of the shop.

Methods:

string getPostcode()

contact_name

The name of the contact person for the shop.

Methods:

string getContactName()

phone_number

The phone number of the shop.

Methods:

string getPhoneNumber()

email

The email address of the shop.

Methods:

string getEmail()

API Calls

array Shop::all()

Get all Shops associated with your account. Currently MyCloud allows only one Shop per client account, so the array returned will always contain at most one Shop.

Returns:

An array Shop objects.

object Shop::get( integer $id )

Get the Shop object identified by the provided id.

Returns:

The Shop object that is identified by the provided id. If the Shop is not associated with your account, a "not located" error will be returned.