Suggest Candidates (Before)

This action manipulates the HTTP request or response before the Suggest Candidates operation occurs in Kibo. Note that Kibo must have enabled Order Routing extensions in your tenant settings first, otherwise you will encounter a validation error. 

JavaScript File Structure

Action files share the following basic structure:

module.exports = function(context, callback) {
   // Your custom code here
   callback();
};

When you code the custom function for an action, you have access to two arguments:

callback—This argument follows the established JavaScript callback pattern: it takes an error as the first argument (or null if there is no error) and a result as the second argument (if required).

context—This argument provides the function access to relevant objects and methods that interface with Kibo.

Context: HTTP

The following methods and objects are available to this action through the use of the context argument.

REST API Operation
This action corresponds to the /commerce/orders/orderrouting/api/v1/routing/candidates operation.

HTTP Request

POST api/commerce/orders/orderrouting/api/v1/routing/candidates

Request Body
Use context.request.body to read/write the HTTP request body using this action.

Response Body
Use context.response.body to write the HTTP response body using this action.

Context Objects Available to All HTTP Actions

• request
• response

Context Methods Available to All HTTP Actions

• request.get
• response.get
• response.set
• response.set
• response.remove
• response.redirect
• response.end
• get.resource
• get.resourceStatus
• items.urlHelper.getUrl

Context Objects Available to All Actions

• apiContext
• configuration

Context Objects Available to All HTTP Actions

request

Accesses the current HTTP request. In the case of Before actions, updates can be made to the request before Kibo processes it.

Example:

context.request.url;

response

Accesses the current HTTP response. For both Before and After actions, updates can be made to the response before Kibo processes it.

Example:

context.response.header;

Context Methods Available to All HTTP Actions

request.get

Returns an HTTP header value for the specified header key.

Example:

context.request.get(field);

Response:

"object"

response.get

Gets a field from the response.

Example:

context.response.get(field);

Response:

"string"

response.set

Sets the HTTP headers for the response.

Example:

context.response.set({ myCustomHeader: "howdy" });

Response: N/A

response.set2

Updates a field in the response.

Example:

context.response.set("name", "stuff");

Response: N/A 

response.remove

Removes an HTTP header from the response.

Example:

context.response.remove(header);

Response: N/A 

response.redirect

Redirects the incoming URL.

Example:

context.response.redirect("http://someOtherSite/foo");

Response: N/A 

response.end

Ends the response so that other actions or Kibo logic can run. Also, signals the callback to complete.

Example:

context.response.end();

Response: N/A

get.resource

Returns the currently persisted value of the requested resource. **Not available for all calls.

Example:

context.get.resource();

Response: N/A 

get.resourceStatus

Gets the HTTP resource status.

Example:

context.get.resourceStatus();

Response: N/A 

items.urlHelper.getUrl

Gets the current URL.

Example:

context.items.urlHelper.getUrl(type, object, config);

Context Objects Available to All Actions

apiContext

Accesses tenant information.

Example:

context.apiContext.baseUrl;

configuration

Receives a JSON response that contains information about the configuration data set in the Action Management JSON editor.

Example:

context.configuration.customData;