Preview only show first 10 pages with watermark. For full document please download

Chapter 1: Plain Paper And Thermal Label Specifications

   EMBED


Share

Transcript

Ship Manager API Label Guide Programmer’s Label Guide January 2006 Legal Terms and Conditions Use of this system constitutes your agreement to the service conditions in the current FedEx Service Guide, available upon request. FedEx will not be responsible for any claim in excess of $100 per package, whether the result of loss, damage, delay, non-delivery, misdelivery, or misinformation, unless you declare a higher value, pay an additional charge, document your actual loss, and file a timely claim. Limitations found in the current FedEx Service Guide apply. Your right to recover from FedEx for any loss, including intrinsic value of the package, loss of sales, income interest, profit, attorney’s fees, cost and other forms of damage whether direct, incidental, consequential, or special is limited to the greater of $100 or the authorized declared value. Recovery cannot exceed actual documented loss. Maximum for items of extraordinary value is $500, e.g. jewelry, precious metals, negotiable instruments, and other items listed in our service guide. Written items must be filed within strict time limits, see current FedEx Service Guide. FedEx will not be liable for loss or damage to prohibited items in any event or for your acts or omissions, including, without limitation, improper or insufficient packaging, securing, marking or addressing, or the acts or omissions, or the recipient, or anyone else with an interest in the package. To obtain information regarding how to file a claim or to obtain a FedEx Service Guide, please call 1.800.Go.FedEx (1.800.463.3339). Confidential and Proprietary The information contained in this Label Guide is confidential and proprietary to FedEx Corporate Services, Inc. and its affiliates (collectively "FedEx"). No part of this Label Guide may be distributed or disclosed in any form to any third party without written permission of FedEx. This Label Guide is provided to you under and its use is subject to the terms and conditions of the FedEx End User and/or Consultant License Agreement. The information in this document may be changed at any time without notice. Any conflict between either of these guides, the FedEx End User and/or Consultant License Agreement, and the FedEx Service Guide shall be governed by the FedEx End User and/or Consultant License Agreement and the FedEx Service Guide, in that order. © 2006 FedEx. FedEx and the FedEx logo are registered service marks. All rights reserved. Unpublished. Table of Contents Table of Contents Introduction ................................................................................................................................................. 2 General Printing Overview and Methods ................................................................................................... 2 What's New .................................................................................................................................................. 3 Referenced Documents .............................................................................................................................. 4 Chapter 1: Plain Paper and Thermal Label Specifications ..................................................................... 5 FedEx Shipping Label................................................................................................................................ 5 Shipping Label Attributes........................................................................................................................... 5 PNG Plain Paper Label.............................................................................................................................. 6 4x6 PNG Label ....................................................................................................................................... 7 Determining Screen Resolution.............................................................................................................. 7 Custom Labels........................................................................................................................................ 8 Label Data Buffer.................................................................................................................................... 8 Using Buffer Data to Print PNG or Thermal Labels................................................................................ 9 Chapter 2: Plain Paper Shipping Label Samples ................................................................................... 13 Plain Paper Types and Documentation ................................................................................................... 13 FedEx Express Shipping Labels........................................................................................................... 13 FedEx Ground Shipping Labels............................................................................................................ 14 Plain Paper Labels – Express .............................................................................................................. 15 Plain Paper Labels – Ground ............................................................................................................... 27 Chapter 3: Thermal Shipping Label Samples......................................................................................... 35 Thermal Label Types and Documentation............................................................................................... 35 FedEx Express Shipping Label ............................................................................................................ 35 FedEx Ground Shipping Labels............................................................................................................ 35 Thermal Labels – FedEx Express ........................................................................................................ 37 Thermal Labels – FedEx Ground ......................................................................................................... 44 Acronyms................................................................................................................................................... 50 Index ........................................................................................................................................................... 51 FedEx Ship Manager® API Label Guide, January 2006 1 Introduction Introduction General Printing Overview and Methods The FedEx ASTRA bar code was designed to accommodate automated scanning and sorting at the stations and hubs. The specifications are written to allow the various scanning systems throughout FedEx to accurately and reliably de-code the information in the bar code. The only way to ensure that the bar codes will work reliably with present and future scanning systems is to make sure that they always meet FedEx minimum standard specifications for print quality. There can be no deviation from these specifications nor can any waiver or modifications be allowed. Print methods: • • • direct thermal thermal transfer LASER (xerographic) or ink jet These print methods are chosen due to their ability to maintain a high and constant quality output throughout the life of the printer and supplies. With these systems, FedEx can check the quality of a customer produced bar code once to verify that the major print components are correct, and be confident that the production bar code will continue to maintain very similar quality. Dot-matrix printers are not permitted. This is because even in the best of conditions, the print quality is highly variable. Some dot matrix printers are capable of printing quality bar codes when the ribbon life and platen pressure are in optimum condition, but in actual production this is nearly impossible to monitor and control. NOTE: While FSM API will support the printing of both plain paper and thermal labels, FedEx does not provide the hardware with which to produce either type label. FedEx Ship Manager® API Label Guide, January 2006 2 What’s New What's New Version Feature Description Jan06 4x6 PNG Label Requirements for the 4x6 PNG Label have been included in this guide. Jan06 PNG Label measurement Measurements for the PNG label have been updated, from 7½” x 5 1/8” to 7”x4.75”. Jan06 PNG Label measurement The code in Example: Sample code implementing Shipping plain paper label in Netscape Browser has been updated to reflect the label size update from 675 to 700 and 467 to 475. FedEx Ship Manager® API Label Guide, January 2006 3 Referenced Documents Referenced Documents Title FedEx Service Guide Version/Revision Current FedEx Ship Manager® API Label Guide, January 2006 Location Call 1.800.Go.FedEx (1.800.463.3339). 4 Chapter 1: Plain Paper and Thermal Label Specifications Chapter 1: Plain Paper and Thermal Label Specifications FedEx Shipping Label To prepare your package for shipment, you need to do the following: 1. Use the Print button in your browser to print this page to your laser printer. 2. Fold the first printed page in half and use as the shipping label. The second page is for your records, and contains both the terms and conditions of shipping, and information useful for tracking your package. 3. After printing the label, place it in a waybill pouch and affix it to your shipment so that the barcode portion of the label can be read and scanned. Shipping Label Attributes Labels can be categorized by three attributes: • • • label type printer type format type The label type is specified with field 1368 in the Ship transaction: • 2 = 2D Common The printer type is specified with field 1369: • • • • • 1 = plain paper (laser) 2 = Eltron Orion 3 = Eltron Eclipse 4 = Zebra ZPL 5 = Unimark The format type is specified with field 1370: • • • • 3 = 4x6¾ thermal with doc-tab at the bottom 4 = 4x6 without doc-tab 5 = plain paper PNG 6 = 4x6¾ thermal with doc-tab at the top The shipping label data will be returned in field 188 in the response transaction. If there is a COD return label, it will be returned in field 411. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a series of command codes that can be serially transmitted to a thermal printer to cause a label to be printed. To ensure fast, reliable parsing of tagged transactions, certain characters are not allowed in the data values of fields. Any occurrences of those characters within a field will have been encoded with other, legal, characters. Thus, after you extract the bytes of data from the label fields (188 and 411), they must be decoded to get the PNG or thermal label image. FedEx Ship Manager® API Label Guide, January 2006 5 Chapter 1: Plain Paper and Thermal Label Specifications PNG Plain Paper Label Printing the plain paper label is different than printing the thermal label. The image orientation dimensions can be manipulated when using a print manager to print a plain paper label. Image Orientation Dimensions are determined when the label is viewed in an imaging editor application. Image orientations for both Shipping and Tracking Signature Proof of Delivery (SPOD) PNG plain paper shipping labels are listed in the corresponding table: PNG Plain Paper Image Orientation Dimensions Print Manager Dimensions Width By Height Shipping PNG (browser and non-browser) 7.0 X 4.75 SPOD PNG (browser and non-browser) 6.8 X 7.6 When the label is printed, it can either increase or decrease in size if the print manager dimensions are not properly set. If the dimensions are increased, the following will result: • • All human readable, barcode data and barcodes will be increased in size and bar codes may become unable to be scanned by the Courier and Ground Operations division. Since the label will need to be folded in half and inserted into the FedEx Pouch, the ASTRA barcode (field 35 in the table below) will need to be fully visible. To ensure full visibility, there should be between 5/16" and ¾" of white space from the bottom of the ASTRA barcode to the fold. If the dimensions are decreased, the following will result: • • All human readable, barcode data and barcodes will be decreased in size. When the label is decreased in size barcodes may become unable to be scanned by the Courier and Ground Operations division. Additionally, if the size is increased or decreased, this may result in the delay of switching the user's application from the validation to production environment. For the Browser based label, the user will need to ensure the appropriate HTML wrapper is attached. The following represents the Page name and File path of a Browser based label: FedEx Ship Manager API Label Page file://C:/Program Files/FedEx/Fed…ples/vb/470004122710.html Reference the Browser based shipping label in the following plain paper shipping label attachments for verbiage orientation. FedEx Ship Manager® API Label Guide, January 2006 6 Chapter 1: Plain Paper and Thermal Label Specifications 4x6 PNG Label FedEx Ship Manager API allows users to request a 4" x 6" PNG graphic of the current FedEx thermal label. These label images can then be embedded into your shipping documentation to alleviate the need for a custom label. The following requirements apply when using the 4"x 6" PNG graphic embedded into your shipping document: • • • • 4"x 6" PNG labels should only be used with peel & stick label stock. 4"x 6" PNG labels that are not on peel & stick label stock will be rejected by the FedEx Ground and FedEx Express label certification teams. Laserjet printers are recommended for printing labels. Inkjet printers should not be used. Most labels created with inkjet printers have been rejected by the label certification teams due to poor print quality. 4"x 6" PNG format should NOT be used on plain paper and will be rejected automatically if submitted for certification on plain paper. 4"x 6" PNG labels should not be printed with a color printer. Most labels created with a color printer have been rejected by the label certification teams due to poor print quality. Determining Screen Resolution Printing the Plain paper shipping labels and SPOD letters require proper sizing. This requires determining the screen resolution selected on the device running the browser. The HTTP parameters and will need to be calculated using the screen DPI values and the desired reproduced screen width and height. Below lists the typical screen resolutions for Windows and Macintosh based on the font size selected. Browser Screen resolution (typical default) Windows using small fonts 96 DPI Windows using large fonts 120 DPI Macintosh 72 DPI Examples of populating HTML tag Height and Width values: Width (pixels) = ScreenDPI * (desired image reproduced width) Height (pixels = ScreenDPI * (desired image reproduced height) Example: Sample code implementing Shipping plain paper label in Netscape Browser: Example for getting screen resolution using Microsoft MFC library: DC hDC = CreateDC( “DISPLAY”, NULL, NULL, NULL ); int DPI = getDeviceCaps ( hDC, LOGPIXELSX); DeleteDC(hDC); Custom Labels FedEx does not support the creation or use of a custom label for either Ship Manager API Ground or Express shipping. Label Data Buffer Upon a successful Ship a Package Request Transaction, the following buffer is returned: NOTE: This example does NOT include all possible fields of the Ship Request and Reply transactions. This is only an example. The label type generated by this example data string is a PNG label. Sends to FedEx: 0,"021"4,"ABC Company"5,"1234 Main Street"7,"Memphis"8,"TN"9,"38101"11,"XYZ Company"13,"9876 Southwest Street"15,"New York"16,"NY"17,"10042"18,"7035551212"23,"1"50,"US"74,"US"75,"LBS"117,"U S"183,"901555121 2"1115,"123456"1116,"I"1273,"02"1274,"01"1401,"2.0"3025,"FDXE"10,"12345 6789"498,"123456 7"24,"20000531"99,"" FedEx Ship Manager® API Label Guide, January 2006 8 Chapter 1: Plain Paper and Thermal Label Specifications Received from FedEx: 0,"121"33,"AA"1136,"XY"30,"XY AYZA"29,"470001338040"526,"0201"1402,"2.0"1419,"25.22"1416,"24.25"1417, ".97"1090,"USD"1 089,"01552"1092,"5"65,"40048946120000014700013380402018"194,"THU"195,"E WR"409,"01JUN00" 431,"N"188,”