POST v1/CarrierAccounts

Add a new CarrierAccount.

Request Information

Requires Authorization!

URI Parameters

None.

Body Parameters

The CarrierAccount changes object

Name	Description	Type	Additional information
ShopOwnerId	Gets or sets the shop owner identifier.	integer	Required
Parameters	Gets or sets the parameters.	Collection of StorablePropValue	Max length: 2147483647
ShippingLabelTemplateId		integer	None.
ReturnShippingLabelTemplateId		integer	None.
DefaultGoodsDescription	Gets or sets the default goods description.	string	Max length: 100
CreateTimestamp	Gets or sets the create timestamp.	date	Required
ChangeTimestamp	Gets or sets the change timestamp.	date	None.
Id	Gets or sets the identifier.	integer	Must be 0
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

Request Formats

application/json, text/json

Sample:

{
  "ShopOwnerId": 1,
  "Parameters": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "ShippingLabelTemplateId": 1,
  "ReturnShippingLabelTemplateId": 1,
  "DefaultGoodsDescription": "sample string 2",
  "CreateTimestamp": "2021-12-02T20:19:31.7947307+01:00",
  "ChangeTimestamp": "2021-12-02T20:19:31.7947307+01:00",
  "Id": 4,
  "AppModuleDefinitionId": 5,
  "Name": "sample string 6",
  "Enabled": true
}

application/xml, text/xml

Sample:

<CarrierAccountChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>4</Id>
  <AppModuleDefinitionId>5</AppModuleDefinitionId>
  <Name>sample string 6</Name>
  <Enabled>true</Enabled>
  <ShopOwnerId>1</ShopOwnerId>
  <Parameters>
    <Parameter>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Parameter>
    <Parameter>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Parameter>
  </Parameters>
  <ShippingLabelTemplateId>1</ShippingLabelTemplateId>
  <ReturnShippingLabelTemplateId>1</ReturnShippingLabelTemplateId>
  <DefaultGoodsDescription>sample string 2</DefaultGoodsDescription>
  <CreateTimestamp>2021-12-02T20:19:31.7947307+01:00</CreateTimestamp>
  <ChangeTimestamp>2021-12-02T20:19:31.7947307+01:00</ChangeTimestamp>
</CarrierAccountChanges>

Response Information

Resource Description

The CarrierAccount object.

CarrierAccount

Name	Description	Type	Additional information
ShopOwnerId	Gets or sets the shop owner identifier.	integer	Required
Parameters	Gets or sets the parameters.	Collection of StorablePropValue	Max length: 2147483647
ShippingLabelTemplateId		integer	None.
ReturnShippingLabelTemplateId		integer	None.
DefaultGoodsDescription	Gets or sets the default goods description.	string	Max length: 100
CreateTimestamp	Gets or sets the create timestamp.	date	Required
ChangeTimestamp	Gets or sets the change timestamp.	date	None.
Id	Gets or sets the identifier.	integer	Must be 0
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:

{
  "ShopOwnerId": 1,
  "Parameters": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "ShippingLabelTemplateId": 1,
  "ReturnShippingLabelTemplateId": 1,
  "DefaultGoodsDescription": "sample string 2",
  "CreateTimestamp": "2021-12-02T20:19:31.7947307+01:00",
  "ChangeTimestamp": "2021-12-02T20:19:31.7947307+01:00",
  "Id": 4,
  "AppModuleDefinitionId": 5,
  "Name": "sample string 6",
  "Enabled": true
}

application/xml, text/xml

Sample:

<CarrierAccount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>4</Id>
  <AppModuleDefinitionId>5</AppModuleDefinitionId>
  <Name>sample string 6</Name>
  <Enabled>true</Enabled>
  <ShopOwnerId>1</ShopOwnerId>
  <Parameters>
    <Parameter>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Parameter>
    <Parameter>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Parameter>
  </Parameters>
  <ShippingLabelTemplateId>1</ShippingLabelTemplateId>
  <ReturnShippingLabelTemplateId>1</ReturnShippingLabelTemplateId>
  <DefaultGoodsDescription>sample string 2</DefaultGoodsDescription>
  <CreateTimestamp>2021-12-02T20:19:31.7947307+01:00</CreateTimestamp>
  <ChangeTimestamp>2021-12-02T20:19:31.7947307+01:00</ChangeTimestamp>
</CarrierAccount>