Generate GS1/UCC Labels via UCC Labels Generator

The UCC Labels Generator allows you to generate GS1/UCC labels in the ZPL file format.

In this article

• Requirements
• Connection Steps
• API Call
• Example

Requirements

• Pipe17 Account - Ensure that you have a Pipe17 account. If you do not yet have a Pipe17 account, book a demo with a Pipe17 team member to get started.

Connection Steps

1. Navigate to the Integrations tab in your Pipe17 portal and click on "Add Integration" in the upper right corner.
2. Find the UCC Labels Generator Connector and Click on Add.
3. The Connection Flow Settings page is displayed, leave these toggles turned off for now. We will revisit these later in the guide.
4. Click Next.
5. Provide a secure Access Key and store it in a secure location. You will be using this to make the API calls.
6. Click Connect.

API Call

The API call will be in this format:

curl --location 'https://connector-webhooks-master.service.pipe17.com/connector_orderful_labels/labels/<IntegrationId>'  \
--header 'x-api-key: <AccessKey>' \
--header 'Content-Type: application/json' \
--data '{
<JSON_BODY>
}'

You will need 3 parameters to make the API call:

1. Access Key - this is the same key you entered when adding the integration on your account.

The AccessKey in the example screenshot below will be: abcdef12345

2. The Integration Id for the UCC labels generator integration added to your account.

Navigate to the UCC labels generator integration in your account and go to the Connection tab.

You will find a hexadecimal number at the end of your browser URL, this is your integration id.

In the example screenshot below the IntegrationId is: 07bcc0a124418354

3. JSON_BODY will be the data passed to Orderful in JSON format to generate the Label.

To find the available fields navigate to the Mappings tab in UCC Labels Generator connector, select 'Labels' from the Entity dropdown list, and click on the 'To UCC Labels Generator' radio button.

The fields on the left side of the mapping table represent the fields that can be set.

In the screenshot below you can ignore `sourcedoc`, the field names seen in the screenshot would be:

retailer, location.name, location.address1

NOTE: The value of 'retailer' should be one of the following values. Contact your Pipe17 representative to get a new retailer added.

• ARMY_AND_AIR_FORCE_EXCHANGE_SERVICE
• BLOOMINGDALES
• BURLINGTON_COAT_FACTORY
• FISHER_SCIENTIFIC
• FISHER_SCIENTIFIC_NON_EDI
• HEB_MIXED
• HEB_STANDARD
• MACYS

• MARINE_CORPS_EXCHANGE

• NEIMAN_MARCUS
• NORDSTROM
• SEPHORA
• SPROUTS_FARMERS_MARKET
• THE_HOME_DEPOT
• VITAMIN_SHOPPE
• VITAMIN_SHOPPE_MIXED
• WALGREENS
• WALMART_CASE_DOMESTIC

Example

Below example includes the list of all available fields:

curl --location 'https://connector-webhooks-master.service.pipe17.com/connector_orderful_labels/labels/07bcc0a124418354' \
--header 'x-api-key: abcdef12345' \
--header 'Content-Type: application/json' \
--data '{
"retailer" : "NORDSTROM",
"location": {
"name": "West",
"address1": "2101 4th Ave",
"address2": "Marine Ct",
"city": "Seattle",
"stateOrProvince": "WA",
"zipCodeOrPostalCode": "98121"
},
"shippingAddress": {
"companyName": "Acme Intl",
"address1": "3101 5th Ave",
"address2": "Beach Dr",
"city": "Seattle",
"stateOrProvince": "WA",
"zipCodeOrPostalCode": "98121"
},
"shippingCarrier": "UPS",
"transport": {
"billOfLadingNumber": "BOL123",
"proNumber": "455",
"ssccCode": "SSCC334"
},
"extOrderId": "ST1099",
"destination": {
"department": "Clothing",
"distributionCenter": "West",
"store": "Main"
},
"casepack": "3",
"cartonMax": "2",
"cartonNumber": "1"
}'

Copy paste the response from API call into a text file and save it with the extension .zpl

See the attached file named example_label.zpl

You can view or print the label by using an online service like https://labelary.com/viewer.html

The label generated via above call will look as below: