ScimGroup

APIDescription
GET v2/Groups/{groupId}
Action will get the group and its members

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/v2/Groups

Sandbox Url: https://sandbox-api.freightpop.com/v2/Groups

Product

APIDescription
POST product/ProductCatalog
Action will Save the product list into the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/product/ProductCatalog

Sandbox Url: https://sandbox-api.freightpop.com/product/ProductCatalog
DELETE product/ProductCatalog?ItemNames[0]={ItemNames[0]}&ItemNames[1]={ItemNames[1]}
Action take a list of Item Names and will Delete the product from FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/product/ProductCatalog

Sandbox Url: https://sandbox-api.freightpop.com/product/ProductCatalog

Address

APIDescription
POST address/addressValidation
Action will allow users to validate address against the address validation tool we already have in our application. It will provide address suggestions agains provided address.

EndPoint

Production Url: https://enterprise.freightpop.com/address/addressValidation

Sandbox Url: https://sandbox-api.freightpop.com/address/addressValidation

User

Handles request releated to user
APIDescription
POST user/adduser
Action will save or update the user into the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/user/saveuser

Sandbox Url: https://sandbox-api.freightpop.com/user/saveuser
POST user/updateuser
Action will update the user into the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/user/saveuser

Sandbox Url: https://sandbox-api.freightpop.com/user/saveuser
GET user/deleteuser?id={id}
Action will delete the user into the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/user/deleteuser?id=

Sandbox Url: https://sandbox-api.freightpop.com/user/deleteuser?id=
GET user/getUsers
Action will Get the users from the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/user/getUsers

Sandbox Url: https://sandbox-api.freightpop.com/user/etUsers

Token

Handles the request releated to token
APIDescription
POST token/getToken
Returns the access token if user credentails are valid

EndPoint

Production Url: https://enterprise.freightpop.com/token/getToken

Sandbox Url: https://sandbox-api.freightpop.com/token/getToken

Rate

Handles request releated to rates
APIDescription
POST rate/getRates

Deprecated This API will be removed in Dec. of 2023. Please use /rates/getRates/V3 instead.

Return the rates provided by carriers

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/rate/getRates

Sandbox Url: https://sandbox-api.freightpop.com/rate/getRates
POST rate/getRates/V2

Deprecated This API will be removed in Dec. of 2023. Please use /rates/getRates/V3 instead.

Return the rates provided by carriers

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/rate/getRates/V2

Sandbox Url: https://sandbox-api.freightpop.com/rate/getRates/V2
POST rate/getRates/V3
Return the rates provided by carriers

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/rate/getRates/V3

Sandbox Url: https://sandbox-api.freightpop.com/rate/getRates/V3
POST rate/getRates/V4
Return the rates provided by carriers

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/rate/getRates/V4

Sandbox Url: https://sandbox-api.freightpop.com/rate/getRates/V4
POST rate/RefreshCache

No documentation available.

ScimUser

APIDescription
POST v2/users
Action will save the user into the FreightPOP using SCIM.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/v2/users

Sandbox Url: https://sandbox-api.freightpop.com/v2/users
GET v2/users/{userId}
Action will get the user and return it Scim Schema.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/v2/users

Sandbox Url: https://sandbox-api.freightpop.com/v2/users
PUT v2/users/{userId}
Action will update the user into the FreightPOP using SCIM.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/v2/users

Sandbox Url: https://sandbox-api.freightpop.com/v2/users
DELETE v2/users/{userId}
Action will InActive the user into the FreightPOP using SCIM.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/v2/users

Sandbox Url: https://sandbox-api.freightpop.com/v2/users

Shipment

Handles the shipment requests
APIDescription
POST shipment/shipWithQuote
Action will make a shipment using provided details. Use this action when you already quoted rates. Pass the QuoteId and RateId with other shipment details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/shipWithQuote

Sandbox Url: https://sandbox-api.freightpop.com/shipment/shipWithQuote
POST shipment/shipWithoutQuote

Deprecated This API will be removed in Dec. of 2023. Please use /shipment/shipWithoutQuote/V2 instead.

Action will make a shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/shipWithoutQuote

Sandbox Url: https://sandbox-api.freightpop.com/shipment/shipWithoutQuote
POST shipment/shipWithoutQuote/V2
Action will make a shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/shipWithoutQuote/V2

Sandbox Url: https://sandbox-api.freightpop.com/shipment/shipWithoutQuote/V2
POST shipment/shipWithoutQuote/V3
Action will make a shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/shipWithoutQuote/V3

Sandbox Url: https://sandbox-api.freightpop.com/shipment/shipWithoutQuote/V3
GET shipment/getShipment?id={id}&type={type}
Action will provide the details of a shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/getShipment?id={id}&type={type}

