Configuring the Adobe Commerce Integration

Configuring the Adobe Commerce integration involves the following:

  • Setting up Delivery Manager to work with the integration.

  • Setting up the Magento Admin app to work with the Delivery Options API and Delivery Manager.

Setting up Delivery Manager

In Delivery Manager, you will do the following:

  • Make a note of summary information about your warehouses.

  • Make a note of codes for your carrier service groups.

  • Review (and modify) cutoff times for each of your carrier services.

  • Review the shipping charges (presented to shoppers at checkout) for each of your carriers.

To set up Delivery Manager for the integration, complete the following steps:

  1. Log into Delivery Manager.

    dm_login.png
  2. Click Setup.

  3. Under Warehouses, click Warehouses.

    dm_setup_warehouses.png

    The warehouses (shipping locations) associated with your shipper account are displayed.

    dm_warehouses_page.png
  4. Make a note of the following information for each warehouse:

    • Warehouse code

    • Name

    • Address

    • Phone number

  5. Click Setup. again.

  6. Under Service Groups, click Service Groups.

    dm_setup_service_groups.png
  7. Make a note of the code for each carrier service group that you want displayed by the Delivery Options API in Shopify.

    dm_service_groups_page.png
  8. Click Setup again.

  9. Under Carriers and Services, click Configure carriers.

    dm_setup_carriers_services.png

    Under Services, active (and inactive) carrier services associated with your shipper account are listed.

  10. Under Active Services, click Set cut off times for each carrier service.

    dm_carrrier_active_services.png
  11. In the Cutoff-Time Details page, review the Cutoff and Web cutoff times for each carrier service to ensure that there is sufficient time between ordering and despatch.

    Change the cutoff times as required.

    dm_carrier_services_cutoff_times.png

    In the example shown, the web cutoff time is two hours before the cutoff. This means that there is confidence that your fulfilment team is confident that it can accept and despatch an order within two hours to meet the delivery date presented to a shopper.

  12. Navigate back to the Configure Carriers page, and click Select a carrier > Set charges.

    dm_carrier_setup_set_charges.png
  13. Under Add Charge Rule(s), select a charge type and add rules for carrier services, applicable areas (countries or zones), and applicable warehouses.

    dm_carrier_setup_add_charge_rules.png

Note

Shipping charges are not required for parcel allocation, so they are not usually defined by Metapack Professional Services implementation consultants when setting up shipper accounts for new Metapack shipping customers. However, if you want to use the Delivery Options API or the Shopify integration, you must set up shipping charges in Delivery Manager.

Tip

For more information about configuring shipping charges, see Setting up the Carrier Charges.

You have now completed setting up Delivery Manager for the integration.

Setting up the Magento Admin app

In the Magento Admin app, you will do the following:

  • Configure Metapack as an available delivery method.

  • Configure API request parameters that are passed to the Delivery Options API.

  • Configure the delivery options presented to shoppers on the product pages, mini-carts, and checkout pages of your eCommerce website.

  • Configure how Magento will use the SOAP Shipping API to generate shipping labels.

Note

If you want to use the Delivery Options API to return retail store locations for the integration, you must first use Metapack Location Services to set up your own stores for the API. For more information about this, see Setting up your Own Stores.

Tip

If you want to set up label generation, you must ask your Metapack Professional Services implementation consultant for the relevant SOAP Shipping API URLs.

