1. Release Readiness Guide
  2. Feature Summary
  3. Manage External Services

Manage External Services

With this update, Order Broker provides a new Manage External Services screen suite to create and manage external services. At this time, only shipping services are supported.

Replaces Store Connect Preferences settings: The shipping service information defined at these new screens replaces the configuration options that were formerly available at the Shipping tab of the Store Connect Preferences screen.

How existing shipping preferences map to new external shipping services: Existing JSON API or ADSI shipping services that were defined at the Store Connect Preferences screen in any organization prior to this release will automatically create external service records. You can then use the Manage External Services screens to review and update the external shipping service records. The settings are mapped as follows:

  • JSON API settings entered at the Store Connect Preferences screen before this release create Standard Shipping Service records in the new screen suite.

  • ADSI settings entered at the Store Connect Preferences screen before this release create ADSI Shipping Service records in the new screen suite.

  • The External Service Type is always set to Shipping.

  • The code used when creating each external service will be SHIP plus an incremental number. For example, the first external service record will be SHIP1, and the second will be SHIP2.

  • The description assigned when creating each external service will be:

    • For ADSI: ADSI Shipping for ORG - ORG Description, where ORG is the organization code and ORG Description is the organization description.

    • For JSON API: Standard Shipping for ORG - ORG Description, where ORG is the organization code and ORG Description is the organization description.

  • Active flag: Selected.

  • Endpoint URL: From the Shipper URL defined at the Store Connect Preferences screen.

  • Shipper Reference: From the Shipper Name defined at the Store Connect Preferences screen.

  • Outbound Message Version: Set to 1 for a Standard Shipping Service. Not used for ADSI.

  • Authentication Type: Set to the current Basic or OAuth setting for a Standard Shipping Service. Not used for ADSI.

  • User ID: Set to the current User ID for a Standard Shipping Service that uses Basic authentication. Not used for ADSI.

  • Password: Set to the current Password for a Standard Shipping Service that uses Basic authentication. Not used for ADSI.

  • OAuth URL: Set to the current OAUTH URL for a Standard Shipping Service that uses OAuth. Not used for ADSI.

  • Scope: Set to the current Scope setting for a Standard Shipping Service that uses OAuth. Not used for ADSI.

  • Client ID: Set to the current Client ID for a Standard Shipping Service that uses OAuth. Not used for ADSI.

  • Client Secret: Set to the current Client Secret for a Standard Shipping Service that uses OAuth. Not used for ADSI.

  • Length Unit of Measure: Set to the current Length Unit of Measure for a Standard Shipping Service. For ADSI, defaults to Inches and cannot be changed. Can be Inches (default) or Centimeters for a Standard Shipping Service.

  • Weight Unit of Measure: Set to the current Weight Unit of Measure for a Standard Shipping Service. For ADSI, defaults to Pound and cannot be changed. Can be Pound (default), Gram, or Kilogram for a Standard Shipping Service.

Note:

After the update to this release, you need to:

  • Review the external service records that were automatically created, and correct or delete them as necessary.

  • Select the external service to use at the Shipping tab of the Store Connect Preferences screen, and set up the Shipping Label Return Address. These are now the only available options at the Shipping tab.

Access to new screens: The new Manage External Services screen, as well as the related Create and Edit screens, are available under the Systems menu. Authority is required under a new Manage External Services role for access to these screens. This role is not assigned to any Order Broker users by default after an upgrade to Order Broker 21.1. For a new installation of Order Broker 21.1, this access is included under the System Administrator Retailer role.