The Shop resource is a collection of the general settings and information about the store.

The resource lets you retrieve information about the store but doesn't let you update any information. Only the merchant can update this information from inside the Shirtplatform admin.

Shop chart
GET /accounts/{accountId}/shops

Get a list of shops for your account. A full account administrator sees every shop of the account; a restricted user sees only the shops they have been granted access to.

Parameters
Name In Default Constraints Description
x-auth-token header     The authentication token
accountId required path   int the unique identifier of the account
filterId query   optional saved Filter.Shop ID; empty string for all
page query 0 int zero-based page index
size query 10 int number of items per page
Response Codes
Code Condition
200 the shops were successfully retrieved
Response Body
Media Type Data Type Description
application/json PagedData
application/xml PagedData
Response (XML) 
<pagedData>
  <records>...</records>
  <totalElements>...</totalElements>
</pagedData>
Response (JSON) 
{
  "pagedData" : {
    "records" : [ { }, { } ],
    "totalElements" : 12345
  }
}
GET /accounts/{accountId}/shops/{shopId}

Get a single shop by its id. The shop must belong to your account and, for a restricted user, be one you have been granted access to; an unknown or foreign shop id is rejected by the ownership check. The shop is read-only over the API — it can only be updated by the merchant from the Shirtplatform admin.

Parameters
Name In Default Constraints Description
x-auth-token header     The authentication token
accountId required path   int the unique identifier of the account
shopId required path   int the unique identifier of the shop
Response Codes
Code Condition
200 the shop was successfully retrieved
Response Body
Media Type Data Type Description
application/json Shop
application/xml Shop
Response (XML) 
<shop>
  <id>...</id>
  <name>...</name>
  <type>...</type>
  <default>...</default>
</shop>
Response (JSON) 
{
  "shop" : {
    "id" : 12345,
    "name" : "...",
    "type" : "PUBLISH",
    "default" : true
  }
}