Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


Excerpt

Komet has a variety of API methods and integrations that help users connect Komet with third party systems. If you want your Komet Account to be synchronize synchronized with your external system, please contact us so we can evaluate the technical requirements. Depending on your role and need, choose one of the following options.



Ui expand
titleIntegrations for Vendors
Método

Komet is integrated directly with cargo agencies and grower systems such as Unosof, Ventures, Vida 18, Cargo Master and some other systems. You can also virtually connect Komet with your system through the next methods.

NeedUtilidad
Change box codesThe method box.code.change This method allows changing one or more box codes.
Obtain a list of box typesThe method boxtype.list This method allows to obtain a list of box types sorted by box type code.
carrier.listThis method allows to obtain a list of carriers sorted by carrier name.
company.location.list This method allows returns a list of locations associated to a given customer.
customer.list This method returns a list of customers sorted by name.
customer.shipto.listThis method allows to obtain a list of ship to's associated to a given customer.
inventory.listEste método permite obtener una lista con el inventario disponible actual.
prebook.createPermite agregar Preventas al sistema.
prebook.details.listRetorna una lista de Preventas con sus correspondientes detalles.
prebook.item.deletePermite eliminar un producto de una Preventa existente en Komet Sales.
product.listPermite obtener una lista de productos ordenados por su descripción.
purchase.order.createPermite crear Órdenes de Compra desde Preventas.
Obtain a list of productsThe method product.list allows to obtain a list of products with its description.
Create Purchase OrdersThe method purchase.order.create allows to create Purchase Orders based on Prebooks.
Add products to an AWBThe method purchase.order.item.awb.add allows adding product lines of a Purchase Order to an AWB.
Delete items from a Purchase OrderThrough the method purchase.order.item.delete users can delete products from a Purchase Order.
Obtain a list of Purchase OrdersThe method purchase.order.list returns a list of Purchase Orders with its corresponding details.
Create Purchase Orders with assorted productThrough the method purchase.order.mixed.create users can create Purchase Orders with assorted products of Prebooks in units.



Ui expand
titleVendor token generation

This functionality allows vendor companies to generate API tokens at their convenience through the Vendor Portal


To generate a vendor token, follow these steps:

Ui steps
sizesmall


Ui step

Log in to the using the username and the password provided via email


Ui step

Click on   to show its menu options


Ui step

Select Vendor Token from the menu list

The vendor window will display with your assigned token.

Ui step

Hover your cursor over the token and click on it to copy it to your clipboard to start connecting your systems with your other companies.

Image Added

Reset token 

You can generate a new token by clicking the refresh button Image Added from the Vendor token window.

By default, this token has the following API methods:


Note
titleIMPORTANT

Be aware that if your token had other API methods before the refresh, your buyer company needs to re-assign any methods that were previously associated with your vendor token.




Ui expand
titleIntegrations for Inventory and Invoices


NeedAvailable Methods

Share Inventory to Komet's Account

This can be done through the API method inventory.add. It is possible to use the parameter confirmInventory so the inventory updates in the external system once a product synchronized is sold or deleted from Komet's account.

Update in real time the synchronized inventory

Once the inventory is shared from the external system into Komet, it is possible to use the inventory.update or inventory.delete API methods to every time a product is sold in the external system, the actual quantity available gets update in Komet.

Create invoices in Komet

The invoice.create method allows you to create an invoice on Komet Sales with its corresponding product items. 

Obtain a list of invoices created in Komet

The API method invoice.details.list returns a list of invoices created in Komet.

Obtain a list of available online inventory for a given customer

The method ecommerce/inventory.list returns a list of the inventory displayed on e-commerce for a given customer.

Consult future inventory

The method future.inventory.openmarket.list allows to obtain the inventory that a company is going to have in a future date.
Obtain Available inventoryThe method inventory.openmarket.list allows users to obtain a list of the current available inventory in a given company.
Obtain a list of invoicesThe method invoice.details.list returns a list of invoices with their corresponding details.
Mark a single invoice as successfully synchronized

The method invoice.mark.sync.status.ok allows you to mark a single invoice as successfully synchronized. 



Ui expand
titleIntegrations for Prebooks and Purchase Orders


NeedAvailable Methods

Create/Update Prebooks

The method prebook.create allows users to add a Prebook to Komet Sales and update existing Prebooks.

Delete Prebooks

With the method prebook.item.delete users can delete Prebooks from Komet Sales. In case this method is used with a vendor token, the system will update the quantities to 0.

Obtain a list of Prebooks created in Komet

This method returns a list of Prebooks with their corresponding details.
Create Purchase OrdersThe method purchase.order.create allows to create Purchase Orders based on Prebooks.
Add items to a AWBThe method purchase.order.item.awb.addPermite agregar líneas de producto de una Orden de Compra a una guía (AWB).addallows to add product lines of a Purchase Order to an AWB.
Delete items from Purchase OrdersThrough the method purchase.order.item.delete users can delete Permite eliminar productos de una Orden de Compra existente en Komet Sales.products from a Purchase Order.
Obtain a list of Purchase Orders created in KometThe method purchase.order.listEste método retorna una lista de Órdenes de Compra con sus correspondientes detalles.returns a list of Purchase Orders with its corresponding details.
Create Purchase Orders with assorted productThrough the method purchase.order.mixed.createPermite crear Órdenes de Compra con producto surtido desde artículos de Preventas en unidades.
Ui expand
titleIntegrations for Inventory and Invoices
users can create Purchase Orders with assorted products of Prebooks in units.




Panel
titleRelated Articles

Filter by label (Content by label)
showLabelsfalse
max10
showSpacefalse
sorttitle
cqllabel = "kb-how-to-article"in ("integrations","api")