API docs by Redocly

Navix Integration API v1 (v1)

Download OpenAPI specification:Download

Getting Started

To begin working with the Navix API, you'll need the following. Your Navix customer success manager will provide you with these details:

  • Tenant UUID. We generally set up both a production tenant and a sandbox tenant. We'll send you the UUIDs for both the production and sandbox tenant.
  • User account. You can use this account to log in to the Navix UI to help test your API interactions.
  • API key. We’ll send you a client ID and client secret to use to authenticate.

Authentication

Every API request should include an x-api-key header that contains your API key.

Although we recommend using an API key for authentication, we also support OAuth. If you'd like to use OAuth, please contact your customer success manager.

Composite Order

Adds a new composite order

This endpoint will always create a new composite order - it is not idempotent. If an existing Order with the same Order Number is found, it will be replaced with the new one. In the case the existing order is matched to an invoice, it will also be replaced, given that the invoice has not been approved yet.

The enableValidations property on the request body is used to determine whether or not to perform validations on the order. If validations are performed, any bad data will result in an error being returned; if validation are disabled, just about any data will be accepted. The validated fields include:

  • Transportation Mode
  • Transportation Service Level
  • Transportation Service Type
  • Currency
  • Billing Term
  • Customer
  • Vendor
  • Reference Number Type
  • Handling Unit
  • Charge Type
Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>

The UUID of the tenant who owns the composite order

Request Body schema: application/json
orderNumber
string or null

The unique identifier for the Order (i.e, "Load Number", "Shipment Number"). This value should be the commonly known identifier for the order that is shared with Vendors (i.e., "Carrier").

transportationMode
string or null

The mode for the order. This field is required if validations are enabled. Possible values are:

  • Ground
  • Air
  • Non-Freight
  • Ocean
  • Rail
transportationServiceLevel
string or null

The service level for the order. This field is required if validations are enabled. Possible values are:

  • Standard
  • Next Day AM
  • Next Day PM
  • 2nd Day
  • Deferred
  • 3-5 Day
  • International
  • Next Day
  • Volume
  • Conestoga
  • Consolidation
  • Flatbed
  • Temperature Controlled
  • 4PL
  • Priority
  • Economy
  • Guaranteed
  • Guaranteed Exclusive
  • TCSW
  • TCSP
transportationServiceType
string or null

The service type for the order. Possible values if validations are enabled or it can be undefined:

  • LTL
  • TL
  • Parcel
  • Expedited
  • Air
  • Cartage
  • Drayage
  • Guaranteed
  • Intermodal
  • Warehouse
  • 4PL
  • Ocean
  • Rail
currency
string or null

The currency for the order. Defaults to USD. Possible values are:

  • USD
  • CAD
freightChargeTerms
string or null

The freight charge terms for the order. This field is required if validations are enabled. Possible values are:

  • Collect
  • Prepaid
  • Prepaid & Add
  • Third Party
plannedShipmentWeight
number or null <double>
actualShipmentWeight
number or null <double>
cubicMeter
number or null <double>
shipDate
string or null <date-time>
deliveredDate
string or null <date-time>
object (System.TimeSpan)
customerCharge
number or null <double>
billingTerm
string or null

The billing term for the order. This field is required if validations are enabled. Possible values are:

  • Net 0
  • Net 2
  • Net 10
  • Net 15
  • Net 20
  • Net 25
  • Net 30
  • Net 45
  • Net 60
  • Net 75
  • Prepaid
paymentTerms
string or null
distance
number or null <double>
metadata
string or null
ratingEngineInfo
string or null

Rating Engine information used by the Navix Rating Engine Integration. This field is optional and should be a list of key value pairs as json. Here are some predefined pairs:
{
"VendorAccountUserName": "value",
"VendorAccountPassword": "value",
"ContractID": "value",
"ContractName": "value",
"ServiceType": "value"
}

uuid
string or null <uuid>
enableValidations
boolean

If set to true, the order will be validated before being created, and an error will be returned if any validations fail.

object (Vendor.Models.Requests.Integrations.VendorRequest)
object (Customer.Models.Requests.Integrations.CustomerRequest)
Array of objects or null (Order.Models.Integrations.OrderCompositeStopRequest)
Array of objects or null (Order.Models.Integrations.OrderCompositeReferenceNumberRequest)
Array of objects or null (Order.Models.Integrations.OrderCompositeLineItemRequest)
Array of objects or null (Order.Models.Integrations.OrderCompositeChargeRequest)
Deprecated

