FreightWise Logo
API docs by Redocly

FreightWise, LLC. Public API (1.0.2)

Download OpenAPI specification:

FreightWise, LLC: support@freightwisellc.com URL: https://freightwisellc.zendesk.com/hc/en-us/articles/360061181731

A public API for integrating with the FreightWise TMS.

Rates

Rates are for getting available carrier, services, costing, and transit times for Parcel, FTL & LTL shipments as a true multi-mode rate.

Get a Freight (LTL) Quote / Rate

Get a Freight (LTL) Quote / Rate

Authorizations:
ApiKeyAuthClientIdAuth
Request Body schema: application/json
required

A JSON object containing rate request information

shipDate
string <date> (FreightWiseDate) ^\d{4}-\d{2}-\d{2}$
Default: "Today's Date and Time"

Date's timezone is considered central.

directionId
integer <int32> (DirectionId)
Default: 1
Enum: 1 2 3 5

The direction ID designates the direction. The following are the options:

  • 1 = Inbound
  • 2 = Outbound
  • 3 = 3rd Party
  • 5 = Transfer

By default it is 1 = Inbound.

termId
integer <int32> (TermId)
Default: 9

The following term IDs are valid for this API:

  • 9 = PPD - PrePaid
  • 10 = COL - Collect
  • 12 = 3rd Party
  • 13 = PPA - PrePaid & Add
object (Address)

Address object at FreightWise

object (Address)

Address object at FreightWise

branchNum
string (BranchNum)
Default: ""

The branch number is a way to designate the outbound or inbound branch that is being used / assigned. This is often then used to set the markups and assign account numbers to shipments and rate quotes. If the branch num cannot be determined it is set as a default to "---". The branch number is a UUID.

Array of objects or null (Commodity)

Please note that only top-level commodities will be used for quoting purposes

accessorialCodes
Array of strings (AccessorialCode)
Items Enum: "LG01" "RES1"

Accessorial codes that should be included on the rates.

object (Reference)

Reference fields that are searchable on the FreightWise applications.

filterModeId
Array of integers <int32> (ModeId) [ items <int32 > ]

Allows the filtering of modes from rating rating responses. This feature is often used if a client does not want a certain mode to be considered during the rating process based on location, type of shipment or any other factor that FreightWise might not be able to determine (expl. customer preference). To remove (filter) a mode prepend a "-" on the mode id or prepend a "+" on the mode id to include exclusively during rating.

filterCarrierScac
Array of strings (Scac)

Allows the filtering of carriers from rating rating responses. This feature is often used if a client does not want a certain carrier to be considered during the rating process based on location, type of shipment or any other factor that FreightWise might not be able to determine (expl. customer preference). To remove (filter) a carrier prepend a "-" on the SCAC or prepend a "+" on the SCAC to include exclusively during rating.

filterCarrierServiceTypeCode
Array of strings (CarrierServiceTypeCode)

Allows the filtering of parcel service types from rating rating responses. This feature is often used if a client does not want a certain parcel service to be considered during the rating process based on location, type of shipment or any other factor that FreightWise might not be able to determine (expl. customer preference). To remove (filter) a carrier prepend a "-" on the parcel service type code or prepend a "+" on the parcel service type code to include exclusively during rating. Please note this setting ONLY affects the parcel mode carrier responses at this time.

Responses

Request samples

Content type
application/json
{
  • "shipDate": "2020-08-15",
  • "directionId": 2,
  • "termId": 9,
  • "from": {
    },
  • "to": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "commodities": [
    ],
  • "accessorialCodes": [
    ],
  • "reference": {
    },
  • "filterModeId": [
    ],
  • "filterCarrierScac": [
    ],
  • "filterCarrierServiceTypeCode": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 4593804,
  • "direction": {
    },
  • "from": {
    },
  • "to": {
    },
  • "rates": [
    ]
}

Get existing Rate

Get existing Rate

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

query Parameters
findByType
string (FindByType)
Enum: "id" "packNum" "poNum" "soNum" "custNum" "sealNum" "delvNum" "freightInvoiceNum"
Example: findByType=id

Please note: These are not required to be unique withing the shipments. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that match your criteria.

Responses

Response samples

Content type
application/json
{
  • "id": 4593804,
  • "direction": {
    },
  • "from": {
    },
  • "to": {
    },
  • "rates": [
    ]
}

Shipments

Shipments are a generic form of shipping a Parcel, LTL, or FTL load.

Get Shipments list for given date range.

Get Shipments list for given date range.

Authorizations:
ApiKeyAuthClientIdAuth
query Parameters
dateEnd
string

An ISO 8601 date string (YYYY-MM-DD) to be used as the most recent date to search for shipments. Always uses end of day. Defaults to today.

dateStart
string

An ISO 8601 date string to be used as the earliest date to search for shipments. Always uses end of day. Defaults to five days ago.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Shipment

Create a new Shipment

Authorizations:
ApiKeyAuthClientIdAuth
Request Body schema: application/json
required

A JSON object containing shipment information

