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
RESTful Calls
Get All Shops
GET/shops
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.
Request Parameters
This request has no parameters.
Response
Name
Type
Example
Description
shop
shop[]
The list of shops attached to your account. Note that the result array will always contain only one shop.
shop
Object
A shop object.
id
integer
342
This is the shop's database key.
name
string
My Shop
This is the shop's name.
code
integer
MA002
This is the shop's MyCloud internal identity code.
address
string
32/1 สุขุมวิท 62, กรุงเทพฯ
This is the shop's physical address.
postcode
string
10260
This is the postcode for the shop's physical address.
contact_name
string
คุณ พวริด
This is the name of the contact person for the shop.
phone_number
string
0809969094
This is the phone number of the contact person for the shop.
email
string
contact@mycloudfulfillmnt.com
This is the email address of the contact person for the shop.
Get Shop
GET/shops/{id}
Get a shop by it's ID.
Request Parameters
Parameter
Type
Required
Example
Description
shop_id
mixed
Yes
JO001
The shop identity. This method allows you to identify the shop with one of three different values:
- ID - the database ID
- Code - the MyCloud unique code
- Email - the shop's contact email address
Response
Name
Type
Example
Description
shop
Object
A shop object.
id
integer
342
This is the shop's database key.
name
string
My Shop
This is the shop's name.
code
integer
MA002
This is the shop's MyCloud internal identity code.
address
string
32/1 สุขุมวิท 62, กรุงเทพฯ
This is the shop's physical address.
postcode
string
10260
This is the postcode for the shop's physical address.
contact_name
string
คุณ พวริด
This is the name of the contact person for the shop.
phone_number
string
0809969094
This is the phone number of the contact person for the shop.
email
string
contact@mycloudfulfillmnt.com
This is the email address of the contact person for the shop.
MODELS
shop
Object: shop
Name
Type
Example
Description
shop
Object
A shop object.
id
integer
342
This is the shop's database key.
name
string
My Shop
This is the shop's name.
code
integer
MA002
This is the shop's MyCloud internal identity code.
address
string
32/1 สุขุมวิท 62, กรุงเทพฯ
This is the shop's physical address.
postcode
string
10260
This is the postcode for the shop's physical address.
contact_name
string
คุณ พวริด
This is the name of the contact person for the shop.
phone_number
string
0809969094
This is the phone number of the contact person for the shop.
email
string
contact@mycloudfulfillmnt.com
This is the email address of the contact person for the shop.