{"info":{"_postman_id":"9952f2ed-8d0e-41ac-a6d4-4c58359ce214","name":"ComFreight Broker - Carrier Invitation v1.0.0","description":"

Carrier Invitation API for mutual Brokers

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8714921","collectionId":"9952f2ed-8d0e-41ac-a6d4-4c58359ce214","publishedId":"Szf54pQf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-04-20T17:17:26.000Z"},"item":[{"name":"Authenticate your client and fetch an access token","id":"97bacd63-2df1-41fa-bb50-a71acb470a74","request":{"auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"","description":"

(This can only be one of client_credentials,password)

\n"}]},"url":"https://api.test.comfreight.com/v1/integrations/auth/token/","description":"

Token Exchange

\n

Gets the Access Token to make any other protected API calls. There are two types of grant_types:

\n
    \n
  1. Client Credentials (client_credentials)
    2. \n
  2. Resource Owner Password Based (password)
    3. \n
\n

Whenever an API call is made on behalf of a client and not accessing any client data, the client credential grant_type should be used. Whenever there is client related information to be fetched, password grant_type should be selected.

\n

For the current scope of intergration, we are only allowing client_credentials grant_type

\n

For the Authorization header on this endpoint, Use Basic authorization with your client_id as the username and the client_secret as the password The response will fetch you an access token, expiration on that access token and the scope granted.

\n","urlObject":{"path":["auth","token",""],"host":["https://api.test.comfreight.com/v1/integrations"],"query":[],"variable":[]}},"response":[{"id":"2e35ec2f-b73e-4858-96a7-48edec8dfe07","name":"Client successfully authenticated, returning the access token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":{"content":" (This can only be one of client_credentials,password)","type":"text/plain"},"key":"grant_type","value":""}]},"url":"https://api.test.comfreight.com/v1/integrations/auth/token/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"sTeqlK8l6x3UYu2joV0iCMjbje4KLu\",\n \"expires_in\": 300,\n \"token_type\": \"\",\n \"scopes\": \"\"\n}"},{"id":"6f9990e0-58b1-4344-83cb-1c5e200a4d1c","name":"Client ID/Secret invalid","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":{"content":" (This can only be one of client_credentials,password)","type":"text/plain"},"key":"grant_type","value":""}]},"url":"https://api.test.comfreight.com/v1/integrations/auth/token/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid Client\"\n}"}],"_postman_id":"97bacd63-2df1-41fa-bb50-a71acb470a74"},{"name":"Add a new Broker Carrier Relationship to the ComFreight System","id":"b7c0501a-1d99-4870-a244-27964e6dbc3d","request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"broker_mc\": \"\",\n \"broker_email\": \"\",\n \"carrier_email\": \"\",\n \"carrier_mc\": \"\",\n \"carrier_dot\": \"\",\n \"carrier_phone\": \"\",\n \"carrier_dba\": \"\"\n}"},"url":"https://api.test.comfreight.com/v1/integrations/onboard_carrier/","description":"

Invite the Carrier on behalf of a Broker

\n

This endpoint lets you invite carriers on behalf of the Broker. The Broker needs to be signed up and approved in the ComFreight system. The carrier email can be repeated if the Carrier needs another Invite link.

\n","urlObject":{"path":["onboard_carrier",""],"host":["https://api.test.comfreight.com/v1/integrations"],"query":[],"variable":[]}},"response":[{"id":"1ef67b73-63b5-430f-bed5-a63bee9f79fd","name":"Bad Request, validation error on one of the fields input. The errors will be displayed in a list of strings in an object with the key of the errored field-name. _Error with looking up the Debtor in the ComFreight database will also return a 4","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"broker_mc\": \"\",\n \"broker_email\": \"\",\n \"carrier_email\": \"\",\n \"carrier_mc\": \"\",\n \"carrier_dot\": \"\",\n \"carrier_phone\": \"\",\n \"carrier_dba\": \"\"\n}"},"url":"https://api.test.comfreight.com/v1/integrations/onboard_carrier/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"broker_mc\": [\n \"\",\n \"\"\n ],\n \"broker_email\": [\n \"\",\n \"\"\n ],\n \"carrier_email\": [\n \"\",\n \"\"\n ],\n \"carrier_mc\": [\n \"\",\n \"\"\n ],\n \"carrier_dot\": [\n \"\",\n \"\"\n ],\n \"carrier_phone\": [\n \"\",\n \"\"\n ],\n \"carrier_dba\": [\n \"\",\n \"\"\n ]\n}"},{"id":"33a36595-850b-4709-9e9b-67f5aaf9c191","name":"Success Response Broker found, sending inviting to the carrier email","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"broker_mc\": \"\",\n \"broker_email\": \"\",\n \"carrier_email\": \"\",\n \"carrier_mc\": \"\",\n \"carrier_dot\": \"\",\n \"carrier_phone\": \"\",\n \"carrier_dba\": \"\"\n}"},"url":"https://api.test.comfreight.com/v1/integrations/onboard_carrier/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"broker_mc\": \"\",\n \"broker_email\": \"\",\n \"carrier_email\": \"\"\n}"},{"id":"89209fe1-4005-431f-9e9e-6b28daa9001d","name":"Auth Token expired / invalid. Fetch the Auth Token again","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"broker_mc\": \"\",\n \"broker_email\": \"\",\n \"carrier_email\": \"\",\n \"carrier_mc\": \"\",\n \"carrier_dot\": \"\",\n \"carrier_phone\": \"\",\n \"carrier_dba\": \"\"\n}"},"url":"https://api.test.comfreight.com/v1/integrations/onboard_carrier/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"},{"id":"bffda43c-2faa-46a2-a303-9baeea1a1efe","name":"Unexpected error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"broker_mc\": \"\",\n \"broker_email\": \"\",\n \"carrier_email\": \"\",\n \"carrier_mc\": \"\",\n \"carrier_dot\": \"\",\n \"carrier_phone\": \"\",\n \"carrier_dba\": \"\"\n}"},"url":"https://api.test.comfreight.com/v1/integrations/onboard_carrier/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"Error server\""}],"_postman_id":"b7c0501a-1d99-4870-a244-27964e6dbc3d"}],"variable":[{"id":"baseUrl","key":"baseUrl","value":"https://api.test.comfreight.com/v1/integrations","type":"string"}]}