Overview

The Infosys Equinox Commerce platform allows the apps to register for extensions to extend the behavior of specific Infosys Equinox Commerce APIs with the business logic. In other words, apps can extend the behavior of the APIs using these extensions or synchronous webhooks.

In this synchronous approach, the process is intercepted, and the outcome of the process is determined by the apps or applications based on some business logic. The transaction or process that is intercepted would be a failure unless the extension receives a valid response payload from the application or app.

The extension is called while processing the create, patch, update, or delete request of an API call, but the result persists based on the response received from the application or app.

Configure an Extension

Apps must expose REST API endpoints to support the request and response structure for each extension point the app has subscribed to. Develop and host an app (HTTPS endpoint function) that accepts webhook extensions with a POST method.

Sample Endpoint:

The following is the sample endpoint:

POST https://<your-domain>/webhookname

When apps receive the payload for the registered extension, the app must transform and construct the payload to call the third-party API, receive the response from the third party, and convert the response to the Infosys Equinox Commerce platform.

Sample Extension Configuration in the App Template:

In the app template, the webhook has to be configured. The following is a sample configuration:

{
                    "url": "https://eq-pdn-apps.equinox.shop/avalara/tax/v1/calculatetax",
                    "webhookType": "SYNC",
                    "priority": "Normal",
                    "events": [
                        "taxservice/tax/calculatetax"
                    ]
                }

The following table describes the parameters of the sample configuration:

Extensions for Standard Apps

Payment App Extensions

The following is the list of extensions available for the payment app integrations:

• Get Customer Session
• Create Token
• Authorize Payment
• Capture Payment
• Cancel Payment
• Refund Payment
• Get Token
• Update Token

Postman Collection

Refer to the following Postman collection for the integration of payment apps:

Get Customer Session

The following table lists the details of the get customer session extension:

The following diagram shows the flow of the get customer session extension:

Create Token

The following table lists the details of the create token extension:

The following diagram shows the flow of the create token extension:

Authorize Payment

The following table lists the details of the authorize payment extension:

The following diagram shows the flow of the authorize payment extension:

Capture Payment

The following table lists the details of the capture payment extension:

The following diagram shows the flow of the capture payment extension:

Cancel Payment

The following table lists the details of the cancel payment extension:

The following diagram shows the flow of the cancel payment extension:

Refund Payment

The following table lists the details of the refund payment extension:

The following diagram shows the flow of the refund payment extension:

Get Token

The following table lists the details of the get token extension:

The following diagram shows the flow of the get token extension:

Update Token

The following table lists the details of the update token extension:

The following diagram shows the flow of the update token extension:

Shipping App Extensions

The following is the list of extensions available for the shipping app integrations:

• Get Shipping Rate

Postman Collection

Refer to the following Postman collection for the integration of payment apps:
USPS_Postman_collection.json

Shipping Rate

The following table lists the details of the get shipping rate extension:

Sample Payload Request:

• shippingrate_request.json

Sample Payload Response:

• shippingrate_response_200.json

The following diagram shows the flow of the get shipping rate extension:

Tax App Extensions

The following is the list of extensions available for the tax app integrations:

• Calculate Tax

Postman Collection

Refer to the following Postman collection for the integration of payment apps:
avalara_postman_collection.json

Calculate Tax

The following table lists the details of the calculate tax extension:

Sample Payload Request:

• calculatetax_request.json

Sample Payload Response:

• calculatetax_response.json

The following diagram shows the flow of the calculate tax extension:

Address App Extensions

The following is the list of extensions available for the address app integrations:

• Validate address

Postman Collection

Refer to the following Postman collection for the integration of payment apps:

CYBERSOURCE_ADDRESS_postman_collection.json

Validate Address

The following table lists the details of the validate address extension:

Sample Payload Request:

• validateaddress_request.json

Sample Payload Response:

• validateaddress_response_400.json
• validateaddress_response_200.json

Validator Extensions

The validator extensions are available in the Infosys Equinox Commerce platform across many services, as shown here. The extensions can be used to validate the request object based on custom business logic and the result will persist in the Infosys Equinox Commerce platform based on the response received for the extension.

Postman Collection

The following are the Postman collections:

• Reference_postman_environment.json
• Validators_postman_collection.json

Sample Response Payload for All Extensions

Success:

Error:

The following table describes the parameters in the Error response:

Revision History

2024-05-23 | AN – Updated the content.
2024-05-20 | JP – Updated the content.
2024-05-15 | AN – Created the page and uploaded the contents for release 8.17.4.