Previously, when using the CalculateVinOemEligibilities method to check for OEM eligibility on the Vehicle Eligibility page, a "requires manual check" result meant you had to manually create a support ticket for further review. The new RequestManualSupportVins method now allows you to automate this process and submit a ticket for these cases, saving you time and effort.
The following changes require action by you or your administrators/users and may affect your workflows:
As previously announced, we've introduced a rate limit of 1,250 requests per 15 minutes to the following methods to ensure optimal performance and reliability of our APIs:
Rate limiting helps manage the number of requests a user can make to our API in a given period, preventing excessive usage that can slow down the system.
Coming early July, the PostOrder API will be enhanced to allow you to specify the exact products and quantities for a replacement order (initiated through returns). This update allows placing a partial replacement order via a single API call, aligning its functionality with the current MyAdmin UI (which allows multiple replacement orders being placed for a single return).
A new optional field (ReplacementDetails) will be added, which will accept a list of SKUs that are eligible for replacement on the same return, as well as a quantity associated with each. For example:
The current PostOrder API functionality for replacements will be maintained. This update is an addition for those who need to place multiple replacement orders for a single return.
To support this enhancement and provide clarity to Integrators, we will also be adding a new optional parameter called displayReplacementDetails to the GetRmas method and two new properties to the apiDeviceRma object. The new properties within the apiDeviceRma object will only be included when the displayReplacementDetails parameter is set to True.
These properties within the apiDeviceRma object will help you identify which products are eligible for free replacement and the maximum quantity that can be ordered.
eligibleforfreereplace (true/false) - Indicates whether a product is eligible for a free replacementmaxorderquantity - Indicates the maximum quantity of this product for a free replacementComing mid to late June 2025, the PostOrder API will be enhanced to allow you to specify the exact products and quantities for a replacement order (initiated through returns). This update allows placing a partial replacement order via a single API call, aligning its functionality with the current MyAdmin UI (which allows multiple replacement orders being placed for a single return).
A new optional field (ReplacementDetails) will be added, which will accept a list of SKUs that are eligible for replacement on the same return, as well as a quantity associated with each. For example:
The current PostOrder API functionality for replacements will be maintained. This update is an addition for those who need to place multiple replacement orders for a single return.
To support this enhancement and provide clarity to Integrators, we will also be adding a new optional parameter called displayReplacementDetails to the GetRmas method and two new properties to the apiDeviceRma object. The new properties within the apiDeviceRma object will only be included when the displayReplacementDetails parameter is set to True.
These properties within the apiDeviceRma object will help you identify which products are eligible for free replacement and the maximum quantity that can be ordered.
eligibleforfreereplace (true/false) - Indicates whether a product is eligible for a free replacementmaxorderquantity - Indicates the maximum quantity of this product for a free replacementLast year, we added the PX Hub opportunity ID field in Checkout to help you link opportunities directly to orders. To further support this process, you can now enter the PX Hub opportunity ID when using the PostOrder method to complete an order.
Specifically, this update introduces the PxHubOpportunityId property to the ApiOrderHeader object for seamless association of orders with their corresponding opportunities.
Coming Soon: We will be adding a new "Delivered" status to the responses from our GetOnlineOrderStatus API. This update will allow you to easily retrieve orders that have been successfully delivered.
NOTE: The “Delivered” status will initially be available exclusively for orders shipped via FedEx. We plan to expand this functionality to include other carriers in the future.
For our Marketplace Partners fulfilling Marketplace Order Now orders through MyAdmin, we've added a new Canceled status to the Partner Fulfillment page (Store > Shipping > Partner Fulfillment).
You can now use the Status filter to view or exclude canceled orders from your view.
We've also updated the Partner Fulfillment API to reflect the new canceled status. Now, when using the GetShipHeader endpoint, you can filter by canceled orders using the status parameter with a new value of "2". The shipmentStatus results will also return "Canceled" for these orders.
As previously mentioned, we are simplifying Rate Plans for ease of use and to support the launch of richer dataset experiences and tools. With these changes, the concept of individual plans will be less relevant.
Effective November 1, 2024, we're excited to introduce our new Data Sharing Plan, powered by the GO Plan. The new Data Sharing Plan is designed to make data sharing more straightforward and efficient.
Smooth API transition: The ShareDevice method will continue to accept legacy plan ID parameters to ensure a smooth and effortless transition. However, behind the scenes, these parameters will automatically map to the new Data Sharing Plan. In early 2025, the plan ID parameters for the ShareDevice method will be deprecated.
To ensure optimal performance and reliability of our APIs, we've introduced rate limits to the following methods. Rate limiting helps manage the number of requests a user can make to our API in a given period, preventing excessive usage that can slow down the system.
These rate limits help ensure that our APIs remain fast and responsive for everyone.
Access device activity with the newly added GetDeviceTimeline method. You can now retrieve detailed device history for devices associated with your account through the SDK, allowing for more comprehensive integrations. To refine your search, optional FromDate and ToDate filters have also been included.
Access device return information with our enhanced SDK. The ApiRma object now includes a dedicated property for the device return type (such as repair, warranty return, investigate, and more), making it readily available for your integrations. This improvement simplifies data retrieval and enables more efficient processing of returns.
As announced last month, Partners are no longer able to terminate or make plan changes for third-party cameras (devices that start with EVD) via the API to avoid billing discrepancies.
This impacts the following API methods:As previously announced, we made some changes to the PostOrder method (specifically the orderItemProductAttributeGroups object within the apiOrderHeader model) to simplify the integration process for IOX-KEYBOX and other configurable products.
OrderItemProductAttribute tablesValue column in the OrderItemProductAttribute table to the OrderItemProductAttributeGroup tableBefore
After
As previously mentioned, we are simplifying Rate Plans for ease of use and to support the launch of richer dataset experiences and tools. With these changes, the concept of individual plans will be less relevant.
Starting October 1, 2024, the following changes will be made to the ChangeDeviceBillingPlanBulkAsync(...) and ChangeDeviceBillingPlan(...) methods:
IMPORTANT: These changes are very important to note if an integration relies on hard-coded values for devicePlanId.
devicePlanId values will be invalid. For all other plan changes, contact Geotab Support.devicePlanIds will be invalid.devicePlanIds for the device type.NOTE: The GO Plan devicePlanId is 54.
In the June What's New announcement, we announced that we were phasing out warranty-related data in APIs as the Limited Lifetime Warranty has been applied to all GO devices.
In this update, we have deprecated the following data in API calls associated with orders:
warrantyOptionId from the PostOrder method.To ensure optimal performance and reliability of our APIs, we will be introducing rate limits to the following methods at the end of October. Rate limiting helps manage the number of requests a user can make to our API in a given period, preventing excessive usage that can slow down the system.
These rate limits will help ensure that our API remains fast and responsive for everyone.
In a future release, Partners will no longer be able to terminate or make plan changes for third-party cameras (devices that start with EVD) via the API to avoid billing discrepancies.
This will impact the following API methods:
We've also updated the Warranty status column to display "Not available" for third-party cameras in the MyAdmin UI temporarily, as well as the following API methods:
As a standard practice, MyAdmin calculates warranty status based on the billing start date. However, for these products, the warranty needs to be calculated from the shipment date. While we work to correctly display warranty in Device Management, you will see "Not available".
To simplify the integration process for IOX-KEYBOX and other configurable products, we are making some changes to the PostOrder method in a future release, specifically the orderItemProductAttributeGroups object within the apiOrderHeader model.
We will be simplifying the structure:
OrderItemProductAttribute tablesValue column in the OrderItemProductAttribute table to the OrderItemProductAttributeGroup tableBefore
After
As previously mentioned, we are simplifying Rate Plans for ease of use and to support the launch of richer dataset experiences and tools. With these changes, the concept of individual plans will be less relevant.
Changes will come to the ChangeDeviceBillingPlanBulkAsync(...) and ChangeDeviceBillingPlan(...) methods on October 1, 2024.
IMPORTANT: These changes are very important to note if an integration relies on hard-coded values for devicePlanId.
devicePlanId values will be invalid. For all other plan changes, contact Geotab Support.devicePlanIds for the device type.NOTE: The GO Plan devicePlanId is 54.
To ensure optimal performance and reliability of our APIs, we will be introducing rate limits to the following methods in a future release. Rate limiting helps manage the number of requests a user can make to our API in a given period, preventing excessive usage that can slow down the system.
PostOrder method — Limited to 100 requests per 15 minutes.
GetOnlineOrderStatus method — Limited to 250 requests per 15 minutes.
These rate limits will help ensure that our API remains fast and responsive for everyone.
Previously, there were two methods that allow you to register External Vendor Devices (EVDs) in MyAdmin
As previously mentioned in last month's announcement and in April's What's New in MyGeotab, we are simplifying Rate Plans for ease of use and to support the launch of richer dataset experiences and tools. With these changes, the concept of individual plans will be less relevant. At the end of September, there will be changes made to the change plan functionality in Device Management (Devices > Device Management) and related APIs.
NOTE: We've included new details about the GO and Base plans, as well as clarification on devices that have yet to activate. You can find more details on how this change might impact you in July's What's New Release Notes here.
IMPORTANT: These changes are very important to note if an integration relies on hard-coded values for devicePlanId.
Specifically, active GO devices cannot change plans starting October 1, 2024:
devicePlanId values will be invalid.devicePlanIds will be invalid.devicePlanIds for the device type.devicePlanIds are 54 and 55, respectively.devicePlanId.devicePlanIdvalues will be invalid.devicePlanIds will be invalid.devicePlanIds for the device type.firstDeviceActivationDate property (in ApiDeviceContract and DeviceContract objects) to retrieve the same data as theFirst Connect Date column in Device Admin.DevicePlanLevel is only applied to GO devices in the order. All other plans are automatically assigned.warrantyOptionId from the PostOrder method.currentStatus property in ApiOnlineOrder.currentStatus property has been replaced by currentOrderStatus to return the current status of the order.Store and Bulk values to the GetOnlineOrderStatus endpoint. MyAdmin will remain as a value for integration continuity.currentStatus property in a future release. We've extended the deprecation date to June 22, 2024.currentStatus property has been replaced by currentOrderStatus to return the current status of the order.warrantyOptionId from the PostOrder method.firstDeviceActivationDate property (in ApiDeviceContract and DeviceContract objects) to retrieve the same data as First Connect Date column in Device Admin.OptionalPara parameter to the GetDeviceContracts method. This will allow Integrators to select and define the properties they want to see in the returned object.currentStatus property to May 25, 2024.currentStatus property has been replaced by currentOrderStatus to return the current status of the order.newCustomerPlan. This new property will return one of the following responses:My reference — 500-character limitGeneral comments for packing slip — 300-character limitOrder comments — 300-character limitdevicePlanLevel property from the ApiOrderHeader API to ApiOnlineOrderItem in a future release.OptionalPara parameter to the GetDeviceContracts method. This will allow Integrators to select and define the properties they want to see in the returned object, as well as improve response times.firstDeviceActivationDate property (in ApiDeviceContract and DeviceContract objects) to retrieve the same data as the First Connect Date column in Device Admin.currentStatus property, as it has been replaced by currentOrderStatus to return the current status of the order.currentStatus was previously communicated in March 2021, which was also when currentOrderStatus became available for use.My reference — 500-character limitGeneral comments for packing slip — 300-character limitOrder comments — 300-character limitfirstDeviceActivationDate property (in ApiDeviceContract and DeviceContract objects) to retrieve the same data as the First Connect Date column in Device Admin.currentStatus property, as it has been replaced by currentOrderStatus to return the current status of the order.currentStatus was previously communicated in March 2021, which was also when currentOrderStatus became available for use.isAutoActivated and billingStartDate) to the GetDeviceContractsByPage and GetDeviceContracts methods. As a result, we have now deprecated the isAutoActivated property from the ApiRatePlan object.isAutoActivated and billingStartDate) to the GetDeviceContractsByPage and GetDeviceContracts methods. As a result, we will be deprecating the isAutoActivated property from the ApiRatePlan object.Auto-Activated and Billing Start Date columns in Device Admin, we have added two new parameters to the GetDeviceContractsByPage and GetDeviceContracts methods:isAutoActivated - Returns a result that indicates whether the device was auto-activated by Geotab.billingStartDate - Returns the date when the device was activated.shippingCost field as a return object to the GetOnlineOrderStatus method. This field will return the shipping cost at the time the order was placed.shippingCost field as a return object to the GetOnlineOrderStatus method. This field will return the shipping cost at the time the order was placed.Auto-Activated and Billing Start Date to improve visibility of auto-activation events, as well as the actual start of billing for a device.Auto-Activated column will help you identify whether a device has been automatically activated by Geotab, and display the following values:Billing Start Date column will help you determine when billing started for a device. This column will display one of the following values:Auto-Activated and Billing Start Date available through the GetDeviceContractsByPage and GetDeviceContracts APIs in a future release.We will provide more details closer to the release date.promoCode - Returns the promo code used when the order was placed, if applicable.rateCode - Returns the promo code used for a monthly Rate Plan subscription when the order was placed, if applicable.databaseFilter). This parameter allows you to retrieve a list of devices that are owned by the specified database.FirstDeviceActivationDate when returning an ApiDeviceContract object (for example, by calling GetDeviceContractsByPage) to align with the Device Admin pageFirstDeviceActivationDate when returning an ApiDeviceContract object (for example, by calling GetDeviceContractsByPage) to align with the Device Admin pageContact-Override role.fromdate and todate parameters are now optional in the GetDeviceContractsByPage API, so more records can be retrieved.OrderSource parameter has been added to the GetOnlineOrderStatus method.OrderSource parameter allows you to view a list of orders based on the channel used to place the order: MyAdmin, Marketplace, or API.Contact-Override role.UserContactIdUserContactId will return -1UserContactName)apikey, sessionID, and a list of usernames userNames, and you must toggle forceChangePassword to True or False.Contact-Override role.ApiOnlineOrder object: OrderSource.DeviceRegister-Bulk role.isAutoActivated parameter to indicate whether a device was auto-activated by Geotab using True or False.poExactMatch, has been added to GetOnlineOrderStatus to allow you to search for orders that match a specific PO number.Requested Delivery Date is going to be added to ApiOrderHeader object, so Partners can request a specific delivery date for orders placed through the API.ordersAddedFrom and ordersAddedTo - to the GetDeviceContracts method, so you can retrieve a list of OEM Purchase Order(PO) numbers added during the specific date range.fromDate and toDate - are not required.includeCancelledOrders, which allows you to include cancelled orders in the search results.Requested Delivery Date is going to be added to ApiOrderHeader object, so Partners can request a specific delivery date for orders placed through the API.ThirdPartyPartner-Admin role is required to access the GetPartnerDeviceContractsAsync API.sessionID in addition to the GetPartnerDeviceContractsAsync method. Once this is complete, the API call retrieves the list of devices including the Serial Number, Database, and Product Code.