> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Labels (After)
**Related API:** This extension modifies the [Get Labels](/api-reference/shipping/get-labels) operation.
This action manipulates the HTTP request or response after the GetLabels operation occurs in Kibo. GetLabels requests a shipping label for the service type requested and returns a shipment response with the label URL, tracking number, and related package responses. Changes made to the response in this action are applied before Kibo returns the label response to the caller.
## 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 [commerce/catalog/storefront/shipping/GetLabels](/api-overviews/openapi_catalog_storefront_overview) operation.
**HTTP Request**
POST `api/commerce/catalog/storefront/shipping/request-labels?responseFields={responseFields}`
**Request Body**
Use `context.request.body` to read the HTTP request body using this action. Because this is an After action, the request has already been processed and the body is read-only. The request body is a `ShipmentRequest`:
| Property | Type | Description |
| ----------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| carrierId | string | The carrier the label is requested from, such as `ups` or `fedex`. |
| shippingServiceType | string | The selected shipping service type. |
| shipmentRequestType | string | The type of shipment request, such as a return. |
| labelFormat | string | The requested label format, either `LASER` or `THERMAL`. The image formats a carrier actually supports vary by carrier. |
| signatureOption | string | An optional signature option for the shipment. Every package inherits this value; set the option at the package level to override it. |
| isoCurrencyCode | string | The ISO currency code for the shipment. |
| fulfillmentMethod | string | The fulfillment method, `Ship` or `Delivery`. An empty value is treated as `Ship`. |
| relatedOrderId | string | The related order ID. Informational only. |
| relatedOrderNumber | integer | The related order number. Informational only. |
| relatedShipmentNumber | integer | The related shipment number. Informational only. |
| shipment | object | The shipment being labeled, including origin and destination addresses and packages. |
| customAttributes | array | Carrier-specific options, as `key` and `value` pairs. For example, `RequiresDeliveryConfirmation` when using USPS with a non-express mail service type. |
| customerReferences | array | Customer reference values to print on the label. |
| consolidationReferences | array | Consolidation references, each carrying `relatedOrderId`, `relatedOrderNumber`, and `relatedShipmentNumber`. |
**Response Body**
Use `context.response.body` to read and write the HTTP response body using this action. The response body is a `ShipmentResponse`:
| Property | Type | Description |
| ---------------- | ------- | -------------------------------------------------------------------------------------------- |
| isSuccessful | Boolean | Indicates whether the label was generated successfully. |
| trackingNumber | string | The master tracking number for the shipment. |
| shippingTotal | object | The shipping cost, as `currencyCode` and `value`. |
| packageResponses | array | One entry per package, each carrying its own label. See below. |
| customAttributes | array | Carrier-specific attributes returned with the response, as `key` and `value` pairs. |
| messages | array | Notifications or warnings returned by the carrier. Each has `source`, `message`, and `code`. |
Each entry in `packageResponses`:
| Property | Type | Description |
| ---------------- | ------ | ---------------------------------------------------------------------------------- |
| id | string | The identifier for the package. |
| trackingNumber | string | The tracking number for this package. |
| label | object | The shipping label for this package. See below. |
| integratorId | string | The carrier integrator's shipment ID, which is required when generating manifests. |
| customAttributes | array | Carrier-specific attributes for this package, as `key` and `value` pairs. |
The `label` object:
| Property | Type | Description |
| ----------- | ------ | --------------------------------------------------------------------------- |
| imageFormat | string | The format of the label image. |
| imageData | string | The label image, Base64 encoded. |
| labelUrl | string | A URL the label image can be retrieved from, when the carrier provides one. |
## Context Objects Available to All HTTP Actions
### request
Accesses the current HTTP request. In the case of After actions, Kibo has already processed the request, so the request is available for reading only.
| Property | Type | Description |
| -------- | ------- | ------------------------------------------------------------------ |
| params | object | The input parameters to the service or webpage. |
| headers | object | The request headers. |
| method | string | The request method. |
| url | string | The request URL. |
| path | string | The request path. |
| cookies | object | 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.
| Property | Type | Description |
| -------- | ------- | -------------------------------------------------------------------------------------------------------------- |
| header | object | The response header collection. |
| viewData | object | 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.
| Parameter | Type | Description |
| --------- | ------ | --------------- |
| key | string | The header key. |
Example:
```
context.request.get(field);
```
Response:
```
"object"
```
### response.get
Gets a field from the response.
| Parameter | Type | Description |
| --------- | ------ | -------------------- |
| key | object | The field to obtain. |
Example:
```
context.response.get(field);
```
Response:
```
"string"
```
### response.set
Sets the HTTP headers for the response.
| Parameter | Type | Description |
| --------- | ------ | -------------------------------- |
| values | object | The values for the HTTP headers. |
Example:
```
context.response.set({ myCustomHeader: "howdy" });
```
Response: N/A
### response.set2
Updates a field in the response.
| Parameter | Type | Description |
| --------- | ------ | ----------------------- |
| key | string | The key of the field. |
| value | string | The value of the field. |
Example:
```
context.response.set("name", "stuff");
```
Response: N/A
### response.remove
Removes an HTTP header from the response.
| Parameter | Type | Description |
| --------- | ------ | -------------------------- |
| key | string | The HTTP header to remove. |
Example:
```
context.response.remove(header);
```
Response: N/A
### response.redirect
Redirects the incoming URL.
| Parameter | Type | Description |
| --------- | ------ | -------------------- |
| url | string | The 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.
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| N/A | N/A | N/A |
Example:
```
context.response.end();
```
Response: N/A
### get.resource
Returns the currently persisted value of the requested resource. \*\*Not available for all calls.
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| N/A | N/A | N/A |
Example:
```
context.get.resource();
```
Response: N/A
### get.resourceStatus
Gets the HTTP resource status.
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| N/A | N/A | N/A |
Example:
```
context.get.resourceStatus();
```
Response: N/A
### items.urlHelper.getUrl
Gets the current URL.
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| type | | |
| object | | |
| config | | |
Example:
```
context.items.urlHelper.getUrl(type, object, config);
```
## Context Objects Available to All Actions
### apiContext
Accesses Kibo eCommerce tenant information.
| Property | Type | Description |
| ------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| baseUrl | string | The base URL for the site. |
| basePciUrl | string | The base PCI URL for the site. |
| tenantPod | string | The name of the tenant pod in which the tenant resides. |
| appClaims | string | The application claims token. |
| appKey | string | The application key. |
| tenantId | integer | Unique identifier for the tenant. |
| siteId | integer | Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site. |
| masterCatalogId | integer | Unique identifier for the master catalog. |
| catalogId | integer | The unique identifier for the product catalog. Catalogs are part of a master catalog. |
| currencyCode | string | The default three-letter ISO currency code for monetary amounts. |
| previewDate | date/time | The 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. |
| localeCode | string | The locale code per the country code provided. This code determines the localized content to use and display. |
| correlationId | string | The unique identifier of the API request associated with the event action, which might contain multiple actions. |
| isAuthorizedAsAdmin | Boolean | Indicates whether the Dev Account user is authorized as an admin. |
| userClaims | string | The 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.
| Property | Type | Description |
| -------- | ------ | ------------------------------------------------------------------------------- |
| Varies | object | Custom fields and values that you can set in the Action Management JSON Editor. |
Example:
```
context.configuration.customData;
```