Deprecated. Replaced by VendorCharges

Array of objects or null (Order.Models.Integrations.OrderCompositeChargeRequest)
Array of objects or null (Order.Models.Integrations.OrderCompositeChargeRequest)

Responses

Request samples

Content type
application/json
{
  • "orderNumber": "string",
  • "transportationMode": "string",
  • "transportationServiceLevel": "string",
  • "transportationServiceType": "string",
  • "currency": "string",
  • "freightChargeTerms": "string",
  • "plannedShipmentWeight": 0,
  • "actualShipmentWeight": 0,
  • "cubicMeter": 0,
  • "shipDate": "2019-08-24T14:15:22Z",
  • "deliveredDate": "2019-08-24T14:15:22Z",
  • "deliverTime": {
    },
  • "customerCharge": 0,
  • "billingTerm": "string",
  • "paymentTerms": "string",
  • "distance": 0,
  • "metadata": "string",
  • "ratingEngineInfo": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "enableValidations": true,
  • "vendor": {
    },
  • "customer": {
    },
  • "stops": [
    ],
  • "referenceNumbers": [
    ],
  • "lineItems": [
    ],
  • "charges": [
    ],
  • "customerCharges": [
    ],
  • "vendorCharges": [
    ]
}

Response samples

Content type
application/json
"string"

Display composite order

Display composite order

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>
orderUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "orderNumber": "string",
  • "transportationMode": "string",
  • "transportationServiceLevel": "string",
  • "transportationServiceType": "string",
  • "currency": "string",
  • "freightChargeTerms": "string",
  • "plannedShipmentWeight": 0,
  • "actualShipmentWeight": 0,
  • "cubicMeter": 0,
  • "shipDate": "2019-08-24T14:15:22Z",
  • "deliveredDate": "2019-08-24T14:15:22Z",
  • "deliverTime": {
    },
  • "customerCharge": 0,
  • "billingTerm": "string",
  • "paymentTerms": "string",
  • "distance": 0,
  • "metadata": "string",
  • "ratingEngineInfo": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "transportationModeId": 0,
  • "transportationServiceLevelId": 0,
  • "transportationServiceTypeId": 0,
  • "currencyId": 0,
  • "billingTermId": 0,
  • "billingEntityId": 0,
  • "createDate": "2019-08-24T14:15:22Z",
  • "dateLastModified": "2019-08-24T14:15:22Z",
  • "userIdLastModified": 0,
  • "customer": {
    },
  • "vendor": {
    },
  • "stops": [
    ],
  • "referenceNumbers": [
    ],
  • "lineItems": [
    ],
  • "charges": [
    ]
}

Composite Vendor Invoices

Add composite vendor invoice

Add composite vendor invoice

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>
Request Body schema: application/json
seqNumber
string or null
vendorInvoiceFormatDescription
string or null
vendorInvoiceFormatUuid
string or null <uuid>
invoiceExpectedAmount
number or null <double>
invoiceNumber
string or null
invoiceDate
string or null <date-time>
paymentAmount
number or null <double>
amt
number or null <double>
currencyCode
string or null
currencyUuid
string or null <uuid>
conversionRate
number or null <double>
shipDate
string or null <date-time>
vendorInvoiceTypeDescription
string or null
vendorInvoiceTypeUuid
string or null <uuid>
transportationModeDescription
string or null
transportationModeUuid
string or null <uuid>
transportationServiceTypeDescription
string or null
transportationServiceTypeUuid
string or null <uuid>
transportationServiceLevelDescription
string or null
transportationServiceLevelUuid
string or null <uuid>
freightChargeTerms
string or null
deliveryDate
string or null <date-time>
mileage
integer or null <int32>
enableValidations
boolean
uuid
string or null <uuid>
object (Invoice.Models.Integrations.InvoiceCompositeCustomerRequest)

A request to associate a Customer with an Invoice.

object (Invoice.Models.Integrations.InvoiceCompositeVendorRequest)

A request to assocate a Vendor with an Invoice.

