OpenBorder

If you do not already have an OpenBorder account please sign up before proceeding.

  • Plugin Activation

  • Checkout Champ pages

  • Direct API Integration

    • High level flow for using the Rate API

  • Troubleshooting

Plugin Activation

  • Go to CRM. Navigate to Admin → Plugins → Data Sources

  • Click on the OpenBorder tile and then the green Activate button

  • FriendlyName - Optional. Enter a name to identify this plugin throughout the app.

  • brandcode - Required. This is a portion of the delivery endpoint URL given to you by OpenBorder, which is typically in the form of https://api.openborder.com/api/ds/shopify-rates/[brandcode] - Only add the [brandcode]

  • From_Address - The address from which orders are shipped.

  • From_Address2 - The address from which orders are shipped.

  • From_City - The city from which orders are shipped.

  • From_State - The state or province from which orders are shipped.

  • From_Country - The country from which orders are shipped.

  • From_PostalCode - The postal code from which orders are shipped.

Click the green Connect button to complete the plugin activation

Checkout Champ pages

This section applies to CheckoutChamp hosted pages only. If using a Direct API integration then proceed to the next section.

  • Edit the funnel on which to enable OpenBorder

  • Go to Settings > Add Ons

  • Check the External Shipping box

  • Save & Continue

  • Publish the funnel

OpenBorder usage requires that shipping options be available in a select on the checkout page. Drag a select to the page and set Name = Ship Profile.

Shipping options are automatically pulled from OpenBorder once the shopper has products in the cart and enters a shipping address. The options are displayed in the select.

The selected shipping price is charged on the order. The OpenBorder id is saved as the order Ship Carrier. Ship Carrier is passed to Shopify with the order.

Direct API Integration

This section should be skipped if using CheckoutChamp hosted pages

High level flow for using the Rate API

  • grant API user access to Order Ship Rate API

  • send valid API request to the Order Ship Rate API. https://apidocs.checkoutchamp.com/#d432f7d4-8266-44b7-82d8-0f9d4719ed87

  • upon valid request you will be presented with several shipping rates/methods/carriers.

  • Choose which options to display on your page for customers to select, or apply this data directly to checkout without providing an option for customer to choose.

  • Modify your Import Order API call to apply data from the Rate API response to the order:

    • Pass in shipCarrier=rateId returned from API, shipMethod=serviceType returned from API, totalShipping=shippingamount chosen from response.

Troubleshooting

  • If the ship rates are not retrieved from OpenBorder, verify the following items:

    • OpenBorder plugin credentials are correct

    • Ship-To address information is entered at checkout. This can be on a lead or checkout page prior to the page on which Shipping is selected.

    • The selected products must have a weight. OpenBorder will not return shipping rates without a weight.

  • ShipEngine requires that Ship-To information is entered on the checkout page or a page prior to checkout. It will not work with a checkout where the Ship To address is retrieved from another source, such as PayPal.

PreviousListrakNextPaperform