GET v1/Shops/{shopId}/CarrierAccounts

Get a list with all available CarrierAccounts for this shop.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
shopId

Shop identifier

integer

Required.

Body Parameters

None.

Response Information

Resource Description

CarrierAccount list


Collection of CarrierAccountBasicInfo
NameDescriptionTypeAdditional information
Id

Gets or sets the identifier.

integer

Required

AppModuleDefinitionId

Gets or sets the AppModuleDefinition identifier.

integer

Required

Name

Gets or sets the name.

string

Required

Max length: 100

Enabled

Indicates whether the CarrierAccount is enabled.

boolean

Required

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "AppModuleDefinitionId": 2,
    "Name": "sample string 3",
    "Enabled": true
  },
  {
    "Id": 1,
    "AppModuleDefinitionId": 2,
    "Name": "sample string 3",
    "Enabled": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfCarrierAccountBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CarrierAccountBasicInfo>
    <Id>1</Id>
    <AppModuleDefinitionId>2</AppModuleDefinitionId>
    <Name>sample string 3</Name>
    <Enabled>true</Enabled>
  </CarrierAccountBasicInfo>
  <CarrierAccountBasicInfo>
    <Id>1</Id>
    <AppModuleDefinitionId>2</AppModuleDefinitionId>
    <Name>sample string 3</Name>
    <Enabled>true</Enabled>
  </CarrierAccountBasicInfo>
</ArrayOfCarrierAccountBasicInfo>