shipDate
string <date> (FreightWiseDate) ^\d{4}-\d{2}-\d{2}$
Default: "Today's Date and Time"

Date's timezone is considered central.

earlyPickUpTimeOpen
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyPickUpTimeClose
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyPickUpTZ
string (Timezone)

Timezone identifier (e.g., America/Chicago). Time zone is derived from the corresponding address.

latePickUpTimeOpen
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

latePickUpTimeClose
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

latePickUpTZ
string (Timezone)

Timezone identifier (e.g., America/Chicago). Time zone is derived from the corresponding address.

earlyDeliveryTimeOpen
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyDeliveryTimeClose
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyDeliveryTZ
string (Timezone)

Timezone identifier (e.g., America/Chicago). Time zone is derived from the corresponding address.

lateDeliveryTimeOpen
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

lateDeliveryTimeClose
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

lateDeliveryTZ
string (Timezone)

Timezone identifier (e.g., America/Chicago). Time zone is derived from the corresponding address.

object (Address)

Address object at FreightWise

object (Address)

Address object at FreightWise

object (Address)

Address object at FreightWise

object (Address)

Address object at FreightWise

object (Address)

Address object at FreightWise

branchNum
string (BranchNum)
Default: ""

The branch number is a way to designate the outbound or inbound branch that is being used / assigned. This is often then used to set the markups and assign account numbers to shipments and rate quotes. If the branch num cannot be determined it is set as a default to "---". The branch number is a UUID.

scac
string (Scac)

The Standard Carrier Alpha Code (SCAC) is a unique two-to-four-letter code used to identify transportation companies. SCAC codes can be obtained from the National Motor Freight Traffic Association (NMFTA).

Example SCACs:

  • USPS = United States postal Service
  • ODFL = Old Dominion Freight Lines
  • CNWY = XPO
  • FDEN = FedEx Express (Parcel)
  • FDEG = FedEx Ground (Parcel)
  • FXFE = FedEx Freight (Priority)
  • FXNL = FedEx Freight (Economy)
  • SAIA = Saia Motor Freight Line
  • EXLA = Estes Express Lines
  • UPSN = UPS Parcel Service
  • etc...
directionId
integer <int32> (DirectionId)
Default: 1
Enum: 1 2 3 5

The direction ID designates the direction. The following are the options:

  • 1 = Inbound
  • 2 = Outbound
  • 3 = 3rd Party
  • 5 = Transfer

By default it is 1 = Inbound.

termId
integer <int32> (TermId)
Default: 9

The following term IDs are valid for this API:

  • 9 = PPD - PrePaid
  • 10 = COL - Collect
  • 12 = 3rd Party
  • 13 = PPA - PrePaid & Add
modeId
integer <int32> (ModeId)
Default: 1

The following mode IDs are valid for this API:

  • 0 = Not Set
  • 1 = LTL
  • 2 = TL
  • 4 = Ocean
  • 5 = Rail
  • 7 = Air (Freight)
  • 8 = Hotshot
  • 9 = Local
  • 10 = Drayage
  • 18 = Parcel
  • 22 = White Glove
  • 27 = MSTL (Multi-Stop Truckload)

If the object is not sent or the modeId is not sent then the system will default to modeId = 1.

priorityLevelId
integer <int32> (PriorityLevelId)

The following priority level IDs are valid for this API:

  • 1 = Urgent
  • 2 = High
  • 3 = Medium
  • 4 = Low
termsOfSaleId
integer <int32> (TermsOfSaleId)

The following terms of sale IDs are valid for this API:

  • 1 = EXW
  • 2 = FCA
  • 3 = CPT
  • 4 = CIP
  • 5 = DAP
  • 6 = DPU
  • 7 = DDP
  • 8 = FAS
  • 9 = FOB
  • 10 = CFR
  • 11 = CIF
reasonForExportId
integer <int32> (ReasonForExportId)

The following reasons for export IDs are valid for this API:

  • 1 = Gift
  • 2 = Not Sold
  • 3 = Personal Effects
  • 4 = Repair and Return
  • 5 = Sample
  • 6 = Sold
totalUnitPriceAmt
number <double> (TotalUnitPriceAmt)
Default: 0

The total unit price of commodities for international shipments.

Array of objects or null (Commodity)
accessorialCodes
Array of strings (AccessorialCode)
Items Enum: "LG01" "RES1"

Accessorial codes to be added to this shipment

carrierServiceTypeCode
string

This is only used when shipment is of mode "PARCEL"

filterModeId
Array of strings[ items^[+-]\d+$ ]
Deprecated

Deprecated: Use constraints instead. Allows filtering of shipment rate modes using prefixed strings (e.g. '-18' to exclude, '+1' to include exclusively). Cannot be used together with constraints.

filterCarrierScac
Array of strings[ items^[+-][A-Z]{2,4}$ ]
Deprecated

Deprecated: Use constraints instead. Allows filtering of carriers from shipment rates using prefixed SCACs (e.g. '-USPS' to exclude, '+CENF' to include exclusively). Cannot be used together with constraints.

