ShipmentHeaderType

Complex type information

Content

• Sequence [1..1]
  from type DocumentIdentificationBaseType
  ID [0..1]    Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.
  RevisionID [0..1]    Is the revision of the semantically named document. The combination of the ID and its revision uniquely identifies the associated entity.
  VariationID [0..1]    
  DocumentIDSet [0..*]    
  from type HeaderBaseType
  LastModificationDateTime [0..1]    The datetime on which the object was last modified
  DocumentDateTime [0..1]    The date that document was created within the system of record.
  from group FreeFormTextGroup
  Description [0..*]    
  Note [0..*]    
  from group ReferencesGroup
  DocumentReference [0..*]    
  Attachment [0..*]    The Attachment represents binary data files that may be included within a BOD. These files replace the paper specifications and drawings attached to a BOD definition to clearly communicate design requirements. This Data Type is optional. Attachment usage is further defined by its position.
  from type StatusHeaderBaseType
  Status [0..*]    Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
  from type ShipHeaderBaseType
  ShipUnitQuantity [0..1]    This contains the quantity of units or things shipped. This represents the container(s), not the product shipped. An example of this is "4 truck loads" or "2 wooden crates"
  WarehouseLocation [0..1]    Is the storage facility for inventory.
  CarrierRouteReference [0..*]    
  BillOfLadingReference [0..*]    Is a reference to the associated Bill of Lading document.
  DeliveryReference [0..*]    Is a reference to the Delivery document.
  ContractReference [0..*]    Is a reference to a contract
  ShipmentReleaseDateTime [0..1]    
  ActualShipDateTime [0..1]    Inidicates the shipping date and time of the line item.
  ScheduledDeliveryDateTime [0..1]    The scheduled delivery date provided by the supplier.
  ActualDeliveryDateTime [0..1]    Is the actual delivery date and time of the line item.
  EstimatedWeightMeasure [0..1]    The estimated weight of an item or object. An estimate is provided as a processing alternative when the actual weight is not known or cannot be calculated exactly.
  LoadingWeightMeasure [0..1]    This is the net weight at loading time of a container in which the materials are being shipped.
  from group ShippingWeightAndVolumeGroup
  DunnageWeightMeasure [0..1]    Specifies details of the shipped unit weight
  TareWeightMeasure [0..1]    Tare weight of the associated Entity. The Tare weight is the weight of the packaging when empty (in the case of a pallet the weight of the empty pallet) that when subtracted from the Gross weight results in the Net weight.
  NetWeightMeasure [0..1]    Net weight of the associaed item. The net weight is calculated by subtracting the tare weight or the weight of the container from the GrossWeight.
  GrossWeightMeasure [0..1]    Gross weight of the associated entity. The total weight of the entity without reduction of packaging or container. I.e The Gross wieght of a pallet of goods includes the weight of the pallet.
  NetVolumeMeasure [0..1]    
  TotalVolumeMeasure [0..1]    Quantifies the volume, or amount of space, that is occupied by an item, container or shipment.
  HazardousMaterialCodes [0..1]    Provides the hazardous material codes that are associated with the given instance of the item.
  CountryOfOriginCode [0..1]    Represents the identifier of the country of origin of an item, service or shipment
  DistributionCenterCode [0..1]    Indicates the DistributionCenter that the Seller will ship the items from.
  TransportationMethodCode [0..1]    Identifies the general type of carrier transportation used to deliver goods.
  SpecialHandlingNote [0..*]    This describes any special, physical handling needs that the freight might have. For example, the need for a lift gate
  DockID [0..1]    Idenitifies the loading dock that the associate entity is to be taken.
  EstimatedDepartureDateTime [0..1]    
  EstimatedArrivalDateTime [0..1]    
  ShipFromParty [0..1]    Identifies the party that the goods or services are being shipped or sent from.
  CarrierParty [0..1]    Identifies the party that serves as the carrier of the goods or services for the transaction.
  PurchasingParty [0..1]    Identifies the party that purchased the goods or services.
  SupplierParty [0..1]    Identifies the supplier organization/entity of the items or inventory for the associated transaction. In most cases there is one SupplierParty per transaction. i.e. one SupplierParty for a given PurchaseOrder. However in the cases where an transaction Broker is involved there are cases where a single transaction may have different SupplierParties at the line level or in the case of a Catalog for the Catalog.
  SoldToParty [0..1]    Is to be used for third party buying to indicate the buying organization. All purchasing scenario will have a CustomerParty is used to indicated the End Customer of the transaction.
  FreightTermCode [0..1]    Describes how the freight cost for a shipment of goods should be billed. EXAMPLES: Prepaid, Collect, Third Party, Prepaid and Add, Consignee Billed
  Party [0..*]    A generic Party for non-validated or application-validated parties. A work-around for situations where Schema-validation of Parties is not feasible or not desired.
  DistributeCharge [0..*]    Specifies the details for allocating a portion of a charge properly
  ShipToParty [0..*]    Identifies the ShipToParty for the document or the line. In a lot of cases, this is the same as the CustomerParty. In multi-organization purchasing, the CustomerParty may be different from the BuyerParty
  from type ShipmentHeaderBaseType
  DeclaredValueAmount [0..1]    Is the declared monetary value of the contents of a shipping unit or a delivery for insurance purposes.
  EstimatedFreightChargeAmount [0..1]    Is used to describe the estimated cost of transporting the items or products being sold, produced or purchased. This amount is usually determined at the time the sales order is created and is quoted to the customer, before the actual shipping method, weight or number of units is known. This is also customarily known as a general "Shipping and Handling" charge.
  FreightCostAmount [0..1]    This is used to describe a shipper's total cost of transporting the items or products being sold, produced or purchased, if it is different that the freight amount being charged to the customer. (Certain businesses may want to track the internal cost of a "free shipping" promotion or utilize their shipping operations as a profit center.)
  FreightChargeAmount [0..1]    Is used to report the total price charged to the customer for transporting the items or products being sold, produced or purchased. This amount is determined by the shipping partner and/or reported by the carrier partner upon shipment or delivery of the product. The shipper's total operational freight cost (which may be different the price charged) can be reported using FreightOperationalAmount.
  SalePriceAmount [0..1]    Identifies the sales price for the associated item or object. This could be used to identify the price at a header level or line item level. This price is considered to be exclusive of freight or other taxes or charges
  ShipmentTotalAmount [0..1]    This is the sum of the FreightChargeAmount and SalePriceAmount for the shipment. If C.O.D. (Collect On Delivery) freight terms were specified for the transaction, this is monetary amount that the carrier is to collect as payment from the customer upon shipment of all the shipping units
  RequiredDeliveryDateTime [0..1]    Indicates the date in which the buyer/customer requests the order to be delivered.
  PromisedDeliveryDateTime [0..1]    Indicates the date in which the associated was promised to be delivered to the customer or consumer.
  LoadingDateTime [0..1]    Identifies the date and time a shipment loading process is complete.
  EarliestShipDateTime [0..1]    This indicates the earliest possible date at which a shipment can be made for the line item
  PromisedShipDateTime [0..1]    Indicates the date in which the associated object was promised to be shipped from the supplier.
  ScheduledShipDateTime [0..1]    The scheduled date to be shipped provided by the supplier.
  ImportLicenseRequiredIndicator [0..1]    Communicates the need for an import license on a good or service. Valid values are '0' for no license required, and '1' for license required.
  ExportLicenseRequiredIndicator [0..1]    Communicates the need for an export license on a good or service. Valid values are '0' for no license required, and '1' for license required.
  DropShipmentIndicator [0..1]    This identifies if a particular shipment is a drop-shipment. In a drop shipment scenario, an organization takes title of the product but does not actually handle, stock or deliver it. E.g., To have one supplier ship directly to another or to have a supplier ship directly to the buyer's customer."
  PartialShipmentAllowedIndicator [0..1]    Identifies if a partial shipment to a customer is allowed.
  EarlyShipmentAllowedIndicator [0..1]    Communicates if it is permitted to ship a good or service prior to the date it is due
  ExclusiveShipmentIndicator [0..1]    
  PriorityCode [0..1]    Indicates the priority or urgency of the associated entity.
  ShipmentServiceLevelCode [0..1]    Is a generic code that specifies a particular type or quality of carrier delivery service to be used for transporting goods. A generic service level code is often established by shippers to consolidate various equivalent, but differently named, carrier service levels for comparison when "rate shopping" for the lowest cost transportation provider. See CarrierServiceLevel for specifying the carrier's actual service level code.
  CarrierServiceLevelCode [0..1]    The carrier's code or marketing term for specifying a particular type or quality of delivery service to be used for transporting goods. Use ShipmentServiceLevel when specifying a shipper-assigned code for generic delivery service level that is not specific to a carrier.
  DestinationCountryCode [0..1]    Indicates the country that the item being manufactured is destinated to go to.
  PointOfLoadingCode [0..1]    Identifies the location shipped goods are to be loaded.
  PointOfShipmentCode [0..1]    Identifies the location the goods are to be shipped.
  PointOfStagingCode [0..1]    Identifies the location goods are to be placed prior to loading for shipment.
  TransportationTerm [0..1]    The terms of the transportation agreement.
  TrackingID [0..*]    TRACKINGID is a unique identifier for the purpose of tracking an individual package or shipment Examples of a valid TRACKINGID include: •An express parcel tracking number as typically assigned by UPS, DHL, Fedex or other similar carriers. •A UCC (Uniform Code Council) Serialized Shipping Container (SCC-18) identifier, as assigned by the shipper. •A "Pro Number" (Progressive Number), as assigned by an LTL (less-than-truckload) freight carrier. Since the same Pro Number can be assigned to multiple shipping units within an LTL shipment, the SHIPUNITSEQ and SHIPUNITTOT field identifiers may be used to identify the individual pieces. •The unique identifier of a motor freight trailer, railroad box or tank car, ocean freight container or other transportation vessel.
  FreightChargeAccountNumberID [0..1]    The account number with the shipping carrier of the party paying the carrier fees for the shipment.
  Disposition [0..1]    Indicates whether an item is active, inactive, or in other various states. Examples of values for this field include: Active, Inactive, Hold, Deleted, Obsolete
  Event [0..*]    Specifies details about a specific occurrence in time
  1. Extension [0..1]    Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The Extension is always the last element in all components, except where the component has been extended inline.

Attributes

None

Used by

• Element ShipmentHeader

Type inheritance chain

• DocumentIdentificationBaseType
  • HeaderBaseType
    • StatusHeaderBaseType
      • ShipHeaderBaseType
        • ShipmentHeaderBaseType
          • ShipmentHeaderType