Outbound shipment headers in WMS(WHSOutboundShipmentHeaderEntity)

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

is.application.releaseVersion

ParameterValueData typeExplanation
releaseVersion"10.0.13.0"stringsemantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOutbound shipment headers
entitya reference to the constant entity holding the list of localized text

Attributes

Name Description First Included in Instance
ShipmentId WMS/WHSOutboundShipmentHeaderEntity
DeliveryName WMS/WHSOutboundShipmentHeaderEntity
CustomerReference WMS/WHSOutboundShipmentHeaderEntity
DeliveryTermsCode WMS/WHSOutboundShipmentHeaderEntity
DeliveryAddressCountryRegionId WMS/WHSOutboundShipmentHeaderEntity
DeliveryAddressStateId WMS/WHSOutboundShipmentHeaderEntity
DeliveryAddressCountyId WMS/WHSOutboundShipmentHeaderEntity
DeliveryAddressZipCode WMS/WHSOutboundShipmentHeaderEntity
DeliveryAddressCity WMS/WHSOutboundShipmentHeaderEntity
DeliveryAddressCityInKana WMS/WHSOutboundShipmentHeaderEntity
DeliveryAddressStreet WMS/WHSOutboundShipmentHeaderEntity
DeliveryAddressStreetInKana WMS/WHSOutboundShipmentHeaderEntity
OutboundLoadId WMS/WHSOutboundShipmentHeaderEntity
Relationship_WHSOutboundLoadHeaderEntityRelationshipId WMS/WHSOutboundShipmentHeaderEntity
BackingTable_WHSShipmentTableRelationshipId WMS/WHSOutboundShipmentHeaderEntity
Relationship_PrimaryCompanyContextRelationshipId WMS/WHSOutboundShipmentHeaderEntity

ShipmentId

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the ShipmentId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryName

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

CustomerReference

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the CustomerReference attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryTermsCode

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryTermsCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryAddressCountryRegionId

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryAddressCountryRegionId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryAddressStateId

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryAddressStateId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryAddressCountyId

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryAddressCountyId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryAddressZipCode

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryAddressZipCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryAddressCity

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryAddressCity attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryAddressCityInKana

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryAddressCityInKana attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryAddressStreet

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryAddressStreet attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeliveryAddressStreetInKana

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the DeliveryAddressStreetInKana attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

OutboundLoadId

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatstring
isNullabletrue

Traits

List of traits for the OutboundLoadId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Relationship_WHSOutboundLoadHeaderEntityRelationshipId

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_WHSOutboundLoadHeaderEntityRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferencesempty tableentitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

BackingTable_WHSShipmentTableRelationshipId

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the BackingTable_WHSShipmentTableRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/SupplyChain/Inventory/WorksheetHeader/WHSShipmentTable.cdm.json/WHSShipmentTableRecId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_PrimaryCompanyContextRelationshipId

First included in: WMS/WHSOutboundShipmentHeaderEntity (this entity)

Properties

NameValue
dataFormatguid

Traits

List of traits for the Relationship_PrimaryCompanyContextRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfoRecId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array