Docs
STEP 2-3

ecforce integration

View as Markdownllms.txt

1. Issue an API authentication token in ecforce

  1. Sign in to the ecforce admin

  2. Go to Change settings > Members / permissions > Manage members and click Configure

  3. Create a user for the API connection with the Create button

    ※For the role, choose one that has API access enabled, such as admin.

    The ecforce member creation screen. Choose a role with API access enabled.

  4. Go back to the member management screen and search for the user you created in step 3

  5. Click Details for the API connection user in the search results

    The member management search results. Click Details for the API connection user.

  6. On the details screen, click Update under API authentication token

    The API authentication token section of the details screen. Click the Update button.

  7. An API authentication token is issued. Copy the value.

◼️Reference: How do I create a user for API connections and issue an authentication token (access token)? (ecforce support, in Japanese)

2. Enter the keys in Recustomer

The ecforce integration settings screen (authentication tab).

  1. In Recustomer, go to Settings > External service integrations > Integrations > ecforce

    Clicking ecforce in the list of integrations.

  2. Enter the domain and the authentication token, then click Authenticate

    The ecforce integration settings. Enter the domain and authentication token, then click Authenticate.

    FieldValue to enter
    DomainEnter your ecforce domain. It is part of the URL you see when signed in to the ecforce admin.
    Example: for https://sample.ec-force.com/admin, the domain is "sample.ec-force.com"
    Authentication tokenEnter the API authentication token you copied in step 7 of section 1

  3. The setup is complete when the status changes to Authenticated

    Setup is complete when ecforce shows the Authenticated status.

3. Order status mapping

  1. Go to Store settings > External service integrations > select ecforce > Authentication > Order status mapping, and map Recustomer's order statuses to ecforce's handling statuses

    The order status mapping screen.

    Important

    Recustomer cannot retrieve orders whose handling status is not registered here. Make sure every handling status is registered under one of Cancelled, Preparing for shipment, or Shipped.

    FieldWhat to set
    CancelledEnter the name (in single-byte alphanumerics) of the handling status that means "cancelled" in ecforce
    Preparing for shipmentEnter the handling status (in single-byte alphanumerics) that means "not yet shipped" in ecforce
    ShippedEnter the handling status (in single-byte alphanumerics) that means "already shipped" in ecforce

    ※Enter one handling status per line.

▼You can see the list of handling statuses in ecforce at Change settings > Orders / subscription orders > Manage handling statuses > Configure

The list of handling statuses in ecforce.

4. Integration settings (cancellation)

  1. Go to Store settings > External service integrations > select ecforce > Integration settings > Cancellation, and configure what happens on the ecforce side when a cancellation occurs

    The Cancellation tab of the integration settings.

    FieldWhat to set
    Handling status on cancellationThe delivery status applied in ecforce when Recustomer cancels the order automatically
    Excluded handling statusesHandling statuses you do not want to accept cancellations for. If a shopper requests a cancellation and the order has one of these statuses, the cancellation is rejected.

▼You can see the list of handling statuses in ecforce at Change settings > Orders / subscription orders > Manage handling statuses > Configure

The list of handling statuses in ecforce.

© Recustomer, Inc.