filterCarrierServiceTypeCode
Array of strings[ items^[+-][A-Z_0-9]+$ ]
Deprecated

Deprecated: Use constraints instead. Allows filtering of service types from shipment rates using prefixed codes (e.g. '-PRIORITY_OVERNIGHT' to exclude). Cannot be used together with constraints.

Array of objects (Constraints)

An array of constraint objects used to filter rate results. Each constraint targets one type (carrier, mode, serviceType, or equipment). At most one entry per type is allowed. Provide either include or exclude (not both). Cannot be used in the same request as the deprecated filterCarrierScac, filterModeId, or filterCarrierServiceTypeCode fields.

glCode
string (GlCode)
Default: "9999.99.99"

A General Ledger Code (GL Code) is a string of alphanumeric characters assigned to a shipment (parcel or freight). Usually the GL Code can indicates basic information to the accounting system on how a cost should be treated as whole within the organization. A GL String is made up of a combination of numbers and groups of numbers that when applied uniformly can categorize costing for accounting and finance.

object (Reference)

Reference fields that are searchable on the FreightWise applications.

Array of objects (Notification)
object

Temperature range with min and max values

temperatureUnit
string
Enum: "fahrenheit" "celsius" "f" "c" "F" "C"

Temperature unit. Accepts: 'fahrenheit', 'celsius', 'f', 'c', 'F', or 'C' (case-insensitive)

Responses

Request samples

Content type
application/json
{
  • "shipDate": "2020-08-15",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "soldTo": {
    },
  • "customsBroker": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "scac": "FXFE",
  • "directionId": 2,
  • "termId": 9,
  • "modeId": 1,
  • "priorityLevelId": 1,
  • "termsOfSaleId": 1,
  • "reasonForExportId": 1,
  • "totalUnitPriceAmt": 0,
  • "commodities": [
    ],
  • "accessorialCodes": [
    ],
  • "carrierServiceTypeCode": "FEDEX_EXPRESS_SAVER",
  • "filterModeId": [
    ],
  • "filterCarrierScac": [
    ],
  • "filterCarrierServiceTypeCode": [
    ],
  • "constraints": [
    ],
  • "glCode": "10.18039.5104-ABC",
  • "reference": {
    },
  • "notifications": [
    ],
  • "temperatureRange": {
    },
  • "temperatureUnit": "f"
}

Response samples

Content type
application/json
{
  • "id": 654321,
  • "shipDate": "2020-08-15",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "carrier": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "mode": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "parcelServiceType": {
    },
  • "orders": [
    ],
  • "cost": {
    },
  • "costDetails": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ],
  • "stops": [
    ]
}

Get existing Shipment

Get existing Shipment

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note: These are not required to be unique withing the shipments. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that match your criteria.

query Parameters
findByType
string (FindByType)
Enum: "id" "packNum" "poNum" "soNum" "custNum" "sealNum" "delvNum" "freightInvoiceNum"
Example: findByType=id

Responses

Callbacks

Response samples

Content type
application/json
{
  • "id": 654321,
  • "shipDate": "2020-08-15",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "carrier": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "mode": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "parcelServiceType": {
    },
  • "orders": [
    ],
  • "cost": {
    },
  • "costDetails": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ],
  • "stops": [
    ]
}

Callback payload samples

Callback
POST: https://your.server.com
Content type
application/json
{
  • "id": 654321,
  • "shipDate": "2020-08-15",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "carrier": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "mode": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "parcelServiceType": {
    },
  • "orders": [
    ],
  • "cost": {
    },
  • "costDetails": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ],
  • "stops": [
    ]
}

Update existing Shipment

Update existing Shipment

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note: These are not required to be unique withing the shipments. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that match your criteria.

query Parameters
findByType
string (FindByType)
Enum: "id" "packNum" "poNum" "soNum" "custNum" "sealNum" "delvNum" "freightInvoiceNum"
Example: findByType=id
Request Body schema: application/json
Any of
object (Reference)

Reference fields that are searchable on the FreightWise applications.

glCode
string (GlCode)
Default: "9999.99.99"

A General Ledger Code (GL Code) is a string of alphanumeric characters assigned to a shipment (parcel or freight). Usually the GL Code can indicates basic information to the accounting system on how a cost should be treated as whole within the organization. A GL String is made up of a combination of numbers and groups of numbers that when applied uniformly can categorize costing for accounting and finance.

Array of objects

Constraints are stored and applied during rating.

shipmentStateId
integer <int32> (StateId)

The state ID of a particular parent state object

Responses

Request samples

Content type
application/json
{
  • "reference": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "constraints": [
    ],
  • "shipmentStateId": 1
}

Response samples

Content type
application/json
{
  • "id": 654321,
  • "shipDate": "2020-08-15",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "carrier": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "mode": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "parcelServiceType": {
    },
  • "orders": [
    ],
  • "cost": {
    },
  • "costDetails": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ],
  • "stops": [
    ]
}

Update existing Shipment - only the fields that ar

Update existing Shipment - only the fields that are specified are able to be updated. This will also return the shipment upon success.

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note: These are not required to be unique withing the shipments. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that match your criteria.

Request Body schema: application/json
Any of
Array of objects (Constraints)

An array of constraint objects used to filter rate results. Each constraint targets one type (carrier, mode, serviceType, or equipment). At most one entry per type is allowed. Provide either include or exclude (not both). Cannot be used in the same request as the deprecated filterCarrierScac, filterModeId, or filterCarrierServiceTypeCode fields.

accountNum
string (AccountNum)

The Account # references the carrier's account number. In many cases a client might have multiple account numbers linked to by the branchNum.

accessorialIds
Array of strings or null <uuid> [ items <uuid > ]
actualDeliveryDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

actualShipDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

assignedCompanyBranchId
string (BranchNum)
Default: ""

The branch number is a way to designate the outbound or inbound branch that is being used / assigned. This is often then used to set the markups and assign account numbers to shipments and rate quotes. If the branch num cannot be determined it is set as a default to "---". The branch number is a UUID.

assignedCompanyDivisionId
string (DivisionNum)
Default: ""

The division number is a way to designate the outbound or inbound location within a branch that is being used / assigned. This is often then used to set the markups and assign account numbers to shipments and rate quotes. If the branch division num cannot be determined it is set as a default to "---". The division number is a UUID.

object (Address)

Address object at FreightWise

Array of objects or null (Commodity)
custNum
string (CustNum)

The Cust# is often used as an internal reference number used by the WMS, ERP, or primary TMS operations to locate the customer of the FreightWise client.

delvNum
string (DelvNum)

The Delv# is often used as Pick Ticket, Delivery, and/or other internal reference number used by the WMS, ERP, or primary TMS operations.

object (Direction)

The direction ID designates the direction. The following are the options:

  • 1 = Inbound
  • 2 = Outbound
  • 3 = 3rd Party
  • 5 = Transfer

By default it is 1 = Inbound.

Array of objects (EquipmentDetail)
estimatedShipDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyDeliveryDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyPickUpDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

estimatedDeliveryDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

glCode
string (GlCode)
Default: "9999.99.99"

A General Ledger Code (GL Code) is a string of alphanumeric characters assigned to a shipment (parcel or freight). Usually the GL Code can indicates basic information to the accounting system on how a cost should be treated as whole within the organization. A GL String is made up of a combination of numbers and groups of numbers that when applied uniformly can categorize costing for accounting and finance.

object (Address)

Address object at FreightWise

fromAppointment
string or null
initialDeliveryDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

latePickUpDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

lateDeliveryDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

modeId
integer <int32> (ModeId)
Default: 1

The following mode IDs are valid for this API:

  • 0 = Not Set
  • 1 = LTL
  • 2 = TL
  • 4 = Ocean
  • 5 = Rail
  • 7 = Air (Freight)
  • 8 = Hotshot
  • 9 = Local
  • 10 = Drayage
  • 18 = Parcel
  • 22 = White Glove
  • 27 = MSTL (Multi-Stop Truckload)

If the object is not sent or the modeId is not sent then the system will default to modeId = 1.

notes
string or null
packNum
string (PackNum)

The Pack# is often used as Pick Ticket, DocEntry, Delivery, and/or other internal reference number used by the WMS, ERP, or primary TMS operations.

parcelServiceTypeId
number or null
poNum
string or null
priorityLevelId
integer <int32> (PriorityLevelId)

The following priority level IDs are valid for this API:

  • 1 = Urgent
  • 2 = High
  • 3 = Medium
  • 4 = Low
reasonForExportId
integer <int32> (ReasonForExportId)

The following reasons for export IDs are valid for this API:

  • 1 = Gift
  • 2 = Not Sold
  • 3 = Personal Effects
  • 4 = Repair and Return
  • 5 = Sample
  • 6 = Sold
requestedDeliveryDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

requestedShipDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

scac
string (Scac)

The Standard Carrier Alpha Code (SCAC) is a unique two-to-four-letter code used to identify transportation companies. SCAC codes can be obtained from the National Motor Freight Traffic Association (NMFTA).

Example SCACs:

  • USPS = United States postal Service
  • ODFL = Old Dominion Freight Lines
  • CNWY = XPO
  • FDEN = FedEx Express (Parcel)
  • FDEG = FedEx Ground (Parcel)
  • FXFE = FedEx Freight (Priority)
  • FXNL = FedEx Freight (Economy)
  • SAIA = Saia Motor Freight Line
  • EXLA = Estes Express Lines
  • UPSN = UPS Parcel Service
  • etc...
sealNum
string (SealNum)

The Seal# is often used by TL carriers to designate on a BOL the seal of the trailer. After the product is loaded and the trailer doors are closed, the supplier (or shipping warehouse) is responsible for affixing a unique numbered trailer seal onto the trailer’s back door latch. The carrier is NOT allowed to apply this seal.

shippingInstructions
string or null

Instructions generally pertaining to an address