Array of objects or null (Invoice.Models.Integrations.InvoiceCompositeStopRequest)
Array of objects or null (Invoice.Models.Integrations.InvoiceCompositeReferenceNumberRequest)
Array of objects or null (Invoice.Models.Integrations.InvoiceCompositeLineItemRequest)
Array of objects or null (Invoice.Models.Integrations.InvoiceCompositeChargeRequest)

Responses

Request samples

Content type
application/json
{
  • "seqNumber": "string",
  • "vendorInvoiceFormatDescription": "string",
  • "vendorInvoiceFormatUuid": "e90d497c-0841-422b-91b5-143f770b0830",
  • "invoiceExpectedAmount": 0,
  • "invoiceNumber": "string",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "paymentAmount": 0,
  • "amt": 0,
  • "currencyCode": "string",
  • "currencyUuid": "cd8aed70-26ae-4fd6-bda6-2518f23cc3e4",
  • "conversionRate": 0,
  • "shipDate": "2019-08-24T14:15:22Z",
  • "vendorInvoiceTypeDescription": "string",
  • "vendorInvoiceTypeUuid": "c812037a-d3b4-40f4-9bd7-341ed9b90939",
  • "transportationModeDescription": "string",
  • "transportationModeUuid": "3d9c1d30-64b1-4ee0-a1aa-19616e370a57",
  • "transportationServiceTypeDescription": "string",
  • "transportationServiceTypeUuid": "3bb8b847-76d5-488d-8ec3-9887260e92b3",
  • "transportationServiceLevelDescription": "string",
  • "transportationServiceLevelUuid": "3701fd49-d277-495b-8046-cdf1704fb4b6",
  • "freightChargeTerms": "string",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "mileage": 0,
  • "enableValidations": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": {
    },
  • "vendor": {
    },
  • "stops": [
    ],
  • "referenceNumbers": [
    ],
  • "lineItems": [
    ],
  • "charges": [
    ]
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Display composite vendor invoice

Display composite vendor invoice

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>
vendorInvoiceUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "seqNumber": "string",
  • "vendorInvoiceFormatDescription": "string",
  • "vendorInvoiceFormatUuid": "e90d497c-0841-422b-91b5-143f770b0830",
  • "invoiceExpectedAmount": 0,
  • "invoiceNumber": "string",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "paymentAmount": 0,
  • "amt": 0,
  • "currencyCode": "string",
  • "currencyUuid": "cd8aed70-26ae-4fd6-bda6-2518f23cc3e4",
  • "conversionRate": 0,
  • "shipDate": "2019-08-24T14:15:22Z",
  • "vendorInvoiceTypeDescription": "string",
  • "vendorInvoiceTypeUuid": "c812037a-d3b4-40f4-9bd7-341ed9b90939",
  • "transportationModeDescription": "string",
  • "transportationModeUuid": "3d9c1d30-64b1-4ee0-a1aa-19616e370a57",
  • "transportationServiceTypeDescription": "string",
  • "transportationServiceTypeUuid": "3bb8b847-76d5-488d-8ec3-9887260e92b3",
  • "transportationServiceLevelDescription": "string",
  • "transportationServiceLevelUuid": "3701fd49-d277-495b-8046-cdf1704fb4b6",
  • "freightChargeTerms": "string",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "mileage": 0,
  • "enableValidations": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "vendor": {
    },
  • "stops": [
    ],
  • "referenceNumbers": [
    ],
  • "lineItems": [
    ],
  • "charges": [
    ],
  • "documents": [
    ],
  • "orders": [
    ]
}

Display audit results

Display audit results

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>
vendorInvoiceUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "invoiceDetails": {
    },
  • "orders": [
    ]
}

Retrieve a list of finalized Vendor Invoices

Retrieves a paginated list containing the unique identifier of each of the Vendor Invoices finalized between the specified StartTime and EndTime.

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>

The UUID of the tenant who owns the finalized Vendor Invoices

query Parameters
StartTime
required
string <date-time>

Start time range to find Vendor Invoices which have finalized after this start time. This start time is exclusive. Start time time zone is interpreted as UTC.

EndTime
string <date-time>

End time range to find Vendor Invoices which have finalized before this start time. This start time is inclusive. Default: Present time. End time time zone is interpreted as UTC.

SortOrder
string

