Stratus Aperture

API Family:Default

Version:24.200.001

Screen ID:SO302000

Properties

Select a row for its DAC field and description

	Property	Type	Data Type
	`BaseCurrencyID`	`StringValue`	string
DAC Field:`PX.Objects.CM.CurrencyInfo.BaseCuryID` Description:Identifier of the base Currency. Defaults to the base currency of the company.
	`ControlQty`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOShipment.ControlQty` Description:No description available
	`CreatedDateTime`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.SO.SOShipment.CreatedDateTime` Description:No description available
	`CurrencyRate`	`DecimalValue`	decimal
DAC Field:`PX.Objects.CM.CurrencyInfo.SampleCuryRate` Description:The exchange rate used for calculations and determined by the values of the CuryMultDiv, CuryRate and RecipRate fields.
	`CurrencyRateTypeID`	`StringValue`	string
DAC Field:`PX.Objects.CM.CurrencyInfo.CuryRateTypeID` Description:The identifier of the Rate Type associated with this object. Corresponds to the CurrencyRateType.CuryRateTypeID field.
	`CurrencyViewState`	`BooleanValue`	boolean
DAC Field:Not mapped to a DAC field Description:No description available
	`CustomerID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.CustomerID` Description:No description available
	`CreateNewShipmentForEveryOrder`	`BooleanValue`	boolean
DAC Field:Not mapped to a DAC field Description:No description available
	`Details`	`List`	ShipmentDetail
DAC Field:Not mapped to a DAC field Description:No description available
	`Description`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.ShipmentDesc` Description:No description available
	`EffectiveDate`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.CM.CurrencyInfo.CuryEffDate` Description:The date, starting from which the specified rate is considered current. Defaults to the current business date.
	`FOBPoint`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.FOBPoint` Description:No description available
	`OverrideFreightPrice`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShipment.OverrideFreightAmount` Description:No description available
	`FreightPrice`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOShipment.CuryFreightAmt` Description:No description available
	`FreightCost`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOShipment.CuryFreightCost` Description:No description available
	`FreightCurrencyID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.CuryID` Description:No description available
	`GroundCollect`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShipment.GroundCollect` Description:No description available
	`Hold`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShipment.Hold` Description:No description available
	`Insurance`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShipment.Insurance` Description:No description available
	`LastModifiedDateTime`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.SO.SOShipment.LastModifiedDateTime` Description:No description available
	`LocationID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.CustomerLocationID` Description:No description available
	`Operation`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.Operation` Description:No description available
	`Orders`	`List`	ShipmentOrderDetail
DAC Field:Not mapped to a DAC field Description:No description available
	`Owner`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.OwnerID` Description:No description available
	`PackageCount`	`IntValue`	int
DAC Field:`PX.Objects.SO.SOShipment.PackageCount` Description:No description available
	`Packages`	`List`	ShipmentPackage
DAC Field:Not mapped to a DAC field Description:No description available
	`PackageWeight`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOShipment.PackageWeight` Description:No description available
	`Picked`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShipment.Picked` Description:No description available
	`ReciprocalRate`	`DecimalValue`	decimal
DAC Field:`PX.Objects.CM.CurrencyInfo.SampleRecipRate` Description:The inverse of the SampleCuryRate. This value is also determined by the values of the CuryMultDiv, CuryRate and RecipRate fields.
	`ResidentialDelivery`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShipment.Resedential` Description:No description available
	`SaturdayDelivery`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShipment.SaturdayDelivery` Description:No description available
	`ShipmentDate`	`DateTimeValue`	DateTime
DAC Field:`PX.Objects.SO.SOShipment.ShipDate` Description:No description available
	`ShipmentNbr`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.ShipmentNbr` Description:No description available
	`ShippedQty`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOShipment.ShipmentQty` Description:No description available
	`ShippedVolume`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOShipment.ShipmentVolume` Description:No description available
	`ShippedWeight`	`DecimalValue`	decimal
DAC Field:`PX.Objects.SO.SOShipment.ShipmentWeight` Description:No description available
	`ShippingSettings`	`ShipToSettings`	ShipToSettings
DAC Field:Not mapped to a DAC field Description:No description available
	`ShippingTerms`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.ShipTermsID` Description:No description available
	`ShippingZoneID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.ShipZoneID` Description:No description available
	`ShipVia`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.ShipVia` Description:No description available
	`Status`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.Status` Description:No description available
	`ToWarehouseID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.DestinationSiteID` Description:No description available
	`Type`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.ShipmentType` Description:No description available
	`UnlimitedPackages`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShipment.UnlimitedPackages` Description:The boolean flag indicating that license limit for the number of packages in the shipment is not checked. If "true", the Shop For Rates, Get Labels, Get Return Labels and Auto-Packaging functionality are not supported.
	`UseCustomersAccount`	`BooleanValue`	boolean
DAC Field:`PX.Objects.SO.SOShipment.UseCustomerAccount` Description:No description available
	`WarehouseID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.SiteID` Description:No description available
	`WorkgroupID`	`StringValue`	string
DAC Field:`PX.Objects.SO.SOShipment.WorkgroupID` Description:No description available
	`NoteID`	`GuidValue`	Guid
DAC Field:`PX.Objects.SO.SOShipment.NoteID` Description:No description available

Minimum Payload

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

{
  "CurrencyRate": {
    "value": 0
  },
  "Status": {
    "value": "string"
  },
  "Details": [
    {
      "OrderLineNbr": {
        "value": 0
      },
      "OrderNbr": {
        "value": "string"
      },
      "OrderType": {
        "value": "string"
      },
      "UOM": {
        "value": "string"
      },
      "WarehouseID": {
        "value": "string"
      }
    }
  ]
}

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

Details is the detail-lines collection (ShipmentDetail); one example row is included above because a document usually has lines, and each row needs OrderLineNbrOrderNbrOrderTypeUOMWarehouseID of its own.

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.

Ordersa list of ShipmentOrderDetailrequired if you include one:OrderNbrOrderTypesupplied by the parent:InvoiceNbrShipmentNbr
Packagesa list of ShipmentPackagerequired if you include one:BoxID

Available in Versions

25.200.001 24.200.001 23.200.001 22.200.001 20.200.001