soNum
string or null
termId
integer <int32> (TermId)
Default: 9

The following term IDs are valid for this API:

  • 9 = PPD - PrePaid
  • 10 = COL - Collect
  • 12 = 3rd Party
  • 13 = PPA - PrePaid & Add
termsOfSaleId
integer <int32> (TermsOfSaleId)

The following terms of sale IDs are valid for this API:

  • 1 = EXW
  • 2 = FCA
  • 3 = CPT
  • 4 = CIP
  • 5 = DAP
  • 6 = DPU
  • 7 = DDP
  • 8 = FAS
  • 9 = FOB
  • 10 = CFR
  • 11 = CIF
object (Address)

Address object at FreightWise

toAppointment
string or null
object or null (TemperatureRange)

Temperature range object

temperatureUnit
string or null
Enum: "fahrenheit" "celsius" "f" "c" "F" "C"

Temperature unit. Accepts: 'fahrenheit', 'celsius', 'f', 'c', 'F', or 'C' (case-insensitive)

Responses

Request samples

Content type
application/json
{
  • "constraints": [
    ],
  • "accountNum": "1234ABDC",
  • "accessorialIds": [
    ],
  • "actualDeliveryDate": "2023-02-20T09:30:26Z",
  • "actualShipDate": "2023-02-20T09:30:26Z",
  • "assignedCompanyBranchId": "MY-BRANCH-ID",
  • "assignedCompanyDivisionId": "MY-DIVISION-ID",
  • "billTo": {
    },
  • "commodities": [
    ],
  • "custNum": "1234ABDC",
  • "delvNum": "1234ABDC",
  • "directionId": {
    },
  • "equipmentTypes": [
    ],
  • "estimatedShipDate": "2023-02-20T09:30:26Z",
  • "earlyDeliveryDate": "2023-02-20T09:30:26Z",
  • "earlyPickUpDate": "2023-02-20T09:30:26Z",
  • "estimatedDeliveryDate": "2023-02-20T09:30:26Z",
  • "glCode": "10.18039.5104-ABC",
  • "from": {
    },
  • "fromAppointment": "string",
  • "initialDeliveryDate": "2023-02-20T09:30:26Z",
  • "latePickUpDate": "2023-02-20T09:30:26Z",
  • "lateDeliveryDate": "2023-02-20T09:30:26Z",
  • "modeId": 1,
  • "notes": "string",
  • "packNum": "1234ABDC",
  • "parcelServiceTypeId": 0,
  • "poNum": "1234ABDC",
  • "priorityLevelId": 1,
  • "reasonForExportId": 1,
  • "requestedDeliveryDate": "2023-02-20T09:30:26Z",
  • "requestedShipDate": "2023-02-20T09:30:26Z",
  • "scac": "FXFE",
  • "sealNum": "1234ABDC",
  • "shippingInstructions": "string",
  • "soNum": "1234ABDC",
  • "termId": 9,
  • "termsOfSaleId": 1,
  • "to": {
    },
  • "toAppointment": "string",
  • "temperatureRange": {
    },
  • "temperatureUnit": "fahrenheit"
}

Response samples

Content type
application/json
{
  • "id": 654321,
  • "shipDate": "2020-08-15",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "carrier": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "mode": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "parcelServiceType": {
    },
  • "orders": [
    ],
  • "cost": {
    },
  • "costDetails": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ],
  • "stops": [
    ]
}

Cancelled the Shipment. This means that the shipme

Cancelled the Shipment. This means that the shipment's state is set to "Cancelled".

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note: These are not required to be unique withing the shipments. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that match your criteria.

query Parameters
findByType
string (FindByType)
Enum: "id" "packNum" "poNum" "soNum" "custNum" "sealNum" "delvNum" "freightInvoiceNum"
Example: findByType=id

Responses

Response samples

Content type
application/json
{
  • "id": 654321,
  • "shipDate": "2020-08-15",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "carrier": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "mode": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "parcelServiceType": {
    },
  • "orders": [
    ],
  • "cost": {
    },
  • "costDetails": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ],
  • "stops": [
    ]
}

Get the BOL PDF URL for a given shipment.

Get the BOL PDF URL for a given shipment.

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

Responses

Response samples

Content type
application/json
{}

Assign a pooled PRO# for a given shipment.

Assign a pooled PRO# for a given shipment.

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

Responses

Response samples

Content type
application/json
{
  • "id": 654321,
  • "shipDate": "2020-08-15",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "carrier": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "mode": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "parcelServiceType": {
    },
  • "orders": [
    ],
  • "cost": {
    },
  • "costDetails": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ],
  • "stops": [
    ]
}

Unassign and release a pooled PRO# from given ship

Unassign and release a pooled PRO# from given shipment.

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

Responses

Response samples

Content type
application/json
{
  • "id": 654321,
  • "shipDate": "2020-08-15",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "carrier": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "mode": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "parcelServiceType": {
    },
  • "orders": [
    ],
  • "cost": {
    },
  • "costDetails": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ],
  • "stops": [
    ]
}

Get the pallet labels URL for a given shipment.

