The Account resource is a collection of the general settings and information about merchants's account. One account can have multiple shops.

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

Account chart
GET /accounts/session

Get the account that belongs to the current logged user.

Available Since
1.3.0
Parameters
Name In Default Constraints Description
x-auth-token header     The authentication token
Response Body
Media Type Data Type Description
application/json Account
application/xml Account
Response (XML) 
<account>
  <id>...</id>
  <name>...</name>
  <fullName>...</fullName>
  <affiliateId>...</affiliateId>
  <accountDataRetention>
    <id>...</id>
    <keepPersonalDataMonths>...</keepPersonalDataMonths>
    <keepPrintDataMonths>...</keepPrintDataMonths>
  </accountDataRetention>
  <persitenceConfig>
    <id>...</id>
    <archiveDays>...</archiveDays>
    <deleteDays>...</deleteDays>
  </persitenceConfig>
</account>
Response (JSON) 
{
  "account" : {
    "id" : 12345,
    "name" : "...",
    "fullName" : "...",
    "affiliateId" : "...",
    "accountDataRetention" : {
      "id" : 12345,
      "keepPersonalDataMonths" : 12345,
      "keepPrintDataMonths" : 12345
    },
    "persitenceConfig" : { }
  }
}
GET /accounts/{accountId}

Get a single account by its id.

Available Since
1.3.0
Parameters
Name In Default Constraints Description
x-auth-token header     The authentication token
accountId required path   int the unique identifier of the account
Response Body
Media Type Data Type Description
application/json Account
application/xml Account
Response (XML) 
<account>
  <id>...</id>
  <name>...</name>
  <fullName>...</fullName>
  <affiliateId>...</affiliateId>
  <accountDataRetention>
    <id>...</id>
    <keepPersonalDataMonths>...</keepPersonalDataMonths>
    <keepPrintDataMonths>...</keepPrintDataMonths>
  </accountDataRetention>
  <persitenceConfig>
    <id>...</id>
    <archiveDays>...</archiveDays>
    <deleteDays>...</deleteDays>
  </persitenceConfig>
</account>
Response (JSON) 
{
  "account" : {
    "id" : 12345,
    "name" : "...",
    "fullName" : "...",
    "affiliateId" : "...",
    "accountDataRetention" : {
      "id" : 12345,
      "keepPersonalDataMonths" : 12345,
      "keepPrintDataMonths" : 12345
    },
    "persitenceConfig" : { }
  }
}