NAV

Merchant settings for shipping method

Your application can require merchants to specify their shipping account details, package size and any other user preferences you may require. We recommend adding a new tab into the Ecwid Control Panel’s Shipping settings for optimal experience - Native applications feature.

Merchant settings example

Merchant settings example

Settings

First, set up a new tab in Ecwid Control Panel, which will serve as a settings page for your users. This tab will load a page from your server in an iframe in a separate tab of Ecwid Control Panel. See Native Applications.

When merchant is in the settings tab of your app, your code can create and modify the merchant settings using the Application storage feature. It’s a simple key:value storage, which can serve you as an app database. For your convenience, you can access it via Javascript (client-side) or Ecwid REST API (server-side).

Request

Once the settings are saved there, Ecwid will send them in a POST request to your application alongside order details when customer is at checkout stage. The request will contain all data from your application storage, including public and other keys that were specified. Use it to idetify the store and a user for the shipping rates.

You can also use the public key of the application storage to save data for accessing in the storefront. More details on how to handle such data: Public application config.

Please make sure not to pass any sensitive user data in the public application config, as this information will be available via Ecwid Javascript API to any 3-rd party. To save and get that kind of information, use any other key names in your application storage. They will be provided in a request to your application as well as public information, but not accessible in the storefront.

Response

After you get a request from Ecwid, your application endpoint should get its components and return correct rates back to the customer in a response.