Setting Up Data for the Store Connect Module
Purpose: Follow the steps below at Order Broker screens when completing data setup for the Store Connect module as part of Order Broker configuration.
Routing Engine setup required first: Complete the steps below after you have completed Setting Up Data for the Routing Engine Module.
Before you start: When setting up data, you typically log into Order Broker as the default admin user. If you are setting up data for an additional organization in Order Broker and are not using the default admin user login, you need full authority to all secured features based on the roles assigned to the user profile. See the Role Wizard and the User Profile Configuration screen for background.
Note:
To enable Store Connect, you need to select Use Store Connect at the Tenant (retailer information) screen.In this topic:
-
Shipping Service Conversion (Confirm and Reconfigure shipping services after upgrading to Order Broker 21.1)
Step | Procedure |
---|---|
Create the Store Connect
Default System. Identify the system for Store Connect locations. Required? This step is required if your Store Connect system is different from a POS system that you set up through Setting Up Data for the Routing Engine Module. Important: You need to use the Store Connect Preferences screen to confirm your settings after setting up the Store Connect system. See Set up Store Connect preferences for your organization. |
Inventory Export: You can also set up and use the Fulfilled Inventory Export at the Schedule Jobs screen. |
Create a location
type for Store Connect locations. About location types: Types must be 1 of 3 categories (store, vendor, or warehouse) and further identify a group of locations based on the system to which they belong, such as Store Connect. Required? This step is required if your Store Connect location type is different from the POS location type that you set up through Setting Up Data for the Routing Engine Module. |
|
Create Store Connect locations. Required? This step is required if your Store Connect locations are different from the POS locations that you set up through Setting Up Data for the Routing Engine Module. |
|
Set up preferences for Store Connect locations. This step is required. |
Preferences: After creating Store Connect locations, you need to use the Preferences screen to apply preference settings to the new locations, including the types of orders that they support. |
Set up Store Connect
preferences for your organization. About Store Connect preferences: Use the Store Connect Preferences screen to set up information, such as specifying:
|
|
Schedule the Generate Pickup Reminder Ready Emails job. |
Optionally, use the Schedule Jobs screen to schedule the Generate Pickup Reminder Ready Emails job. |
Specify the logo to display in Store Connect. |
|
Create Store Connect
users. About Store Connect users: A Store Connect user has authority only to Store Connect screens. |
Use the Identity Cloud User Synchronization job to import users from IDCS or OCI IAM. Store Connect users need to have the OBCS_Store_User role assigned in IDCS or OCI IAM. See the Identity Cloud User Synchronization for more information. Assign locations:
Note: When you make any changes in IDCS or OCI IAM to an existing store associate’s user role, the changes do not take effect until the user logs in. For example, if the associate is currently logged into Store Connect and you remove the OBCS_Store_User role, the associate can continue working in the current, open session. |
Create reason codes. About reason codes: You can set up reason codes that the associate uses:
|
|
Create boxes. About boxes: Create one or more boxes to define the dimensions of a box used to ship one or more items using an automated shipping system. If the store associate confirms shipment of items on delivery orders through integration with an automated shipping system, the system requires you to select the box size on the Estimated Weight and Dimensions window. The store associate can select one of the predefined box sizes or manually define the length, width, and height of the box. |
|
Set up carriers. |
|
Create external shipping services. |
Use the Manage External Services screen suite to create and manage shipping external services. You then use the Shipping tab of the Store Connect Preferences screen to assign shipping services at any level in the Store Connect hierarchy: the Store Connect system, a location type, or an individual store. See below for information on how existing shipping services are converted through the 21.1 update or higher. |
Shipping Service Conversion
With the 21.1 update or higher, 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 advancing to this update, 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. See below for more information. These are now the only available options at the Shipping tab.
Additional Integrated Shipping Setup and Troubleshooting
Additional required setup: The setup required for integrated shipping in Store Connect also includes the following:
-
return address: The Shipping Label Return Address specifies the location whose address is used as the return address on the shipping label, and should include:
- contact name and company name
- street address line 1
- U.S. city, state/province, and postal code
- phone number of 10 positions, plus any formatting (for example, (508) 555-1111). The store location phone number is used if there is not a day or evening phone number for the order shipping address.
See the Edit Location screen for more information on setting up locations.
-
Carrier codes: The service codes set up in the integrated shipping system should match the carrier codes set up in Order Broker. If the service codes include leading zeros, then the carrier codes must match; for example, 1 is not a match for 01.
See Carriers screen in Modern View for more information on setting up carriers.
- Boxes: The dimensions of the box used with each shipment is required for all delivery orders using an integrated shipping system. When the store associate confirms shipment of items on delivery orders through integration with an automated shipping system, the system requires you to select the box size on the Estimated Weight and Dimensions window. The store associate can select one of the predefined box sizes or manually define the length, width, and height of the box. See the Boxes screen in Modern View.
-
originating address: The address of the fulfilling location is used as the originating address, and must include:
- street address line 1
- U.S. city, state/province, and postal code
- phone number of 10 positions, plus any formatting (for example, (508) 555-1111).
See the Edit Location screen for more information on setting up locations.
- allow list: If a store associate attempts to ship through integration with ADSI and the ADSI URL is not on the allow list, the Store Connect screen opens a pop-up window indicating an unhandled ADSI error. Also, an error message is logged.
Restrictions for integrated shipping:
- International shipping not supported: Shipping to addresses outside of the United States is not currently supported through integrated shipping screens in Store Connect.
- Address line and apartment/suite: Address line 2 cannot exceed 35 positions; also, the apartment/suite number is appended to address line 2. If the address line 2 exceeds 35 positions, ADSI truncates the line for a Federal Express carrier, and returns an error for a UPS carrier.
Note:
- Duplicate service codes: If you set up multiple service codes in ADSI for the same carrier, the first service code is used on the shipment regardless of whether it was the carrier selected for the order. For example, if you set up both service code 10 and service code 20 in ADSI as UPS Next Day, and the associate confirms the shipment using carrier 20, service code 10 is returned from the integrated shipping system.
- Rate shopping: If the associate confirms a shipment using a rate-shopping service code, and ADSI returns a code that is not currently a valid carrier in Order Broker, Order Broker automatically creates the carrier code.