ScimGroup
API | Description |
---|---|
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. EndPointProduction Url: https://enterprise.freightpop.com/v2/GroupsSandbox Url: https://sandbox-api.freightpop.com/v2/Groups |
Product
API | Description |
---|---|
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. EndPointProduction Url: https://enterprise.freightpop.com/product/ProductCatalogSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/product/ProductCatalogSandbox Url: https://sandbox-api.freightpop.com/product/ProductCatalog |
POST product/AutoCalculateShipmentDetails |
Action will auto calculate the shipment details.
Pass HTTP Authorization request header with value "Bearer {token}" to perform this action. EndPointProduction Url: https://enterprise.freightpop.com/product/AutoCalculateShipmentDetailsSandbox Url: https://sandbox-api.freightpop.com/product/AutoCalculateShipmentDetails |
Address
API | Description |
---|---|
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.
EndPointProduction Url: https://enterprise.freightpop.com/address/addressValidationSandbox Url: https://sandbox-api.freightpop.com/address/addressValidation |
User
Handles request releated to user
API | Description |
---|---|
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. EndPointProduction Url: https://enterprise.freightpop.com/user/saveuserSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/user/saveuserSandbox 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. EndPointProduction 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. EndPointProduction Url: https://enterprise.freightpop.com/user/getUsersSandbox Url: https://sandbox-api.freightpop.com/user/etUsers |
Token
Handles the request releated to token
API | Description |
---|---|
POST token/getToken |
Returns the access token if user credentails are valid
EndPointProduction Url: https://enterprise.freightpop.com/token/getTokenSandbox Url: https://sandbox-api.freightpop.com/token/getToken |
Rate
Handles request releated to rates
API | Description |
---|---|
POST rate/getRates |
Deprecated This API will be removed in Dec. of 2023. Please use /rates/getRates/V3 instead.Return the rates provided by carriersPass HTTP Authorization request header with value "Bearer {token}" to perform this action EndPointProduction Url: https://enterprise.freightpop.com/rate/getRatesSandbox 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 carriersPass HTTP Authorization request header with value "Bearer {token}" to perform this action EndPointProduction Url: https://enterprise.freightpop.com/rate/getRates/V2Sandbox 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 EndPointProduction Url: https://enterprise.freightpop.com/rate/getRates/V3Sandbox 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 EndPointProduction Url: https://enterprise.freightpop.com/rate/getRates/V4Sandbox Url: https://sandbox-api.freightpop.com/rate/getRates/V4 |
POST rate/RefreshCache |
No documentation available. |
ScimUser
API | Description |
---|---|
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. EndPointProduction Url: https://enterprise.freightpop.com/v2/usersSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/v2/usersSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/v2/usersSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/v2/usersSandbox Url: https://sandbox-api.freightpop.com/v2/users |
Shipment
Handles the shipment requests
API | Description |
---|---|
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. EndPointProduction Url: https://enterprise.freightpop.com/shipment/shipWithQuoteSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/shipment/shipWithoutQuoteSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/shipment/shipWithoutQuote/V2Sandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/shipment/shipWithoutQuote/V3Sandbox 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. EndPointProduction 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. EndPointProduction 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. EndPointProduction Url: https://enterprise.freightpop.com/shipment/externalShipmentSandbox 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. EndPointProduction 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. EndPointProduction 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. EndPointProduction Url: https://enterprise.freightpop.com/shipment/getSavedShipmentsSandbox Url: http://sandbox-api.freightpop.com/shipment/getSavedShipments |
Order
Handles request releated to orders
API | Description |
---|---|
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. EndPointProduction Url: https://enterprise.freightpop.com/order/importOrderSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/order/deleteOrderSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/order/importOrder/v2Sandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/order/importOrder/v3Sandbox Url: https://sandbox-api.freightpop.com/order/importOrder/v3 |
Lookup
API | Description |
---|---|
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 EndPointProduction Url: https://enterprise.freightpop.com/lookup/getCarriers?isUserCarrierOnly=trueSandbox 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 EndPointProduction Url: https://enterprise.freightpop.com/lookup/getPackagesSandbox 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 EndPointProduction Url: https://enterprise.freightpop.com/lookup/getCompanyAddresses?isDefault=trueSandbox 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 EndPointProduction Url: https://enterprise.freightpop.com/lookup/GetAddressBookRules?companyId={{companyId}}Sandbox Url: https://sandbox-api.freightpop.com/lookup/GetAddressBookRules?companyId={{companyId}} |
Cubiscan
API | Description |
---|---|
POST cubiscan/inbound?apiKey={apiKey} |
Action will save the cubiscan data. Pass the ApiKey with Inbound Data.
EndPointProduction 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
API | Description |
---|---|
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
EndPointProduction Url: https://enterprise.freightpop.com/Track/UpdateTrackingSandbox 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. EndPointProduction Url: https://enterprise.freightpop.com/Track/GetTrackingSandbox 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}". EndPointProduction Url: https://enterprise.freightpop.com/Track/GetTrackingReadOnlySandbox Url: https://sandbox-api.freightpop.com/Track/GetTrackingReadOnly |