Get the pallet labels URL for a given shipment.

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

query Parameters
format
string

Optionally specify the format of the label. Valid values are pdf (default) and png.

Responses

Response samples

Content type
application/json
Example
{}

Get labels for a given parcel shipment.

Get labels for a given parcel shipment.

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

query Parameters
format
string

Optionally specify the format of the label. Valid values are zpl, pdf and png.

Responses

Response samples

Content type
application/json
[]

Create and return labels for a given parcel shipme

Create and return labels for a given parcel shipment.

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

query Parameters
format
string

Optionally specify the format of the label. Valid values are zpl, pdf and png.

Responses

Response samples

Content type
application/json
[]

Void and remove any labels associated with the giv

Void and remove any labels associated with the given shipment.

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Specify the id of the shipment you want to void.

Responses

Response samples

Content type
application/json
{ }

Schedule a pickup request

Schedule a pickup request for a shipment that has already been created and rated. The shipment must be in a "Planned" state with no existing pickup confirmation number. Electronic BOL eligibility is determined automatically based on carrier and client settings. If eligible, an electronic BOL is generated before requesting the pickup from the carrier. On success, the shipment state transitions from "Planned" to "Scheduled Pickup".

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

Responses

Response samples

Content type
application/json
{
  • "pickupConfirmationNumber": "PU123456789",
  • "freightInvoiceNum": "1234567890",
  • "shipmentState": {
    },
  • "pickupReferenceNumbers": [
    ]
}

Cancel a pickup request

Cancel an existing pickup request for a shipment. The shipment must have an existing pickup confirmation number and the carrier must support cancellations. On success, the shipment state transitions from "Scheduled Pickup" back to "Planned".

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

Responses

Response samples

Content type
application/json
{ }

Get rate for a given shipment.

Get rate for a given shipment.

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

Responses

Response samples

Content type
application/json
{
  • "rate": {
    },
  • "shipment": {
    }
}

Orders

Orders are used to merge, split, and or send one-to-one shipment to the FW system.

Create a new Order

Create a new Order

Authorizations:
ApiKeyAuthClientIdAuth
Request Body schema: application/json
required

A JSON object containing order information

earlyPickUpDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyPickUpTimeOpen
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyPickUpTimeClose
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyPickUpTZ
string (Timezone)

Timezone identifier (e.g., America/Chicago). Time zone is derived from the corresponding address.

latePickUpDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

latePickUpTimeOpen
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

latePickUpTimeClose
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

latePickUpTZ
string (Timezone)

Timezone identifier (e.g., America/Chicago). Time zone is derived from the corresponding address.

earlyDeliveryDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyDeliveryTimeOpen
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyDeliveryTimeClose
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

earlyDeliveryTZ
string (Timezone)

Timezone identifier (e.g., America/Chicago). Time zone is derived from the corresponding address.

lateDeliveryDate
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

lateDeliveryTimeOpen
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

lateDeliveryTimeClose
string <datetime> (FreightWiseISO8601DateTime)
Default: "Today's Date and Time"

Date's timezone is considered ISO8601DateTime format.

lateDeliveryTZ
string (Timezone)

Timezone identifier (e.g., America/Chicago). Time zone is derived from the corresponding address.

object (Address)

Address object at FreightWise

object (Address)

Address object at FreightWise

object (Address)

Address object at FreightWise

branchNum
string (BranchNum)
Default: ""

The branch number is a way to designate the outbound or inbound branch that is being used / assigned. This is often then used to set the markups and assign account numbers to shipments and rate quotes. If the branch num cannot be determined it is set as a default to "---". The branch number is a UUID.

directionId
integer <int32> (DirectionId)
Default: 1
Enum: 1 2 3 5

The direction ID designates the direction. The following are the options:

  • 1 = Inbound
  • 2 = Outbound
  • 3 = 3rd Party
  • 5 = Transfer

By default it is 1 = Inbound.

termId
integer <int32> (TermId)
Default: 9

The following term IDs are valid for this API:

  • 9 = PPD - PrePaid
  • 10 = COL - Collect
  • 12 = 3rd Party
  • 13 = PPA - PrePaid & Add
priorityLevelId
integer <int32> (PriorityLevelId)

The following priority level IDs are valid for this API:

  • 1 = Urgent
  • 2 = High
  • 3 = Medium
  • 4 = Low
Array of objects or null (Commodity)
accessorialCodes
Array of strings (AccessorialCode)
Items Enum: "LG01" "RES1"

Accessorial codes to be added to this shipment

glCode
string (GlCode)
Default: "9999.99.99"

A General Ledger Code (GL Code) is a string of alphanumeric characters assigned to a shipment (parcel or freight). Usually the GL Code can indicates basic information to the accounting system on how a cost should be treated as whole within the organization. A GL String is made up of a combination of numbers and groups of numbers that when applied uniformly can categorize costing for accounting and finance.

object (Reference)

Reference fields that are searchable on the FreightWise applications.

Array of objects (Notification)
object

Temperature range with min and max values