Sandbox Url: http://sandbox-api.freightpop.com/shipment/getShipment?id={id}&type={type}
GET shipment/getShipment/V2?id={id}&type={type}
Action will provide the details of a shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/getShipment/V2?id={id}&type={type}

Sandbox Url: http://sandbox-api.freightpop.com/shipment/getShipment/V2?id={id}&type={type}
POST shipment/externalShipment
Action will make a shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/externalShipment

Sandbox Url: https://sandbox-api.freightpop.com/shipment/externalShipment
GET shipment/getShipment/V3?id={id}&type={type}
Action will provide the details of a shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/getShipment/V3?id={id}&type={type}

Sandbox Url: http://sandbox-api.freightpop.com/shipment/getShipment/V3?id={id}&type={type}
GET shipment/cancelShipment?id={id}
Action will cancel a shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/cancelShipment?id={id}

Sandbox Url: http://sandbox-api.freightpop.com/shipment/cancelShipment?id={id}
POST shipment/getSavedShipments
Action will provide the details of a saved shipment using provided details.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/shipment/getSavedShipments

Sandbox Url: http://sandbox-api.freightpop.com/shipment/getSavedShipments

Order

Handles request releated to orders
APIDescription
POST order/importOrder

Deprecated This API will be removed in Dec. of 2023. Please use /order/importOrder/v3 instead.

Action will import the orders into the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/order/importOrder

Sandbox Url: https://sandbox-api.freightpop.com/order/importOrder
POST order/deleteOrder
Action will delete the orders from FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/order/deleteOrder

Sandbox Url: https://sandbox-api.freightpop.com/order/deleteOrder
POST order/importOrder/v2

Deprecated This API will be removed in Dec. of 2023. Please use /order/importOrder/v3 instead.

Action will import the orders into the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/order/importOrder/v2

Sandbox Url: https://sandbox-api.freightpop.com/order/importOrder/v2
POST order/importOrder/v3
Action will import the orders into the FreightPOP.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/order/importOrder/v3

Sandbox Url: https://sandbox-api.freightpop.com/order/importOrder/v3

Lookup

APIDescription
GET lookup/getCarriers?isUserCarrierOnly={isUserCarrierOnly}
Returns the carriers registered by a company in FreightPOP application

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/lookup/getCarriers?isUserCarrierOnly=true

Sandbox Url: https://sandbox-api.freightpop.com/lookup/getCarriers?isUserCarrierOnly=true
GET lookup/getPackages
Returns the Packages registered by a company in FreightPOP application

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/lookup/getPackages

Sandbox Url: https://sandbox-api.freightpop.com/lookup/getPackages
GET lookup/getCompanyAddresses?isDefault={isDefault}&page={page}&pageSize={pageSize}
Returns the Addresses registered by a company in FreightPOP application

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/lookup/getCompanyAddresses?isDefault=true

Sandbox Url: https://sandbox-api.freightpop.com/lookup/getCompanyAddresses?isDefault=true
GET lookup/getAddressBookRules?companyId={companyId}
Returns the Address Book Rules against a company id

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/lookup/GetAddressBookRules?companyId={{companyId}}

Sandbox Url: https://sandbox-api.freightpop.com/lookup/GetAddressBookRules?companyId={{companyId}}

Cubiscan

APIDescription
POST cubiscan/inbound?apiKey={apiKey}
Action will save the cubiscan data. Pass the ApiKey with Inbound Data.

EndPoint

Production Url: https://enterprise.freightpop.com/cubiscan/inbound?apiKey={apiKey}

Sandbox Url: https://sandbox-api.freightpop.com/cubiscan/inbound?apiKey={apiKey}

Track

Handles the tracking requests
APIDescription
POST Track/UpdateTracking
Action will update tracking status/details inside the system. Pass the Shipment ID and APICompanyID. Error message will be returned if shipment did not found inside system

EndPoint

Production Url: https://enterprise.freightpop.com/Track/UpdateTracking

Sandbox Url: https://sandbox-api.freightpop.com/Track/UpdateTracking
POST Track/GetTracking
Action will generate tracking details from the system. Error message will be returned if transaction will not found inside system.

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action.

EndPoint

Production Url: https://enterprise.freightpop.com/Track/GetTracking

Sandbox Url: https://sandbox-api.freightpop.com/Track/GetTracking
POST Track/GetTrackingReadOnly
Generates tracking details from the system based on the provided tracking request object. If the specified transaction is not found, an error message will be returned.

To perform this action, include the HTTP Authorization request header with the value "Bearer {token}".

EndPoint

Production Url: https://enterprise.freightpop.com/Track/GetTrackingReadOnly

Sandbox Url: https://sandbox-api.freightpop.com/Track/GetTrackingReadOnly