Tenant

Get Tenant (Single)

GET https://api.shopgo.me/v1/platform/tenant/:id

Get single tenant object.

Path Parameters

Name	Type	Description
id	string	Tenant unique identifier

200

{
    "result": "success",
    "payload": {
        "tenant": <Tenant>
    }
}

Get Tenants (All)

GET https://api.shopgo.me/v1/platform/tenant/

Get list of all platform tenant. For a full breakdown of response payload see definition of Tenant object.

200

{
    "result": "success",
    "payload": {
        "tenants": [<Tenant>]
    }
}

Set store front

POST https://api.shopgo.me/platform/tenant/store-front

Set store front

Request Body

Name	Type	Description
tenant	string	Tenant name
front_end	string	Front end type ("flat", standard)

200 Success

{
    "result": "success",
    "payload": {}
}

400

404 Tenant not found

Set store plan

POST https://api.shopgo.me/platform/tenant/plan

Set Store subscription plan

Request Body

Name	Type	Description
tenant	string	Tenant name
override_plan	string	Plan name [ "trial", "plan1", "plan2", "plan3", "plan4", "plan5", ]

200 Success

{
    "result": "success",
    "payload": {}
}

400 Invalid plan provided

404 Tenant not found

Domain name link

POST https://api.shopgo.me/platform/tenant/domain-link

Request Body

Name	Type	Description
tenant	string	Tenant name
host	string	Host name
forward_www	boolean

201

{
    "result": "success",
    "payload": {
        "host": {
            "host": "somsewheerswdse.com",
            "tenant": "store-q4gt"
        }
    }
}

404 Tenant not found

409 Duplicate Host