--- title: "FAQs" description: "Frequently Asked Questions" url: "https://api-docs.centraldispatch.com/faqs" image: "https://api-docs.centraldispatch.com/_og/d/c_Ocean.takumi,title_FAQs,description_Frequently+Asked+Questions,props_eyJ0aGVtZSI6eyJtb2RlIjoibGlnaHQiLCJjb2xvcnMiOnsicHJpbWFyeSI6IiNmZTgyMWUifX19,p_Ii9mYXFzIg,s_Bc3zSnsGgtwi1xQ_.png" --- ## Frequently Asked Questions ## Authorization & Credentials Can I receive Auth Code Flow credentials? Auth Code Flow credentials are available only to our Software Provider/ 3rd party clients. Please contact your account manager to discuss if this option is right for your business needs. I am building a CRM and am interested in integrating with your APIs for my future clients as a third party. How can I do this? Currently, we do not offer integration with emerging CRMs. However, we are always open to exploring future opportunities. Please feel free to contact us at [salessupport@centraldispatch.com](mailto:salessupport@centraldispatch.com) for more information. Thank you for your understanding! What is the default lifetime (expiration time) of the access and refresh token? Refresh token last for a long period of time (years); access tokens expire after 30 minutes ## Testing I am in the testing phase. I am attempting to log into the UI with my test accounts, but I keep getting a “We are sorry, but you cannot access this page” message. Why? As stated in your onboarding email, the UI is limited in the test marketplace. You may not be able to view any listings or complete any dispatches through the UI. However, you can accept a dispatch as your test carrier if you’ve received test carrier credentials. Please refer to your onboarding email for more details. How long do I have to test my APIs? We currently do not have a testing limit. However, you will not be able to post or dispatch in the Public Marketplace until you have completed your testing and notified the [datasyndicationsupport@centraldispatch.com](mailto:datasyndicationsupport@centraldispatch.com) inbox that you’re ready for production credentials. My test account invite expired. How can I get it resent? Please email us at [datasyndicationsupport@centraldispatch.com](mailto:datasyndicationsupport@centraldispatch.com), and we’ll be happy to reset and resend your test account invite. Why am I getting this error during testing? { "errors": \[ { "code": "listings.api\_service.forbidden", "message": "Current user does not have access to post to one or more marketplaces in the listing request" } \] } This error typically means one of two things: - You're trying to post to a marketplace you’re not authorized to access. During testing, you can only post to your assigned test marketplace—not the Public marketplace (ID: 10000) or others. - The marketplace parameters in your request are incorrect or missing. Be sure to include the correct test marketplace ID in your request payload. ## Listings API I do not see the ‘Load ID’ field in the API. What field can I use in its place? You can use the ‘ShipperOrderID’ field. What are the Listings API rate limits? The rate limit is 100 requests per minute. This limit cannot be changed at this time. If I delete a listing and repost the same listing exactly as it is, will that count as a new listing? Yes, reposting the same listing will count as a new listing against your quota limit, as it will have a new 30-day expiration date. If I add a vehicle to a current listing, does that count towards my vehicle quota? Yes, adding a vehicle or making any changes to the vehicles (e.g., Year/Make/Model or VIN) on your listings will count towards your vehicle quota. Can I change the ShipperID field when creating a listing? The ShipperID field is used to identify which account created the listing. It should be automatically added to the request based on the Bearer Token of the caller. ## Fulfillment API What are the dateTypes when completing dispatching activites? ESTIMATED\_PICKUP, ESTIMATED\_DROPOFF, ACTUAL\_PICKUP, and ACTUAL\_DROPOFF As a shipper, can I update a dispatch status via the API? Yes, by setting the appropriate actual date on the dispatch using the Update Dispatch endpoint. 1. Call Get Dispatch by ID to retrieve the current ETag. 2. Call Update Dates and provide the correct dateType and dateValue. Supported date types: - ACTUAL\_PICKUP — Updates the dispatch to Picked Up - ACTUAL\_DROPOFF — Updates the dispatch to Delivered How can I archive a dispatch? Archiving a dispatch via API is not currently supported. You can archive dispatches once they are delivered or canceled through the user interface (UI). Can I reassign a dispatched job, and how? To reassign a dispatched job: 1. Use the 'Cancel Dispatch' endpoint to cancel the existing dispatch. 2. Call the 'Create Dispatch from Canceled' endpoint, pass the previous dispatch ID and specify the new carrier ID. Note: This avoids duplicated counting. My dispatch status in the API does not match what is in the UI. Why is that? We are working to improve our API to UI mapping. Currently, the expected API values are provided on the left, and how they display in the UI is on the right: - NOT\_SIGNED = "Not Signed" - PENDING\_PICKUP = "Dispatched" - PENDING\_DELIVERY = "Picked Up" - DELIVERED = "Delivered" - CANCELED = "Canceled" - DECLINED = "Declined" ## Membership API What is the difference between the Membership API - Get User & Get User mine (Get My Users) endpoints? The Get User and Get User mine are used by both shippers and carriers. The Get User endpoint was created to ensure the HREF return URL within the Get User mine endpoint works as expected for one single user. They both return the same data EXCEPT the Get User Mine endpoint also returns the 'role' for a user. Is it possible to filter by customer type in the Membership API Get Customer ID endpoint response? Currently, the system responds with both shipper and carrier types. We are considering this as an enhancement for future releases. Why am I receiving a 404 Error? { "code": "NotFound", "message": "no items returned from /customer-search." } This usually means you're trying to retrieve data for a carrier that isn’t available in your test environment. Only your Test Carrier is accessible in the test marketplace. Requests for any other carrier will return a 404 error. ## Event API I am subscribed to your Events API. Will I still receive email notifications? Yes, you may still receive email notifications for Dispatches & Listings updates. ## Market Intelligence API How can I receive Price Check Plus data through an API? To retrieve pricing data similar to the data from Price Check Plus, you need to subscribe to our Market Intelligence API. This API is available at an additional cost, separate from your Core or Premium package pricing. For more details, please contact our support team at [datasyndicationsupport@centraldispatch.com](mailto:datasyndicationsupport@centraldispatch.com). Can the Market Intelligence API filter data based on Dispatch status? No, the Market Intelligence API does not filter data based on Dispatch status. It will return data from various statuses, not just 'Delivered.' Why am I getting an error when using the Get List Prices endpoint? Common causes include: - The vehicle year is before 1981 (not supported). - The Year/Make/Model (Y/M/M) doesn't exactly match the manufacturer's naming. - The VIN is invalid or incorrectly formatted.