To set up the Magento Admin app for the integration, complete the following steps:

  1. Log into the Magento Admin app.

    magento_admin_config_menu.png
  2. Click Stores > Settings > Configuration.

  3. Click Sales > Delivery Methods.

    If the Metapack Magento app has been downloaded to your Magento.com account, Metapack is listed as an available delivery method.

  4. Click Metapack.

    magento_admin_config_method_mp.png
  5. Configure the Metapack delivery method as follows:

    1. In the Enabled list, ensure that Yes is selected.

      Otherwise, the Delivery Options API will not be used for your eCommerce websites.

    2. In the Host URL field, enter the URL of the Metapack Options host server.

      This URL will be provided by Metapack.

    3. In the Title field, enter the title that will be used for delivery options in product details pages.

    4. In the Refresh Interval field, set the interval (in milliseconds) that will be used by your eCommerce websites for executing new Delivery Options API requests if shoppers leave web browser tabs open without purchasing anything.

      This helps ensure that the most accurate delivery options are displayed.

    5. Optional: In the Debug list, selecting Yes will write logs to var/log/metapack.log.

    6. In the Create manifest crontab field, set the interval time (in minutes) for when manifesting data to carriers should occur if shipping labels have been generated.

      Metapack recommends setting this time to 240 (four hours).

      magento_admin_config_method_mp_details.png
  6. Click Save Config.

  7. Click API Request Parameters.

  8. Configure the API request parameters to be passed to the Delivery Options API by entering details from Delivery Manager about each warehouse from which consignments will be dispatched as follows (each warehouse’s details must be entered separately):

    1. In the Warehouse Code field, enter the code of a warehouse.

    2. In the Warehouse Country Code field, enter the country code of the warehouse.

    3. In the Warehouse Name field, enter the name of the warehouse.

    4. In the Warehouse Address Line 1 field, enter the first line of the address of the warehouse.

    5. In the Warehouse Address Line 2 field, enter the second line of the address of the warehouse.

    6. In the Warehouse Postcode field, enter the postcode/Zip code of the warehouse.

    7. In the Warehouse Phone field, enter the phone number of the warehouse.

    8. In the Warehouse Email field, enter the email address of the warehouse.

      The necessity of entering this address will vary by carrier.

    9. Local Collect and Store Collect delivery options only: In the Search Radius field, enter the search radius (in metres) used for searching for nearby PUDO and retail stores.

      Default value: 1000.

    10. Local Collect and Store Collect delivery options only: In the Minimum number of Own Stores field, enter a minimum number of your retail stores that should be returned by the Delivery Options API (regardless of the search radius).

    11. Local Collect and Store Collect delivery options only: In the Maximum number of Own Stores field, enter a maximum number of your retail stores that should be returned by the Metapack Delivery Options API (regardless of the search radius).

    12. Local Collect and Store Collect delivery options only: In the Search across borders for PUDO/Store Collect field, enter true if you want to return PUDO or Retail Store options from a country that neighbours the country where a package will be delivered.

      magento_admin_config_api_request.png
  9. Click Save Config.

  10. Click Product Page Settings.

  11. Configure the delivery options presented on your product details pages as follows:

    1. In the Show delivery options in product page list, select Yes to display delivery options.

    2. In the Delivery options window, select the delivery options that you want to offer shoppers.

    3. In the Service groups for PDP API request section, add the carrier service groups data extracted from Delivery Manager.

      Metapack recommends setting Display Calendar to No for each service group.

    4. In the Return Type/Sortation field, enter a three-letter code for the return type that will be used by the Delivery Options API.

      Possible values are as follows:

      • lgg returns the cheapest next available delivery option for each carrier service group.

        Metapack recommends this setting for product details pages.

      • lsc returns the next available delivery option for each carrier service.

      • ggg returns the cheapest delivery option for each carrier service group for the next 20 days.

      • gsc returns the delivery options for each carrier service for the next 20 days.

      magento_admin_config_pdp.png
  12. Click Save Config.

  13. Click Mini-Cart Settings.

  14. Configure the delivery options presented in your mini-carts as follows:

    1. In the Show delivery options in minicart list, select Yes to display delivery options.

    2. In the Delivery options list, select the delivery option that you want to offer shoppers.

    3. In the Service groups for mini-cart API request section, add the carrier service groups data extracted from Delivery Manager.

      Metapack recommends setting Display Calendar to No for each service group.

      magento_admin_config_cart.png
  15. Click Save Config.

  16. Click Checkout Page Settings.

  17. Configure the delivery options presented in your checkout pages as follows:

    1. In the Show delivery options in checkout page list, select Yes to display delivery options.

    2. In the Delivery options window, select the delivery options that you want to offer shoppers.

    3. In the Service groups for HOME delivery section, add the carrier service groups data extracted from Delivery Manager.

      If you want to offer a nominated day delivery for a specific service group, set Display Calendar to Yes.

      If set to No, the first available delivery date will be displayed.

    4. In the Return Type/Sortation field, enter ggg for the return type that will be used by the Delivery Options API.

    5. In the Service groups for PUDO delivery section, add the carrier service groups data extracted from Delivery Manager.

      Metapack recommends setting Display Calendar to No for each service group.

    6. In the Return Type/Sortation field, enter lsc for the return type that will be used by the Delivery Options API.

    7. In the Service groups for OWNSTORE delivery section, add the carrier service groups data extracted from Delivery Manager.

      Metapack recommends setting Display Calendar to No for each service group.

    8. In the Return Type/Sortation field, enter lsc for the return type that will be used by the Delivery Options API.

      magento_admin_config_checkout.png
  18. Click Save Config.

  19. Click Labelling Settings.

  20. Configure how the Magento Admin will use the SOAP Shipping API to generate shipping labels for parcels:

    1. In the Create Label for Parcel list, select Yes to enable this capability.

      If you want to use this integration only with the Delivery Options API, select No to disable it.

    2. In the UserName field, enter your SOAP Shipping API user name (as provided by Metapack Professional Services).

    3. In the Password field, enter your SOAP Shipping API user password (as provided byMetapack Professional Services).

    4. In the WSDL for Allocation Service, WSDL for Consignment Service, and WSDL for Manifest Service fields, enter the relevant Web Services Description Language (WSDL) URLs provided by Metapack.

      magento_admin_config_labels.png
  21. Click Save Config.

You have now completed setting up Magento Admin app for the integration.