Systems and methods for application programming interfaces for shipping services

DESCRIPTION OF THE INVENTION

[0002] 1 Field of the Invention

[0003] This invention relates to providing an internet customer with information relative to shipping services using application programming interfaces (“API's” or “Web Tools API”) supplied by the United States Postal Service (“USPS”). The API's are designed to allow electronic commerce (“e-commerce entities”) to generate requests and to send them over the network to servers for access to USPS shipping information. E-commerce entities may include multi-carriers, electronic retailers (“e-tailers”), electronic shopping malls, auction houses, or third party vendors that buy in broker services over a network. The network is preferably the Internet; however, any type of network known to those skilled in the art may be used.

[0004] 2. Background of the Invention

[0005] Currently, a person desiring to send a package to a recipient may take the package to a mailing point where she is provided information about the various shipping options and costs of shipping. The person selects a shipping option, pays the mailer for the cost of shipping, receives a label that is applied to the package, and the package is then placed into a mail stream. One such example of a mail stream is the mail stream provided by the USPS. Alternatively, a person may contact a mailing company. The mailing company provides to the person information about the various shipping options and costs of shipping. The person selects a shipping option, pays the mailing company for the cost of shipping, and gives the package to a mailer associated with the mailing company. The mailer then generates a label and applies it to the package. Thereafter, the mailer places the package into the mail stream. Either way, the person must wait to be informed of the cost of mailing the package and/or wait to pay for the mailing label before the package may be sent.

[0006] With the advent of e-commerce, electronic shoppers (“e-shoppers”) may make purchases from e-commerce entities over the network. It is advantageous to the e-commerce entities to have e-shoppers to stay on their web sites and buy more items, instead of having to make separate arrangements for receiving information for shipping or returning a purchased item. It is advantageous to the e-shoppers to have the ability to receive shipping labels electronically for application to a packaged item or to request that an e-commerce entity package and ship a purchased item.

[0007] It is accordingly an object of an embodiment of the invention to provide e-commerce entities with access to USPS shipping services information. The e-commerce entities may in turn provide such information to e-shoppers, thereby allowing e-shoppers to request and receive information about the various shipping options and the cost of mailing an item. In addition, the e-shoppers may purchase mailing labels, delivery confirmation labels, or request merchandise return labels. The shipping options may include services such as Express Mail®, Priority Mail®, and Parcel Post™, etc. The shipping services information may include domestic and international postal rates, service standards, addressing information, mailing labels, merchandise return labels, delivery confirmation labels, etc.

[0008] This is achieved by providing to e-commerce entities a collection of API's, which provide access to servers having USPS shipping information. The servers may include, for example, one or more USPS servers. These API's may be coded in a language which is independent of operating system and hardware implementation. Preferably, the API's are implemented in Extensible Markup Language (“XML”); however, they are not limited to language and could be written in any programming language known to those skilled in the art.

[0009] An e-commerce entity may utilize the API's to make a request to a USPS server over the network for shipping information. For convenience, the USPS server will be referred to herein as the “Web Tools API Server.” The Web Tools API server receives the request, generates a response to the request, and sends the response over the network to the e-commerce entity. The response may include the requested shipping information.

SUMMARY OF THE INVENTION

[0010] In accordance with the invention, systems and methods are disclosed for providing shipping services information over a network by providing instructions to a first server from a second server which permits the first server to access the shipping services information residing on the second server over the network. The first server receives a request from a client for the shipping services information residing on the second server. Thereafter, the second server provides the requested shipping services information from the second server to the client through the first server.

[0011] It is to be understood that both the foregoing general description and the following detailed description are exemplary and explanatory only and are not restrictive of the invention, as claimed.

[0012] The accompanying drawings, which are incorporated in and constitute a part of this specification, illustrate embodiments of the invention and together with the description, serve to explain the principles of the invention.

BRIEF DESCRIPTION OF THE DRAWINGS

[0013]
FIG. 1 is a block diagram of a system consistent with the present invention.

[0014]
FIG. 2 is a block diagram of an end-user/client system, e-commerce server system, and Web Tools API server system consistent with the present invention.

[0015]
FIG. 3 is a flowchart showing a method for providing shipping services information over a network.

[0016]
FIG. 4 is a block diagram showing data exchange occurring within a system for a merchandise return API.

[0017]

FIG. 4

a
is a diagram of a merchandise return label including a delivery confirmation barcode.

[0018]
FIG. 5 is a flowchart showing a method for providing an electronic merchandise return label.

[0019]
FIG. 6 is a block diagram showing data exchange occurring within a system for a rate calculation API.

[0020]
FIG. 7 is a flowchart showing a method for providing rate calculation information.

[0021]
FIG. 8 is a block diagram showing data exchange occurring within a system for a tracking/confirmation API.

[0022]
FIG. 9 is a flowchart showing a method for providing tracking/confirmation information.

[0023]
FIG. 10 is a block diagram showing data exchange occurring within a system for a service/commitment standards API.

[0024]
FIG. 11 is a flowchart showing a method for providing service/commitment standards information.

[0025]
FIG. 12 is a block diagram showing data exchange occurring within a system for a delivery confirmation service API.

[0026]
FIG. 13 is a flowchart showing a method for providing a delivery confirmation label.

[0027]
FIG. 14 is a block diagram showing data exchange occurring within a system for a courtesy reply label API.

[0028]
FIG. 15 is a flowchart showing a method for providing a courtesy reply label.

[0029]
FIG. 16 is a block diagram showing data exchange occurring within a system for an address information service API.

[0030]
FIG. 17 is a flowchart showing a method for providing address information.

DESCRIPTION OF THE EMBODIMENTS

[0031] Reference will now be made in detail to an exemplary embodiment of the invention, an example of which is illustrated in the accompanying drawings. Wherever possible, the same reference numbers will be used throughout the drawings to refer to the same or like parts. For convenience, an e-shopper will be described herein as an “end-user.”

[0032]
FIG. 1 is a block diagram of an exemplary system with which the invention may be implemented. System 100 may include a plurality of end-user/client systems 101, a network 110, a plurality of e-commerce server systems 120, one or more Web Tools API server systems 130, and one or more shipping information databases 150. In addition, system 100 may optionally include one or more tracking servers 140 for tracking the delivery status of mailed items in a mail stream, and one or more tracking databases 160. Network 110 may include, for example, a Local Area Network (LAN), a Wide-Area Network (WAN), a wireless network, the Internet, an intranet, and/or any other network or communication medium known to one of ordinary skill in the relevant art.

[0033]
FIG. 2 is a block diagram of an end-user/client system 101, e-commerce server system 120, and Web Tools API server system 130 consistent with the present invention. End-user/client system 101 may include a processor (“CPU”) 225, which connects over a bus 217 to a memory 200, a mass storage 220, and a network interface module 230. Memory 200 may include an user interface module 205, a browser software module 210, and an operating system 215.

[0034] Operation of end-user/client system 101 is generally controlled and coordinated by operating system software 215. Operating system 215 controls allocation of system resources and performs tasks, such as memory management, process scheduling, networking, and services, among other things.

[0035] Mass storage 220 may include a computer-readable medium, such as a disk drive and a compact disc (“CD”) drive or a read/write CD drive. From the CD drive or the read/write CD drive, software and data may be loaded onto the disk drive, which may then be copied into memory 200. Similarly, software and data in memory 200 may be copied onto the disk drive, which may then be loaded onto a read/write CD drive.

[0036] Network interface module 230 may include hardware and software for sending and receiving data over network 110. End-user/client system 101 may communicate with an e-commerce server system 120 over network 110 through network interface module 230.

[0037] E-commerce server system 120 may include a processor (“CPU”) 257, which connects over a bus 247 to a memory 235, a mass storage 255, and a network interface module 260. Memory 235 may include one or more API modules 240 in the Web Tools API suite integrated with an e-commerce entity's application software, and operating system 245, each of which will be described below in detail.

[0038] Operation of e-commerce server system 120 is generally controlled and coordinated by operating system software 245. Operating system 245 controls allocation of system resources and performs tasks, such as memory management, process scheduling, networking, and services, among other things.

[0039] Mass storage 255 may include a computer-readable medium, such as a disk drive and a CD drive or a read/write CD drive. From the CD drive or the read/write CD drive, software and data may be loaded onto the disk drive, which may then be copied into memory 235. Similarly, software and data in memory 235 may be copied onto the disk drive, which may then be loaded onto a read/write CD drive.

[0040] Network interface module 260 may include hardware and software for sending and receiving data over network 110. E-commerce server system 120 may communicate with a plurality of end-user/client systems 101 and/or one or more Web Tools API server systems 130 over network 110 through network interface module 260. Alternatively, e-commerce server system 120 may communicate with one or more Web Tools API server systems 130 over network 110 through a firewall 265 via network interface module 260.

[0041] Web Tools API server system 130 may include a processor (“CPU”) 293, which connects over a bus 275 to a memory 270, a mass storage 290, a network interface module 295, and one or more shipping information databases 150. Memory 270 may include API server module 277, standard API modules 285, and operating system 280, each of which will be described below in detail.

[0042] Operation of Web Tools API server system 130 is generally controlled and coordinated by operating system software 280. Operating system 280 controls allocation of system resources and performs tasks, such as memory management, process scheduling, networking, and services, among other things.

[0043] Mass storage 290 may include a computer-readable medium, such as a disk drive and a CD drive or a read/write CD drive. From the CD drive or the read/write CD drive, software and data may be loaded onto the disk drive, which-may then be copied into memory 270. Similarly, software and data in memory 270 may be copied onto the disk drive, which may then be loaded onto a read/write CD drive.

[0044] Network interface module 295 may include hardware and software for sending and receiving data over network 110. Web Tools API server system 130 may communicate with a plurality of e-commerce server systems 120 over network 110 through network interface module 295. Alternatively, Web Tools API server system 130 may communicate with a plurality of e-commerce server systems 120 over network 110 through a firewall 265 via network interface module 295. In addition, the Web Tools API server system 130 may send and/or receive shipping information to/from one or more shipping information databases 150. Optionally, the Web Tools API server system 130 may communicate with one or more tracking servers 140 over network 110 through network interface module 295 to request and receive information from one or more tracking databases 160.

[0045] In one example, an e-commerce entity may make a request to an API provider for one or more API modules in the Web Tools API suite. The API provider may include, for example, the USPS. The e-commerce entity registers with the API provider and receives a username and password for connecting to a Web Tools API Server 130. The API provider may send the requested API modules to the e-commerce entity by any known delivery method. For example, the API provider may send the requested API modules by an email, or by placing the API modules on a CD or floppy disk and mailing them to the e-commerce entity. In another example, the API provider may access an API server module 277 on a Web Tools API server 130 to send the requested API modules over a network 110 to an e-commerce server 120 specified by the e-commerce entity. Thereafter, the e-commerce entity may integrate the API modules with its application software on one or more e-commerce servers 120 to generate Extensible Markup Language (“XML”) requests to the Web Tools API server 130 for shipping information. The API modules may provide for processing multiple requests within a single transaction.

[0046] Once the API modules are integrated with application software of an e-commerce server 120, an end-user 101 may access the e-commerce server 120 over a network 110 through a client system 101 and make a request for information, for example, a request for a merchandise return label. E-commerce server 120 generates an XML request based on the request from the end-user. Thereafter, e-commerce server 120 sends the request to the Web Tools API server 130. Web Tools API server 130 receives the request and calls an appropriate standard API module 285 to processes the request. Once the request is processed, Web Tools API server 130 sends an XML response back to e-commerce server 120. E-commerce server 120 may send the XML response back to the end-user at client system 101 through network 110. If e-commerce server 120 detects an error condition in the XML response, it may notify the end-user of the error condition. Otherwise, e-commerce server 120 retrieves the requested information from the XML response and sends it to the end-user, in this example, the merchandise return label is sent to the end-user.

[0047]
FIG. 3 is a flowchart showing a method for providing shipping services information over a network. The discussion that follows is a more detailed description of the processing performed by e-commerce server 120 and Web Tools API server 130. An e-commerce server 120 receives a request from an end-user through a client system 101 (stage 300). E-commerce server 120 generates an XML request based on the request from the end-user (stage 310). The XML request may include a tag that specifies a particular API in the standard API modules 285 to use in processing the request, and one or more tags that represent information relevant for processing the request. The format of an XML request for each API is described below in detail. In addition, the USPS may provide to an e-commerce entity example integration source code that may be used by an e-commerce server 120 to generate XML requests.

[0048] Next, e-commerce server 120 may make a network connection to a Web Tools API server 130 (stage 320). The USPS may provide to an e-commerce entity example integration source code that may be used by an e-commerce server 120 to-connect to a Web Tools API server 130.

[0049] Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110 (stage 330). The Web Tools API server 130 receives the XML request and determines, based on the XML request, which API within the standard API modules 285 to call to process the request. Next, API server module 277 calls the applicable API in the standard API modules 285 to process the request, and sends an XML response to the e-commerce server 120 through network 110. E-commerce server 120 receives the XML response from the Web Tools API server 130 through network 110 (stage 340). The XML response may include one or more tags that specify a type for the response, and one or more tags that include the requested information. The format of an XML response for each API is described below in detail.

[0050] E-commerce server 120 determines, based on the XML response, whether an error occurred during the processing of the XML request by the Web Tools API server 130 (stage 350). If an error occurred (“Yes”), e-commerce server 120 generates an error status, based on the XML response, and sends it to client system 101 through network 110 (stage 370). Client system 101 may display the error status to the end-user through browser software module 210. Otherwise (“No”), e-commerce server 120 may generate a reply response, based on the XML response, and send it to client system 101 through network 110 (stage 360). Client system 101 may display the reply response to the end-user through browser software module 210 or user interface module 205. Alternatively, e-commerce server 120 sends the XML response received from Web Tools API server 130 to client system 101 through network 110.

[0051] FIGS. 4-17 describe API's that may be included in the Web Tools API suite. However, the API's are not limited to the API's described herein.

[0052]
FIG. 4 is a block diagram showing data exchange occurring within a system for a merchandise return API. Specifically, FIG. 4 shows an example of the flow of information for a merchandise return API, which is a merchandise return solution set up for e-commerce entity's that have customers who need to return a package that they've purchased. The merchandise return API has been specifically designed for e-commerce entities that elect to provide to their customers a pre-paid postage return label. This API facilitates returns by allowing e-commerce entities to request and receive a merchandise return label for merchandise return, which the e-commerce entity can provide to its customers or end-users through any known distribution medium, such as email, regular mail, fax, etc.

[0053] As shown in. FIG. 4, an end-user accesses an e-commerce server 120 over a network 110 through a client system 101 and makes a request to return a purchased item to a retailer. E-commerce server 120 may provide to the end-user, based on information supplied by the end-user, a list of items that were purchased. The end-user may select from the list one or more items to return. For purposes of this example, the end-user selects a single item. Thereafter, e-commerce server 120 may determine whether the end-user has permission to return the selected item, and if so, whether the item requires insurance for shipping. If the end-user has permission to return the selected item to the retailer, e-commerce server 120 generates an XML request based on the information supplied by the end-user and the selected item.

[0054] The request includes, for example, the name and address of the customer who purchased the item, name and address of the retailer who sold the item, service type, permit information, Postage Due Unit (“PDU”) information, label image type, insurance value, package weight, return materials authorization (“RMA”), and mailing acknowledgement. The mailing acknowledgement is an optional service that provides a customer with an acknowledgement when an item is returned/delivered to a retailer. The e-commerce entity may be required to register with the USPS to receive a user ID and password to allow e-commerce server 120 to provide a valid user ID and password in each XML request.

[0055] For example, the XML request includes the following tags:

1InputXML TagValues AllowedRequest<EMRSV2.0Request . . .Input tagexactly aspresented.User ID. . . USERID=Use user ID“userid” . . .provided withregistration.Password. . . PASSWORD=Use password“password”>provided withregistration.Customer's<CustomerName>MaximumNamecharactersallowed: 32Customer's<CustomerAddress>MaximumAddresscharactersallowed: 24Customer's<CustomerCity>MaximumCitycharactersallowed: 21Customer's<CustomerState>Maximum charactersStateallowed: 2Customer's<CustomerZip5>Input tagZIP Code ®exactly aspresented,not all caps.Maximumcharactersallowed: 5Retailer's<RetailerName>MaximumNamecharactersallowed: 32Retailer's<RetailerAddress>MaximumAddresscharactersallowed: 32Post Office<PermitNumber>Input permitPermitnumberNumberprovidedby your localpost office.City Issuing<PermitIssuingPOCity>MaximumPost OfficecharactersPermitallowed: 15State Issuing<PermitIssuingPOState>MaximumPost OfficecharactersPermitallowed: 2ZIP Code ® of<PermitIssuingPOZip5>Input tagPost Officeexactly asIssuing Permitpresented,not all caps.Maximumcharactersallowed: 5Postage Due<PDUPOBox>MaximumUnit PO Boxcharactersallowed: 24Postage Due<PDUCity>MaximumUnit Citycharactersallowed: 15Postage Due<PDUState>MaximumUnit Statecharactersallowed: 2Postage Due<PDUZip5>Input tagUnit ZIPexactly asCode ®presented,not all caps.Maximumcharactersallowed: 5Postage Due<PDUZip4>Input tagUnit ZIPexactly asCode ® + 4presented,not all caps.Maximumcharactersallowed: 4Service Type<ServiceType>Valid entriesRequestedare: “FirstClass,”“Priority,”“Parcel Post,”“BoundPrinted Matter,”“SpecialStandard,” or“Library Rate.”Delivery<DeliveryConfirmation>The valid valuesConfirmation ™are “True”Serviceor “False”Insurance<InsuranceValue>Enter numericDesired bycurrency withPermit Holderdollars and cents(no dollarsign). If insur-ance is notrequired, leavevalue blank.A value of “0.00”will result inan error beingreturned.Unique Parcel<MailingAckPackageID>E-commerceIdentificationentity assign-Numberable number.Maximumcharactersallowed: 24.Value entryis optional.Refer to“Mailing Ack-nowledgement”below.Package<WeightInPounds>Value must beWeight innumeric. MaximumPoundscharactersallowed: 2.Package<WeightinOunces>Value must beWeight innumeric. MaximumOuncescharactersallowed: 4.Return<RMA>Value entryMaterialsis optional.AuthorizationLabel Image<ImageType>Either of twoTypevalues allowed:“TIF” or“PDF”

[0056] Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110 (stage 330). Web Tools API server 130 receives the XML request, and may call a merchandise return API module 285 to generate a merchandise return label based on the XML request. The merchandise return label may, for example, be in Portable Document Format (“PDF”) or Tagged Image File (“TIF”) format, which is determined by the value supplied in the Label Image Type tag in the XML request. Next, merchandise return API module 285 generates an XML response, which includes the merchandise return label. The merchandise return label may include forwarding information such as, address of the sender, address of a recipient, barcode, RMA, and an indication of pre-paid postage.

[0057] For example, the XML response includes the following tags:

2OutputXML TagType of Response<EMRSV2.0Response>Zone<Zone>Image of Merchandise Return Label<MerchandiseReturnLabel>Insurance Cost<InsuranceCost>

[0058] However, if Web Tools API server 130 detects an error condition in processing a request from an e-commerce entity, the XML response includes information about the error. Thus, if Web Tools API server 130 detects an error condition, it may generate an XML response with tags that may have the following format:

3<Error><Number></Number><Source></Source><Description></Description><HelpFile></HelpFile><HelpContext></HelpContext></Error>

[0059] The number tag includes an error number generated by Web Tools API server 130. The source tag includes information about the source code component and API that generated the error condition on Web Tools API server 130. The description tag includes a description of the error.

[0060] After merchandise return API module 285 generates the XML response, Web Tools API server 130 sends the XML response to the e-commerce server 120 through network 110. E-commerce server 120 receives the XML response and extracts the merchandise return label. E-commerce server 120 may send the merchandise return label to client system 101 through network 110. Client system 101 may display the merchandise return label to the end-user. The end-user may then print the merchandise return label and attach it to the packaged item. Alternatively, e-commerce server 120 may fax the merchandise return label to the end-user, email the merchandise return label to the end-user, or mail it to the end-user.

[0061]

FIG. 4

a
is a diagram of a merchandise return label 410 generated by Web Tools API server 130. As shown in FIG. 4a, the merchandise return label 410 includes a return label 420 having forwarding information such as, address of a sender 425, address of a recipient 445, delivery confirmation barcode 430, RMA 440, and an indication of pre-paid postage 435. The postage for the return label is pre-paid by the e-commerce entity or the retailer, so the end-user is not required to apply postage to the return label. Optionally, the merchandise return label may include a mailing acknowledgment form 450 coupled to the return label 420 and a mailing acknowledgement identification number 415 is included on the mailing acknowledgment form 450 and the return label 420.

[0062]
FIG. 5 is a flowchart showing a method for providing an electronic merchandise return label. As shown in FIG. 5, an end-user accesses an e-commerce server 120 through a client system 101, and makes a request to return merchandise to a retailer (stage 500). E-commerce server 120 may display to the end-user, based on information supplied by the end-user, a list of items of merchandise that were purchased from the retailer (stage 505). The end-user selects from the list an item of merchandise to return (stage 510). Thereafter, e-commerce server 120 determines whether the end-user has permission to return the selected merchandise by requesting approval from the retailer (stage 515). If the end-user does not have permission to return the merchandise to the retailer (“No”), e-commerce server 120 sends a message to the end-user informing her that her request is denied and the transaction stops (stage 520). Otherwise (“Yes”), the end-user has permission to return the merchandise to the retailer. E-commerce server 120 generates an XML request based on the information supplied by the end-user and the selected merchandise (stage 525).

[0063] Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server-130 through network 110 (stage 530). Web Tools API server 130 receives the XML request (stage 535). Next, Web Tools API server 130 may call a merchandise return API module 285 to generate an XML response, which includes the merchandise return label (stage 540). Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110 (stage 545). E-commerce server receives the XML response and extracts the merchandise return label (stage 550). E-commerce server 120 sends the merchandise return label to the end-user at client system 101 through network 110 (stage 555). Client system 101 displays the merchandise return label to the end-user. The end-user may then print the merchandise return label and attach it to the packaged item. Alternatively, e-commerce server 120 may fax the merchandise return label to the end-user, email the merchandise return label to the end-user, or mail it to the end-user.

[0064] In an alternate example, the e-commerce entity may request and receive a courtesy reply label instead of a merchandise return label. However, unlike the merchandise return labels, postage is not pre-paid. The courtesy reply label will be described below in detail.

[0065]
FIG. 6 is a block diagram showing data exchange occurring within a system for a rate calculation API. The rate calculation API's provide access to domestic and/or international rates for various shipping rates such as Express Mail®, Priority Mail®, and Parcel Post™, to assist in making shipping decisions.

[0066] As shown in FIG. 6, an end-user accesses an e-commerce server 120 over a network 110 through a client system 101 and makes a request for rate information for shipping a package. In addition, the end-user supplies information about the package to be shipped, the point of destination, and in the case of domestic mailing, the point of origin. E-commerce server 120 generates an XML request for the rate information based on the information supplied by the end-user.

[0067] For example, the XML request for domestic rates includes the following tags:

4InputXML TagValues AllowedType of<RateRequest . . .Input tagRequestexactly aspresented.User ID. . . USERID=Use user ID“userid” . . .provided withregistration.Password. . . PASSWORD=Use password“password”>provided withregistration.Package<Package ID=“#”>No restrictionsID Numberon number ortype of characters.Type of<Service>The service typeServicemust be one ofRequestedthe following:“Express,”“Priority,”or “Parcel.”The API validatesthe entry tothe service type.Origination<ZipOrigination>Input tag exactlyZIP Code ®as presented.ZIP Codes ®must be valid.Maximumcharactersallowed: 5Destination<ZipDestination>Input tag exactlyZIP Code ®as presented.ZIP Codes ®must be valid.Maximumcharactersallowed: 5Package<Pounds>Value must beWeight innumeric.PoundsPackage weightcannot exceed70 pounds.Parcel Post ™packages mustweigh at least1 pound.Package<Ounces>Value must beWeight innumeric.OuncesPackage weightcannot exceed70 pounds.Parcel Post ™packages mustweigh at least1 pound.Shipping<Container>See below forContainervalid entries.Package<Size>Valid entries are:Size“Regular,”“Large,” and“Oversize.”Machinable<Machinable>The Machinable tagis required forParcel Post ™only. Thevalue enteredmust be either“True” or“False”

[0068] For example, the XML request for international rates includes the following tags:

5InputXML TagValues AllowedType of<IntlRateRequest . . .Input tag exactlyRequestas presented.User ID. . . USERID=Use user ID provided“userid” . . .with registration.Password. . . PASSWORD=Use password provided“password”>with registration.Package<Package ID=“#”>No restriction on numberID Numberor typeof characters.Weight of<Pounds>Value must be numeric.packagePackage weight cannot(pounds)exceed 70 pounds.Parcel Post ™ packagesmust weigh at least 1 pound.Weight of<Ounces>Value must be numeric.packagePackage weight cannot(ounces)exceed 70 pounds.Parcel Post ™ packagesmust weigh at least 1 pound.Type of<MailType>The following are validMailinternational mail types:“letters or letter packages”“other packages”“postcards or aerogrammes”“regular printed matter”“books or sheet music”“publishers' periodicals”“matter for the blind”Destination<Country>Entries must be from the USPSCountrylist of valid countries.

[0069] Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110. Web Tools API server 130 receives the XML request and calls a rate calculation API module 285 to process the request. Rate calculation API module 285 queries a shipping information database 150 for the requested rate information based on the XML request. Next, rate calculation API module 285 generates an XML response based on results of information returned from the query. For example, if the request is for domestic rate information, the XML response includes the following tags:

6OutputXML TagCommentsType of Response<RateResponse>Package Identification<PackageNumberID=“#”>Type of Service<Service>RequiredOrigination ZIP Code ®<ZipOrigination>Destination ZIP Code ®<ZipDestination>Package Weight<Pounds>(Pounds)Package Weight<Ounces>(Ounces)Shipping Container<Container>Package Size<Size>Postage Rate Charged<Postage>Postal Zone<Zone>U.S. Postal ServiceZones are used forPriority Mail ®packages over 5 lbs.

[0070] For example, if the request is for international rate information, the XML response includes the following tags:

7OutputXML TagCommentsType of Response<IntlRateResponse>Package Identification<Package ID=“#”>NumberServices Identification<Service ID=“#”>For each packageNumbersubmitted, theavailable servicesfor that packageare returned with aseparateidentificationnumber.Weight of package<Pounds>(pounds)Weight of package<Ounces>(ounces)Type of Mail<MailType>Destination Country<Country>Postage Rate Charged<Postage>Service Commitments<SVCCommitments>Service Description<SvcDescription>Maximum Dimensions of<MaxDimensions>Package AllowedMaximum Weight of<MaxWeight>Package Allowed

[0071] After rate calculation API module 285 generates the XML response, Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110. E-commerce server 120 receives the XML response and extracts the rate information. E-commerce server 120 sends the rate information to the end-user at client system 101 through network 110. Client system 101 may display the rate information to the end-user.

[0072]
FIG. 7 is a flowchart showing a method for providing rate calculation information. As shown in FIG. 7, an end-user accesses an e-commerce server 120 through a client system 101 (stage 700). The end-user makes a request to e-commerce server 120 for rate information for shipping a package, and supplies information about the package to be shipped, the point of destination, and in the case of domestic mailing, the point of origin (stage 710). E-commerce server 120 generates an XML request for the rate information based on the information supplied by the end-user (stage 720). Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110 (stage 730).

[0073] Web Tools API server 130 receives the XML request (stage 740). Thereafter, Web Tools API server 130 calls a rate calculation API module 285 to process the request (stage 750). Rate calculation API module 285 queries a shipping information database 150 for the requested rate information based on the XML request. Next, rate calculation API module 285 generates an XML response based on results of information returned from the query. The XML response includes the requested rate information. Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110 (stage 760). E-commerce server 120 receives the XML response and extracts the rate information. E-commerce server 120 sends the rate information to the end-user at client system 101 through network 110, (stage 760). Client system 101 may display the rate information to the end-user.

[0074]
FIG. 8 is a block diagram showing data exchange occurring within a system for a tracking/confirmation API. The tracking/confirmation API provides for determining the delivery status of Priority Mail® and Parcel Post™ mail items and for Delivery Confirmation™ of mail items. It also provides for tracking Express Mail® shipments.

[0075] As shown in FIG. 8, an end-user accesses an e-commerce server 120 over a network 110 through a client system 101 and makes a request for tracking information for a package, and supplies information about the package such as a unique identification code or tracking ID. A “tracking ID” may also be referred to herein as a “package identification code.” E-commerce server 120 generates an XML request for the tracking/confirmation information based on the information supplied by the end-user.

[0076] For example, the XML request for tracking/confirmation information includes the following tags:

8InputXML TagValues AllowedType of<TrackRequest . . .Input tag exactly asRequestpresented.User ID. . . USERID=Use user ID provided with“userid” . . .registration.Password. . . PASSWORD=Use password provided“password”>with registration.Package<TrackID ID=“#########”>No restrictions on numberTrackingor type of characters.ID Number

[0077] Thereafter, E-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110. Web Tools API server 130 receives the XML request and calls a tracking/confirmation API module 285 to process the request. Tracking/confirmation API module 285 sends the XML request to a tracking server 140 through network 110, thereby forwarding the tracking data to tracking server 140. Tracking server 140 queries one or more tracking databases 160 for the requested tracking information based on the XML request. Next, tracking server 140 retrieves the tracking information from tracking database 160 and sends it tracking/confirmation API module 285 through network 110. Tracking/confirmation API module 285 generates an XML response based on the tracking information received from tracking server 140.

[0078] For example, the XML response includes the following tags:

9OutputXML TagType of Response<TrackResponse>Package Tracking ID Number<TrackInfo ID=“#######”>Tracking Summary Information<TrackSummary>Tracking Detail Information<TrackDetail>

[0079] After tracking information API module 285 generates the XML response, Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110. E-commerce server 120 receives the XML response and extracts the tracking information. E-commerce server 120 sends the tracking information to the end-user at client system 101 through network 110. Client system 101 may display the tracking information to the end-user.

[0080]
FIG. 9 is a flowchart showing a method for providing tracking/confirmation information. As shown in FIG. 9, an end-user accesses an e-commerce server 120 over network 110 through a client system 101 (stage 900). The end-user makes a request to an e-commerce server 120 for tracking/confirmation information for a package, and supplies information about the package such as a unique identification code or tracking ID. (stage 910). E-commerce server 120 generates an XML request for the tracking/confirmation information based on the information supplied by the end-user (stage 920). Thereafter, e-commerce server 120 sends the XML request to the Web Tools API server 130 through network 110 (stage 930).

[0081] Web Tools API server 130 receives the XML request and calls a tracking/confirmation API module 285 (stage 940). Tracking/confirmation API module 285 sends the XML request to a tracking server 140 (stage 950). Tracking server 140 searches one or more tracking databases 160, and retrieves the requested tracking/confirmation information. Thereafter, tracking server 140 sends the tracking/confirmation information to tracking/confirmation API module 285 through network 110 (stage 960). Next, tracking/confirmation API module 285 generates an XML response based on the tracking/confirmation information received from tracking server 140 (stage 970). Web-Tools API server 130 sends the XML response to e-commerce server 120 through network 110 (stage 980).

[0082] E-commerce server 120 receives the XML response and extracts the tracking/confirmation information. E-commerce server 120 sends the tracking/confirmation information to the end-user at client system 101 through network 110 (stage 990). Client system 101 may display the tracking/confirmation information to the end-user. Alternatively, Web Tools API server 130 sends the tracking/confirmation information instead of the XML response to e-commerce server 120 through network 110 (stage 980). Thereafter, e-commerce server 120 sends the tracking/confirmation information to the end-user at client system 101 through network 110 (stage 990).

[0083]
FIG. 10 is a block diagram showing data exchange occurring within a system for a service/commitment standards API. The service/commitment standards API's may be used to determine the number of days (on average) it takes for a mail item to arrive at its destination. One such API is for Priority Mail® service standards, which returns the number of days it will take a Priority Mail® item to arrive at its destination. Another API is for standard mail service standards, which returns the number of days it will take a standard mail item to arrive at its destination. Yet another API is for Express Mail® service standards, which returns the service commitments for Monday-Friday, Saturday-Sunday, and Holiday delivery.

[0084] As shown in FIG. 10, an end-user accesses an e-commerce server 120 over a network 110 through a client system 101 and makes a request for service/commitment information for shipping a package from point A to point B, and supplies information about the package to be shipped. The information supplied by the end-user may include the point of origin (A), destination (B), and type of mail service, for example, Priority Mail. E-commerce server 120 generates an XML request for the service/commitment information based on the information supplied by the end-user.

[0085] For example, the XML request for Priority Mail® service standards includes the following tags:

10InputXML TagValues AllowedType of<PriorityMailRequest . . .Input tag exactly as presented.RequestUsername. . . USERID=Use user ID provided with“userid” . . .registration.Password. . . PASSWORD=Use password provided with“password”>registration.Origination<OriginZip>Origination and destination ZIPZIP Code ®Codes ® must be valid. Onlythe first 3 digits of the ZipCode ® are entered betweenthe open tag and close tag. If a1- or 2-digit ZIP Code ® isentered, it will be treated thesame as a 3-digit zip prefixedwith 2 or 1 zeros, respectively.If a 4- or 5-digit ZIP Code ® isentered, the last 1 or 2 digitswill be ignored.Destination<DestinationZip>Origination and destination ZIPZIP Code ®Codes ® must be valid. Onlythe first 3 digits of the ZipCode ® are entered betweenthe open tag and close tag. If a1- or 2-digit ZIP Code ® isentered, it will be treated thesame as a 3-digit zip prefixedwith 2 or 1 zeros, respectively.If a 4- or 5-digit ZIP Code ® isentered, the last 1 or 2 digitswill be ignored.

[0086] For example, the XML request for Parcel Post™ service standards, which is a component of standard mail services, includes the following tags:

11InputXML TagValues AllowedType of<StandardBRequest . . .Input tag exactly as presented.RequestUsername. . . USERID=Use user ID provided with“userid” . . .registration.Password. . . PASSWORD=Use password provided with“password”>registration.Origination<OriginZip>Origination and destination ZIPZIP Code ®Codes ® must be valid. Onlythe first 3 digits of the ZipCode ® are entered betweenthe open tag and close tag. If a1- or 2-digit ZIP Code ® isentered, it will be treated thesame as a 3-digit zip prefixedwith 2 or 1 zeros, respectively.If a 4- or 5-digit ZIP Code ® isentered, the last 1 or 2 digitswill be ignored.Destination<DestinationZip>Origination and destination ZIPZIP Code ®Codes ® must be valid. Onlythe first 3 digits of the ZipCode ® are entered betweenthe open tag and close tag. If a1- or 2-digit ZIP Code ® isentered, it will be treated thesame as a 3-digit zip prefixedwith 2 or 1 zeros, respectively.If a 4- or 5-digit ZIP Code ® isentered, the last 1 or 2 digitswill be ignored.

[0087] For example, the XML request for Express Mail® service standards includes the following tags:

12InputXML TagValues AllowedType of<ExpressMailRequest . . .Input tag exactlyRequestas presented.User ID. . . USERID=Use user ID provided“userid” . . .with registration.Password. . . PASSWORD=Use password provided“password”>with registration.Origination<OriginZip>Origination andZIP Code ®destination ZIPCodes ® must bevalid. If a 1-to 4-digit ZIPCode ® isentered, it willbe treated as ifprefixed with 4to 1 zeros,respectively.Destination<DestinationZip>Origination andZIP Code ®destination ZIPCodes ® must bevalid. If a 1-to 4-digit ZIPCode ® isentered, it willbe treated as ifprefixed with 4to 1 zeros,respectively.

[0088] Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110. Web Tools API server 130 receives the XML request and calls a service/commitment API module 285 to process the request. Service/commitment API module 285 searches a shipping information database 150 for the requested service/commitment information based on the XML request. Next, service/commitment API module 285 generates an XML response based on retrieved service/commitment information.

[0089] For example, the XML response for Priority Mail® service standards includes the following tags:

13OutputXML TagCommentsResponse Type<PriorityMailResponse>Origination<OriginZip>Only the first 3ZIP Code ®digits of the ZIPCode ® are returned.Destination ZIP<DestinationZip>Only the first 3Code ®digits of the ZIPCode ® are returned.Average number<Days>of days it willtake the packageto arrive

[0090] For example, the XML response for Parcel Post™ service standards includes the following tags:

14OutputXML TagCommentsResponse Type<StandardBResponse>Origination ZIP<OriginZip>Only the first 3 digits of theCode ®ZIP Code ® are returned.Destination ZIP<DestinationZip>Only the first 3 digits of theCode ®ZIP Code ® are returned.Average number of<Days>days it will take thepackage to arrive

[0091] For example, the XML response for Express Mail® service standards includes the following tags:

15OutputXML TagCommentsResponse Type<ExpressMailResponse>Origination ZIP Code ®<OriginZip>Destination ZIP Code ®<DestinationZip>Monday-Friday Service<MonFriCommitment>Commitment (12:00 pm,3:00 pm, 2-daycommitment)Saturday-Sunday Service<SatSunCommitment>Holiday service isCommitment (12:00 pm,the same as3:00 pm, 2-day commit-Sunday Servicement, where applicable)Commitment.

[0092] After service/commitment API module 285 generates the XML response, Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110. E-commerce server 120 receives the XML response and extracts the service/commitment information. E-commerce server 120 sends the service/commitment information to the end-user at client system 101 through network 110. Client system 101 may display the service/commitment information to the end-user. Alternatively, Web Tools API server 130 sends the service/commitment information instead of the XML response to e-commerce server 120 through network 110. Thereafter, e-commerce server 120 sends the service/commitment information to the end-user at client system 101 through network 110.

[0093]
FIG. 11 is a flowchart showing a method for providing service/commitment standards information. As shown in FIG. 11, an end-user accesses an e-commerce server 120 through a client system 101 (stage 1100). The end-user makes a request to e-commerce server 120 for service/commitment information for shipping a package from point A to point B, and supplies information about the package to be shipped (stage 1110). The information supplied by the end-user may include the point of origin (A), destination (B), and type of mail service, for example, Priority Mail. E-commerce server 120 generates an XML request for the service/commitment information based on the information supplied by the end-user (stage 1120). Thereafter, e-commerce server 120 sends the XML request to Web Tools API server 130 through network 110 (stage 1130).

[0094] Web Tools API server 130 receives the XML request and calls a service/commitment API module 285 to process the request (stage 1140). Service/commitment API module 285 searches a shipping information database 150 for the requested service/commitment information based on the XML request and retrieves the requested service/commitment information. Next, service/commitment API module 285 generates an XML response based on retrieved service/commitment information (stage 1150). Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110 (stage 1160). E-commerce server receives the XML response and extracts the service/commitment information. E-commerce server 120 sends the service/commitment information to the end-user at client system 101 through network 110 (stage 1170). Client system 101 may display the service/commitment information to the end-user. Alternatively, Web Tools API server 130 sends the service/commitment information instead of the XML response to e-commerce server 120 through network 110 (stage 1160). Thereafter, e-commerce server 120 sends the service/commitment information to the end-user at client system 101 through network 110 (stage 1170).

[0095]
FIG. 12 is a block diagram showing data exchange occurring within a system for a delivery confirmation service API. A delivery confirmation service API provides information about the delivery status of Priority Mail® and Standard B packages, including the date, time, and ZIP Code® of delivery, as well as attempted deliveries, forwarding, and returns. This API may also provide a Delivery Confirmation™ label for Priority Mail® and Standard B, which includes Parcel Post™, Bound Printed Matter, Special Standard, and Library Rate. The label returned by the API may be printed by the sender of a mail item such as a package, and attached to the package. Standard B may be referred to as “Package Services.” Special Standard may be referred to as “Media Mail.” Library Rate may be referred to as “Library Mail.”

[0096] This API provides for an end-user to request and receive a delivery confirmation barcode label for placement on either a Priority Mail® or a Standard B-mail item. An end-user may obtain, at no charge, a delivery confirmation barcode label and a package identification code (“PIC”). The PIC is a unique identifier associated with a delivery confirmation barcode. The delivery confirmation barcode allows a sender and a recipient of a Priority Mail® or a Standard B-mail item, such as a package to obtain delivery confirmation information about the package's delivery based on the PIC. As the package travels through a mail stream such as that provided by the USPS, the delivery confirmation barcode is scanned and the scanned information is stored in one or more tracking databases. Upon delivery of the package, the delivery confirmation barcode is scanned again, and the scanned information is stored in one of the tracking databases.

[0097] As shown in FIG. 12, an end-user accesses an e-commerce server 120 over a network 110 through a client system 101 and makes a request for a delivery confirmation barcode label, and supplies information about the package on which the delivery confirmation barcode label will be placed. The information supplied by the end-user may include information about the sender, receiver, package weight, mail service type, label image type, etc. The mail service type specifies, for example, either Priority Mail® or Standard B-mail. The label image type specifies the format of the graphic image of the delivery confirmation barcode label. The label option indicates the type of information that is to be included in the label. E-commerce server 120 generates an XML request for the delivery confirmation barcode label based on the information supplied by the end-user.

[0098] For example, the XML request for a delivery confirmation barcode label includes the following tags:

16InputXML TagValues AllowedType of<DeliveryConfirma-Input tag exactly asRequesttionV2.0Request . . .presented.User ID. . . USERID=Use user ID provided with“userid” . . .registration.Password. . . PASSWORD=Use password provided“password”>with registration.Label<Option>Either of two valuesOptionallowed:“1” for LabelOption #1 or“2” for LabelOption #2.For Label Option #1, agraphic image is returnedthat will include abarcode, PIC number,return name and address,and delivery name andaddress.For Label Option #2, agraphic image is returnedthat will include a barcodeand PIC number withoutthe return and deliveryname and address.Printer<ImageParameters>This tag is for future use.DefinitionThe tag is required, butthere are no values toenter.Name of<FromName>Maximum charactersSenderallowed: 32Company<FromFirm>This tag is required butNamethe value is optional.Maximum charactersallowed: 32From<FromAddress1>Use this tag for anAddressapartment or suiteLine 1number. This tag isrequired but the value isoptional. Maximumcharacters allowed: 32From<FromAddress2>Maximum charactersAddressallowed: 32Line 2From City<FromCity>Maximum charactersallowed: 21From<FromState>Maximum charactersStateallowed: 2From ZIP<FromZip5>Input tag exactly asCode ®presented, not all caps.Maximum charactersallowed: 5From ZIP<FromZip4>Input tag exactly asCode ® + 4presented, not all caps.This tag is required butthe value is optional.Maximum charactersallowed: 4Name of<ToName>Maximum charactersRecipientallowed: 38Company<ToFirm>This tag is required butNamethe value is optional.Maximum charactersallowed: 38To<ToAddress1>Use this tag for anAddressapartment or suiteLine 1number. This tag isrequired but the valueis optional. Maximumcharacters allowed: 38To<ToAddress2>Maximum charactersAddressallowed: 38Line 2To City<ToCity>Maximum charactersallowed: 21To State<ToState>Maximum charactersallowed: 2To ZIP<ToZip5>Input tag exactly asCode ®presented, not all caps.Maximum charactersallowed: 5To ZIP<ToZip4>Input tag exactly asCode ® + 4presented, not all caps.This tag is required butthe value is optional.Maximum charactersallowed: 4Package<WeightinOunces>Value must be numeric.WeightMail<ServiceType>Either of two values areServiceallowedType“Priority” forPriority Mail ® or“StandardB” forParcel Post ™,Bound Printed Matter,Special Standard,or Library Rate.Label<ImageType>Either of two valuesImageallowed:Type“TIF” or “PDF”

[0099] Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110. Web Tools API server 130 receives the XML request and calls a delivery confirmation service API module 285 to generate the requested delivery confirmation barcode label and to associate a PIC with the delivery confirmation barcode. Delivery confirmation service API module 285 sends the PIC and other information such as the zip codes and package weight, to a tracking server 140, where the PIC and other information is stored in a tracking database 160. In addition, delivery confirmation service API module 285 generates an XML response based on the delivery confirmation barcode label and the PIC.

[0100] For example, the XML response includes the following tags:

17OutputXML TagType of Response<DeliveryConfirmationV2.0Response>Delivery Confirmation ™<DeliveryConfirmationNumber>ID Number (PIC #)Delivery Confirmation ™<DeliveryConfirmationLabel>Label

[0101] After delivery confirmation service API module 285 generates the XML response, Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110. E-commerce server 120 receives the XML response and extracts the delivery confirmation barcode label and the PIC. Alternatively, Web Tools API server 130 may directly send the delivery confirmation barcode label and the PIC to e-commerce server 120 instead of generating and sending an XML response. E-commerce server 120 sends the delivery confirmation barcode label and the PIC to the end-user at client system 101 through network 110. Client system 101 may display the delivery confirmation barcode label and/or the PIC to the end-user.

[0102]
FIG. 13 is a flowchart showing a method for providing a delivery confirmation label. As shown in FIG. 13, an end-user accesses an e-commerce server 120 through a client system 101 (stage 1300). The end-user makes a request to e-commerce server 120 for a delivery confirmation barcode label, and supplies information about the package on which the delivery confirmation barcode label will be placed (stage 1310). The information supplied by the end-user may include information about the sender, receiver, package weight, mail service type, label image type, etc. E-commerce server 120 generates an XML request for the delivery confirmation barcode label based on the information supplied by the end-user (stage 1320). Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110 (stage 1330).

[0103] Web Tools API server 130 receives the XML request and calls a delivery confirmation service API module 285 to process the request. Delivery confirmation service API module 285 generates the requested delivery confirmation barcode label and associates a PIC with the delivery confirmation barcode (stage 1340). Delivery confirmation service API module 285 sends the PIC and other information such as the zip codes and package weight, to a tracking server 140, where the PIC and other information is stored in a tracking database 160 (stage 1350). In addition, delivery confirmation service API module 285 generates an XML response based on the delivery confirmation barcode label and the PIC (stage 1360). Next, Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110 (stage 1370).

[0104] E-commerce server 120 receives the XML response and extracts the delivery confirmation barcode label and the PIC (stage 1380). E-commerce server 120 sends delivery confirmation barcode label and the PIC to the end-user at client system 101 through network 110 (stage 990). Client system 101 may display the delivery confirmation barcode label and/or the PIC to the end-user. Alternatively, Web Tools API server 130 sends the delivery confirmation barcode label and the PIC instead of the XML response to e-commerce server 120 through network 110 (stage 1370). Thereafter, e-commerce server 120 sends the delivery confirmation barcode label and the PIC to the end-user at client system 101 through network 110 (stage 1380).

[0105]
FIG. 14 is a block diagram showing data exchange occurring within a system for a courtesy reply label API. The courtesy reply label API has been specifically designed for e-commerce entities that elect to have their customers pay the postage on a return item, but still wish to provide a convenient return label. This API facilitates returns by allowing e-commerce entities to request and receive a courtesy reply label for merchandise return, which the e-commerce entity can provide to its customers or end-users through any known distribution medium, such as email, regular mail, fax, etc.

[0106] As shown in FIG. 14, an end-user accesses an e-commerce server 120 over a network 110 through a client system 101 and makes a request to return a purchased item to a retailer. E-commerce server 120 may provide to the end-user, based on information supplied by the end-user, a list of items that were purchased. The end-user may select from the list one or more items to return. For purposes of this example, the end-user selects a single item. Thereafter, e-commerce server 120 determines whether the end-user has permission to return the selected item, and if so, whether the item requires insurance for shipping. If the end-user has permission to return the selected item to the retailer, e-commerce server 120 generates an XML request based on the information supplied by the end-user and the selected item.

[0107] The request includes, for example, the name and address of the customer who purchased the item, name and address of the retailer who sold the item, service type, permit information, PDU information, label image type, insurance value, package weight, and RMA.

[0108] For example, the XML request a courtesy reply label includes the following tags:

18InputXML TagValues AllowedType of<CourtesyLabelRequest . . .Input tag exactlyRequestas presented.User ID. . . USERID=Use user ID provided“userid” . . .with registration.Password. . . PASSWORD=Use password provided“password”>with registration.Customer's<FromName>Maximum charactersNameallowed: 32Customer's<FromAddress1>Maximum charactersAddressallowed: 32Customer's<FromAddress2>Maximum charactersAddressallowed: 32Customer's<FromCity>Maximum charactersCityallowed: 21Customer's<FromState>Maximum charactersStateallowed: 2Customer's<FromZip5>Input tag exactlyZIP Code ®as presented,not all caps. Maximumcharacters allowed: 5Customer's<FromZip4>Input tag exactlyZIP Code ®as presented,not all caps. Maximumcharacters allowed: 5Retailer's<ToName>Maximum charactersNameallowed: 32Retailer's<ToAddress1>Maximum charactersAddressallowed: 32Retailer's<ToAddress2>Maximum charactersAddressallowed: 32Retailer's<ToCity>Maximum charactersCityallowed: 21Retailer's<ToState>Maximum charactersStateallowed: 2Retailer's<ToZip5>Input tag exactlyZIP Code ®as presented,not all caps. Maximumcharacters allowed: 5Retailer's<ToZip4>Input tag exactlyZIP Code ®as presented,not all caps. Maximumcharacters allowed: 5Retailer<Comment>Value entry is optional.DataNo restriction on numberor type of characters.Any shipping orinventory informationcan be used with thistag. Any informationentered with this tagwill appear on the label.Label Image<ImageType>Either of two valuesTypeallowed:“TIF” or “PDF”

[0109] Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110 (stage 330). Web Tools API server 130 receives the XML request and calls a courtesy reply label API module 285 to generate the courtesy reply label based on the XML request. The courtesy' reply label may, for example, be in PDF or TIF format, which is determined by the value supplied in the Label Image Type tag. Next, courtesy reply label API module 285 generates an XML response, which includes the courtesy reply label. For example, the XML response includes the following tags:

19OutputXMLTagType of Response<CourtesyLabelResponse>Image of Courtesy Label<CourtesyLabel>

[0110] After courtesy reply label API module 285 generates the XML response, Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110. E-commerce server 120 receives the XML response and extracts the courtesy reply label. E-commerce server 120 may send the courtesy reply label to client system 101 through network 110. Client system 101 may display the courtesy reply label to the end-user. The end-user may then print the courtesy reply label and attach it to the packaged item. Alternatively, e-commerce server 120 may fax the merchandise return label to the end-user, email the merchandise return label to the end-user, or mail it to the end-user.

[0111]
FIG. 15 is a flowchart showing a method for providing a courtesy reply label. As shown in FIG. 15, an end-user accesses an e-commerce server 120 through a client system 101, and makes a request to return merchandise to a retailer (stage 1500). E-commerce server 120 may display to the end-user, based on information supplied by the end-user, a list of items of merchandise that were purchased from the retailer (stage 1505). The end-user selects from the list an item of merchandise to return (stage 1510). Thereafter, e-commerce server 120 determines whether the end-user has permission to return the selected merchandise by requesting approval from the retailer (stage 1515). If the end-user does not have permission to return the merchandise to the retailer (“No”), e-commerce server 120 sends a message to the end-user informing her that her request is denied and the transaction stops (stage 1520). Otherwise (“Yes”), the end-user has permission to return the merchandise to the retailer. E-commerce server 120 generates an XML request based on the information supplied by the end-user and the selected merchandise (stage 1525).

[0112] Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110 (stage 1530). Web Tools API server 130 receives the XML request and calls a courtesy reply label API module 285 to process the request (stage 1535). Next, courtesy reply label API module 285 generates an XML response, which includes the courtesy reply label (stage 1540). Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110 (stage 1545). E-commerce server 120 receives the XML response and extracts the courtesy reply label (stage 1550). E-commerce server 120 sends the courtesy reply label to the end-user at client system 101 through network 110 (stage 1555). Client system 101 displays the courtesy reply label to the end-user. The end-user may then print the courtesy reply label, attach it to the packaged item, and apply postage to the package. Alternatively, e-commerce server 120 may fax the courtesy reply label to the end-user, email the courtesy reply label to the end-user, or mail it to the end-user.

[0113]
FIG. 16 is a block diagram showing data exchange occurring within a system for an address information service API. The address information service API's provide access to standard address formats (“address information”) and may include, but is not limited to, a city/state lookup API, ZIP code lookup API, and address standardization API. The ZIP code lookup API receives as input a given city and state code and returns a corresponding ZIP code. The city/state lookup API receives as input a given ZIP code and returns the city and state corresponding to the ZIP code. The address standardization API receives as input an address and corrects errors in the address, such as errors in street or city names and/or errors in the ZIP code, if any.

[0114] E-commerce entities needing to validate address information provided by an e-shopper or end-user may use one or more of the address information service API's to check the address information provided by the e-shopper or end-user. Alternatively, an end-user may request the e-commerce entity to provide a Zip code for a given city and state. The e-commerce entity may send a request to the ZIP code lookup API, which returns the requested ZIP code to the e-commerce entity.

[0115] As shown in FIG. 16, an end-user accesses an e-commerce server 120 over a network 110 through a client system 101 and makes a request for address information, such as the city and state information for a ZIP code specified by the end-user. E-commerce server 120 generates an XML request for the address information based on the information supplied by the end-user.

[0116] For example, the XML request for city/state lookup includes the following tags:

20InputXML TagType of Request<CityStateLookupRequest . . .User ID. . . USERID=“userid” . . .Password. . . PASSWORD=“password”>ZIP Code Lookup Number1<ZipCode ID=‘#’>ZIP Code of City or State<Zip5>

[0117] For example, the XML request for ZIP code lookup includes the following tags:

21InputXML TagType of Request<ZipCodeLookupRequest . . .User ID. . . USERID=“userid” . . .Password. . . PASSWORD=“password”>Address Lookup Number1<Address ID=‘#’>Name of Firm2<FirmName>Address Line 13<Address1>Address Line 23<Address2>City<City>State<State>

[0118] For example, the XML request for address standardization lookup includes the following tags:

22InputXML TagType of Request<AddressValidateRequest...User ID...USERID=“userid”...Password...PASSWORD=“password”>Address Verification Number1<Address ID=‘#’>Name of Firm2<FirmName>Address Line 1<Address1>Address Line 2<Address2>City<City>State<State>ZIP Code ®<Zip5>ZIP Code ® + 4<Zip4>

[0119] Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110. Web Tools API server 130 receives the XML request and calls an address information service API module 285 to process the request. Address information service API module 285 searches a shipping information database 150 for the requested address information based on the XML request. Shipping information database 150 may include, for example, an address database. Next, address information service API module 285 generates an XML response based on retrieved, address information.

[0120] For example, the XML response for city/state lookup includes the following tags:

23OutputXML TagType of Response<CityStateLookupResponse...ZIP Code Lookup Number<ZipCode ID=‘#’>ZIP Code of City or State<Zip5>City for Requested ZIP Code ®<City>State for requested ZIP Code ®<State>

[0121] For example, the XML response for ZIP code lookup includes the following tags:

24OutputXML TagType of Response<ZipCodeLookupResponse>Address ID Number<Address ID=‘#’>Name of Firm*<FirmName>Address Line 1*<Address1>Address Line 2*<Address2>City<City>State<State>ZIP Code<Zip5>ZIP Code + 4<Zip4>

[0122] For example, the XML response for address standardization lookup includes the following tags:

25OutputXML TagType of Response<AddressValidateResponse>Address Verification Number<Address ID=‘#’>Name of Firm*<FirmName>Address Line 1<Address1>Address Line 2<Address2>City<City>State<State>ZIP Code ®<Zip5>ZIP Code ® + 4<Zip4>

[0123] After address information service API module 285 generates the XML response, Web Tools API server 130 sends the XML response to the e-commerce server 120 through network 110. E-commerce server receives the XML response and extracts the address information. E-commerce server 120 sends the address information to the end-user at client system 101 through network 110. Client system 101 may display the address information to the end-user. Alternatively, Web Tools API server 130 sends the address information instead of the XML response to e-commerce server 120 through network 110. Thereafter, e-commerce server 120 sends the address information to the end-user at client system 101 through network 110.

[0124]
FIG. 17 is a flowchart showing a method for providing address information. As shown in FIG. 17, an end-user accesses an e-commerce server 120 through a client system 101 (stage 1700). The end-user makes a request to e-commerce server 120 for address information, such as the city and state information for a ZIP code specified by the end-user (stage 1710). E-commerce server 120 generates an XML request for the address information based on the information supplied by the end-user (stage 1720). Thereafter, e-commerce server 120 sends the XML request to Web Tools API server 130 through network 110 (stage 1730).

[0125] Web Tools API server 130 receives the XML request and calls an address information service API module 285 to process the request (stage 1740). Address information service API module 285 searches a shipping information database 150 for the requested address information based on the XML request and retrieves the requested address information. Shipping information database 150 may include, for example, an address database. Next, address information service API module 285 generates an XML response based on the retrieved address information (stage 1750). Web Tools API server sends the XML response to e-commerce server 120 through network 110 (stage 1760). E-commerce server receives the XML response and extracts the address information. E-commerce server 120 sends the address information to the end-user at client system 101 through network 110 (stage 1770). Client system 101 may display the address information to the end-user. Alternatively, Web Tools API server 130 sends the address information instead of the XML response to e-commerce server 120 through network 110 (stage 1160). Thereafter, e-commerce server 120 sends the address information to the end-user at client system 101 through network 110 (stage 1170).

[0126] In another example, an end-user accesses an e-commerce server 120 through a client system 101. The end-user provides a delivery address to e-commerce server 120 for the shipment of a purchased item. E-commerce server 120 generates an XML request for the validation of the address information. Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 through network 110.

[0127] Web Tools API server 130 receives the XML request and calls an address information service API module 285 to process the request. Address information service API module 285 searches a shipping information database 150 for address information based on the XML request, and using information from the address, corrects errors or omissions to the address information in the XML request. Shipping information database 150 may include, for example, an address database. Next, address information service API module 285 generates an XML response based on the address information and corrections to the address information.

[0128] Web Tools API server sends the XML response to the e-commerce server 120 through network 110. E-commerce server 120 receives the XML response and extracts the address information. E-commerce server 120 generates an XML request for a delivery confirmation label based on the address information. Thereafter, e-commerce server 120 sends the XML request to a Web Tools API server 130 over network 110.

[0129] Web Tools API server 130 receives the XML request and calls a delivery confirmation service API module 285 to generate the requested delivery confirmation barcode label and to associate a PIC with the delivery confirmation barcode. Delivery confirmation service API module 285 sends the PIC and other information such as the zip codes and package weight, to a tracking server 140, where the PIC and other information is stored in a tracking database 160. In addition, delivery confirmation service API module 285 generates an XML response based on the delivery confirmation barcode label and the PIC. Web Tools API server 130 sends the XML response to e-commerce server 120 through network 110. E-commerce server 120 may send the delivery label to the end-user using any known delivery method.

[0130] Other embodiments of the invention will be apparent to those skilled in the art from consideration of the specification and practice of the invention disclosed herein. It is intended that the specification and examples be considered as exemplary only, with a true scope and spirit of the invention being indicated by the following claims.

Systems and methods for application programming interfaces for shipping services

Information

Publication Number

Date Filed

Date Published

Inventors

CPC

US Classifications

International Classifications

Abstract

Description

Claims

CROSS REFERENCE TO RELATED APPLICATION

PCT Information