Skip to main content

Onport Component

Onport supports marketplace and/or dropship vendor models. Integrating Onport with Commerce means you can enable support for marketplace and dropship vendor models in Commerce. The Onport Integration supports the following features.

  • Product changes in Onport causes webhook events to be generated to change product data in Commerce.

  • Inventory changes in Onport causes webhook events to be generated that increment or decrement inventory in Commerce.

  • Order changes in Commerce like creating, updating, fulfilling and so on, causes webhook events to be generated that cause orders to be created, updated, fulfilled and so on, in Onport. The following Commerce event types can be used to generate webhook events.

    • order.created
    • order.updated
    • order.fulfilled
    • order.paid
    • order.authorized
  • Split Orders orders generated in Commerce causes webhook events to be generated in Onport that allow Onport to split an order based on vendors.

Connections

Collect the following setup information from Onport.

OptionDescription
API Base URLYour Onport API Base URL. Default value is https://api.jetti.io/api.
API KeyYour Onport API Key.

Actions

The component has the following actions.

Manual Sale

InputTypeDescription
ConnectionconnectionOnport connection.
Channel IDstringYour Onport Channel ID. See Create an Onport Channel ID.
Order RequeststringAs part of the Onport Integration, changes in orders in Commerce automatically updates order data in Onport. See Synchronizing Commerce Order Data With Onport Order Data.

Update Inventory Endpoint

InputTypeDescription
ConnectionconnectionOnport connection.
Custom Channel IDstringYour Onport Channel ID. See Create an Onport Channel ID.
Inventory EndpointstringChanges in inventory in Onport automatically updates inventory data in Commerce.

Update Publishing Endpoint

InputTypeDescription
ConnectionconnectionOnport connection.
Custom Channel IDstringYour Onport Channel ID. See Create an Onport Channel ID.
Publishing EndpointstringAs part of the Onport Integration, changes in product data in Onport automatically updates product data in Commerce. See Synchonizing Onport Product Data With Commerce Product Data.

Update Price Endpoint

InputTypeDescription
ConnectionconnectionOnport connection.
Custom Channel IDstringYour Onport Channel ID. See Create an Onport Channel ID.
Price EndpointstringAs part of the Onport Integration, changes in price in Onport automatically updates price data in Commerce. See Synchronizing Onport Price Data With Commerce.

Update Fulfilment Endpoint

InputTypeDescription
ConnectionconnectionOnport connection.
Custom Channel IDstringYour Onport Channel ID. See Create an Onport Channel ID.
Fulfilment EndpointstringAs part of the Onport Integration, changes in fulfilment in Onport automatically updates fulfilment data in Commerce. See Synchronizing Onport Fulfilment Data With Commerce.

Get Sale Return Items

InputTypeDescription
ConnectionconnectionOnport connection.
Query ParametersobjectKey value pair, for example, key = where[saleReturnId] and value = 282309.