# ACI Parcel Label API

# Getting Started with Label API

The ACI Label API offers clients a convenient way to request per package labels that are compliant with ACI�s service offerings. The labels include all necessary elements to complete last mile delivery to the end customer. 

The Label API workflow consists of three basic operations:  

- `requestLabel`: Client submits package information and receives a label object in return.  

- `reprintLabel`: Client may retrieve a previously-generated label object for reprinting. 

- `printLabel`: Clients who require an alternative label format, specifically PDF or PNG label formats. 

## Label Types
The ACI Label may return several different label types depending on the package�s physical attributes, contents, and delivery geography. These returned labels will be compliant with the ACI delivery service model requirements. The following list defines the most common templates: 

1. **ACI Direct Label**: a label compliant with the ACI Direct service model. This template is similar in many ways to a USPS label template but uses a custom ACI Tracking Number value. The template includes all necessary elements (barcodes and markings) and ACI sort code values.  

2. **USPS Label**: a label compliant with ACI�s USPS delivery service model. This template is compliant with the USPS parcel label guidelines and IMPB barcode spec. The template includes all necessary elements (barcodes and endorsements) and ACI sort code values. 

3. **USPS Hazmat Label**: all packages that contain hazardous materials are required to be flagged as �Hazmat� in the request object. In all cases these packages will receive a compliant USPS label with all necessary markings and attributes. 

> **_NOTE:_** Although the ACI Label API may return an array of label types the request JSON object definition is the same for all label types.

## Label Formats
The ACI Label API response object contains, by default, a ZPL label object. Clients may request a PNG or PDF version of the label using the `printLabel` Operation described in this document. 

## Change Log
- 20240903 v2.1: Added the `serviceType` attribute in the `requestLabel` JSON response object. This has two enumerated values: "USPS" to indicate a USPS label was generated and "ACIDirect" when an ACI Direct label is generated. Updated the schema and example sections. 

Version: 2.1.0

## Servers

```
https://api.acilogistix.com/aciparcellabel/v1
```

## Security

### apiKey

Type: apiKey
In: header
Name: aci-apikey

## Download OpenAPI description

[ACI Parcel Label API](https://developer.fastgroup.co/_spec/labelapi/swagger.yaml)

## Other

### Manifest a label

 - [POST /manifestlabel](https://developer.fastgroup.co/labelapi/swagger/other/manifestlabel.md)

### Reprint a label

 - [POST /reprintlabel](https://developer.fastgroup.co/labelapi/swagger/other/reprintlabel.md)

### Request a label

 - [POST /requestlabel](https://developer.fastgroup.co/labelapi/swagger/other/requestlabel.md): Clients submit a single request object for each package. The request object must include common package attributes.

The API will validate each label request.  Passing requests receive a label response object.