Sort order applied to the finalization time. Values: ASC, DESC. Default value is DESC

PageSize
integer <int32>

Number of records per page. Default value is 20, maximum value is 100

PageNumber
integer <int32>

Page index of the records to return. First page and default value is 0

ResultsDelivered
boolean

Flag filter to return only Finalized Invoices which have been delivered or not. If this flag is not set, then the filter is not applied. Values: true, false, Null. Default value is Null

Responses

Response samples

Content type
application/json
{
  • "currentPage": 0,
  • "totalPages": 0,
  • "pageSize": 0,
  • "totalRecords": 0,
  • "records": [
    ]
}

Mark Invoices as Delivered

Mark Invoices as Delivered

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>

The UUID of the tenant who owns the Invoices

Request Body schema: application/json

The list of Invoice UUIDs of the tenant who owns Invoices

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Customers

Search customer guid

Search customer guid by account number, name or address information

Authorizations:
Bearer
path Parameters
tenantGuid
required
string <uuid>
Request Body schema: application/json
uuid
string or null <uuid>
accountNumber
string or null
name
string or null
object (Customer.Infrastructure.Models.Requests.SearchCustomerAddressRequest)

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "accountNumber": "string",
  • "name": "string",
  • "addressDetail": {
    }
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Documents

Add vendor invoice documents

Add vendor invoice documents

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>
vendorInvoiceUuid
required
string <uuid>
Request Body schema: multipart/form-data
VendorInvoiceDocumentTypeId
integer <int32>
Document
file
CustomLogMessage
string

Responses

Response samples

Content type
application/json
"string"

Download document

Get the file content for the specified file as a pdf binary

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>

The UUID of the tenant who owns the Vendor Invoices

vendorInvoiceUuid
required
string <uuid>

The UUID of the Vendor Invoice who owns the document

documentUuid
required
string <uuid>

The UUID of the Vendor Invoice document

Responses

Response samples

Content type
application/json
{
  • "canRead": true,
  • "canWrite": true,
  • "canSeek": true,
  • "canTimeout": true,
  • "length": 0,
  • "position": 0,
  • "readTimeout": 0,
  • "writeTimeout": 0
}

Tenant Settings

Display tenant Integration settings

Display tenant Integration settings

Authorizations:
Bearer
path Parameters
tenantGuid
required
string <uuid>
integrationName
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Related Documents

/integration/v1/api/tenants/{tenantUuid}/related-documents

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>
Request Body schema: application/json
parentUuid
string <uuid>
type
string or null
format
string or null
data
string or null

Responses

Request samples

Content type
application/json
{
  • "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
  • "type": "string",
  • "format": "string",
  • "data": "string"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Invoices

Look up invoice guids from order number

Look up invoice guids from order number

Authorizations:
Bearer
path Parameters
tenantGuid
required
string <uuid>
query Parameters
orderNumber
string

Responses

Response samples

Content type
application/json
{
  • "invoicesGuids": [
    ]
}

Look up invoice from shipment number and vendor scac

Look up invoice from shipment number and vendor scac

Authorizations:
Bearer
path Parameters
tenantGuid
required
string <uuid>
query Parameters
shipmentNumber
string
vendorScac
string

Responses

Response samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Vendor Invoice Statuses

Set Vendor Invoice status to Approved

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>

The UUID of the tenant who owns the Vendor Invoices

vendorInvoiceUuid
required
string <uuid>

The UUID of the Vendor Invoice

Responses

Set Vendor Invoice status to Ready

Authorizations:
Bearer
path Parameters
tenantUuid
required
string <uuid>

The UUID of the tenant who owns the Vendor Invoices

vendorInvoiceUuid
required
string <uuid>

The UUID of the Vendor Invoice

Responses

Vendors

Search vendor guid

Search vendor guid by account number, name or address information

Authorizations:
Bearer
path Parameters
tenantGuid
required
string <uuid>
Request Body schema: application/json
uuid
string or null <uuid>
accountNumber
string or null
accountNumberType
string or null
name
string or null
scacCode
string or null
object (Vendor.Application.Models.Requests.SearchVendorAddressRequest)

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "accountNumber": "string",
  • "accountNumberType": "string",
  • "name": "string",
  • "scacCode": "string",
  • "addressDetail": {
    }
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"