Skip to main content
Related API: This extension modifies the Get Future Allocatable Items operation.
This action manipulates the HTTP request or response after the Create Future Shipments for Future Allocatable Items operation occurs in Kibo. Changes made to the shipment or shipment items in this action persist in Kibo. 
Action TypeHTTP
Full Action IDhttp.commerce.fulfillment.futureShipments.after
Runs multiple custom functions?Yes

​
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 methods and objects documented here are available to this action through the use of the context argument. REST API Operation
This action corresponds to the Create Future Shipments for Future Allocatable Items operation. HTTP Request POST api/commerce/shipments/{shipmentNumber}/futureAllocatableItems 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

Accesses the current HTTP request. In the case of Before actions, updates can be made to the request before Kibo eCommerce processes it.
PropertyTypeDescription
paramsobjectThe input parameters to the service or webpage.
headersobjectThe request headers.
methodstringThe request method.
urlstringThe request URL.
pathstringThe request path.
cookiesobject
The request cookies.
*Available only for Storefront HTTP actions. | | query | object | The request query. | | href | string | The request href. | | secure | Boolean | Indicates whether the request uses HTTPS. | | ip | string | The request IP address. | | ips | string | The request secure IP address. | | body | object | The request body of the API operation associated with this action. | 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 eCommerce processes it.
PropertyTypeDescription
headerobjectThe response header collection.
viewDataobject
The viewData collection used by the storefront rendering engine.
*Available only for Storefront HTTP actions. | | viewName | string | The response viewName value. *Available only for Storefront HTTP actions. | | body | object | The response body of the API operation associated with this action. | | status | integer | The response status code. | | message | string | The response message. | | length | integer | The response length. | | type | string | The response type. | Example: 
context.response.header;

​
Context Methods Available to All HTTP Actions

​
request.get

Returns an HTTP header value for the specified header key.
ParameterTypeDescription
keystringThe header key.
Example: 
context.request.get(field);
Response: 
"object"

​
response.get

Gets a field from the response.
ParameterTypeDescription
keyobjectThe field to obtain.
Example: 
context.response.get(field);
Response: 
"string"

​
response.set

Sets the HTTP headers for the response.
ParameterTypeDescription
valuesobjectThe values for the HTTP headers.
Example: 
context.response.set({ myCustomHeader: "howdy" });
Response: N/A

​
response.set2

Updates a field in the response.
ParameterTypeDescription
keystringThe key of the field.
valuestringThe value of the field.
Example: 
context.response.set("name", "stuff");
Response: N/A

​
response.remove

Removes an HTTP header from the response.
ParameterTypeDescription
keystringThe HTTP header to remove.
Example: 
context.response.remove(header);
Response: N/A

​
response.redirect

Redirects the incoming URL.
ParameterTypeDescription
urlstringThe destination URL.
Example: 
context.response.redirect("http://someOtherSite/foo");
Response: N/A;

​
response.end

Ends the response so that other actions or Kibo eCommerce logic can run. Also, signals the callback to complete.
ParameterTypeDescription
N/AN/AN/A
Example: 
context.response.end();
Response: N/A

​
get.resource

Returns the currently persisted value of the requested resource. **Not available for all calls.
ParameterTypeDescription
N/AN/AN/A
Example: 
context.get.resource();
Response: N/A

​
get.resourceStatus

Gets the HTTP resource status.
ParameterTypeDescription
N/AN/AN/A
Example: 
context.get.resourceStatus();
Response: N/A

​
items.urlHelper.getUrl

Gets the current URL.
ParameterTypeDescription
type
object
config
Example: 
context.items.urlHelper.getUrl(type, object, config);

​
Context Objects Available to All Actions

​
apiContext

Accesses Kibo eCommerce tenant information.
PropertyTypeDescription
baseUrlstringThe base URL for the site.
basePciUrlstringThe base PCI URL for the site.
tenantPodstringThe name of the tenant pod in which the tenant resides.
appClaimsstringThe application claims token.
appKeystringThe application key.
tenantIdintegerUnique identifier for the tenant.
siteIdintegerUnique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.
masterCatalogIdintegerUnique identifier for the master catalog.
catalogIdintegerThe unique identifier for the product catalog. Catalogs are part of a master catalog.
currencyCodestringThe default three-letter ISO currency code for monetary amounts.
previewDatedate/timeThe date and time that the content is being viewed. This might be a future date if the content is previewed with an active date range set in the future.
localeCodestringThe locale code per the country code provided. This code determines the localized content to use and display.
correlationIdstringThe unique identifier of the API request associated with the event action, which might contain multiple actions.
isAuthorizedAsAdminBooleanIndicates whether the Dev Account user is authorized as an admin.
userClaimsstringThe user claims token.
Example: 
context.apiContext.baseUrl;

​
configuration

Receives a JSON response that contains information about the configuration data set in the Action Management JSON editor.
PropertyTypeDescription
VariesobjectCustom fields and values that you can set in the Action Management JSON Editor.
Example: 
context.configuration.customData;