Account Data Type

Account represents a merchant's top-level account. An account holds one or more shops and contains billing, company, and data-retention settings.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the Account.
name string The name of the Account.
fullName string Full legal name of the account holder, used on invoices and official documents.
affiliateId string Affiliate identifier used for partner programme tracking.
accountDataRetention AccountDataRetention Data retention policy configured for this account. Controls how long customer and order data is kept.
persitenceConfig object Storage and persistence configuration for this account.
Used in
GET /accounts/session response GET /accounts/{accountId} response
Account (JSON) 
{
  "account" : {
    "id" : 12345,
    "name" : "...",
    "fullName" : "...",
    "affiliateId" : "...",
    "accountDataRetention" : {
      "id" : 12345,
      "keepPersonalDataMonths" : 12345,
      "keepPrintDataMonths" : 12345
    },
    "persitenceConfig" : { }
  }
}
Account Data Type

Account represents a merchant's top-level account. An account holds one or more shops and contains billing, company, and data-retention settings.

Available Since
1.3.0
Properties
Name Type Description
accountDataRetention AccountDataRetention Data retention policy configured for this account. Controls how long customer and order data is kept.
affiliateId string Affiliate identifier used for partner programme tracking.
fullName string Full legal name of the account holder, used on invoices and official documents.
id int Unique numeric identifier for the Account.
name string The name of the Account.
persitenceConfig persitenceConfigPrime Storage and persistence configuration for this account.
Used in
GET /accounts/session response GET /accounts/{accountId} response
Account (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>