temperatureUnit
string
Enum: "fahrenheit" "celsius" "f" "c" "F" "C"

Temperature unit. Accepts: 'fahrenheit', 'celsius', 'f', 'c', 'F', or 'C' (case-insensitive)

Array of objects (Constraints)

An array of constraint objects used to filter rate results. Each constraint targets one type (carrier, mode, serviceType, or equipment). At most one entry per type is allowed. Provide either include or exclude (not both). Cannot be used in the same request as the deprecated filterCarrierScac, filterModeId, or filterCarrierServiceTypeCode fields.

Responses

Request samples

Content type
application/json
{
  • "earlyPickUpDate": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpDate": "2023-02-20T09:30:26Z",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryDate": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryDate": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "directionId": 2,
  • "termId": 9,
  • "priorityLevelId": 1,
  • "commodities": [
    ],
  • "accessorialCodes": [
    ],
  • "glCode": "10.18039.5104-ABC",
  • "reference": {
    },
  • "notifications": [
    ],
  • "temperatureRange": {
    },
  • "temperatureUnit": "f",
  • "constraints": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 654321,
  • "earlyPickUpDate": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpDate": "2023-02-20T09:30:26Z",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryDate": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryDate": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "cost": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ]
}

Get existing Order by the Order ID

Get existing Order by the Order ID

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

query Parameters
findByType
string (FindByType)
Enum: "id" "packNum" "poNum" "soNum" "custNum" "sealNum" "delvNum" "freightInvoiceNum"
Example: findByType=id

Please note: These are not required to be unique withing the orders. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that match your criteria.

Responses

Callbacks

Response samples

Content type
application/json
{
  • "id": 654321,
  • "earlyPickUpDate": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpDate": "2023-02-20T09:30:26Z",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryDate": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryDate": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "cost": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ]
}

Callback payload samples

Callback
POST: https://your.server.com
Content type
application/json
{
  • "id": 654321,
  • "earlyPickUpDate": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpDate": "2023-02-20T09:30:26Z",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryDate": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryDate": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "cost": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ]
}

Update existing Orders

Update existing Orders

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

query Parameters
findByType
string (FindByType)
Enum: "id" "packNum" "poNum" "soNum" "custNum" "sealNum" "delvNum" "freightInvoiceNum"
Example: findByType=id

Please note: These are not required to be unique withing the orders. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that match your criteria.

Request Body schema: application/json
Any of
object (Reference)

Reference fields that are searchable on the FreightWise applications.

glCode
string (GlCode)
Default: "9999.99.99"

A General Ledger Code (GL Code) is a string of alphanumeric characters assigned to a shipment (parcel or freight). Usually the GL Code can indicates basic information to the accounting system on how a cost should be treated as whole within the organization. A GL String is made up of a combination of numbers and groups of numbers that when applied uniformly can categorize costing for accounting and finance.

Array of objects (Constraints)

An array of constraint objects used to filter rate results. Each constraint targets one type (carrier, mode, serviceType, or equipment). At most one entry per type is allowed. Provide either include or exclude (not both). Cannot be used in the same request as the deprecated filterCarrierScac, filterModeId, or filterCarrierServiceTypeCode fields.

Responses

Request samples

Content type
application/json
{
  • "reference": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "constraints": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 654321,
  • "earlyPickUpDate": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpDate": "2023-02-20T09:30:26Z",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryDate": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryDate": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "cost": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ]
}

Cancelled the Order. This means that the order's s

Cancelled the Order. This means that the order's state is set to "Cancelled".

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
findByValue
required
string (FindByValue)
Example: 654321

Please note the findByValue is NOT case sensitive.

query Parameters
findByType
string (FindByType)
Enum: "id" "packNum" "poNum" "soNum" "custNum" "sealNum" "delvNum" "freightInvoiceNum"
Example: findByType=id

Please note: These are not required to be unique withing the orders. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that match your criteria.

Responses

Response samples

Content type
application/json
{
  • "id": 654321,
  • "earlyPickUpDate": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyPickUpTimeClose": "2023-02-20T09:30:26Z",
  • "earlyPickUpTZ": "America/Chicago",
  • "latePickUpDate": "2023-02-20T09:30:26Z",
  • "latePickUpTimeOpen": "2023-02-20T09:30:26Z",
  • "latePickUpTimeClose": "2023-02-20T09:30:26Z",
  • "latePickUpTZ": "America/Chicago",
  • "earlyDeliveryDate": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "earlyDeliveryTZ": "America/Chicago",
  • "lateDeliveryDate": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeOpen": "2023-02-20T09:30:26Z",
  • "lateDeliveryTimeClose": "2023-02-20T09:30:26Z",
  • "lateDeliveryTZ": "America/Chicago",
  • "state": {
    },
  • "client": {
    },
  • "from": {
    },
  • "to": {
    },
  • "billTo": {
    },
  • "branchNum": "MY-BRANCH-ID",
  • "direction": {
    },
  • "term": {
    },
  • "priorityLevel": {
    },
  • "commodities": [
    ],
  • "accessorials": [
    ],
  • "cost": {
    },
  • "glCode": "10.18039.5104-ABC",
  • "freightInvoiceNum": "1234ABCdef",
  • "notifications": [
    ],
  • "reference": {
    },
  • "files": [],
  • "temperatureRange": {
    },
  • "temperatureUnit": {
    },
  • "metadata": {
    },
  • "constraints": [
    ]
}

