1. Integration Guide
  2. Job Interface

Job Interface

A job offers a workspace that brings together the objects and activities required of them, including:

  • The ability to group all objects related to a job and perform existing functions/actions against those objects, including buy shipments, sell shipments, non-freight related charges, and customer bills.
  • The ability to manage jobs from various perspectives depending on responsibility. For example, export, import, both, or consolidations.
  • The ability to manage settlement functions at the job level, including profitability, expenses, revenues, and billing.
Note: The interface is supported on the outbound only.

The primary business objects in the Job Interface are:

  1. Order releases
    • For each order release related to the job, JOB_ORDER_RELEASE_JOIN will be added to the XML. Although orders are not required to create a job, at least one order should be related to the job to send out the interface.
  2. Buy side costs
    • The Buy Side Costs wrapper element contains two sub elements, Buy Shipments and Buy Allocation.
    • Buy shipments: Select all related orders. For each order, select all related buy shipments where the shipment job GID equals null or it equals the current job GID. There may be zero or more buy shipments.
    • Buy allocation: Each allocation will be selected for each order, where the allocation Shipment Job GID is equal to the current job or it is equal to null. There may be zero or more allocations.
  3. Sell side costs
    • The sell side costs works exactly the same as the buy side, except the selection criteria is based on sell side perspective.
  4. Bills
    • Each customer bill related to the job will be included in the XML. Bills can be found in the JOB_BILL table. Zero or more bills are required.
    • Because this interface can potentially be large, redundant data has been reduced across multiple data elements included in the interface. This includes:
    • The ability to only include the Order Release GID in the shipment, allocation, and bill elements.
    • The ability to only include the Shipment GID in the allocation and bill elements.