ShipVia

12 properties
API Family:Default
Version:20.200.001
DAC Mapping:PX.Objects.CS.Carrier
Screen ID:CS207500

Properties

Select a row for its DAC field and description
PropertyTypeData Type
CalculationMethodStringValuestring
DAC Field:PX.Objects.CS.Carrier.CalcMethod
Description:The method used to calculate freight charges using the rate breakdown specified in the related FreightRate records. Allowed values are: ""P"" - Per Unit, ""N"" - Net (flat rates), ""M"" - Manual. Defaults to Manual (""M"").
CalendarStringValuestring
DAC Field:PX.Objects.CS.Carrier.CalendarID
Description:The Calendar associated with the carrier, which reflects its work hours and the days when it ships the goods. Corresponds to the CSCalendar.CalendarID field.
CarrierIDStringValuestring
DAC Field:PX.Objects.CS.Carrier.CarrierID
Description:Key field. A unique code of a non-integrated carrier, a method of the integrated carrier or a shipping option of the company.
CommonCarrierBooleanValueboolean
DAC Field:PX.Objects.CS.Carrier.IsCommonCarrier
Description:Indicates whether the carrier is a common carrier. Because common carriers deliver goods from a company branch to the customer location that is a selling point, the value of this field affects the set of taxes that applies to the corresponding invoice. When set to "true", the carrier is considered common and hence the taxes from the customer's tax zone are applied. Otherwise, the system applies the taxes from the taz zone associated with the selling branch.
DescriptionStringValuestring
DAC Field:PX.Objects.CS.Carrier.Description
Description:The description of the carrier or shipping option.
FreightExpenseAccountStringValuestring
DAC Field:PX.Objects.CS.Carrier.FreightExpenseAcctID
Description:Identifier of the General Ledger expense Account, that is used to record the freight charges to be paid to the Carrier.
FreightExpenseSubaccountStringValuestring
DAC Field:PX.Objects.CS.Carrier.FreightExpenseSubID
Description:Identifier of the General Ledger Subaccount, that is used to record the freight charges to be paid to the Carrier.
FreightRatesListShipViaFreightRate
DAC Field:Not mapped to a DAC field
Description:No description available
FreightSalesAccountStringValuestring
DAC Field:PX.Objects.CS.Carrier.FreightSalesAcctID
Description:Identifier of the General Ledger income Account, that is used to record the freight charges to be paid to the company.
FreightSalesSubaccountStringValuestring
DAC Field:PX.Objects.CS.Carrier.FreightSalesSubID
Description:Identifier of the General Ledger Subaccount, that is used to record the freight charges to be paid to the company.
PackagesListShippingBox
DAC Field:Not mapped to a DAC field
Description:No description available
TaxCategoryStringValuestring
DAC Field:PX.Objects.CS.Carrier.TaxCategoryID
Description:Identifier of the Tax Category to be applied to the freight amount when goods are shipped with this shipping option. Corresponds to the TaxCategory.TaxCategoryID field.

Minimum Payload

Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.

6 required fields
{
  "CarrierID": {
    "value": "string"
  },
  "Description": {
    "value": "string"
  },
  "FreightExpenseAccount": {
    "value": "string"
  },
  "FreightExpenseSubaccount": {
    "value": "string"
  },
  "FreightSalesAccount": {
    "value": "string"
  },
  "FreightSalesSubaccount": {
    "value": "string"
  }
}

For every property this entity accepts, see the properties table.

Optional Children

None of these child collections is required — a payload without them is valid. If you do include one, these are the fields each row of it needs; keys the parent record supplies are named separately and must not be sent.

  • FreightRatesa list of ShipViaFreightRaterequired if you include one:LineNbrVolumeWeightZoneID
  • Packagesa list of ShippingBoxrequired if you include one:BoxID

Available in Versions

25.200.00124.200.00123.200.00122.200.00120.200.001