Tracking

Tracking Freight and Parcel interface. Allows near real-time tracking of LTL and Parcel shipments for FreightWise clients.

Get tracking details

Get tracking details

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
scac
required
string (Scac)
Example: FXFE

The Standard Carrier Alpha Code (SCAC) is a unique two-to-four-letter code used to identify transportation companies. SCAC codes can be obtained from the National Motor Freight Traffic Association (NMFTA).

Example SCACs:

  • USPS = United States postal Service
  • ODFL = Old Dominion Freight Lines
  • CNWY = XPO
  • FDEN = FedEx Express (Parcel)
  • FDEG = FedEx Ground (Parcel)
  • FXFE = FedEx Freight (Priority)
  • FXNL = FedEx Freight (Economy)
  • SAIA = Saia Motor Freight Line
  • EXLA = Estes Express Lines
  • UPSN = UPS Parcel Service
  • etc...
freightInvoiceNum
required
string (FreightInvoiceNum)
Example: 1234ABCdef

This is the Parcel or LTL / FTL tracking number. On LTL this is usually referred to as the PRO#.

Responses

Response samples

Content type
application/json
{
  • "state": {
    },
  • "freightInvoiceNum": "1234ABCdef",
  • "carrier": {
    },
  • "events": [
    ]
}

POST / Add tracking detail events

POST / Add tracking detail events

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
scac
required
string (Scac)
Example: FXFE

The Standard Carrier Alpha Code (SCAC) is a unique two-to-four-letter code used to identify transportation companies. SCAC codes can be obtained from the National Motor Freight Traffic Association (NMFTA).

Example SCACs:

  • USPS = United States postal Service
  • ODFL = Old Dominion Freight Lines
  • CNWY = XPO
  • FDEN = FedEx Express (Parcel)
  • FDEG = FedEx Ground (Parcel)
  • FXFE = FedEx Freight (Priority)
  • FXNL = FedEx Freight (Economy)
  • SAIA = Saia Motor Freight Line
  • EXLA = Estes Express Lines
  • UPSN = UPS Parcel Service
  • etc...
freightInvoiceNum
required
string (FreightInvoiceNum)
Example: 1234ABCdef

This is the Parcel or LTL / FTL tracking number. On LTL this is usually referred to as the PRO#.

Request Body schema: application/json
required

A JSON object containing Tracking Event information

eventAt
string <date> (FreightWiseDateTimeLocal)
Default: "Today's Date and Time (local)"

Date's timezone is considered local

stateId
integer <int32> (StateId)

The state ID of a particular parent state object

object (Address)

Address object at FreightWise

description
string

Responses

Request samples

Content type
application/json
{
  • "eventAt": "2020-08-15 14:30:45",
  • "stateId": 1,
  • "address": {
    },
  • "description": "In Transit. Pickup up by driver 1234."
}

Response samples

Content type
application/json
{
  • "state": {
    },
  • "freightInvoiceNum": "1234ABCdef",
  • "carrier": {
    },
  • "events": [
    ]
}

EDI

EDI are the public endpoints for third-party EDI providers to interface with FreightWise.

Create an Transaction

Create an Transaction

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
ediSpec
required
string (EdiSpec)
Enum: "210" "214"
Example: 210

EDI Specs

Request Body schema: application/json
required

A JSON object containing EDI information

object (JsonObject)

JSON Object - Unstructured

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Freight Invoices

Freight Invoices are the invoices that FreightWise holds for FP&A processing.

Update existing Freight Invoice

Update existing Freight Invoice

Authorizations:
ApiKeyAuthClientIdAuth
path Parameters
freightInvoiceId
required
string <uuid> (FreightInvoiceId)
Example: 1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d

This is unique assigned identifier that FreightWise assigns to all freight invoices.

Request Body schema: application/json
Any of
glCode
string (GlCode)
Default: "9999.99.99"

A General Ledger Code (GL Code) is a string of alphanumeric characters assigned to a shipment (parcel or freight). Usually the GL Code can indicates basic information to the accounting system on how a cost should be treated as whole within the organization. A GL String is made up of a combination of numbers and groups of numbers that when applied uniformly can categorize costing for accounting and finance.

Responses

Request samples

Content type
application/json
{
  • "glCode": "10.18039.5104-ABC"
}

Response samples

Content type
application/json
{
  • "id": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d",
  • "freightInvoiceNum": "1234ABCdef",
  • "shipDate": "2020-08-15",
  • "client": {
    },
  • "carrier": {
    },
  • "mode": {
    },
  • "direction": {
    },
  • "glCode": "10.18039.5104-ABC"
}