POST api/cfgShippingService

Insert a new record into the ShippingServices table.

Request Information

URI Parameters

None.

Body Parameters

cfgShippingServiceDb
NameDescriptionTypeAdditional information
ShippingServiceID

integer

None.
ShippingServiceCode

string

Required

Max length: 80
ShippingServiceName

string

Max length: 100
ExternalReferenceID

globally unique identifier

None.
ServiceLevelCode

string

Max length: 15
CarrierCode

string

Max length: 4
CarrierServiceCode

string

Max length: 10
UniversalService

boolean

None.
SetRequiredShipDate

boolean

None.
IsActive

boolean

None.
CreatedBy

integer

None.
CreatedDate

date

None.
UpdatedBy

integer

None.
UpdatedDate

date

None.
CarrierReferenceID

globally unique identifier

None.
ResidentialMode

integer

None.
results

Collection of ValidationResult

None.

Request Formats

application/json, text/json

Sample: 
{
  "results": null,
  "ShippingServiceID": 1,
  "ShippingServiceCode": "sample string 2",
  "ShippingServiceName": "sample string 3",
  "ExternalReferenceID": "5b389f94-aa2d-4862-bbab-9a434b92d086",
  "ServiceLevelCode": "sample string 4",
  "CarrierCode": "sample string 5",
  "CarrierServiceCode": "sample string 6",
  "UniversalService": true,
  "SetRequiredShipDate": true,
  "IsActive": true,
  "CreatedBy": 10,
  "CreatedDate": "2026-02-02T14:34:16.2749308+00:00",
  "UpdatedBy": 12,
  "UpdatedDate": "2026-02-02T14:34:16.2749308+00:00",
  "CarrierReferenceID": "8f1d2308-9694-4dc7-bfed-6c6ef1eea7ed",
  "ResidentialMode": 14
}

application/xml, text/xml

Sample: 
<cfgShippingServiceDb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
  <CarrierCode>sample string 5</CarrierCode>
  <CarrierReferenceID>8f1d2308-9694-4dc7-bfed-6c6ef1eea7ed</CarrierReferenceID>
  <CarrierServiceCode>sample string 6</CarrierServiceCode>
  <CreatedBy>10</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-02-02T14:34:16.2749308Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <ExternalReferenceID>5b389f94-aa2d-4862-bbab-9a434b92d086</ExternalReferenceID>
  <IsActive>true</IsActive>
  <ResidentialMode>14</ResidentialMode>
  <ServiceLevelCode>sample string 4</ServiceLevelCode>
  <SetRequiredShipDate>true</SetRequiredShipDate>
  <ShippingServiceCode>sample string 2</ShippingServiceCode>
  <ShippingServiceID>1</ShippingServiceID>
  <ShippingServiceName>sample string 3</ShippingServiceName>
  <UniversalService>true</UniversalService>
  <UpdatedBy>12</UpdatedBy>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-02-02T14:34:16.2749308Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
</cfgShippingServiceDb>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'cfgShippingServiceDb'.

Response Information

Resource Description

UpsertRetOfcfgShippingServiceDb
NameDescriptionTypeAdditional information
returnID

integer

None.
results

Collection of ValidationResult

None.
returnItem

cfgShippingServiceDb

None.
displayMessage

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "returnID": 1,
  "results": null,
  "returnItem": {
    "results": null,
    "ShippingServiceID": 1,
    "ShippingServiceCode": "sample string 2",
    "ShippingServiceName": "sample string 3",
    "ExternalReferenceID": "69b5c319-bf60-42f8-8ed1-3ddc0363cddb",
    "ServiceLevelCode": "sample string 4",
    "CarrierCode": "sample string 5",
    "CarrierServiceCode": "sample string 6",
    "UniversalService": true,
    "SetRequiredShipDate": true,
    "IsActive": true,
    "CreatedBy": 10,
    "CreatedDate": "2026-02-02T14:34:16.2934911+00:00",
    "UpdatedBy": 12,
    "UpdatedDate": "2026-02-02T14:34:16.2934911+00:00",
    "CarrierReferenceID": "2d9fbca7-202d-48e4-a851-563224d58428",
    "ResidentialMode": 14
  },
  "displayMessage": "sample string 1"
}

application/xml, text/xml

Sample: 
<UpsertRetOfcfgShippingServiceDb66KPc_SrH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
  <displayMessage>sample string 1</displayMessage>
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
  <returnID>1</returnID>
  <returnItem xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
    <results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
    <d2p1:CarrierCode>sample string 5</d2p1:CarrierCode>
    <d2p1:CarrierReferenceID>2d9fbca7-202d-48e4-a851-563224d58428</d2p1:CarrierReferenceID>
    <d2p1:CarrierServiceCode>sample string 6</d2p1:CarrierServiceCode>
    <d2p1:CreatedBy>10</d2p1:CreatedBy>
    <d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-02-02T14:34:16.2934911Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:ExternalReferenceID>69b5c319-bf60-42f8-8ed1-3ddc0363cddb</d2p1:ExternalReferenceID>
    <d2p1:IsActive>true</d2p1:IsActive>
    <d2p1:ResidentialMode>14</d2p1:ResidentialMode>
    <d2p1:ServiceLevelCode>sample string 4</d2p1:ServiceLevelCode>
    <d2p1:SetRequiredShipDate>true</d2p1:SetRequiredShipDate>
    <d2p1:ShippingServiceCode>sample string 2</d2p1:ShippingServiceCode>
    <d2p1:ShippingServiceID>1</d2p1:ShippingServiceID>
    <d2p1:ShippingServiceName>sample string 3</d2p1:ShippingServiceName>
    <d2p1:UniversalService>true</d2p1:UniversalService>
    <d2p1:UpdatedBy>12</d2p1:UpdatedBy>
    <d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-02-02T14:34:16.2934911Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:UpdatedDate>
  </returnItem>
</UpsertRetOfcfgShippingServiceDb66KPc_SrH>