POST api/companies/{companyId}/ShippingAccounts?userId={userId}

Create the Shipping Account for a Company

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

The ID of the company

integer

Required

userId

The user ID that is doing the change

string

None.

Body Parameters

The Shipping Account

ShippingAccountDTO
NameDescriptionTypeAdditional information
Id

integer

Required

CompanyId

integer

None.

IsDefault

boolean

None.

Name

string

None.

Carrier

string

None.

CarrierType

SHIPPING_CARRIER_TYPE

None.

AccountNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "companyId": 1,
  "isDefault": true,
  "name": "sample string 2",
  "carrier": "sample string 3",
  "carrierType": 1,
  "accountNumber": "sample string 4"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The new Shipping Account data with new ID

ShippingAccountDTO
NameDescriptionTypeAdditional information
Id

integer

Required

CompanyId

integer

None.

IsDefault

boolean

None.

Name

string

None.

Carrier

string

None.

CarrierType

SHIPPING_CARRIER_TYPE

None.

AccountNumber

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "companyId": 1,
  "isDefault": true,
  "name": "sample string 2",
  "carrier": "sample string 3",
  "carrierType": 1,
  "accountNumber": "sample string 4"
}