Professional Documents
Culture Documents
Office Order Service Transaction Guide Sep 2020
Office Order Service Transaction Guide Sep 2020
The information contained in this Transaction Guide is confidential and proprietary to FedEx
Corporate Services, Inc. and its affiliates (collectively "FedEx"). No part of this Transaction
Guide may be distributed or disclosed in any form to any third party without written permission
of FedEx. This Transaction Guide is provided to you under, and its use is subject to, the terms
and conditions of the Developer Resource Center License Agreement and the FedEx Web
Services End User License Agreement. The information in this document may be changed at
any time without notice. Any conflict between this Transaction Guide, the Developer Resource
Center License Agreement, and the FedEx Web Services End User License Agreement shall be
governed by the FedEx Web Services End User License Agreement and the Developer
Resource Center License Agreement, in that order.
© 2020 FedEx. FedEx and the FedEx logo are registered service marks. All rights reserved.
Unpublished.
i
About the Guide
This guide serves as a supplement to the FedEx Web Service for Office and Print Developer
Guide and describes how to work with the Office Order Web Service transaction set.
It is written for the application developer who uses web services to design and deploy
applications enabled by FedEx. The guide includes element descriptions, samples, and error
codes. Request elements are designated as required (R), optional (O), or conditional (C).
Resources
The following may also be useful for the FedEx Web Service for Office and Print developer:
• FedEx Developer Resource Center for FedEx Office:
http://www.fedex.com/us/developer/web- services/office/index.html
• FedEx Office Print Online: printonline.fedex.com
• Web Services Interoperability: www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html
Support
Integration Consultants
A FedEx Office Web Integration Solutions Consultation team member can assist you in the pre-
production stages of integration. Contact your FedEx Office account executive or email
officewebservices@fedex.com to request a consultation.
A consultant will contact you within 3 business days.
Email Support
Email OfficeWSProdSupport@fedex.com, and we’ll send your request to our internal team of
FedEx Office Web Services specialists for print services. They will address your questions as
quickly as possible.
ii
Revision History
The following table provides the reader with a history of the significant additions, deletions, and
corrections made to this document.
Version Revision
September 2009 Initial document. Contents correspond to functionality associated with first
release of FedEx Office Order Web Service.
January 2010 Document updated to reflect new functionality incorporated into FedEx Office
Order Web Service in January 2010.
New features:
• File type support extended
Office Order Service now accepts the upload of documents saved in
the following formats: text, rich text, Adobe® PDF, Adobe
PostScript®, Microsoft® Word, Microsoft Excel® and Microsoft
PowerPoint®.
• Special instructions
As a supplement to the direct selection of print, finishing and fulfillment
options via Office Order Service, free-form instructions can now also
be submitted to FedEx Office when an order is placed.
• Payment via major credit card
Acceptable forms of payment now also include the following major
credit cards: American Express®, Diners Club®, Discover®,
MasterCard® and Visa®.
Miscellaneous revisions:
• Notification Codes updated
• Media Categories and Descriptions updated to reflect new/revised
options
• Finishing Thresholds corrected for Comb Binding
July 2010 Document updated to reflect new functionality incorporated into FedEx Office
Order Web Service in July 2010.
New features:
• Multi-file support
Office Order Service now supports the upload and association of
multiple digital files with an order.
• Multi-document support
Office Order Service has been enhanced to support the order of
multiple items on a single order
• Multi-section support
iii
Office Order Service now provides customers with the flexibility to
declare print and finishing options (where applicable) on a section by
section basis within their print order.
Miscellaneous revisions
• Center ID is no longer limited to use with only pickup delivery group.
When an order is to be shipped, you can now set the Center ID where
you would like it produced. Previously, the production center was
automatically selected based upon the recipient’s address.
June 2011 Document updated to reflect new functionality incorporated into FedEx Office
Order Web Service in June 2011.
New features:
• Promotion codes accepted
Office Order Service now accepts promotion codes so that customers
can take advantage of special FedEx Office discount offers (where
applicable).
• Lamination functionality added
Office Order Service now accepts the lamination finishing option.
May 2013 Document updated to reflect new functionality incorporated into FedEx Office
Order Web Service.
New features:
• Corporate Catalog Integration
Office Order Service now allows customers to request catalog
documents in an order.
• Direct Mail
Direct mail is now available as a delivery method. Note: Prior
approval is required.
• Simplified Paper Options
Removed media types and sizes that are no longer supported.
• Additional Customer Reference Type
Supports an additional customer reference type for populating a P.O.
number reference on the order’s corresponding shipping label.
October 2013 Document updated to reflect new functionality incorporated into FedEx Office
Order Web Service.
New features:
• FedEx Office Local Delivery
Local delivery (by the FedEx Office location producing the order) is
now available as a delivery method.
• Phone Number Extension
A phone number extension may now be populated for the order
contact and order recipient.
iv
September 2014 Corrected FEDEX_2DAY to FEDEX_2_DAY in ServiceType enumerated lists
to align with Office Order WSDL
September 2015 Document updated to reflect new functionality incorporated into FedEx Office
Order Web Service:
Tabs and Inserts can now be added to a document’s print options.
February 2016 Document updated to reflect new functionality incorporated into FedEx Office
Order Web Service.
New features:
• Color printing on color paper is now available.
Prepare for Payment Service Updates:
• The credit card processor will only accept alphanumeric characters in
the P.O. number and customer reference fields. If special characters
are entered, they may be removed before transaction is sent to credit
card processor, in which case the integrator would receive a
notification that the special characters may be removed.
• Postal code will be required to support credit card validation.
July 2016 Document updated to reflect new functionality incorporated into FedEx Office
Order Web Service:
Media Category table has been updated to include more options and SKU
numbers for cross reference purposes.
New features:
• FedEx Office Account number and FedEx Shipping Account number
will now be referred to as FedEx Account number.
• Payment Service Update
With the change of the payment service used for credit card authorization
and processing, the following improvements will now be in effect that
further increase the quality of this service:
i. CVV (Card Verification Value) field has been added. To reduce
fraud, it is recommended to capture CVV for validation for online
transactions.
ii. Zip Code Validation will be performed by the credit card processor.
If billing zip code does not match zip code tied to the credit card,
the card will not authorize.
iii. New error codes have been added to help identify why accounts
or credit cards are rejected whether used for tender or discount.
• Address Validation
We recommend performing an address validation on recipient addresses
using the FedEx validation API before submitting a local delivery order.
v
March 2018 Additional error codes have been added to support payment service and direct
mail.
Updated sample notification code to correct the URLs.
vi
Contents
Introduction ................................................................................................ 1
Office Order Service .................................................................................. 3
Upload Location......................................................................................... 7
Operation Details ...................................................................................... 7
Coding Details .......................................................................................... 7
Upload Location Request Elements .......................................................... 9
Upload Location Reply Elements ............................................................ 11
Upload Document File ............................................................................. 13
Operation Details .................................................................................... 13
Coding Details ........................................................................................ 13
Upload Document File Request Elements............................................... 15
Upload Document File Reply Elements ................................................... 16
Rate Office Order ..................................................................................... 17
Operation Details .................................................................................... 17
Coding Details ........................................................................................ 18
Rate Order Request Elements ................................................................ 20
Rate Order Reply Elements .................................................................... 48
Create Office Order .................................................................................. 63
Operation Details .................................................................................... 63
Coding Details ........................................................................................ 65
Create Order Request Elements ............................................................. 68
Create Order Reply Elements ................................................................. 99
Appendix ................................................................................................ 114
Examples ............................................................................................. 116
Upload Location Request................................................................... 119
Upload Location Reply ....................................................................... 120
Upload Document File ....................................................................... 121
Upload Multiple Document Files ........................................................ 122
vii
Rate Office Order Request ................................................................ 123
Rate Office Order Reply..................................................................... 127
Create Office Order Request ............................................................. 130
Create Office Order Reply ................................................................. 155
Email Confirmations ........................................................................... 180
Order Confirmation Sent to Order Contact ......................................... 182
Special Instructions Next Steps Sent to Order Contact....................... 183
Order Confirmation Sent to Recipient ................................................. 184
Order Completion Notice Sent to Order Contact................................. 185
Order Completion Notice Sent to Recipient ........................................ 186
Notification Messages and Codes ..................................................... 188
Severity Descriptions ......................................................................... 188
Notification Codes.............................................................................. 190
Media Categories and Descriptions .................................................. 216
Finishing Terms Reference ................................................................ 220
Finishing Thresholds .......................................................................... 224
viii
Introduction
FedEx Office Web Service for Print is a portfolio of transaction interfaces to digital printing
functionality hosted by FedEx Office. These transactions are used by customers to create
custom, highly efficient solutions that enable them to directly manage the creation,
configuration, and submission of FedEx Office digital print orders.
FedEx Web Services for Office and Print provides the following web service:
• Office Order Service
The Office Order Service enables the client application to directly manage the entire
order transaction workflow. The client is responsible for capturing the order intent and
content (printing/finishing instructions, contact/recipient, payment data, etc.) and
transmitting via the defined transaction set. The client application is also responsible for
receiving and responding to reply transactions returned by the web service.
Customers who choose to take advantage of FedEx Web Service for Office and Print will begin
by registering on the FedEx Developer Resource Center website in the FedEx Office Web
Services section located at fedex.com/us/developer/web-services/office. There you will find
technical documentation, sample software code, and support material designed to help you
build your custom solution. Once development is complete, FedEx will certify that your software
integration is ready for use.
This Transaction Guide is designed to facilitate the development of Office Order Service
implementations.
Operating Scenario
There are two scenarios for FedEx Office print orders:
1. Customer uses Office Order Service-enabled application to select a file that he/she
would like printed by FedEx Office. The client application will connect to FedEx to
request an upload location for the file. After the client is authenticated, FedEx replies
with the requested information and the client subsequently uploads the file.
Next, the client application is responsible for obtaining from the customer the desired
print and finishing options for the document. These documents are known as ad hoc
documents.
2. The customer has a corporate catalog and wishes to order from that catalog rather than
creating a customized document(s) for each order. FedEx Office establishes a catalog
to the customer’s specifications and provides the document identifiers to the developer
of the client application. These are known as catalog documents.
Each catalog document has static print and finishing options, as well as pre-determined
pricing. Static document content is supported, but a catalog document may be
configured to allow dynamic content as well.
If the customer is ordering a catalog document with dynamic content, the customer will
use the client application to select the content file. The client application will connect to
FedEx to request an upload location for the file. After the client is authenticated, FedEx
replies with the requested information and the client subsequently uploads the file.
(Please note that orders are not limited to one scenario or the other. A single order may include
both ad hoc documents and catalog documents.)
From that point forward, both scenarios follow the same steps. The client application is
responsible for obtaining from the customer all the information required to successfully place a
print order with FedEx Office, including customer contact information, payment information, and
delivery/pickup preferences. If delivery via direct mail is requested, the client application must
upload an additional file containing the list of addressees. Once the customer has provided the
client application with this information, the customer may request a rate quote for ad hoc
documents using the Rate Office Order service. Rate request is not required when using
Catalog-only workflow.
The client application will request the quote by passing a rate request to FedEx along with all
the information that the customer has provided. FedEx will reply with a detailed rate quote that
includes not only the cost of the order, but also information regarding where the order will be
Operation Details
The getUploadLocation operation is used to pass an OfficeOrderUploadLocationRequest
message and subsequently receive an OfficeOrderUploadLocationReply message.
The following details apply:
• Web Authentication Detail, Client Detail, and Version information are required in request.
• Transaction Detail is optional in requests and echoed within reply.
• The file token with the Upload URL and Upload Session ID elements included in
OfficeOrderUploadLocationReply are required for later operations associated with
current document.
• See Upload Location Request Elements and Upload Location Reply Elements.
• See Notification Messages and Codes.
Coding Details
When uploading a file to FedEx Office:
• A call to getUploadLocation is required prior to uploading a file to FedEx Office.
• Client application is responsible for uploading the target file to the FedEx-designated
Upload Location. File upload functionality is not part of the Office Order Service.
File Upload Input: Protocol=HTTPS; Action=UploadUrl;
Enctype=“multipart/form- data”; Method=“POST”; content-
length (entity header required); Type=”file”;
Name=”file1”
Example: resultCode=SUCCESS&fileAuthToken=101010101010101010
• See Examples
Version R Descriptive data used to identify the web service that the client
application intends to call.
User Password R Second part of the authentication credential which has a direct
relationship with the credential key.
Client Detail
Client Product ID R Data assigned by FedEx used to identify product.
Client Product Version R Data assigned by FedEx used to identify product version.
Transaction Detail
Customer Transaction ID O Client-provided descriptive data used by the client to identify a
transaction call.
Localization O Defines the desired translation for data payload values in the
reply. (Note: Translation is currently not supported, so any
values in this object will be ignored.)
Version
Service ID R Data used by FedEx to identify the system or sub-system
which will perform the requested operation.
Value:
• oord
Element Description
• FAILURE
• ERROR
• WARNING
• NOTE
• SUCCESS
Version Descriptive data used to identify the web service that executed the
request.
Upload URL Location provided to the client for uploading the file.
Upload Session ID Unique identifier associated with the file upload authorization.
Notifications
Severity Identifies the severity of the notification.
• FAILURE
• ERROR
• WARNING
• NOTE
• SUCCESS
Message Parameters
ID Identifies the type of the data in the Value element.
Value Identifies the value that was used as the replacement parameter.
Transaction Detail
Customer Transaction ID Client-provided descriptive data used by the client to identify a
transaction call.
Version
Service ID Data used by FedEx to identify the system or sub-system that executed
the requested operation.
Value:
• oord
Operation Details
The Upload Document File operation is used to upload a document file to the FedEx
designated file upload location (Upload URL) returned within the Upload Location Reply
message. The Upload Document File operation is not a native component of the Office Order
Service and must be coded within the client software by the developer.
• Protocol: HTTPS
• Method: POST
• File upload location (Upload URL) element is returned within the Upload Location Reply.
• File name must be passed as “file1”. Multiple file uploads are supported. In case of
multiple file upload the file names are “file1”, “file2”, file3”... “fileN”, where N is the number
of files that is used in the Office Order Request.
Coding Details
When uploading a file to FedEx Office:
• Via HTTPS, execute a “multipart/form-data”-encoded POST of the document file to the
FedEx designated file upload location (Upload URL) using “file1” as the file name.
• See Examples
Element Description
Upload Document File
Protocol: HTTPS
Request
In case of multiple file uploads the Name Value must be file1 for
the first file, file2 for the second file, and so on.
Element Description
Upload Document File Character set: ASCII
Reply
Format:
Example:
resultCode=SUCCESS&fileAuthToken=10101010101010101010
10101010101010101010
• FAILED
• SUCCESS
Operation Details
The rateOfficeOrder operation is used to pass a RateOfficeOrderRequest message and
subsequently receive a RateOfficeOrderReply message.
The following details apply:
• Web Authentication Detail, Client Detail, and Version information are required in request.
• Requests containing Custom Media Sizes or Special Instructions are not supported.
Note: Special Instructions will suppress online tender. A center will be in touch with order
contact to complete the order.
• Transaction Detail is optional in requests and echoed within reply.
• FedEx Account Number enabled for Print or major credit card is required.
• Requests may contain multiple line items. Each line item must contain either an ad hoc
document or a catalog document but may not contain both.
• Ad hoc documents and catalog documents may be combined in a single delivery group.
• Ad hoc documents and catalog documents may contain multiple sections.
• Data returned within RateOfficeOrderReply is calculated AS IF a print order had actually
been placed.
• Detailed estimated cost and discount data (where applicable) is returned in the
RateOfficeOrderReply. This data represents an estimate and may differ from the actual
invoiced amount.
• For pickup delivery groups, the location nearest to the address designated in the
RateOfficeOrderRequest message is assigned to produce the delivery group, unless a
different location is specified in the Center ID element or the customer configuration
profile stipulates a particular location.
• For local delivery delivery groups, the locations near the recipient address that can
complete the delivery by the specified date/window are identified, and the delivery group
is assigned to the closest one, unless a different location is specified in the Center ID
element or the customer configuration profile stipulates a particular location. If a Center
ID is specified, that location must be within a 30-mile radius of the recipient address in
most circumstances.
Coding Details
Required/
Element Optional/ Description
Conditional
Version R Descriptive data used to identify the web service that the client
application intends to call.
Requested Office Order R Descriptive data needed from a web service client to rate a
FedEx Office order.
User Password R Second part of the authentication credential which has a direct
relationship with the credential key.
Client Detail
Client Product ID R Data assigned by FedEx used to identify product.
Client Product Version R Data assigned by FedEx used to identify product version.
User Detail
Transaction Detail
Customer Transaction ID O Client-provided descriptive data used by the client to identify a
transaction call.
Localization O Defines the desired translation for data payload values in the
reply. (Note: Translation is currently not supported, so any
values in this object will be ignored.)
Version
Service ID R Data used by FedEx to identify the system or sub-system
which will perform the requested operation.
Value:
• oord
Order Contact R Descriptive data identifying the individual placing the FedEx
Office order.
Delivery Groups R Descriptive data establishing the discrete delivery methods for
the items in the order and identifying which items to convey
through each delivery method.
Note: Between one and two delivery groups are allowed per
order. The following combinations are supported:
Office Order Charges R Descriptive data for the means of payment for any charges
Payment assessed by FedEx Office.
Order Confirmation Email O Indicates whether or not email messages should be sent to
Requested the order contact and recipient confirming that the order was
received.
Values:
• TRUE
• FALSE
Order Completion Email O Indicates whether or not email messages should be sent to
Requested the order contact and recipient confirming that the order has
been completed.
Values:
• TRUE
• FALSE
Order Notification BCC Email O Identifies other email addresses to include as BCC recipients
Addresses of the order confirmation and completion emails.
Discount Code O Identifies the FedEx account number to use in calculating print
discounts for the order.
Order Contact
Contact R Identifies the contact person’s contact information.
Fax Number O Identifies the contact person's fax machine phone number.
Values:
• US
Delivery Group
Name O Identifies the delivery group. The Name from the request is
echoed back to the caller in the corresponding reply.
Print Line Items R Descriptive data about the contents of this delivery group.
Multiple line items are allowed per delivery group.
Catalog Document
Document Number C Specifies the unique identifier for the document within this
order. Each order's documents must be numbered
sequentially starting with 1.
Type R Specifies the type of catalog that contains the document being
ordered.
Values:
• GLOBAL
• PERSONAL
Folder Path R Specifies the catalog folder path where the document can be
found.
Document Name R Specifies the name of the document as stored in the catalog.
Customized Sections O The descriptive data about the individual sections of the
catalog document being customized, if any.
Values:
• DECLINED
Customized Sections
Section Number C Specifies the unique identifier for the section within this
document.
Upload Session ID R Specifies the unique identifier of the file upload authorization
that was used to upload the file. Combined with File Token, it
uniquely identifies the file to be used to create the section.
File Token R Specifies the identifier generated for the file by FedEx Office
when it was uploaded. Combined with Upload Session ID, it
uniquely identifies the file to be used to create the section.
Document
Document Number C Specifies the unique identifier for the document within this
order. Each order’s documents must be numbered
sequentially starting with 1.
Name O Identifies the document. The Name from the request is echoed
back to the caller in the corresponding reply.
Finishing Options Requested O Descriptive data about the document finishing that is
requested for the printed document.
Document Options O Descriptive data about the options requested for the
Requested document.
Values:
• DECLINED
Values:
• UNCOLLATED
• STAPLING
• DRILLING
• CUTTING
• FIRST_PAGE_IN_COLOR
• FIRST_PAGE_AS_COVER
• FRONT_COVER
• BACK_COVER
• FOLDING
• BINDING
• BINDER
• LAMINATION
• INSERTS
Drilling Detail C The descriptive data required for a document to be drilled (i.e.,
hole-punched).
Front Cover Media Detail C The descriptive data required for a document's front cover.
Back Cover Media Detail C The descriptive data required for a document's back cover.
Stapling Detail
Values:
• LEFT_UPPER
• TWO_ON_LONG_SIDE
Drilling Detail
Drilling Type R Identifies the type of drilling.
Values:
• THREE_HOLE_SIDE
• TWO_HOLE_TOP
Cutting Detail
Cutting Type R Identifies the type of cutting.
Values:
• HALF_CUT_PORTRAIT
• HALF_CUT_LANDSCAPE
• THIRD_CUT_PORTRAIT
• THIRD_CUT_LANDSCAPE
• QUARTER_CUT_PORTRAIT
• QUARTER_CUT_LANDSCAPE
Values:
• CARDSTOCK
• COVER
• RESUME_CARDSTOCK
Media Description R Indicates the media description used for Front Cover.
Combined with Media Category, it uniquely identifies the
media.
• ULTRA_LIME
• SUN_YELLOW
• ULTRA_ORANGE
• RED
• ULTRA_FUCHSIA
• BRIGHT_BLUE
• ULTRA_BRIGHT_WHITE
• NATURAL
• IVORY
• CANARY
• PASTEL_BLUE
• PASTEL_GREEN
• INDEX_110_LB
• BLACK_VINYL_COVER
• BLUE_VINYL_COVER
• FROSTED_COVER
• CLEAR_COVER
• SOFT_PINK
• SANDSTONE
• SEA_SPRAY
• ANTIQUE_GRAY
Values:
• CARDSTOCK
• COVER
• RESUME_CARDSTOCK
Media Description R Indicates the media description used for Back Cover.
Combined with Media Category, it uniquely identifies the
media.
• ULTRA_LIME
• SUN_YELLOW
• ULTRA_ORANGE
• RED
• ULTRA_FUCHSIA
• BRIGHT_BLUE
• ULTRA_BRIGHT_WHITE
• NATURAL
• IVORY
• CANARY
• PASTEL_BLUE
• PASTEL_GREEN
• INDEX_110_LB
• BLACK_VINYL_COVER
• BLUE_VINYL_COVER
• FROSTED_COVER
• CLEAR_COVER
• SOFT_PINK
• SANDSTONE
• SEA_SPRAY
• ANTIQUE_GRAY
Folding Detail
Text Position C Identifies whether the text on the page should be on the inside
or outside of the document after it is folded. Only applies to
single-folding and single-page double-folding.
Values:
• IN
• OUT
Values:
• SINGLE
• DOUBLE
• Z
Binding Detail
Binding Type R Identifies the type of binding.
Values:
• COIL
• COMB
Binder Detail
Binder Color R Identifies the color of the binder.
Values:
• BLACK
• WHITE
Values:
• ONE_HALF_INCH
• ONE_INCH
• ONE_AND_ONE_HALF_INCH
• TWO_INCH
• THREE_INCH
First Page in Cover O Indicates whether an extra copy of the first page of the
document should be printed and inserted in the clear plastic
cover.
Values:
• TRUE
• FALSE
Lamination Detail
Border Type O Specifies the size of the lamination border around the edge of
the document (if a border is desired).
Values:
• ONE_QUARTER_INCH
Insert Details
Sequence Number R A unique identifier for this insert within the document.
Page Number R Specifies the page numbers where Inserts must be added
(enter page number of document where the insert should
follow. If insert is to become page 5 of the document, then it
should be inserted after page 4 of the document; enter value
of 4)
Media Category O Indicates the media category used for Inserts. Combined with
Media Description, it uniquely identifies the media.
Values:
• CARDSTOCK
• COVER
• RESUME_CARDSTOCK
• STANDARD
Media Description R Indicates the media description used for Inserts. Combined
with Media Category, it uniquely identifies the media.
• ULTRA_LIME
• SUN_YELLOW
• ULTRA_ORANGE
• RED
• ULTRA_FUCHSIA
• BRIGHT_BLUE
• ULTRA_BRIGHT_WHITE
• NATURAL
• IVORY
• CANARY
• PASTEL_BLUE
• PASTEL_GREEN
• INDEX_110_LB
• BLACK_VINYL_COVER
• BLUE_VINYL_COVER
• FROSTED_COVER
• CLEAR_COVER
• SOFT_PINK
• SANDSTONE
• SEA_SPRAY
• ANTIQUE_GRAY
Tab Detail
Label Lines O One or more text lines that may appear on the tab of a
document insert.
Line Number R Specifies the line number of the Label on the Tab
Values:
• 1
• 2
Content O Specifies the text content appearing on the Label Line. The
maximum character length per Label line is 30.
Font O The font details used to render the text on the tab label lines.
Values:
• Arial
• Arial Narrow
• Times New Roman
Values:
• 8
• 10
• 12
• 14
Values:
• Bold
• Italics
• Underline
Values:
Section
Section Number C Specifies the unique identifier for the section within this
document. Each document’s sections must be numbered
sequentially starting with 1.
Upload Session ID R Specifies the unique identifier of the file upload authorization
that was used to upload the file. Combined with File Token, it
uniquely identifies the file to be used to create the section.
File Token R Specifies the identifier generated for the file by FedEx Office
when it was uploaded. Combined with Upload Session ID, it
uniquely identifies the file to be used to create the section.
Values:
• BLACK_AND_WHITE
• COLOR
Values:
• SINGLE
• DOUBLE
Section Media Detail R The descriptive data that identifies the media on which the
section is to be printed.
Section Options Requested C The descriptive data about the options requested for the
section.
Media Category R Indicates the media category used for the section. Combined
with Media Description, it uniquely identifies the media.
Values:
• CARBONLESS_MULTI_PART
• CARDSTOCK
• COVER_GLOSS
• EXECUTIVE
• PASTEL_BRIGHTS
• RESUME
• RESUME_CARDSTOCK
• STANDARD
• STANDARD_LASER
• TEXT_GLOSS
• TRANSPARENCY
Media Description R Indicates the media description used for the section.
Combined with Media Category, it uniquely identifies the
media.
Values:
• ANTIQUE • RECYCLED_100_PERCENT
• ANTIQUE_GRAY • RECYCLED_30_PERCENT
• BRIGHT_BLUE • RED
• CANARY • SALMON
• FOUR_PART • SANDSTONE
• GLOSS_COVER_10_PT • SEA_SPRAY
• GLOSS_TEXT • SIGNATURE_WHITE
• INDEX_110_LB • SOFT_PINK
• IVORY • STANDARD_WHITE
• LASER_PAPER • SUN_YELLOW
• NATURAL • TAN
• ORCHID • THREE_PART
• PASTEL_BLUE • TRANSPARENCY
• PASTEL_GREEN • TWO_PART
• PURE_WHITE • ULTRA_BRIGHT_WHITE
• ULTRA_FUCHSIA
• ULTRA_LEMON
• ULTRA_LIME
• ULTRA_ORANGE
• WILLOW
Values:
• LETTER
• LEGAL
• TABLOID
Values:
• PRESENTATION_OUTPUT
Values:
• HANDOUTS
• NOTES
• SLIDES
Values:
• FRAME_SLIDES
Handout Detail
Layout R Indicates the number of slides to be printed per page.
Values:
• ONE_SLIDE_PER_PAGE
• TWO_SLIDES_PER_PAGE
• THREE_SLIDES_PER_PAGE
• FOUR_SLIDES_PER_PAGE
• SIX_SLIDES_PER_PAGE
• NINE_SLIDES_PER_PAGE
Values:
• HORIZONTAL
• VERTICAL
Delivery Method
Delivery Type R Identifies the type of delivery for the delivery group.
Values:
• DIRECT_MAIL
• LOCAL_DELIVERY
• PICKUP
• SHIPMENT
Order Recipient C Descriptive data about the recipient of the documents in the
delivery group.
Order Direct Mail Detail C Descriptive data about the direct mail recipient list.
Order Local Delivery Detail C Descriptive data about the rqeuested local delivery.
Order Pickup Detail C Descriptive data about the criteria to use in selecting a FedEx
Office location for delivery group pickup.
Order Shipment Detail C Descriptive data about the FedEx billing and service details for
the delivery group shipment.
Order Recipient
Contact R Identifies the recipient’s contact information.
Values:
• US
Values:
• TRUE
• FALSE
File Token R Specifies the identifier generated for the file by FedEx Office
when it was uploaded. Combined with Upload Session ID, it
uniquely identifies the recipient address file.
Address Count R Specifies the number of lines in the file, where each line
corresponds to a single address. This field exists for
verification purposes.
Requested Delivery Window R Identifies the local time window when the delivery group
recipient wishes to receive the delivery group.
Values:
• MORNING
• AFTERNOON
Due Date and Time O Identifies the local date and time when the delivery group
recipient wishes to pick up the delivery group.
Format: YYYY-MM-DDTHH
Example: 2013-06-25T18
State or Province Code C Identifies state near which recipient wishes to pick up the
delivery group.
Postal Code C Identifies postal code near which recipient wishes to pick up
the delivery group.
Country Code R Identifies the country where the recipient wishes to pick up the
delivery group.
Values:
• US
Service Type R Identifies the FedEx service to use in shipping the package.
Values:
• FIRST_OVERNIGHT
• PRIORITY_OVERNIGHT
• STANDARD_OVERNIGHT
• FEDEX_2_DAY
• FEDEX_EXPRESS_SAVER
• FEDEX_GROUND
• GROUND_HOME_DELIVERY
Values:
• RECIPIENT
• THIRD_PARTY
Values:
• ACCOUNT
• CREDIT_CARD
Credit Card C The descriptive data required for payment via credit card.
Values:
• FEDEX_OFFICE
Account Number R Identifies the FedEx account number assigned to the payor.
Values:
• AMEX
• DINERS
• DISCOVER
• MASTERCARD
• VISA
Credit Card Holder R Descriptive data about the credit card’s holder.
Office Order Charges Payment > Credit Card > Credit Card Holder
Contact R Identifies the credit card holder’s contact information.
Office Order Charges Payment > Credit Card > Credit Card Holder > Contact
Person Name R Identifies the credit card holder’s name.
Office Order Charges Payment > Credit Card > Credit Card Holder > Contact > Person Name
First Name R Identifies the credit card holder’s first name.
Office Order Charges Payment > Credit Card > Credit Card Holder > Address
Street Lines R Identifies the credit card holder’s street address.
Values:
• US
Customer References
Type R Identifies the type of customer reference.
Values:
• CUSTOMER_REFERENCE
• P_O_NUMBER
• FAILURE
• ERROR
• WARNING
• NOTE
• SUCCESS
Version Descriptive data used to identify the web service that executed the
request.
Rated Office Order The descriptive data generated by FedEx Office for the FedEx Office
order that was submitted for rating.
Notifications
Severity Identifies the severity of the notification.
• FAILURE
• ERROR
• WARNING
• NOTE
• SUCCESS
Message Parameters
ID Identifies the type of the data in the Value element.
Value Identifies the value that was used as the replacement parameter.
Transaction Detail
Customer Transaction ID Client-provided descriptive data used by the client to identify a
transaction call.
Version
Service ID Data used by FedEx to identify the system or sub-system that executed
the requested operation.
Value:
• oord
Pricing The aggregate pricing information for the entire FedEx Office order.
Rated Catalog Document Document-level details generated by FedEx Office for each catalog
Details document in the delivery group that was rated.
Rated Document Details Document-level details generated by FedEx Office for each ad hoc
document in the delivery group that was rated.
Pricing The aggregate pricing information for the entire delivery group.
Rated Order Local Delivery The descriptive data specifying which FedEx Office location would be
Detail delivering the delivery group, had the delivery group been created and
not just rated. This element only applies when LOCAL_DELIVERY is
specified as the Delivery Type.
Rated Order Pickup Detail The descriptive data specifying where and when the delivery group
would have been available for pickup, had the delivery group been
created and not just rated. This element only applies when PICKUP is
specified as the Delivery Type.
Type Specifies the type of catalog that contains the document. The Type
from the request is echoed back to the caller in the corresponding reply.
Folder Path Specifies the catalog folder path where the document can be found.
The Folder Path from the request is echoed back to the caller in the
corresponding reply.
Document Name Specifies the name of the document as stored in the catalog. The
Document Name from the request is echoed back to the caller in the
corresponding reply.
Pricing The descriptive data about the pricing for the document.
Total Discount Identifies the total amount of all elements in the collection of Discounts.
Net Cost The Total Cost value less the Total Discount value.
Costs A list capturing each cost amount and its respective type.
Discounts A list capturing each discount amount and its respective type.
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• BASE_COST
• OTHER
Rated Catalog Document Details > Pricing > Costs > Amount
Currency Identifies the currency of the monetary amount.
Values:
• USD
Values:
• VOLUME
• ACCOUNT
• PROMOTION
• OTHER
Rated Catalog Document Details > Pricing > Discounts > Amount
Currency Identifies the currency of the monetary amount.
Values:
• USD
Name Identifies the document. The Name from the request is echoed back to
the caller in the corresponding reply. If there is no Name value in the
request, this will be the document's filename.
Pricing The descriptive data about the pricing for the document.
Total Discount Identifies the total amount of all elements in the collection of Discounts.
Net Cost The Total Cost value less the Total Discount value.
Costs A list capturing each cost amount and its respective type.
Discounts A list capturing each discount amount and its respective type.
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• BASE_COST
• OTHER
Values:
• USD
Values:
• VOLUME
• ACCOUNT
• PROMOTION
• OTHER
Values:
• USD
Total Discount Identifies the total amount of all elements in the collection of Discounts.
Net Cost The Total Cost value less the Total Discount value.
Tax The total tax amount assessed on the Net Cost value.
Net Price The Net Cost value plus the Tax value.
Costs A list capturing each cost amount and its respective type. At the
delivery group level, the list includes both group-level costs as well as
all costs associated with the delivery group’s documents.
Discounts A list capturing each discount amount and its respective type. At the
delivery group level, the list includes both group-level discounts as well
as all discounts associated with the delivery group’s documents.
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• BASE_COST
• FILE_RENDERING
• HANDLING
• OTHER
• POSTAGE
• SHIPPING
Rated Delivery Group Details > Pricing > Costs > Amount
Currency Identifies the currency of the monetary amount.
Values:
• USD
Values:
• VOLUME
• ACCOUNT
• PROMOTION
• OTHER
Rated Delivery Group Details > Pricing > Discounts > Amount
Currency Identifies the currency of the monetary amount.
Values:
• USD
Rated Order Local Delivery Detail > FedEx Office Center Detail
Name Identifies the name of the FedEx Office location that would be delivering
the delivery group, had it been created instead of just rated.
ID Specifies the unique identifier that FedEx Office uses to designate the
location that would be delivering the delivery group, had it been created
instead of just rated.
Address Identifies the address of the FedEx Office location that would be
delivering the delivery group, had it been created instead of just rated.
Phone Number Identifies the phone number of the FedEx Office location that would be
delivering the delivery group, had it been created instead of just rated.
Email Address Identifies the email address of the FedEx Office location that would be
delivering the delivery group, had it been created instead of just rated.
City Identifies the city of the FedEx Office location that would be delivering
the delivery group, had it been created instead of just rated.
State or Province Code Identifies the state of the FedEx Office location that would be delivering
the delivery group, had it been created instead of just rated.
Postal Code Identifies the postal code of the FedEx Office location that would be
delivering the delivery group, had it been created instead of just rated.
Country Code Identifies the country of the FedEx Office location that would be
delivering the delivery group, had it been created instead of just rated.
Values:
• US
Center ID Specifies the unique identifier that FedEx Office uses to designate the
location where the delivery group would have been available for pickup,
had it been created instead of just rated.
Center Address Identifies the address of the FedEx Office location where the delivery
group would have been available for pickup, had it been created
instead of just rated.
Center Phone Number Identifies the phone number of the FedEx Office location where the
delivery group would have been available for pickup, had it been
created instead of just rated.
Center Email Address Identifies the email address of the FedEx Office location where the
delivery group would have been available for pickup, had it been
created instead of just rated.
Due Date and Time Indicates the local date/time when the delivery group would have been
available for pickup, had it been created instead of just rated.
City Identifies the name of the city where the delivery group would have
been available for pickup, had it been created instead of just rated.
State or Province Code Identifies the name of the state where the delivery group would have
been available for pickup, had it been created instead of just rated.
Postal Code Identifies the postal code where the delivery group would have been
available for pickup, had it been created instead of just rated.
Country Code Identifies the name of the country where the delivery group would have
been available for pickup, had it been created instead of just rated.
Values:
• US
Total Discount Identifies the total amount of all elements in the collection of Discounts.
Net Cost The Total Cost value less the Total Discount value.
Tax The total tax amount assessed on the Net Cost value.
Net Price The Net Cost value plus the Tax value.
Costs A list capturing each cost amount and its respective type. At the order
level, the list includes both order-level costs as well as all costs
associated with the order’s delivery groups and documents.
Discounts A list capturing each discount amount and its respective type. At the
order level, the list includes both order-level discounts as well as all
discounts associated with the order’s delivery groups and documents.
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• BASE_COST
• FILE_RENDERING
• HANDLING
• OTHER
• POSTAGE
• SHIPPING
Values:
• USD
Values:
• VOLUME
• ACCOUNT
• PROMOTION
• OTHER
Values:
• USD
Operation Details
The createOfficeOrder operation is used to pass a CreateOfficeOrderRequest message and
subsequently receive a CreateOfficeOrderReply message.
Version R Descriptive data used to identify the web service that the client
application intends to call.
Requested Office Order R Descriptive data needed from a web service client to create a
FedEx Office order.
User Password R Second part of the authentication credential which has a direct
relationship with the credential key.
Client Detail
Client Product ID R Data assigned by FedEx used to identify product.
Client Product Version R Data assigned by FedEx used to identify product version.
User Detail
Transaction Detail
Customer Transaction ID O Client-provided descriptive data used by the client to identify a
transaction call.
Localization O Defines the desired translation for data payload values in the
reply. (Note: Translation is currently not supported, so any
values in this object will be ignored.)
Version
Service ID R Data used by FedEx to identify the system or sub-system
which will perform the requested operation.
Value:
• oord
Order Contact R Descriptive data identifying the individual placing the FedEx
Office order.
Delivery Groups R Descriptive data establishing the discrete delivery methods for
the items in the order and identifying which items to convey
through each delivery method.
Note: Between one and two delivery groups are allowed per
order. The following combinations are supported:
Order Confirmation Email C Indicates whether or not email messages should be sent to
Requested the order contact and recipient confirming that the order was
received.
Values:
• TRUE
• FALSE
Order Completion Email O Indicates whether or not email messages should be sent to
Requested the order contact and recipient confirming that the order has
been completed.
Values:
• TRUE
• FALSE
Order Notification BCC Email O Identifies other email addresses to include as BCC recipients
Addresses of the order confirmation and completion emails.
Discount Code O Identifies the FedEx account number enabled for print to use
in calculating print discounts for the order.
Order Contact
Contact R Identifies the contact person’s contact information.
Fax Number O Identifies the contact person's fax machine phone number.
Values:
• US
Delivery Group
Name O Identifies the delivery group. The Name from the request is
echoed back to the caller in the corresponding reply.
Print Line Items R Descriptive data about the contents of this delivery group.
Multiple line items are allowed per delivery group.
Catalog Document
Document Number C Specifies the unique identifier for the document within this
order. Each order's documents must be numbered
sequentially starting with 1.
Type R Specifies the type of catalog that contains the document being
ordered.
Values:
• GLOBAL
• PERSONAL
Folder Path R Specifies the catalog folder path where the document can be
found.
Document Name R Specifies the name of the document as stored in the catalog.
Customized Sections O The descriptive data about the individual sections of the
catalog document being customized, if any.
Values:
• DECLINED
Customized Sections
Section Number C Specifies the unique identifier for the section within this
document.
Upload Session ID R Specifies the unique identifier of the file upload authorization
that was used to upload the file. Combined with FileToken, it
uniquely identifies the file to be used to create the section.
File Token R Specifies the identifier generated for the file by FedEx Office
when it was uploaded. Combined with UploadSessionId, it
uniquely identifies the file to be used to create the section.
Document
Document Number C Specifies the unique identifier for the document within this
order. Each order’s documents must be numbered
sequentially starting with 1.
Name O Identifies the document. The Name from the request is echoed
back to the caller in the corresponding reply.
Finishing Options Requested O Descriptive data about the document finishing that is
requested for the printed document.
Document Options O Descriptive data about the options requested for the
Requested document.
Values:
• DECLINED
Values:
• UNCOLLATED
• STAPLING
• DRILLING
• CUTTING
• FIRST_PAGE_IN_COLOR
• FIRST_PAGE_AS_COVER
• FRONT_COVER
• BACK_COVER
• FOLDING
• BINDING
• BINDER
• LAMINATION
• INSERT
Drilling Detail C The descriptive data required for a document to be drilled (i.e.,
hole-punched).
Front Cover Media Detail C The descriptive data required for a document's front cover.
Back Cover Media Detail C The descriptive data required for a document's back cover.
Stapling Detail
Stapling Type R Identifies the type of stapling.
Values:
• LEFT_UPPER
• TWO_ON_LONG_SIDE
Drilling Detail
Drilling Type R Identifies the type of drilling.
Values:
• THREE_HOLE_SIDE
• TWO_HOLE_TOP
Cutting Detail
Cutting Type R Identifies the type of cutting.
Values:
• HALF_CUT_PORTRAIT
• HALF_CUT_LANDSCAPE
• THIRD_CUT_PORTRAIT
• THIRD_CUT_LANDSCAPE
• QUARTER_CUT_PORTRAIT
• QUARTER_CUT_LANDSCAPE
Values:
• CARDSTOCK
• COVER
• RESUME_CARDSTOCK
Media Description R Indicates the media description used for Front Cover.
Combined with Media Category, it uniquely identifies the
media.
• ULTRA_LIME
• SUN_YELLOW
• ULTRA_ORANGE
• RED
• ULTRA_FUCHSIA
• BRIGHT_BLUE
• ULTRA_BRIGHT_WHITE
• NATURAL
• IVORY
• CANARY
• PASTEL_BLUE
• PASTEL_GREEN
• INDEX_110_LB
• BLACK_VINYL_COVER
• BLUE_VINYL_COVER
• FROSTED_COVER
• CLEAR_COVER
• SOFT_PINK
• SANDSTONE
• SEA_SPRAY
• ANTIQUE_GRAY
Values:
• CARDSTOCK
• COVER
• RESUME_CARDSTOCK
Media Description R Indicates the media description used for Back Cover.
Combined with Media Category, it uniquely identifies the
media.
• ULTRA_LIME
• SUN_YELLOW
• ULTRA_ORANGE
• RED
• ULTRA_FUCHSIA
• BRIGHT_BLUE
• ULTRA_BRIGHT_WHITE
• NATURAL
• IVORY
• CANARY
• PASTEL_BLUE
• PASTEL_GREEN
• INDEX_110_LB
• BLACK_VINYL_COVER
• BLUE_VINYL_COVER
• FROSTED_COVER
• CLEAR_COVER
• SOFT_PINK
• SANDSTONE
• SEA_SPRAY
• ANTIQUE_GRAY
Folding Detail
Text Position C Identifies whether the text on the page should be on the inside
or outside of the document after it is folded. Only applies to
single-folding and single-page double-folding.
Values:
• IN
• OUT
Values:
• SINGLE
• DOUBLE
• Z
Binding Detail
Binding Type R Identifies the type of binding.
Values:
• COIL
• COMB
Binder Detail
Binder Color R Identifies the color of the binder.
Values:
• BLACK
• WHITE
Values:
• ONE_HALF_INCH
• ONE_INCH
• ONE_AND_ONE_HALF_INCH
• TWO_INCH
• THREE_INCH
First Page in Cover O Indicates whether an extra copy of the first page of the
document should be printed and inserted in the clear plastic
cover.
Values:
• TRUE
• FALSE
Lamination Detail
Border Type O Specifies the size of the lamination border around the edge of
the document (if a border is desired).
Values:
• ONE_QUARTER_INCH
Insert Details
Sequence Number R A unique identifier for this insert within the document.
Page Number R Specifies the page numbers where Inserts must be added
(enter page number of document where the insert should
follow. If insert is to become page 5 of the document, then it
should be inserted after page 4 of the document; enter value
of 4)
Media Category O Indicates the media category used for Inserts. Combined with
Media Description, it uniquely identifies the media.
Values:
• CARDSTOCK
• COVER
• RESUME_CARDSTOCK
• STANDARD
Media Description R Indicates the media description used for Inserts. Combined
with Media Category, it uniquely identifies the media.
• ULTRA_LIME
• SUN_YELLOW
• ULTRA_ORANGE
• RED
• ULTRA_FUCHSIA
• BRIGHT_BLUE
• ULTRA_BRIGHT_WHITE
• NATURAL
• IVORY
• CANARY
• PASTEL_BLUE
• PASTEL_GREEN
• INDEX_110_LB
• BLACK_VINYL_COVER
• BLUE_VINYL_COVER
• FROSTED_COVER
• CLEAR_COVER
• SOFT_PINK
• SANDSTONE
• SEA_SPRAY
• ANTIQUE_GRAY
Tab Detail
Label Lines O One or more text lines that may appear on the tab of a
document insert.
Line Number R Specifies the line number of the Label on the Tab
Values:
• 1
• 2
Content O Specifies the text content appearing on the Label Line. The
maximum character length per Label line is 30.
Font O The font details used to render the text on the tab label lines.
Values:
• Arial
• Arial Narrow
• Times New Roman
Values:
• 8
• 10
• 12
• 14
Values:
• Bold
• Italics
• Underline
Values:
Section
Section Number C Specifies the unique identifier for the section within this
document. Each document’s sections must be numbered
sequentially starting with 1.
Upload Session ID R Specifies the unique identifier of the file upload authorization
that was used to upload the file. Combined with File Token, it
uniquely identifies the file to be used to create the section.
File Token R Specifies the identifier generated for the file by FedEx Office
when it was uploaded. Combined with Upload Session ID, it
uniquely identifies the file to be used to create the section.
Values:
• BLACK_AND_WHITE
• COLOR
Values:
• SINGLE
• DOUBLE
Section Media Detail C The descriptive data that identifies the media on which the
section is to be printed.
Section Options Requested C The descriptive data about the options requested for the
section.
Media Category R Indicates the media category used for the section. Combined
with Media Description, it uniquely identifies the media.
Values:
• CARBONLESS_MULTI_PART
• CARDSTOCK
• COVER_GLOSS
• EXECUTIVE
• PASTEL_BRIGHTS
• RESUME
• RESUME_CARDSTOCK
• STANDARD
• STANDARD_LASER
• TEXT_GLOSS
• TRANSPARENCY
Media Description R Indicates the media description used for the section.
Combined with Media Category, it uniquely identifies the
media.
Values:
• ANTIQUE • RECYCLED_100_PERCENT
• ANTIQUE_GRAY • RECYCLED_30_PERCENT
• BRIGHT_BLUE • RED
• CANARY • SALMON
• FOUR_PART • SANDSTONE
• GLOSS_COVER_10_PT • SEA_SPRAY
• GLOSS_TEXT • SIGNATURE_WHITE
• INDEX_110_LB • SOFT_PINK
• IVORY • STANDARD_WHITE
• LASER_PAPER • SUN_YELLOW
• NATURAL • TAN
• ORCHID • THREE_PART
• PASTEL_BLUE • TRANSPARENCY
• PASTEL_GREEN • TWO_PART
• PURE_WHITE • ULTRA_BRIGHT_WHITE
• ULTRA_FUCHSIA
• ULTRA_LEMON
• ULTRA_LIME
• ULTRA_ORANGE
• WILLOW
Values:
• LETTER
• LEGAL
• TABLOID
• CUSTOM
Media Dimensions C Descriptive data specifying the exact dimensions of the media.
Media Dimensions
Length R Indicates the length of the media, in the unit of measure stated
in the Units element.
Width R Indicates the width of the media, in the unit of measure stated
in the Units element.
Units R Indicates the unit of measure in which the length and width
values are stated.
Values:
• IN
Section Option Types C Identifies each section option requested by the customer.
Values:
• PRESENTATION_OUTPUT
Values:
• HANDOUTS
• NOTES
• SLIDES
Values:
• FRAME_SLIDES
Handout Detail
Layout R Indicates the number of slides to be printed per page.
Values:
• ONE_SLIDE_PER_PAGE
• TWO_SLIDES_PER_PAGE
• THREE_SLIDES_PER_PAGE
• FOUR_SLIDES_PER_PAGE
• SIX_SLIDES_PER_PAGE
• NINE_SLIDES_PER_PAGE
Values:
• HORIZONTAL
• VERTICAL
Values:
• SPECIAL_INSTRUCTIONS
Special Instructions Details C Descriptive data about the special instructions specified by the
customer for the document.
Values:
• OTHER
Delivery Method
Delivery Type R Identifies the type of delivery for the delivery group.
Values:
• DIRECT_MAIL
• LOCAL_DELIVERY
• PICKUP
• SHIPMENT
Order Recipient C Descriptive data about the recipient of the documents in the
delivery group.
Order Direct Mail Detail C Descriptive data about the direct mail recipient list.
Order Shipment Detail C Descriptive data about the FedEx billing and service details for
the delivery group shipment.
Order Recipient
Contact R Identifies the recipient’s contact information.
Values:
• US
Values:
• TRUE
• FALSE
File Token R Specifies the identifier generated for the file by FedEx Office
when it was uploaded. Combined with Upload Session ID, it
uniquely identifies the recipient address file.
Address Count R Specifies the number of lines in the file, where each line
corresponds to a single address. This field exists for
verification purposes.
Requested Delivery Window R Identifies the local time window when the delivery group
recipient wishes to receive the delivery group.
Values:
• MORNING
• AFTERNOON
Due Date and Time O Identifies the local date and time when the delivery group
recipient wishes to pick up the delivery group.
Format: YYYY-MM-DDTHH
Example: 2013-06-25T18
State or Province Code C Identifies state near which recipient wishes to pick up the
delivery group.
Postal Code C Identifies postal code near which recipient wishes to pick up
the delivery group.
Country Code R Identifies the country where the recipient wishes to pick up the
delivery group.
Values:
• US
Service Type R Identifies the FedEx service to use in shipping the package.
Values:
• FIRST_OVERNIGHT
• PRIORITY_OVERNIGHT
• STANDARD_OVERNIGHT
• FEDEX_2_DAY
• FEDEX_EXPRESS_SAVER
• FEDEX_GROUND
• GROUND_HOME_DELIVERY
Values:
• RECIPIENT
• THIRD_PARTY
Values:
• ACCOUNT
• CREDIT_CARD
Credit Card C The descriptive data required for payment via credit card.
Values:
• FEDEX_OFFICE
Account Number R Identifies the FedEx account number assigned to the payor.
Values:
• AMEX
• DINERS
• DISCOVER
• MASTERCARD
• VISA
Credit Card Holder R Descriptive data about the credit card’s holder.
Office Order Charges Payment > Credit Card > Credit Card Holder
Contact R Identifies the credit card holder’s contact information.
Office Order Charges Payment > Credit Card > Credit Card Holder > Contact
Person Name R Identifies the credit card holder’s name.
Office Order Charges Payment > Credit Card > Credit Card Holder > Contact > Person Name
First Name R Identifies the credit card holder’s first name.
Office Order Charges Payment > Credit Card > Credit Card Holder > Address
Street Lines R Identifies the credit card holder’s street address.
Postal Code R Identifies the credit card holder’s postal code. (Validated by
the payment processor.)
Values:
• US
Customer References
Type R Identifies the type of customer reference.
Values:
• CUSTOMER_REFERENCE
• P_O_NUMBER
• FAILURE
• ERROR
• WARNING
• NOTE
• SUCCESS
Version Descriptive data used to identify the web service that executed the
request.
Completed Office Order The descriptive data generated by FedEx Office for the order that was
submitted for creation.
Notifications
Severity Identifies the severity of the notification.
• FAILURE
• ERROR
• WARNING
• NOTE
• SUCCESS
Message Parameters
ID Identifies the type of the data in the Value element.
Value Identifies the value that was used as the replacement parameter.
Transaction Detail
Customer Transaction ID Client-provided descriptive data used by the client to identify a
transaction call.
Version
Service ID Data used by FedEx to identify the system or sub-system that executed
the requested operation.
Value:
• oord
Completed Delivery Group Pricing and delivery method details generated by FedEx Office for each
Details delivery group in the order that was created.
Pricing The aggregate pricing information for the entire FedEx Office order.
Completed Catalog Document-level details generated by FedEx Office for each catalog
Document Details document in the delivery group that was created.
Completed Document Document-level details generated by FedEx Office for each ad hoc
Details document in the delivery group that was created.
Pricing The aggregate pricing information for the entire delivery group.
Completed Order Local The descriptive data specifying which FedEx Office location will be
Delivery Detail delivering the delivery group. This element only applies when
LOCAL_DELIVERY is specified as the Delivery Type.
Completed Order Pickup The descriptive data specifying where and when the delivery group will
Detail be available for pickup. This element only applies when PICKUP is
specified as the Delivery Type.
Type Specifies the type of catalog that contains the document. The Type
from the request is echoed back to the caller in the corresponding reply.
Folder Path Specifies the catalog folder path where the document can be found.
The Folder Path from the request is echoed back to the caller in the
corresponding reply.
Document Name Specifies the name of the document as stored in the catalog. The
Document Name from the request is echoed back to the caller in the
corresponding reply.
Pricing The descriptive data about the pricing for the document.
Total Discount Identifies the total amount of all elements in the collection of Discounts.
Net Cost The Total Cost value less the Total Discount value.
Costs A list capturing each cost amount and its respective type.
Discounts A list capturing each discount amount and its respective type.
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• BASE_COST
• OTHER
Completed Catalog Document Details > Pricing > Costs > Amount
Currency Identifies the currency of the monetary amount.
Values:
• USD
Values:
• VOLUME
• ACCOUNT
• PROMOTION
• OTHER
Completed Catalog Document Details > Pricing > Discounts > Amount
Currency Identifies the currency of the monetary amount.
Values:
• USD
Name Identifies the document. The Name from the request is echoed back to
the caller in the corresponding reply. If there is no Name value in the
request, this will be the document's filename.
Pricing The descriptive data about the pricing for the document.
Total Discount Identifies the total amount of all elements in the collection of Discounts.
Net Cost The Total Cost value less the Total Discount value.
Costs A list capturing each cost amount and its respective type.
Discounts A list capturing each discount amount and its respective type.
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• BASE_COST
• OTHER
Values:
• USD
Values:
• VOLUME
• ACCOUNT
• PROMOTION
• OTHER
Values:
• USD
Total Discount Identifies the total amount of all elements in the collection of Discounts.
Net Cost The Total Cost value less the Total Discount value.
Tax The total tax amount assessed on the Net Cost value.
Net Price The Net Cost value plus the Tax value.
Costs A list capturing each cost amount and its respective type. At the
delivery group level, the list includes both group-level costs as well as
all costs associated with the delivery group’s documents.
Discounts A list capturing each discount amount and its respective type. At the
delivery group level, the list includes both group-level discounts as well
as all discounts associated with the delivery group’s documents.
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• BASE_COST
• FILE_RENDERING
• HANDLING
• OTHER
• POSTAGE
• SHIPPING
Completed Delivery Group Details > Pricing > Costs > Amount
Currency Identifies the currency of the monetary amount.
Values:
• USD
Values:
• VOLUME
• ACCOUNT
• PROMOTION
• OTHER
Completed Delivery Group Details > Pricing > Discounts > Amount
Currency Identifies the currency of the monetary amount.
Values:
• USD
Completed Order Local Delivery Detail > FedEx Office Center Detail
Name Identifies the name of the FedEx Office location that will be delivering
the delivery group.
ID Specifies the unique identifier that FedEx Office uses to designate the
location that will be delivering the delivery group.
Address Identifies the address of the FedEx Office location that will be delivering
the delivery group.
Phone Number Identifies the phone number of the FedEx Office location that will be
delivering the delivery group.
Email Address Identifies the email address of the FedEx Office location that will be
delivering the delivery group.
City Identifies the city of the FedEx Office location that will be delivering the
delivery group.
State or Province Code Identifies the state of the FedEx Office location that will be delivering
the delivery group.
Postal Code Identifies the postal code of the FedEx Office location that will be
delivering the delivery group.
Country Code Identifies the country of the FedEx Office location that will be delivering
the delivery group.
Values:
• US
Center ID Specifies the unique identifier that FedEx Office uses to designate the
location where the delivery group will be available for pickup.
Center Address Identifies the address of the FedEx Office location where the delivery
group will be available for pickup.
Center Phone Number Identifies the phone number of the FedEx Office location where the
delivery group will be available for pickup.
Center Email Address Identifies the email address of the FedEx Office location where the
delivery group will be available for pickup.
Due Date and Time Indicates the local date/time when the delivery group will be available
for pickup.
City Identifies the name of the city where the delivery group will be available
for pickup.
State or Province Code Identifies the name of the state where the delivery group will be
available for pickup.
Postal Code Identifies the postal code where the delivery group will be available for
pickup.
Country Code Identifies the name of the country where the delivery group will be
available for pickup.
Values:
• US
Total Discount Identifies the total amount of all elements in the collection of Discounts.
Net Cost The Total Cost value less the Total Discount value.
Tax The total tax amount assessed on the Net Cost value.
Net Price The Net Cost value plus the Tax value.
Costs A list capturing each cost amount and its respective type. At the order
level, the list includes both order-level costs as well as all costs
associated with the order’s delivery groups and documents.
Discounts A list capturing each discount amount and its respective type. At the
order level, the list includes both order-level discounts as well as all
discounts associated with the order’s delivery groups and documents.
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• USD
Values:
• BASE_COST
• FILE_RENDERING
• HANDLING
• OTHER
• POSTAGE
• SHIPPING
Values:
• USD
Values:
• VOLUME
• ACCOUNT
• PROMOTION
• OTHER
Values:
• USD
This section of the guide provides example SOAP messages for the Office Order Web
Service (OORD).
Request and reply transactions are provided for each of the below functions:
• Upload Location
Example: Get Upload Location request with correct credentials
Service Request: Click Here
Service Reply: Click Here
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://fedex.com/ws/officeorder/v2">
<soapenv:Header/>
<soapenv:Body>
<v2:OfficeOrderUploadLocationRequest>
<v2:WebAuthenticationDetail>
<v2:UserCredential>
<v2:Key>xxxxxxxxxxxxxxxx</v2:Key>
<v2:Password>xxxxxxxxxxxxxxxxxxxxxxxxx</v2:Password>
</v2:UserCredential>
</v2:WebAuthenticationDetail>
<v2:ClientDetail>
<v2:ClientProductId>XXXX</v2:ClientProductId>
<v2:ClientProductVersion>0000</v2:ClientProductVersion>
<v2:IntegratorId>00000</v2:IntegratorId>
</v2:ClientDetail>
<v2:TransactionDetail>
<v2:CustomerTransactionId>sampleTransaction</v2:CustomerTransactionId>
</v2:TransactionDetail>
<v2:Version>
<v2:ServiceId>oord</v2:ServiceId>
<v2:Major>3</v2:Major>
<v2:Intermediate>1</v2:Intermediate>
<v2:Minor>0</v2:Minor>
</v2:Version>
</v2:OfficeOrderUploadLocationRequest>
</soapenv:Body>
</soapenv:Envelope>
Back to Examples
Example
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<OfficeOrderUploadLocationReply
xmlns="http://fedex.com/ws/officeorder/v2">
<HighestSeverity>SUCCESS</HighestSeverity>
<Notifications>
<Severity>SUCCESS</Severity>
<Source>oord</Source>
<Code>0000</Code>
<Message>Request was successful.</Message>
<LocalizedMessage>Request was successful.</LocalizedMessage>
</Notifications>
<TransactionDetail>
<CustomerTransactionId>sampleTransaction</CustomerTransactionId>
</TransactionDetail>
<Version>
<ServiceId>oord</ServiceId>
<Major>3</Major>
<Intermediate>1</Intermediate>
<Minor>0</Minor>
</Version>
<UploadUrl>https://printonline.fedex.com/partnerUpload.process?authToken=11111
11111111111111111111111111111111111&partnerId=1111111111</UploadUrl>
<UploadSessionId>11111111111111111111111111111111111111111111111111</Upload Ses
sionId>
</OfficeOrderUploadLocationReply>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Back to Examples
Note: The below example is written in Java. It is provided for illustrative purposes only and
is not intended for production application nor guaranteed to work for all programming
languages, applications, and host systems.
Back to Examples
Note: The below example is written in Java. It is provided for illustrative purposes only and
is not intended for production application nor guaranteed to work for all programming
languages, applications, and host systems.
Back to Examples
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://fedex.com/ws/officeorder/v2">
<soapenv:Header />
<soapenv:Body>
<v2:RateOfficeOrderRequest>
<v2:WebAuthenticationDetail>
<v2:UserCredential>
<v2:Key>xxxxxxxxxxxxxxxx</v2:Key>
<v2:Password>xxxxxxxxxxxxxxxxxxxxxxxxx</v2:Password>
</v2:UserCredential>
</v2:WebAuthenticationDetail>
<v2:ClientDetail>
<v2:ClientProductId>XXXX</v2:ClientProductId>
<v2:ClientProductVersion>0000</v2:ClientProductVersion>
<v2:IntegratorId>00000</v2:IntegratorId>
</v2:ClientDetail>
<!--Optional: -->
<v2:TransactionDetail>
<!--Optional: -->
<v2:CustomerTransactionId>0001</v2:CustomerTransactionId>
</v2:TransactionDetail>
<v2:Version>
<v2:ServiceId>oord</v2:ServiceId>
<v2:Major>3</v2:Major>
<v2:Intermediate>1</v2:Intermediate>
<v2:Minor>0</v2:Minor>
</v2:Version>
<v2:RequestedOfficeOrder>
<v2:OrderContact>
<v2:Contact>
<v2:PersonName>
<v2:FirstName>John</v2:FirstName>
<v2:LastName>Doe</v2:LastName>
</v2:PersonName>
<!--Optional: -->
<v2:CompanyName>ABC Company</v2:CompanyName>
<v2:PhoneNumber>9015555555</v2:PhoneNumber>
<!--Optional: -->
<v2:FaxNumber>9015555556</v2:FaxNumber>
<!--Optional: -->
<v2:EMailAddress>john.doe@abccompany.com</v2:EMailAddress>
</v2:Contact>
<!--Optional: -->
<v2:Address>
Back to Examples
Example
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<RateOfficeOrderReply xmlns="http://fedex.com/ws/officeorder/v2">
<HighestSeverity>SUCCESS</HighestSeverity>
<Notifications>
<Severity>SUCCESS</Severity>
<Source>oord</Source>
<Code>0000</Code>
<Message>Request was successful.</Message>
<LocalizedMessage>Request was successful.</LocalizedMessage>
</Notifications>
<TransactionDetail>
<CustomerTransactionId>0001</CustomerTransactionId>
</TransactionDetail>
<Version>
<ServiceId>oord</ServiceId>
<Major>3</Major>
<Intermediate>1</Intermediate>
<Minor>0</Minor>
</Version>
<RatedOfficeOrder>
<RatedDeliveryGroupDetails>
<RatedDocumentDetails>
<Name>testDocument.pdf</Name>
<Pricing>
<TotalCost>
<Currency>USD</Currency>
<Amount>3.25</Amount>
</TotalCost>
<TotalDiscount>
<Currency>USD</Currency>
<Amount>0.0</Amount>
</TotalDiscount>
<NetCost>
<Currency>USD</Currency>
<Amount>3.25</Amount>
</NetCost>
<Costs>
<Type>BASE_COST</Type>
<Amount>
<Currency>USD</Currency>
<Amount>3.25</Amount>
</Amount>
Back to Examples
Example 1
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://fedex.com/ws/officeorder/v2">
<soapenv:Header/>
<soapenv:Body>
<v2:CreateOfficeOrderRequest>
<v2:WebAuthenticationDetail>
<v2:UserCredential>
<v2:Key>xxxxxxxxxxxxxxxx</v2:Key>
<v2:Password>xxxxxxxxxxxxxxxxxxxxxxxxx</v2:Password>
</v2:UserCredential>
</v2:WebAuthenticationDetail>
<v2:ClientDetail>
<v2:ClientProductId>XXXX</v2:ClientProductId>
<v2:ClientProductVersion>0000</v2:ClientProductVersion>
<v2:IntegratorId>00000</v2:IntegratorId>
</v2:ClientDetail>
<v2:TransactionDetail>
<v2:CustomerTransactionId/> </v2:TransactionDetail>
<v2:Version>
<v2:ServiceId>oord</v2:ServiceId>
<v2:Major>3</v2:Major>
<v2:Intermediate>1</v2:Intermediate>
<v2:Minor>0</v2:Minor>
</v2:Version>
<v2:RequestedOfficeOrder>
<v2:OrderContact>
<v2:Contact>
<v2:PersonName>
<v2:FirstName>John</v2:FirstName>
<v2:LastName>Doe</v2:LastName>
</v2:PersonName>
<v2:PhoneNumber>9015555555</v2:PhoneNumber>
<v2:EMailAddress>John.Doe@abccompany.com</v2:EMailAddress>
</v2:Contact>
<v2:Address>
<!--1 to 2 repetitions: -->
<v2:StreetLines>100 Main Street</v2:StreetLines>
<v2:StreetLines>2nd Floor </v2:StreetLines>
<v2:City>Collierville</v2:City>
<v2:StateOrProvinceCode>TN</v2:StateOrProvinceCode>
<v2:PostalCode>38017</v2:PostalCode>
<v2:CountryCode>US</v2:CountryCode>
<!--Optional: -->
<v2:Residential>false</v2:Residential>
Back to Examples
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://fedex.com/ws/officeorder/v2">
<soapenv:Header/>
<soapenv:Body>
<v2:CreateOfficeOrderRequest>
<v2:WebAuthenticationDetail>
<v2:UserCredential>
<v2:Key>xxxxxxxxxxxxxxxx</v2:Key>
<v2:Password>xxxxxxxxxxxxxxxxxxxxxxxxx</v2:Password>
</v2:UserCredential>
</v2:WebAuthenticationDetail>
<v2:ClientDetail>
<v2:ClientProductId>XXXX</v2:ClientProductId>
<v2:ClientProductVersion>0000</v2:ClientProductVersion>
<v2:IntegratorId>00000</v2:IntegratorId>
</v2:ClientDetail>
<v2:TransactionDetail>
<v2:CustomerTransactionId/> </v2:TransactionDetail>
<v2:Version>
<v2:ServiceId>oord</v2:ServiceId>
<v2:Major>3</v2:Major>
<v2:Intermediate>1</v2:Intermediate>
<v2:Minor>0</v2:Minor>
</v2:Version>
<v2:RequestedOfficeOrder>
<v2:OrderContact>
<v2:Contact>
<v2:PersonName>
<v2:FirstName>John</v2:FirstName>
<v2:LastName>Doe</v2:LastName>
</v2:PersonName>
<v2:PhoneNumber>9015555555</v2:PhoneNumber>
<v2:EMailAddress>john.doe@abccompany.com</v2:EMailAddress>
</v2:Contact>
<v2:Address>
<!--1 to 2 repetitions: -->
<v2:StreetLines>555 Fairfield Lane</v2:StreetLines>
<v2:StreetLines>Apt #505</v2:StreetLines>
<v2:City>Memphis</v2:City>
<v2:StateOrProvinceCode>TN</v2:StateOrProvinceCode>
<v2:PostalCode>38103</v2:PostalCode>
<v2:CountryCode>US</v2:CountryCode>
<!--Optional: -->
<v2:Residential>true</v2:Residential>
</v2:Address>
</v2:OrderContact>
<v2:DeliveryGroups>
<v2:DeliveryMethod>
Back to Examples
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://fedex.com/ws/officeorder/v2">
<soapenv:Header />
<soapenv:Body>
<v2:CreateOfficeOrderRequest>
<v2:WebAuthenticationDetail>
<v2:UserCredential>
<v2:Key>xxxxxxxxxxxxxxxx</v2:Key>
<v2:Password>xxxxxxxxxxxxxxxxxxxxxxxxx</v2:Password>
</v2:UserCredential>
</v2:WebAuthenticationDetail>
<v2:ClientDetail>
<v2:ClientProductId>XXXX</v2:ClientProductId>
<v2:ClientProductVersion>0000</v2:ClientProductVersion>
<v2:IntegratorId>00000</v2:IntegratorId>
</v2:ClientDetail>
<v2:TransactionDetail>
<v2:CustomerTransactionId>SystemRef</v2:CustomerTransactionId>
</v2:TransactionDetail>
<v2:Version>
<v2:ServiceId>oord</v2:ServiceId>
<v2:Major>3</v2:Major>
<v2:Intermediate>1</v2:Intermediate>
<v2:Minor>0</v2:Minor>
</v2:Version>
<v2:RequestedOfficeOrder>
<v2:OrderContact>
<v2:Contact>
<v2:PersonName>
<v2:FirstName>John</v2:FirstName>
<v2:LastName>Doe</v2:LastName>
</v2:PersonName>
<v2:CompanyName>ABC Company</v2:CompanyName>
<v2:PhoneNumber>901-555-5555</v2:PhoneNumber>
<v2:EMailAddress>John.Doe@abccompany.com</v2:EMailAddress>
</v2:Contact>
<v2:Address>
<!--1 to 2 repetitions: -->
<v2:StreetLines>100 Main Street</v2:StreetLines>
<v2:StreetLines>2nd Floor</v2:StreetLines>
<v2:City>Collierville</v2:City>
<v2:StateOrProvinceCode>TN</v2:StateOrProvinceCode>
<v2:PostalCode>38017</v2:PostalCode>
<v2:CountryCode>US</v2:CountryCode>
<v2:Residential>false</v2:Residential>
</v2:Address>
</v2:OrderContact>
<v2:DeliveryGroups>
Back to Examples
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://fedex.com/ws/officeorder/v2">
<soapenv:Header/>
<soapenv:Body>
<v2:CreateOfficeOrderRequest>
<v2:WebAuthenticationDetail>
<v2:UserCredential>
<v2:Key>xxxxxxxxxxxxxxxx</v2:Key>
<v2:Password>xxxxxxxxxxxxxxxxxxxxxxxxx</v2:Password>
</v2:UserCredential>
</v2:WebAuthenticationDetail>
<v2:ClientDetail>
<v2:ClientProductId>XXXX</v2:ClientProductId>
<v2:ClientProductVersion>0000</v2:ClientProductVersion>
<v2:IntegratorId>00000</v2:IntegratorId>
</v2:ClientDetail>
<v2:TransactionDetail>
<v2:CustomerTransactionId>X0</v2:CustomerTransactionId>
</v2:TransactionDetail>
<v2:Version>
<v2:ServiceId>oord</v2:ServiceId>
<v2:Major>3</v2:Major>
<v2:Intermediate>1</v2:Intermediate>
<v2:Minor>0</v2:Minor>
</v2:Version>
<v2:RequestedOfficeOrder>
<v2:OrderContact>
<v2:Contact>
<v2:PersonName>
<v2:FirstName>John</v2:FirstName>
<v2:LastName>Doe</v2:LastName>
</v2:PersonName>
<v2:CompanyName>ABC Company</v2:CompanyName>
<v2:PhoneNumber>901-555-5555</v2:PhoneNumber>
<v2:EMailAddress>John.Doe@abccompany.com</v2:EMailAddress>
</v2:Contact>
<v2:Address>
<!--1 to 2 repetitions: -->
<v2:StreetLines>100 Main Street</v2:StreetLines>
<v2:StreetLines>2nd Floor</v2:StreetLines>
<v2:City>Collierville</v2:City>
<v2:StateOrProvinceCode>TN</v2:StateOrProvinceCode>
<v2:PostalCode>38017</v2:PostalCode>
<v2:CountryCode>US</v2:CountryCode>
<v2:Residential>false</v2:Residential>
</v2:Address>
</v2:OrderContact>
<v2:DeliveryGroups>
Back to Examples
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://fedex.com/ws/officeorder/v2">
<soapenv:Header/>
<soapenv:Body>
<v2:CreateOfficeOrderRequest>
<v2:WebAuthenticationDetail>
<v2:UserCredential>
<v2:Key>xxxxxxxxxxxxxxxx</v2:Key>
<v2:Password>xxxxxxxxxxxxxxxxxxxxxxxxx</v2:Password>
</v2:UserCredential>
</v2:WebAuthenticationDetail>
<v2:ClientDetail>
<v2:ClientProductId>XXXX</v2:ClientProductId>
<v2:ClientProductVersion>0000</v2:ClientProductVersion>
<v2:IntegratorId>00000</v2:IntegratorId>
</v2:ClientDetail>
<v2:UserDetail>
<v2:UserId>sample_user</v2:UserId>
<v2:Password>sample_password</v2:Password>
</v2:UserDetail>
<v2:Version>
<v2:ServiceId>oord</v2:ServiceId>
<v2:Major>3</v2:Major>
<v2:Intermediate>1</v2:Intermediate>
<v2:Minor>0</v2:Minor>
</v2:Version>
<v2:RequestedOfficeOrder>
<v2:CustomerConfigurationProfileName>Sample
Profile</v2:CustomerConfigurationProfileName>
<v2:OrderContact>
<v2:Contact>
<v2:PersonName>
<v2:FirstName>John</v2:FirstName>
<v2:LastName>Doe</v2:LastName>
</v2:PersonName>
<v2:CompanyName>ABC Corporation</v2:CompanyName>
<v2:PhoneNumber>4445558888</v2:PhoneNumber>
<v2:FaxNumber>4445558889</v2:FaxNumber>
<v2:EMailAddress>john.doe@abccompany.com</v2:EMailAddress>
</v2:Contact>
<v2:Address>
<v2:StreetLines>123 Main St.</v2:StreetLines>
<v2:City>Irving</v2:City>
<v2:StateOrProvinceCode>TX</v2:StateOrProvinceCode>
<v2:PostalCode>75063</v2:PostalCode>
<v2:CountryCode>US</v2:CountryCode>
<v2:Residential>false</v2:Residential>
</v2:Address>
Back to Examples
FedEx Confidential and Proprietary 148
This page intentionally left blank.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v2="http://fedex.com/ws/officeorder/v2">
<soapenv:Header/>
<soapenv:Body>
<v2:CreateOfficeOrderRequest>
<v2:WebAuthenticationDetail>
<v2:UserCredential>
<v2:Key>xxxxxxxxxxxxxxxx</v2:Key>
<v2:Password>xxxxxxxxxxxxxxxxxxxxxxxxx</v2:Password>
</v2:UserCredential>
</v2:WebAuthenticationDetail>
<v2:ClientDetail>
<v2:ClientProductId>XXXX</v2:ClientProductId>
<v2:ClientProductVersion>0000</v2:ClientProductVersion>
<v2:IntegratorId>00000</v2:IntegratorId>
</v2:ClientDetail>
<v2:TransactionDetail>
<v2:CustomerTransactionId>SystemRef</v2:CustomerTransactionId>
</v2:TransactionDetail>
<v2:Version>
<v2:ServiceId>oord</v2:ServiceId>
<v2:Major>3</v2:Major>
<v2:Intermediate>1</v2:Intermediate>
<v2:Minor>0</v2:Minor>
</v2:Version>
<v2:RequestedOfficeOrder>
<v2:OrderContact>
<v2:Contact>
<v2:PersonName>
<v2:FirstName>John</v2:FirstName>
<v2:LastName>Doe</v2:LastName>
</v2:PersonName>
<v2:CompanyName>ABC Company</v2:CompanyName>
<v2:PhoneNumber>901-555-5555</v2:PhoneNumber>
<v2:EMailAddress>John.Doe@abccompany.com</v2:EMailAddress>
</v2:Contact>
<v2:Address>
<!--1 to 2 repetitions: -->
<v2:StreetLines>100 Main Street</v2:StreetLines>
<v2:StreetLines>2nd Floor</v2:StreetLines>
<v2:City>Collierville</v2:City>
<v2:StateOrProvinceCode>TN</v2:StateOrProvinceCode>
<v2:PostalCode>38017</v2:PostalCode>
<v2:CountryCode>US</v2:CountryCode>
<v2:Residential>false</v2:Residential>
</v2:Address>
</v2:OrderContact>
Back to Examples
Example 1
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header />
<SOAP-ENV:Body>
<CreateOfficeOrderReply xmlns="http://fedex.com/ws/officeorder/v2">
<HighestSeverity>SUCCESS</HighestSeverity>
<Notifications>
<Severity>SUCCESS</Severity>
<Source>oord</Source>
<Code>0000</Code>
<Message>Request was successful.</Message>
<LocalizedMessage>Request was successful.</LocalizedMessage>
</Notifications>
<TransactionDetail>
<!--Optional: -->
</CustomerTransactionId>
</TransactionDetail>
<Version>
<ServiceId>oord</ServiceId>
<Major>3</Major>
<Intermediate>1</Intermediate>
<Minor>0</Minor>
</Version>
<CompletedOfficeOrder>
<OrderGlobalTrackingNumber>1111111111111111</OrderGlobalTrackingNumber>
<CompletedDeliveryGroupDetails>
<CompletedDocumentDetails>
<Name>Single Page Test Document.pdf</Name>
<Pricing>
<TotalCost>
<Currency>USD</Currency>
<Amount>3.4</Amount>
</TotalCost>
<TotalDiscount>
<Currency>USD</Currency>
<Amount>1.36</Amount>
</TotalDiscount>
<NetCost>
<Currency>USD</Currency>
<Amount>2.04</Amount>
</NetCost>
<Costs>
<Type>BASE_COST</Type>
<Amount>
<Currency>USD</Currency>
Back to Examples
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header />
<SOAP-ENV:Body>
<CreateOfficeOrderReply xmlns="http://fedex.com/ws/officeorder/v2">
<HighestSeverity>SUCCESS</HighestSeverity>
<Notifications>
<Severity>SUCCESS</Severity>
<Source>oord</Source>
<Code>0000</Code>
<Message>Request was successful.</Message>
<LocalizedMessage>Request was successful.</LocalizedMessage>
</Notifications>
<TransactionDetail>
<!--Optional: -->
</CustomerTransactionId>
</TransactionDetail>
<Version>
<ServiceId>oord</ServiceId>
<Major>3</Major>
<Intermediate>1</Intermediate>
<Minor>0</Minor>
</Version>
<CompletedOfficeOrder>
<OrderGlobalTrackingNumber>1111111111111111</OrderGlobalTrackingNumber>
<CompletedDeliveryGroupDetails>
<CompletedDocumentDetails>
<Name>Test File.pdf</Name>
<Pricing>
<TotalCost>
<Currency>USD</Currency>
<Amount>4085.76</Amount>
</TotalCost>
<TotalDiscount>
<Currency>USD</Currency>
<Amount>1933.55</Amount>
</TotalDiscount>
<NetCost>
<Currency>USD</Currency>
<Amount>2152.21</Amount>
</NetCost>
<Costs>
<Type>BASE_COST</Type>
<Amount>
<Currency>USD</Currency>
<Amount>4085.76</Amount>
</Amount>
</Costs>
<Discounts>
Back to Examples
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header />
<SOAP-ENV:Body>
<CreateOfficeOrderReply xmlns="http://fedex.com/ws/officeorder/v2">
<HighestSeverity>SUCCESS</HighestSeverity>
<Notifications>
<Severity>SUCCESS</Severity>
<Source>oord</Source>
<Code>0000</Code>
<Message>Request was successful.</Message>
<LocalizedMessage>Request was successful.</LocalizedMessage>
</Notifications>
<TransactionDetail>
<CustomerTransactionId>SystemRef</CustomerTransactionId>
</TransactionDetail>
<Version>
<ServiceId>oord</ServiceId>
<Major>3</Major>
<Intermediate>1</Intermediate>
<Minor>0</Minor>
</Version>
<CompletedOfficeOrder>
<OrderGlobalTrackingNumber>1111111111111111</OrderGlobalTrackingNumber>
<CompletedDeliveryGroupDetails>
<CompletedDocumentDetails>
<Name>Sample Flyer</Name>
<Pricing>
<TotalCost>
<Currency>USD</Currency>
<Amount>11.8</Amount>
</TotalCost>
<TotalDiscount>
<Currency>USD</Currency>
<Amount>0.0</Amount>
</TotalDiscount>
<NetCost>
<Currency>USD</Currency>
<Amount>11.8</Amount>
</NetCost>
<Costs>
<Type>BASE_COST</Type>
<Amount>
<Currency>USD</Currency>
<Amount>11.8</Amount>
</Amount>
</Costs>
</Pricing>
<DocumentNumber>1</DocumentNumber>
Back to Examples
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header />
<SOAP-ENV:Body>
<CreateOfficeOrderReply xmlns="http://fedex.com/ws/officeorder/v2">
<HighestSeverity>SUCCESS</HighestSeverity>
<Notifications>
<Severity>SUCCESS</Severity>
<Source>oord</Source>
<Code>0000</Code>
<Message>Request was successful.</Message>
<LocalizedMessage>Request was successful.</LocalizedMessage>
</Notifications>
<TransactionDetail>
<CustomerTransactionId>X0</CustomerTransactionId>
</TransactionDetail>
<Version>
<ServiceId>oord</ServiceId>
<Major>3</Major>
<Intermediate>1</Intermediate>
<Minor>0</Minor>
</Version>
<CompletedOfficeOrder>
<OrderGlobalTrackingNumber>1111111111111111</OrderGlobalTrackingNumber>
<CompletedDeliveryGroupDetails>
<CompletedDocumentDetails>
<Name>My Document</Name>
<Pricing>
<TotalCost>
<Currency>USD</Currency>
<Amount>1815.3</Amount>
</TotalCost>
<TotalDiscount>
<Currency>USD</Currency>
<Amount>603.0</Amount>
</TotalDiscount>
<NetCost>
<Currency>USD</Currency>
<Amount>1212.3</Amount>
</NetCost>
<Costs>
<Type>BASE_COST</Type>
<Amount>
<Currency>USD</Currency>
<Amount>1815.3</Amount>
</Amount>
</Costs>
<Discounts>
<Type>VOLUME</Type>
Back to Examples
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header />
<SOAP-ENV:Body>
<CreateOfficeOrderReply xmlns="http://fedex.com/ws/officeorder/v2">
<HighestSeverity>SUCCESS</HighestSeverity>
<Notifications>
<Severity>SUCCESS</Severity>
<Source>oord</Source>
<Code>0000</Code>
<Message>Request was successful.</Message>
<LocalizedMessage>Request was successful.</LocalizedMessage>
</Notifications>
<Version>
<ServiceId>oord</ServiceId>
<Major>3</Major>
<Intermediate>1</Intermediate>
<Minor>0</Minor>
</Version>
<CompletedOfficeOrder>
<OrderGlobalTrackingNumber>1111111111111111</OrderGlobalTrackingNumber>
<CompletedDeliveryGroupDetails>
<CompletedCatalogDocumentDetails>
<DocumentNumber>1</DocumentNumber>
<Type>GLOBAL</Type>
<FolderPath>/ALL FOLDERS/abc</FolderPath>
<DocumentName>Sample Document</DocumentName>
<Pricing>
<TotalCost>
<Currency>USD</Currency>
<Amount>16.42</Amount>
</TotalCost>
<TotalDiscount>
<Currency>USD</Currency>
<Amount>8.48</Amount>
</TotalDiscount>
<NetCost>
<Currency>USD</Currency>
<Amount>7.94</Amount>
</NetCost>
<Costs>
<Type>BASE_COST</Type>
<Amount>
<Currency>USD</Currency>
<Amount>16.42</Amount>
</Amount>
</Costs>
<Discounts>
<Type>ACCOUNT</Type>
Back to Examples
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header />
<SOAP-ENV:Body>
<CreateOfficeOrderReply xmlns="http://fedex.com/ws/officeorder/v2">
<HighestSeverity>SUCCESS</HighestSeverity>
<Notifications>
<Severity>SUCCESS</Severity>
<Source>oord</Source>
<Code>0000</Code>
<Message>Request was successful.</Message>
<LocalizedMessage>Request was successful.</LocalizedMessage>
</Notifications>
<Version>
<ServiceId>oord</ServiceId>
<Major>3</Major>
<Intermediate>2</Intermediate>
<Minor>0</Minor>
</Version>
<CompletedOfficeOrder>
<OrderGlobalTrackingNumber>1111111111111111</OrderGlobalTrackingNumber>
<CompletedDeliveryGroupDetails>
<CompletedDocumentDetails>
<Name>Sample Flyer</Name>
<Pricing>
<TotalCost>
<Currency>USD</Currency>
<Amount>11.7</Amount>
</TotalCost>
<TotalDiscount>
<Currency>USD</Currency>
<Amount>0.0</Amount>
</TotalDiscount>
<NetCost>
<Currency>USD</Currency>
<Amount>11.7</Amount>
</NetCost>
<Costs>
<Type>BASE_COST</Type>
<Amount>
<Currency>USD</Currency>
<Amount>11.7</Amount>
</Amount>
</Costs>
</Pricing>
<DocumentNumber>1</DocumentNumber>
</CompletedDocumentDetails>
<CompletedDocumentDetails>
<Name>Sample 2</Name>
Back to Examples
This section of the guide provides example email confirmation messages that are
generated by Office Order Service. These messages are sent to the email addresses in the
“Order Contact Email Address” and “Recipient Email Address” fields. Email notifications
can be deactivated using the “Order Confirmation Email Requested” field in the Requested
Office Order section in the Rate and Create Office Order service.
Example email text is provided for each of the following confirmation types:
Thank you for choosing FedEx Office. This email confirms that we have received your order. Please
retain this email for your records.
You are welcome to follow up with the center if you have any questions.
If you need to cancel this order, you must immediately call FedEx Office customer relations at
1.800.GoFedEx 1.800.463.3339. You can reference your order by Order Number 1111111111111111. Most
jobs go into production within 15 minutes of receipt. Orders cancelled after going into
production may be subject to a charge.
All jobs produced for customers will be retained for 30 days after the order ready by date on the
receipt at which time you will be charged for the completed job if you have not picked up the
order. FedEx Office is not responsible for retaining any work not picked up by customer after
such 30 day period and is entitled to collect and retain payment for all work performed on the
customer's behalf.
Order Price
Subtotal: $xxx.xx
Shipping: $--
Tax: $xx.xx
Total: $xxxx.xx
ORDER_DETAIL -- Part 1
Documents:
Mid-South Sales Training Presentation.pdf (xx)
Mid-South Sales Training Presentation.pdf
Price: $xxx.xx
Shipping Cost: $--
Tax: $xx.xx
From: no-reply.ecommerce@fedex.com
To: Jim Smith
Subject: Urgent - Next Steps to Complete your FedEx Office Order Number 1111111111111111)
Since your order contains special instructions, you will need to call the FedEx Office center
listed below to review your order, determine final pricing, and provide payment information
before it can be completed.
Here are the special instructions that you entered with your order:
Please add a black hard bound book cover instead of a regular binder to my document.
Please allow at least 30 minutes for the center to receive your order.
Memphis TN Germantown
Thank you,
FedEx Office
From: no-reply.ecommerce@fedex.com
To: Jane Smith
Subject: FedEx Office order confirmation (GTN 2222222222222222)
The order will be ready for you to pick up on May 13, 2009 at 11:00 PM CDT
If you have questions concerning your order, please call the FedEx Office center and ask for the
Project Coordinator. You can reference your order by Job number 2222222222222222.
If you have any other questions, comments, or concerns regarding FedEx Office, please contact the
FedEx Office customer relations at 1.800.GoFedEx 1.800.463.3339.
Thank you for choosing FedEx Office. This mail confirms that we have completed your order and
delivered it based on your instructions.
If you have questions concerning your order, please call the FedEx Office center producing the
order and ask for the Project Coordinator. You can reference your order by Order number
5555555555555555.
If you have questions about this order or other comments or concerns regarding FedEx Office,
please contact FedEx Office customer relations at 1.800.GoFedEx 1.800.463.3339. You can reference
your order by Order number 5555555555555555.
Order Price
Subtotal: $xxx.xx
Shipping: $xx.xx
Tax: $xx.xx
Total: $xxxx.xx
ORDER_DETAIL -- Part 1
Shipping address:
123 Lost Lane Retreat
Third Floor
BRAINTREE, MA 02185
UNITED STATES
Delivery Method FedEx Priority Overnight
Price: $xxx.xx
Shipping Cost: $xx.xx *
Tax: $xx.xx
* Reflects Packing Fee only. Shipping will be billed separately to your FedEx account enabled
for Shipping.
From: no-reply.ecommerce@fedex.com
To: John Adams
Subject: FedEx Office order completion (GTN 6666666666666666)
FedEx Office shipped the order to you by FedEx Priority Overnight on May 21, 2009 at 02:00 PM CDT
If you have any questions about this order or other comments or concerns regarding FedEx Office,
please contact FedEx Office customer relations at 1.800.GoFedEx 1.800.463.3339.
Severity Descriptions
There is a possibility of multiple Notification objects for a single request. The response
notification severity values of ERROR, FAILURE, and SUCCESS will never be combined in a
single response.
Value Definition
FAILURE Code/message explains that your request could not be handled at this time;
please do not resubmit right now.
ERROR Code/message identifies a problem with your request data; you may fix the
request data and try again. See Notification Codes.
WARNING Your request was successful. However, the code/message explains what had to
be done to fulfill your request; you may need to determine whether that is what
you intended, you may need to do this differently next time, or you may need to
prepare for a future change. Request was completed.
NOTE Your request was successful. However, the code/message contains additional
information about how your request was fulfilled; you do not need to take any
special action.
This section details the supported Media Categories for the Office Order Web Service and the
associated Media Descriptions, Detailed Descriptions, and Media Sizes.
Use the following table to select your media type. SKU’s are not used in the request; these are
provided for reference purposes only.
Associated SKU
Media Description Black Black
Media Category Specifications Size
Values & & Color Color
White White Single Double
Single Double Sided Sided
Sided Sided
STANDARD
White paper STANDARD_WHITE Standard White, 8.5X11 0001 0033 N/A N/A
Various weights 20# 8.5X14 0269 0270 N/A N/A
Opaque 11X17 0009 0041 N/A N/A
Acid-free RECYCLED_100_PERCENT Recycled, 20#, 8.5X11 2465 2466 N/A N/A
100% Recycled
Choose: 10M Encore
For everyday print jobs RECYCLED_30_PERCENT FedEx Office 8.5X11 2419 2456 0177 0176
White, 20# 30% 8.5X14 2463 2464 N/A N/A
Recycled 11X17 2461 2462 N/A N/A
PASTEL_BRIGHTS
Opaque ULTRA_LEMON Britehue, Ultra 8.5X11 0002 0034 0173 0178
Lightweight, but not thin Lemon, 60#
Uncoated ULTRA_LIME Britehue, Ultra 8.5X11 0002 0034 0173 0178
Colored paper Lime, 60#
Acid-free SUN_YELLOW Britehue, Sun 8.5X11 0002 0034 0173 0178
Yellow, 60# 8.5X14 0267 0268
Choose: 11X17 0010 0042 0197 0202
For eye-catching ULTRA_ORANGE Britehue, Ultra 8.5X11 0002 0034 0173 0178
promotional items such as Orange, 60#
brochures, handouts,
RED Britehue, Red, 8.5X11 0002 0034 0173 0178
newsletters, fliers, self-
60#
mailers, and small signs
ULTRA_FUSCHIA Britehue, Ultra 8.5X11 0002 0034 0173 0178
Fuschia, 60#
BRIGHT_BLUE Britehue, Blue, 8.5X11 0002 0034 0173 0178
60# 11X17 0010 0042 0197 0202
EXECUTIVE
Opaque NATURAL Via Neutrals 8.5X11 0004 0036 0198 0214
Lightweight, but not thin Linen, Natural,
Uncoated 70#
Acid-free ULTRA_BRIGHT_WHITE Environment, 8.5X11 0004 0036 0198 0214
High quality Ultra Bright
White, 80# Text
Choose: PURE_WHITE Strathmore 8.5X11 0004 0036 0198 0214
For formal, professional Writing, 24#,
documents like resumes, 100% Cotton
business proposals and SIGNATURE_WHITE Laser Signature 8.5X11 0218 0221 0224 0227
executive communications White, 32# 8.5X14 0219 0222 0267 0268
11X17 0220 0223 0197 0202
RESUME
SOFT_PINK Environment 8.5X11 N/A N/A N/A N/A
Pageant Rose
SANDSTONE Concept, 8.5X11 0003 0035 0173 0178
Sandstone, 24# 11X17 0012 0044 0197 0202
SEA_SPRAY Concept, Sea 8.5X11 0003 0035 0173 0178
Spray, 24# 11X17 0012 0044 0197 0202
WILLOW Environment, 8.5X11 0003 0035 0173 0178
Willow, 80# Text
ANTIQUE Parchment, 8.5X11 0003 0035 0173 0178
Antique, 60#
TAN Parchment, Tan, 8.5X11 0003 0035 0173 0178
60 #
ANTIQUE_GRAY Environment, 8.5X11 0003 0035 0173 0178
Antique Gray,
80# Text
RESUME_CARDSTOCK
SOFT_PINK Cardstock, 8.5X11 0005 0037 2509 2513
Environment
Pageant Rose
SANDSTONE Cardstock, 8.5X11 0005 0037 2509 2513
Sandstone, 80#
SEA_SPRAY Cardstock, Sea 8.5X11 0005 0037 2509 2513
Spray, 80#
Collated* UNCOLLATED
* Default designation. Not an enumerated value within FedEx Web Services for Office
and Print.
Stapling Documents that do not exceed the maximum thickness allowed for the
selected media may be stapled either in the upper left corner of the
document or along the left side of the document.
LEFT_UPPER TWO_ON_LONG_SIDE
Drilling Documents may be drilled (hole-punched) with either three holes along
the left side of the document or two holes along the top of the
document.
THREE_HOLE_SIDE TWO_HOLE_TOP
HALF_CUT_PORTRAIT HALF_CUT_LANDSCAPE
THIRD_CUT_PORTRAIT THIRD_CUT_LANDSCAPE
QUARTER_CUT_PORTRAIT QUARTER_CUT_LANDSCAPE
Folding Documents that do not exceed the maximum thickness allowed for the
selected media may be folded in single, double, or Z fashion.
SINGLE DOUBLE Z
ONE_QUARTER_INCH None*
* Default designation. Not an enumerated value within FedEx Web Services for Office
and Print.
Tab Text positioning and orientation on tabs will be Text In (Portrait) and
Text Out (Landscape) and will default using Text In. This represents
the orientation of the tabs and not the document.
This section details maximum page quantity thresholds associated with finishing options and
selected media.
NOTE: These quantities refer to the number of physical pages, not the number of pages in the
uploaded file. For instance, a 20-page single-sided document has 20 physical pages.
However, a 20-page double-sided document has 10 physical pages.
0.5 ” 1.0 ” 1.5 ” 2.0 ” 3.0 ” Comb Coil Fold Staple Lamination
PASTEL
57 115 171 228 285 228 115 5 150 1
BRIGHTS
RESUME
25 50 75 100 125 100 50 1 75 1
CARDSTOCK
STANDARD
75 150 225 300 375 300 150 5 150 1
LASER
COVER
20 40 60 80 100 80 40 1 75 N/A
GLOSS