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

Add a Company Shipping Profile

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId	The company ID	integer	Required
userId	Optional - The user id that is Changing the data	string	None.

Body Parameters

Shipping Profile Model

ShippingProfileDTO

Name	Type	Additional information
Id	integer	Required
CompanyId	integer	None.
IsDefault	boolean	None.
ProfileName	string	Required
ProfileDescription	string	None.
DestinationCompanyName	string	None.
Attention_FreeText	string	Data type: Text
PhoneNumber	string	Data type: PhoneNumber Matching regular expression pattern: ^\s\+?([0-9\-\.\s]{3,22})\s$
EmailAddress	string	Data type: EmailAddress
Address	AddressDTO	None.
ShippingAccount	ShippingAccountDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "companyId": 1,
  "isDefault": true,
  "profileName": "sample string 2",
  "profileDescription": "sample string 3",
  "destinationCompanyName": "sample string 4",
  "attention_FreeText": "sample string 5",
  "phoneNumber": "sample string 6",
  "emailAddress": "sample string 7",
  "address": {
    "id": 1,
    "country": "sample string 1",
    "stateOrProvinceName": "sample string 2",
    "city": "sample string 3",
    "addressLine1": "sample string 4",
    "addressLine2": "sample string 5",
    "zipCode": "sample string 6",
    "postalCode": "sample string 7",
    "isBilling": true,
    "isShipping": true,
    "isMainAddress": true
  },
  "shippingAccount": {
    "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 Shipping Profile Data

ShippingProfileDTO

Name	Type	Additional information
Id	integer	Required
CompanyId	integer	None.
IsDefault	boolean	None.
ProfileName	string	Required
ProfileDescription	string	None.
DestinationCompanyName	string	None.
Attention_FreeText	string	Data type: Text
PhoneNumber	string	Data type: PhoneNumber Matching regular expression pattern: ^\s\+?([0-9\-\.\s]{3,22})\s$
EmailAddress	string	Data type: EmailAddress
Address	AddressDTO	None.
ShippingAccount	ShippingAccountDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "companyId": 1,
  "isDefault": true,
  "profileName": "sample string 2",
  "profileDescription": "sample string 3",
  "destinationCompanyName": "sample string 4",
  "attention_FreeText": "sample string 5",
  "phoneNumber": "sample string 6",
  "emailAddress": "sample string 7",
  "address": {
    "id": 1,
    "country": "sample string 1",
    "stateOrProvinceName": "sample string 2",
    "city": "sample string 3",
    "addressLine1": "sample string 4",
    "addressLine2": "sample string 5",
    "zipCode": "sample string 6",
    "postalCode": "sample string 7",
    "isBilling": true,
    "isShipping": true,
    "isMainAddress": true
  },
  "shippingAccount": {
    "id": 1,
    "companyId": 1,
    "isDefault": true,
    "name": "sample string 2",
    "carrier": "sample string 3",
    "carrierType": 1,
    "accountNumber": "sample string 4"
  }
}