Omacro
Book a Demo
Help Center

omacro.com

Buy Now

Buy Now API guide

Reference for Omacro Buy Now service endpoints, required identifiers, and the supported retrieval and analytics endpoint groups.

The following guide is aimed at assisting developers in understanding how the omacro Buy Now services work in an effort to develop a custom front-end solution. If you are not familiar with this type of development, it is highly recommended that you use omacro's prebuilt solution. To learn more about Buy Now, please review our Supplier Buy Now Implementation Guide.

Prerequisites

Configure Network To Support Buy Now

It may be necessary to ensure that your network firewall is configured properly communicate with the omacro web services outside of your network. Learn more about Buy Now Service Information for Network Professionals.

Overview

The Buy Now service endpoints can be called to request basic client information, Buy Now configuration data and dealer and product information. This guide will outline these endpoints and their functions.

omacro Service Base Endpoint Address

  1. https://services-v2.omacro.com/buynow/

Variable Terms Used In Endpoints

Please note, in order to call most Buy Now endpoints, you may be required to supply the following key parameters:

  • companyId - The internal global unique identifier assigned to your company from omacro (aka "omacro ID" or Company GUID). The companyId parameter can be found on the Buy Now -> Site Code page or by clicking on your company name in the top left hand corner of the omacro navigation menu. The companyId will appear in the URL parameter "id".
  • productId - The internal global unique identifier assigned to your product from omacro (aka Product GUID). At this time, the productId parameter can be found within the omacro Products -> Manage Product page by clicking on the product Model and launching the "live" view page. The productid will appear in the URL as the parameter "p".

Endpoints

Data Retrieval

  • geolocate
  • companies/{companyId:guid}
  • companies/{companyId:guid}/retailers/online
  • companies/{companyId:guid}/retailers/local
  • companies/{companyId:guid}/validate
  • companies/{companyId:guid}/products
  • companies/{companyId:guid}/products/{productId:guid}/retailers/online
  • companies/{companyId:guid}/products/{productId:guid}/retailers/local

Analytic Tracking

  • dealertransaction
  • producttransaction
  • producttransactionsimple
  • dealertransactionsimple

The following is an example of a fully qualified endpoint address: