Skip to main content

How to use CRM Integrations

To invoke CRM Endpoints from MSC dynamic integration, you need following details

  1. URL
  2. Authentication
  3. Payload

URL​

You can copy url from the Endpoint Details when you create a new CRM integration in Marketplace.

Endpoint URL details when creating a CRM integration

Authentication​

Url Copied in above contains query string apikey which is already populated with value.

If you cannot use query string, then you need to add Header having Key Authorization with value of apikey in url

Payload​

**Common Endpoints: **

Marketplace has already defined few of the most commonly used endpoints.

  1. Customer: gets the customer by email and phone number. Append email and/or phone to url with values

    Customer endpoint example

  2. Orders: gets the order by email and phone number. Append email and/or phone to url with values

Orders endpoint example

  1. OrdersById: gets the orders by Id

    OrdersById endpoint example

  2. Search: finds the order/customer by email or phone number. Append email and/or phone to url with values

    Search endpoint example

Custom Endpoint:

This endpoint can be used to query any APIs from the available CRMs. You need to provide the

  1. HTTP Method

  2. Endpoint URL

  3. Query Parameters

  4. Data (In case of POST or PUT requests)

    Custom endpoint data payload example

{
  "method": "string",
  "path": "string",
  "query": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "data": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}