diff --git a/.gitignore b/.gitignore
index 0bc7fdf..e3b5ffa 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,10 @@ dist
build
.idea
.DS_Store
+doc_src/.doctrees
+doc_src/_sources/*
+doc_src/_static/*
+doc_src/*.html
+doc_src/_build/*
+.python-version
+/venv
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..6413ae2
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,13 @@
+language: python
+sudo: false
+python:
+ - "2.7"
+ - "3.5"
+
+# command to install dependencies
+install:
+ - pip install .
+ - pip install -r requirements.txt
+
+# command to run tests
+script: nosetests
diff --git a/CHANGES.rst b/CHANGES.rst
index 33dce04..51f7419 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -1,18 +1,66 @@
Change Log
==========
+2.4.0
+-----
+
+* Pickup Service usingv11 WSDL (hornedbull)
+* Added documentation and unit tests for Pickup Service. (radzhome)
+* Update package data to include tools (noodlebreak)
+
+2.3.1
+-----
+
+* Set fedex logging to INFO for tests. (radzhome)
+* Sphinx documentation (hosted on read the docs). (radzhome)
+* Update Ship Service test to allow warnings. (radzhome)
+* Added log warning for requests that yield a WARNING. (radzhome)
+
+2.3.0
+-----
+
+* Added Location Service using v3 WSDL. (radzhome)
+* Added examples and unit tests for Location Service. (radzhome)
+* Updated certification process scripts to work with latest WSDLs. (radzhome)
+* Added warning logging for requests that come back with warning notes. (radzhome)
+* Added PyPI, Travis, requires.io integration/badges. (radzhome)
+* Organization change from gtaylor to python-fedex-devs. (gtaylor)
+* Added deprecation message for movement service. (radzhome)
+* Added conversion tools to convert suds xml object into python dict. (radzhome)
+* Redirect logging to stdout for examples and tests when not ran via nose. (radzhome)
+
+2.2.0
+-----
+
+* Added Country Service / Postal Code Validation service. (radzhome)
+* Added CountryService_v4.wsdl for Postal Code Validation. (radzhome)
+* Added unit tests and examples for Country service. (radzhome)
+* Added Signature Option to ship example. (radzhome)
+* Fix base service logging request and response. (radzhome)
+
+2.1.0
+-----
+
+* Added Validation, Availability and Commitment (AVC) service. (radzhome)
+* Added [Validation]AvailabilityAndCommitmentService_v4.wsdl for AVC service. (radzhome)
+* Added examples and unit tests for AVC service.
+* Refactored examples and documentation. (radzhome)
+* A quick PEP8 pass using pycharm on most of the codebase (radzhome)
+* Add travis yml (radzhome)
+
+
2.0.0
-----
-* Bump ShipService WSDL to v17 for create and delete shipment. (radlws)
-* Bump AddressValidation WSDL to v4. (radlws)
-* Bump RateService WSDL to v18. (radlws)
-* Bump TrackService WSDL to v10. (radlws)
-* General improvements to base class. (radlws)
-* Refactoring and updates to examples. (radlws)
-* Added test classes. (radlws)
-* Remove old and unused WSDLs. (radlws)
-* Change dependency to suds-jurko to include python 3 support. (radlws)
+* Bump ShipService WSDL to v17 for create and delete shipment. (radzhome)
+* Bump AddressValidation WSDL to v4. (radzhome)
+* Bump RateService WSDL to v18. (radzhome)
+* Bump TrackService WSDL to v10. (radzhome)
+* General improvements to base class. (radzhome)
+* Refactoring and updates to examples. (radzhome)
+* Added test classes. (radzhome)
+* Remove old and unused WSDLs. (radzhome)
+* Change dependency to suds-jurko to include python 3 support. (radzhome)
1.1.1
-----
@@ -24,7 +72,7 @@ Change Log
-----
* A quick PEP8 pass on most of the codebase. Yucky. (gtaylor)
-* Changing recommended install method to use pip + PyPi. (radlws)
+* Changing recommended install method to use pip + PyPi. (radzhome)
* Updated rate_request and freight_rate_request examples for WSDL v16
compatibility. (foxxyz)
* Updated rate service WSDL from v8 to v16. (foxxyz)
diff --git a/MANIFEST.in b/MANIFEST.in
index feb9b2a..39bd3df 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -2,4 +2,5 @@ include LICENSE.txt
include README.rst
recursive-include examples *.txt *.py
recursive-include docs *
+recursive-include fedex/tools *
recursive-include fedex/wsdl *
\ No newline at end of file
diff --git a/README.rst b/README.rst
index 6b1e823..034d5a2 100644
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,24 @@
Python FedEx SOAP API Module
============================
-:Author: Greg Taylor
+.. image:: https://badge.fury.io/py/fedex.svg
+ :target: https://badge.fury.io/py/fedex
+
+.. image:: https://travis-ci.org/python-fedex-devs/python-fedex.svg?branch=master
+ :target: https://travis-ci.org/python-fedex-devs/python-fedex
+
+.. image:: https://requires.io/github/python-fedex-devs/python-fedex/requirements.svg?branch=master
+ :target: https://requires.io/github/python-fedex-devs/python-fedex/requirements/?branch=master
+ :alt: Requirements Status
+
+.. image:: https://readthedocs.org/projects/python-fedex/badge/?version=latest
+ :target: http://python-fedex.readthedocs.org/en/latest/?badge=latest
+ :alt: Documentation Status
+
+:Author: Greg Taylor, Radek Wojcik
+:Maintainer: Python FedEx Developers
:License: BSD
:Status: Stable
-:Maintained: Quasi-maintained, looking for new maintainer
What is it?
-----------
@@ -23,13 +37,15 @@ The easiest way is via pip or easy_install::
Quick Start
-----------
-Edit the example_config.py file in examples with your fedex credentials
-and run any of the provided examples.
+- Clone this repository.
+
+- Edit the `example_config.py` file in See `examples/ `_ with your fedex credentials and run any of the provided examples.
Documentation
-------------
-Refer to the documentation_ for more details on the project.
+Refer to the documentation_ for more details on the project. Latest doc builds
+are found in docs_ and doc build scripts in doc_source_. Sphinx documentation is in doc_src_.
There are also a lot of useful examples under the examples directory within
this directory.
@@ -37,26 +53,49 @@ this directory.
Support
-------
-Head over to https://github.com/gtaylor/python-fedex/issues
-and submit an issue if you have any problems or questions. Due to this
-package's quasi-maintained state, most problems are going to require
-investigation or a submitted pull request by someone other than
-Greg Taylor.
+Issues & Questions: https://github.com/gtaylor/python-fedex/issues
+
+Most problems are going to require investigation or a submitted
+pull request by someone from the Python FedEx Developers organization.
+To contribute a new feature or service, feel free to create a pull request.
+We are always looking for new contributors to help maintain the project.
Fedex Support and Documentation
-------------------------------
Fedex Support Email: websupport@fedex.com
+
Developer Portal: http://www.fedex.com/us/developer/
-Legal Mumbo Jumbo
------------------
+Updates To Services: https://www.fedex.com/us/developer/web-services/process.html (FedEx Web Services Announcements)
+
+
+Related Projects
+----------------
+
+- FedEx Commercial Invoice Generation, see https://github.com/radzhome/fedex-commercial-invoice
+
+Todos
+-----
+
+- Increase service specific request validation
+- Remove deprecated services (package movement service)
+- Pickup service unit tests
+
+Legal
+-----
+
+Copyright (C) 2008-2015 Greg Taylor
-Copyright (C) 2015 Gregory Taylor
+Copyright (C) 2015-2016 Python FedEx Developers
This software is licensed under the BSD License.
python-fedex is not authored by, endorsed by, or in any way affiliated with
FedEx.
-.. _documentation: https://pythonhosted.org/fedex/
+.. _documentation: https://readthedocs.org/projects/python-fedex/
+.. _documentation2: https://pythonhosted.org/fedex/
+.. _docs: docs/
+.. _doc_source: doc_source/
+.. _doc_src: doc_src/
diff --git a/doc_src/Makefile b/doc_src/Makefile
new file mode 100644
index 0000000..baa9814
--- /dev/null
+++ b/doc_src/Makefile
@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+ @echo "Please use \`make ' where is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " applehelp to make an Apple Help Book"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+ @echo " coverage to run coverage check of the documentation (if enabled)"
+
+clean:
+ rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-fedex.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-fedex.qhc"
+
+applehelp:
+ $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+ @echo
+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+ @echo "N.B. You won't be able to view it unless you put it in" \
+ "~/Library/Documentation/Help or install it in your application" \
+ "bundle."
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/python-fedex"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-fedex"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/doc_src/_static/.GIT_FOO b/doc_src/_static/.GIT_FOO
new file mode 100755
index 0000000..e69de29
diff --git a/doc_src/_templates/.GIT_FOO b/doc_src/_templates/.GIT_FOO
new file mode 100755
index 0000000..e69de29
diff --git a/doc_src/base_service.rst b/doc_src/base_service.rst
new file mode 100755
index 0000000..804ae46
--- /dev/null
+++ b/doc_src/base_service.rst
@@ -0,0 +1,9 @@
+.. _base_service:
+
+.. include:: global.txt
+
+Base Service Class
+==================
+
+.. autoclass:: fedex.base_service.FedexBaseService
+
diff --git a/doc_src/conf.py b/doc_src/conf.py
new file mode 100644
index 0000000..fb3e8ef
--- /dev/null
+++ b/doc_src/conf.py
@@ -0,0 +1,298 @@
+# -*- coding: utf-8 -*-
+#
+# python-fedex documentation build configuration file, created by
+# sphinx-quickstart on Sat Jan 30 21:51:05 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+import shlex
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+project_root = os.path.dirname(os.path.abspath('.'))
+sys.path.insert(0, project_root)
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'python-fedex'
+copyright = u'2016, Python Fedex Devs'
+author = u'2016, Python Fedex Devs'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '2.0'
+# The full version, including alpha/beta/rc tags.
+release = '2.3.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'classic' # 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# " v documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'python-fedexdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'python-fedex.tex', u'python-fedex Documentation',
+ u'2015, Python Fedex Devs', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'python-fedex', u'python-fedex Documentation',
+ [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'python-fedex', u'python-fedex Documentation',
+ author, 'python-fedex', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
+
+autoclass_content = "both"
+autodoc_default_flags = ["members", "inherited-members", "show-inheritance"]
+autodoc_member_order = "groupwise"
\ No newline at end of file
diff --git a/doc_src/config_object.rst b/doc_src/config_object.rst
new file mode 100755
index 0000000..ea8e4e3
--- /dev/null
+++ b/doc_src/config_object.rst
@@ -0,0 +1,13 @@
+.. _config_object:
+
+.. include:: global.txt
+
+Config Object
+=============
+
+A standardized configuration container object used
+by python-fedex.
+
+.. autoclass:: fedex.config.FedexConfig
+
+
diff --git a/doc_src/exceptions.rst b/doc_src/exceptions.rst
new file mode 100755
index 0000000..302823c
--- /dev/null
+++ b/doc_src/exceptions.rst
@@ -0,0 +1,27 @@
+.. _exceptions:
+
+.. include:: global.txt
+
+Exception Classes
+=================
+
+python-fedex implements various custom exceptions.
+
+Fedex Base Service Exception
+----------------------------
+
+.. autoclass:: fedex.base_service.FedexBaseServiceException
+
+
+Fedex Failure
+-------------
+
+.. autoclass:: fedex.base_service.FedexFailure
+
+
+Fedex Error
+-----------
+
+.. autoclass:: fedex.base_service.FedexError
+
+
diff --git a/doc_src/global.txt b/doc_src/global.txt
new file mode 100755
index 0000000..959a154
--- /dev/null
+++ b/doc_src/global.txt
@@ -0,0 +1,10 @@
+.. _GitHub project: https://github.com/python-fedex-devs/python-fedex
+.. _issue tracker: https://github.com/python-fedex-devs/python-fedex/issues
+.. _suds_jurko: https://bitbucket.org/jurko/suds
+
+.. _FedEx Web Services: http://www.fedex.com/us/developer/web-services/
+
+.. _Python: http://python.org
+.. _GitHub: https://github.com/
+
+.. _BSD License: http://opensource.org/licenses/bsd-license.php
diff --git a/doc_src/index.rst b/doc_src/index.rst
new file mode 100644
index 0000000..9c89db1
--- /dev/null
+++ b/doc_src/index.rst
@@ -0,0 +1,37 @@
+.. python-fedex documentation master file, created by
+ sphinx-quickstart on Sat Jan 30 21:51:05 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+.. include:: global.txt
+
+Python-Fedex: a suds fedex api wrapper
+======================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ installation
+ quick_start
+ services
+ tools
+ config_object
+ base_service
+ exceptions
+ suds_plugin
+
+
+.. toctree::
+ :maxdepth: 1
+
+ release_notes
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+
diff --git a/doc_src/installation.rst b/doc_src/installation.rst
new file mode 100755
index 0000000..49d0f81
--- /dev/null
+++ b/doc_src/installation.rst
@@ -0,0 +1,15 @@
+.. _installation:
+
+.. include:: global.txt
+
+Installation
+============
+
+python-fedex is compatible with Python 2.7+. The only other
+requirement is suds_jurko_ although the module is also compatible with the
+original suds module.
+
+For those on Linux/Unix Mac OS, the easiest route will be :command:`pip` or
+:command:`easy_install`::
+
+ pip install fedex
diff --git a/doc_src/make.bat b/doc_src/make.bat
new file mode 100644
index 0000000..9f24a0e
--- /dev/null
+++ b/doc_src/make.bat
@@ -0,0 +1,263 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^` where ^ is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. xml to make Docutils-native XML files
+ echo. pseudoxml to make pseudoxml-XML files for display purposes
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ echo. coverage to run coverage check of the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+
+REM Check if sphinx-build is available and fallback to Python version if any
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 goto sphinx_python
+goto sphinx_ok
+
+:sphinx_python
+
+set SPHINXBUILD=python -m sphinx.__init__
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+:sphinx_ok
+
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\python-fedex.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\python-fedex.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "latexpdf" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf
+ cd %~dp0
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "latexpdfja" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf-ja
+ cd %~dp0
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+if "%1" == "coverage" (
+ %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of coverage in the sources finished, look at the ^
+results in %BUILDDIR%/coverage/python.txt.
+ goto end
+)
+
+if "%1" == "xml" (
+ %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The XML files are in %BUILDDIR%/xml.
+ goto end
+)
+
+if "%1" == "pseudoxml" (
+ %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+ goto end
+)
+
+:end
diff --git a/doc_src/quick_start.rst b/doc_src/quick_start.rst
new file mode 100644
index 0000000..4839a84
--- /dev/null
+++ b/doc_src/quick_start.rst
@@ -0,0 +1,226 @@
+.. _quick_start:
+
+.. include:: global.txt
+
+Quick Start
+===========
+
+To get you started, a comprehensive set of examples and tests is included in
+the examples and tests directory respectively. The examples below are
+come from the included unit tests.
+
+Initialize Config Object
+------------------------
+
+.. code-block:: python
+
+ from fedex.config import FedexConfig
+ CONFIG_OBJ = FedexConfig(key='',
+ password='',
+ account_number='',
+ meter_number='')
+
+Create and Delete a Shipment
+----------------------------
+
+.. code-block:: python
+
+ shipment = FedexProcessShipmentRequest(CONFIG_OBJ)
+
+ shipment.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
+ shipment.RequestedShipment.ServiceType = 'FEDEX_GROUND'
+ shipment.RequestedShipment.PackagingType = 'YOUR_PACKAGING'
+
+ shipment.RequestedShipment.Shipper.Contact.PersonName = 'Sender Name'
+ shipment.RequestedShipment.Shipper.Contact.PhoneNumber = '9012638716'
+
+ shipment.RequestedShipment.Shipper.Address.StreetLines = ['Address Line 1']
+ shipment.RequestedShipment.Shipper.Address.City = convert_to_utf8('Herndon')
+ shipment.RequestedShipment.Shipper.Address.StateOrProvinceCode = 'VA'
+ shipment.RequestedShipment.Shipper.Address.PostalCode = '20171'
+ shipment.RequestedShipment.Shipper.Address.CountryCode = 'US'
+
+ shipment.RequestedShipment.Recipient.Contact.PersonName = 'Recipient Name'
+ shipment.RequestedShipment.Recipient.Contact.PhoneNumber = '9012637906'
+
+ shipment.RequestedShipment.Recipient.Address.StreetLines = ['Address Line 1']
+ shipment.RequestedShipment.Recipient.Address.City = convert_to_utf8('TorontoåæâèéHerndon')
+ shipment.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'VA'
+ shipment.RequestedShipment.Recipient.Address.PostalCode = '20171'
+ shipment.RequestedShipment.Recipient.Address.CountryCode = 'US'
+ shipment.RequestedShipment.EdtRequestType = 'NONE'
+
+ shipment.RequestedShipment.ShippingChargesPayment.Payor.ResponsibleParty.AccountNumber \
+ = CONFIG_OBJ.account_number
+
+ shipment.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
+
+ shipment.RequestedShipment.LabelSpecification.LabelFormatType = 'COMMON2D'
+ shipment.RequestedShipment.LabelSpecification.ImageType = 'PNG'
+ shipment.RequestedShipment.LabelSpecification.LabelStockType = 'PAPER_7X4.75'
+ shipment.RequestedShipment.LabelSpecification.LabelPrintingOrientation = 'BOTTOM_EDGE_OF_TEXT_FIRST'
+
+ # Use order if setting multiple labels or delete
+ del shipment.RequestedShipment.LabelSpecification.LabelOrder
+
+ package1_weight = shipment.create_wsdl_object_of_type('Weight')
+ package1_weight.Value = 2.0
+ package1_weight.Units = "LB"
+ package1 = shipment.create_wsdl_object_of_type('RequestedPackageLineItem')
+ package1.PhysicalPackaging = 'ENVELOPE'
+ package1.Weight = package1_weight
+ shipment.add_package(package1)
+
+ shipment.send_validation_request()
+ shipment.send_request()
+
+ assert shipment.response
+ assert shipment.response.HighestSeverity == 'SUCCESS'
+ track_id = shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].TrackingIds[0].TrackingNumber
+ assert track_id
+
+ del_shipment = FedexDeleteShipmentRequest(CONFIG_OBJ)
+ del_shipment.DeletionControlType = "DELETE_ALL_PACKAGES"
+ del_shipment.TrackingId.TrackingNumber = track_id
+ del_shipment.TrackingId.TrackingIdType = 'EXPRESS'
+
+ del_shipment.send_request()
+
+Get the Response
+----------------
+
+Once you perform `send_request()`, you can access the `response` attribute
+of the service request object. To access the response from the
+above delete shipment example:
+
+.. code-block:: python
+
+ request_response = del_shipment.response
+
+Validate an Address
+-------------------
+
+.. code-block:: python
+
+ avs_request = FedexAddressValidationRequest(CONFIG_OBJ)
+ address1 = avs_request.create_wsdl_object_of_type('AddressToValidate')
+ address1.Address.StreetLines = ['155 Old Greenville Hwy', 'Suite 103']
+ address1.Address.City = 'Clemson'
+ address1.Address.StateOrProvinceCode = 'SC'
+ address1.Address.PostalCode = 29631
+ address1.Address.CountryCode = 'US'
+ address1.Address.Residential = False
+ avs_request.add_address(address1)
+
+ avs_request.send_request()
+
+Estimate Delivery Time
+----------------------
+
+.. code-block:: python
+
+ avc_request = FedexAvailabilityCommitmentRequest(CONFIG_OBJ)
+ avc_request.Origin.PostalCode = 'M5V 3A4'
+ avc_request.Origin.CountryCode = 'CA'
+ avc_request.Destination.PostalCode = '27577' # 29631
+ avc_request.Destination.CountryCode = 'US'
+
+Validate Postal Code
+--------------------
+
+.. code-block:: python
+
+ inquiry = FedexValidatePostalRequest(CONFIG_OBJ)
+ inquiry.Address.PostalCode = '29631'
+ inquiry.Address.CountryCode = 'US'
+
+ inquiry.send_request()
+
+FedEx Store Search
+------------------
+
+.. code-block:: python
+
+ location_request = FedexSearchLocationRequest(CONFIG_OBJ)
+ location_request.Address.PostalCode = '38119'
+ location_request.Address.CountryCode = 'US'
+
+
+Get Package Rate
+----------------
+
+.. code-block:: python
+
+ rate = FedexRateServiceRequest(CONFIG_OBJ)
+
+ rate.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
+ rate.RequestedShipment.ServiceType = 'FEDEX_GROUND'
+ rate.RequestedShipment.PackagingType = 'YOUR_PACKAGING'
+
+ rate.RequestedShipment.Shipper.Address.StateOrProvinceCode = 'SC'
+ rate.RequestedShipment.Shipper.Address.PostalCode = '29631'
+ rate.RequestedShipment.Shipper.Address.CountryCode = 'US'
+
+ rate.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'NC'
+ rate.RequestedShipment.Recipient.Address.PostalCode = '27577'
+ rate.RequestedShipment.Recipient.Address.CountryCode = 'US'
+
+ rate.RequestedShipment.EdtRequestType = 'NONE'
+ rate.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
+
+ package1_weight = rate.create_wsdl_object_of_type('Weight')
+ package1_weight.Value = 1.0
+ package1_weight.Units = "LB"
+ package1 = rate.create_wsdl_object_of_type('RequestedPackageLineItem')
+ package1.Weight = package1_weight
+ package1.PhysicalPackaging = 'BOX'
+ package1.GroupPackageCount = 1
+ rate.add_package(package1)
+
+ rate.send_request()
+
+Track a Package
+---------------
+
+.. code-block:: python
+
+ track = FedexTrackRequest(CONFIG_OBJ)
+ tracking_num = '781820562774'
+ track.SelectionDetails.PackageIdentifier.Type = 'TRACKING_NUMBER_OR_DOORTAG'
+ track.SelectionDetails.PackageIdentifier.Value = tracking_num
+ track.send_request()
+
+
+Get JSON and Dictionary Response
+--------------------------------
+
+.. code-block:: python
+
+ from fedex.tools.conversion import sobject_to_dict
+ from fedex.tools.conversion import sobject_to_json
+ response_dict = sobject_to_dict(shipment.response)
+ response_json = sobject_to_json(shipment.response)
+
+Advanced Requests
+-----------------
+
+Since this module is a suds wrapper, you can browse each service's WSDL
+in ``fedex/wsdls`` and add any required objects to your request.
+
+For example, the `Ship Service` WSDL has a `simpleType` definition for `ServiceType`
+with the following options:
+
+* ``'STANDARD_OVERNIGHT'``
+* ``'PRIORITY_OVERNIGHT'``
+* ``'FEDEX_GROUND'``
+* ``'FEDEX_EXPRESS_SAVER'``
+* ``'FEDEX_2_DAY'``
+* ``'INTERNATIONAL_PRIORITY'``
+* ``'SAME_DAY'``
+* ``'INTERNATIONAL_ECONOMY'``
+
+You can see all what is available for a specific definition by
+browsing a service's WSDL. It is possible to customize your request beyond what
+is included in the examples but still within the confines of
+this package. If it's something common enough, please bring it
+forward so that it can be included along as an example.
\ No newline at end of file
diff --git a/doc_src/release_notes.rst b/doc_src/release_notes.rst
new file mode 100755
index 0000000..cf88ac2
--- /dev/null
+++ b/doc_src/release_notes.rst
@@ -0,0 +1,139 @@
+.. _release_notes:
+
+.. include:: global.txt
+
+Change Log
+==========
+
+2.4.0
+-----
+
+* Pickup Service usingv11 WSDL (hornedbull)
+* Added documentation and unit tests for Pickup Service. (radzhome)
+* Update package data to include tools (noodlebreak)
+
+2.3.0
+-----
+
+* Added Location Service using v3 WSDL. (radzhome)
+* Added examples and unit tests for Location Service. (radzhome)
+* Updated certification process scripts to work with latest WSDLs. (radzhome)
+* Added warning logging for requests that come back with warning notes. (radzhome)
+* Added PyPI, Travis, requires.io integration/badges. (radzhome)
+* Organization change from gtaylor to python-fedex-devs. (gtaylor)
+* Added deprecation message for movement service. (radzhome)
+* Added conversion tools to convert suds xml object into python dict. (radzhome)
+* Redirect logging to stdout for examples and tests when not ran via nose. (radzhome)
+
+2.2.0
+-----
+
+* Added Country Service / Postal Code Validation service. (radzhome)
+* Added CountryService_v4.wsdl for Postal Code Validation. (radzhome)
+* Added unit tests and examples for Country service. (radzhome)
+* Added Signature Option to ship example. (radzhome)
+* Fix base service logging request and response. (radzhome)
+
+2.1.0
+-----
+
+* Added Validation, Availability and Commitment (AVC) service. (radzhome)
+* Added [Validation]AvailabilityAndCommitmentService_v4.wsdl for AVC service. (radzhome)
+* Added examples and unit tests for AVC service.
+* Refactored examples and documentation. (radzhome)
+* A quick PEP8 pass using pycharm on most of the codebase (radzhome)
+* Add travis yml (radzhome)
+
+
+2.0.0
+-----
+
+* Bump ShipService WSDL to v17 for create and delete shipment. (radzhome)
+* Bump AddressValidation WSDL to v4. (radzhome)
+* Bump RateService WSDL to v18. (radzhome)
+* Bump TrackService WSDL to v10. (radzhome)
+* General improvements to base class. (radzhome)
+* Refactoring and updates to examples. (radzhome)
+* Added test classes. (radzhome)
+* Remove old and unused WSDLs. (radzhome)
+* Change dependency to suds-jurko to include python 3 support. (radzhome)
+
+1.1.1
+-----
+
+* Made RateService_v16.wsdl point at ws.fedex.com instead of
+ wsbeta.fedex.com. Fixes issues in production. (ikks)
+
+1.1.0
+-----
+
+* A quick PEP8 pass on most of the codebase. Yucky. (gtaylor)
+* Changing recommended install method to use pip + PyPi. (radzhome)
+* Updated rate_request and freight_rate_request examples for WSDL v16
+ compatibility. (foxxyz)
+* Updated rate service WSDL from v8 to v16. (foxxyz)
+* Added a freight rate request example (mwcbrent)
+* Bump ShipService WSDL to v13. (mwcbrent)
+* Update rate example to show multiple ServiceTypes. (danielatdattrixdotcom)
+
+1.0.14
+------
+
+* Re-licensed under BSD.
+
+1.0.12 and 1.0.13
+-----------------
+
+* Forget that these ever existed.
+
+1.0.11
+------
+
+* Bug fix of a bug fix for regions config. (jcartmell)
+
+1.0.10
+------
+
+* Bug fix regarding regions and when they are sent. (jcartmell)
+
+1.0.9
+-----
+
+* Various fixes to RateRequest() FedEx API call. (jcartmell)
+* Added this changelog. (gtaylor)
+
+1.0.8
+-----
+
+* Fixed some problems with the unit tests. (gtaylor)
+
+1.0.7
+-----
+
+* Fixed a bug with international rate request example. (gtaylor)
+
+1.0.6
+-----
+
+* Lots of documentation improvements. (gtaylor)
+* FedEx RateRequest call implemented. (yahtib)
+* FedEx Postal Inquiry call implemented. (yahtib)
+
+1.0.4
+-----
+
+* Removal of unecessary files. (gtaylor)
+* Documentation improvements. (gtaylor)
+
+1.0.3
+-----
+
+* Wrote some label certification modules that can help
+ with the label certification process. (gtaylor)
+
+
+initial
+^^^^^^^
+
+* 1.0
+
diff --git a/doc_src/services.rst b/doc_src/services.rst
new file mode 100755
index 0000000..7fad30d
--- /dev/null
+++ b/doc_src/services.rst
@@ -0,0 +1,87 @@
+.. _services:
+
+.. include:: global.txt
+
+Implemented Services
+====================
+
+python-fedex implements various `FedEx Web Services`_. These
+services along with the implemented functionality is
+described below.
+
+Ship Service
+------------
+
+Generates (FedEx Waybill) and deletes shipments.
+
+.. autoclass:: fedex.services.ship_service.FedexProcessShipmentRequest
+
+.. autoclass:: fedex.services.ship_service.FedexDeleteShipmentRequest
+
+Rate Service
+------------
+
+Calculates the cost of a shipment.
+
+.. autoclass:: fedex.services.rate_service.FedexRateServiceRequest
+
+
+Validation Availability And Commitment Service
+----------------------------------------------
+
+Calculates the estimated arrival time of a shipment.
+
+.. autoclass:: fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest
+
+
+Track Service
+-------------
+
+Returns tracking information for a given tracking number.
+
+.. autoclass:: fedex.services.track_service.FedexTrackRequest
+
+Address Validation Service
+--------------------------
+
+Validates and cleans a given address.
+
+.. autoclass:: fedex.services.address_validation_service.FedexAddressValidationRequest
+
+
+Location Service
+----------------
+
+Returns FedEx store locations based on a given location query.
+
+.. autoclass:: fedex.services.location_service.FedexSearchLocationRequest
+
+
+Country Service
+---------------
+
+Validates the postal codes for a given address.
+
+.. autoclass:: fedex.services.country_service.FedexValidatePostalRequest
+
+
+Pickup Service
+--------------
+
+Creates a FedEx pickup request.
+
+.. autoclass:: fedex.services.pickup_service.FedexCreatePickupRequest
+
+Queries pickup availability.
+
+.. autoclass:: fedex.services.pickup_service.FedexPickupAvailabilityRequest
+
+
+Package Movement Service
+------------------------
+
+DEPRECATED service that was used to validate postal codes and
+calculate shipment arrival times. Replaced with two distinct services:
+Validation Availability And Commitment Service, and Country Service.
+
+.. autoclass:: fedex.services.country_service.FedexValidatePostalRequest
diff --git a/doc_src/suds_plugin.rst b/doc_src/suds_plugin.rst
new file mode 100755
index 0000000..2029012
--- /dev/null
+++ b/doc_src/suds_plugin.rst
@@ -0,0 +1,11 @@
+.. _suds_plugin:
+
+.. include:: global.txt
+
+General Suds Plugin
+===================
+
+python-fedex uses the following suds plugin for suds xml requests.
+
+
+.. autoclass:: fedex.base_service.GeneralSudsPlugin
diff --git a/doc_src/tools.rst b/doc_src/tools.rst
new file mode 100755
index 0000000..62ef68f
--- /dev/null
+++ b/doc_src/tools.rst
@@ -0,0 +1,24 @@
+.. _tools:
+
+.. include:: global.txt
+
+Format Conversion Tools
+=======================
+
+Additional utility functions for converting suds xml
+object into other formats.
+
+Basic Suds Object to Dictionary
+-------------------------------
+
+.. autofunction:: fedex.tools.conversion.basic_sobject_to_dict
+
+Advanced Suds Object to Dictionary
+----------------------------------
+
+.. autofunction:: fedex.tools.conversion.sobject_to_dict
+
+Suds Object to JSON
+-------------------
+
+.. autofunction:: fedex.tools.conversion.sobject_to_json
diff --git a/epydoc_source/README.rst b/epydoc_source/README.rst
new file mode 100644
index 0000000..e42f2b3
--- /dev/null
+++ b/epydoc_source/README.rst
@@ -0,0 +1,15 @@
+python-fedex legacy documentation
+=================================
+
+This directory contains legacy build scripts for python-fedex documentation
+using epydoc 3.0.1. The following was used to generate doc:
+
+ cd python-fedex/docs
+ epydoc -v -o 2.X.X ../fedex/
+
+The epydoc documentation is hosted at https://pythonhosted.org/fedex/.
+
+Latest documentation is now generated using Sphinx. Updates can be made to the
+*.rst files in doc_src:
+
+ cd python-fedex/doc_src
diff --git a/doc_source/build_docs.sh b/epydoc_source/build_docs.sh
similarity index 100%
rename from doc_source/build_docs.sh
rename to epydoc_source/build_docs.sh
diff --git a/docs/api-objects.txt b/epydoc_source/docs/1.0.0/api-objects.txt
similarity index 100%
rename from docs/api-objects.txt
rename to epydoc_source/docs/1.0.0/api-objects.txt
diff --git a/docs/class-tree.html b/epydoc_source/docs/1.0.0/class-tree.html
similarity index 100%
rename from docs/class-tree.html
rename to epydoc_source/docs/1.0.0/class-tree.html
diff --git a/docs/crarr.png b/epydoc_source/docs/1.0.0/crarr.png
similarity index 100%
rename from docs/crarr.png
rename to epydoc_source/docs/1.0.0/crarr.png
diff --git a/docs/epydoc.css b/epydoc_source/docs/1.0.0/epydoc.css
similarity index 100%
rename from docs/epydoc.css
rename to epydoc_source/docs/1.0.0/epydoc.css
diff --git a/docs/epydoc.js b/epydoc_source/docs/1.0.0/epydoc.js
similarity index 99%
rename from docs/epydoc.js
rename to epydoc_source/docs/1.0.0/epydoc.js
index e787dbc..119e71e 100644
--- a/docs/epydoc.js
+++ b/epydoc_source/docs/1.0.0/epydoc.js
@@ -22,7 +22,7 @@ function toggle_private() {
}
}
// Update all table rows containing private objects. Note, we
- // use "" instead of "block" becaue IE & firefox disagree on what
+ // use "" instead of "block" because IE & firefox disagree on what
// this should be (block vs table-row), and "" just gives the
// default for both browsers.
var elts = document.getElementsByTagName("tr");
diff --git a/docs/fedex-module.html b/epydoc_source/docs/1.0.0/fedex-module.html
similarity index 100%
rename from docs/fedex-module.html
rename to epydoc_source/docs/1.0.0/fedex-module.html
diff --git a/docs/fedex-pysrc.html b/epydoc_source/docs/1.0.0/fedex-pysrc.html
similarity index 100%
rename from docs/fedex-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex-pysrc.html
diff --git a/docs/fedex.base_service-module.html b/epydoc_source/docs/1.0.0/fedex.base_service-module.html
similarity index 100%
rename from docs/fedex.base_service-module.html
rename to epydoc_source/docs/1.0.0/fedex.base_service-module.html
diff --git a/docs/fedex.base_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.base_service-pysrc.html
similarity index 100%
rename from docs/fedex.base_service-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.base_service-pysrc.html
diff --git a/docs/fedex.base_service.FedexBaseService-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.FedexBaseService-class.html
similarity index 100%
rename from docs/fedex.base_service.FedexBaseService-class.html
rename to epydoc_source/docs/1.0.0/fedex.base_service.FedexBaseService-class.html
diff --git a/docs/fedex.base_service.FedexBaseServiceException-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.FedexBaseServiceException-class.html
similarity index 100%
rename from docs/fedex.base_service.FedexBaseServiceException-class.html
rename to epydoc_source/docs/1.0.0/fedex.base_service.FedexBaseServiceException-class.html
diff --git a/docs/fedex.base_service.FedexError-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.FedexError-class.html
similarity index 100%
rename from docs/fedex.base_service.FedexError-class.html
rename to epydoc_source/docs/1.0.0/fedex.base_service.FedexError-class.html
diff --git a/docs/fedex.base_service.FedexFailure-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.FedexFailure-class.html
similarity index 100%
rename from docs/fedex.base_service.FedexFailure-class.html
rename to epydoc_source/docs/1.0.0/fedex.base_service.FedexFailure-class.html
diff --git a/docs/fedex.base_service.SchemaValidationError-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.SchemaValidationError-class.html
similarity index 100%
rename from docs/fedex.base_service.SchemaValidationError-class.html
rename to epydoc_source/docs/1.0.0/fedex.base_service.SchemaValidationError-class.html
diff --git a/docs/fedex.config-module.html b/epydoc_source/docs/1.0.0/fedex.config-module.html
similarity index 100%
rename from docs/fedex.config-module.html
rename to epydoc_source/docs/1.0.0/fedex.config-module.html
diff --git a/docs/fedex.config-pysrc.html b/epydoc_source/docs/1.0.0/fedex.config-pysrc.html
similarity index 100%
rename from docs/fedex.config-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.config-pysrc.html
diff --git a/docs/fedex.config.FedexConfig-class.html b/epydoc_source/docs/1.0.0/fedex.config.FedexConfig-class.html
similarity index 100%
rename from docs/fedex.config.FedexConfig-class.html
rename to epydoc_source/docs/1.0.0/fedex.config.FedexConfig-class.html
diff --git a/docs/fedex.printers-module.html b/epydoc_source/docs/1.0.0/fedex.printers-module.html
similarity index 100%
rename from docs/fedex.printers-module.html
rename to epydoc_source/docs/1.0.0/fedex.printers-module.html
diff --git a/docs/fedex.printers-pysrc.html b/epydoc_source/docs/1.0.0/fedex.printers-pysrc.html
similarity index 100%
rename from docs/fedex.printers-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.printers-pysrc.html
diff --git a/docs/fedex.printers.unix-module.html b/epydoc_source/docs/1.0.0/fedex.printers.unix-module.html
similarity index 100%
rename from docs/fedex.printers.unix-module.html
rename to epydoc_source/docs/1.0.0/fedex.printers.unix-module.html
diff --git a/docs/fedex.printers.unix-pysrc.html b/epydoc_source/docs/1.0.0/fedex.printers.unix-pysrc.html
similarity index 100%
rename from docs/fedex.printers.unix-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.printers.unix-pysrc.html
diff --git a/docs/fedex.printers.unix.DirectDevicePrinter-class.html b/epydoc_source/docs/1.0.0/fedex.printers.unix.DirectDevicePrinter-class.html
similarity index 100%
rename from docs/fedex.printers.unix.DirectDevicePrinter-class.html
rename to epydoc_source/docs/1.0.0/fedex.printers.unix.DirectDevicePrinter-class.html
diff --git a/docs/fedex.services-module.html b/epydoc_source/docs/1.0.0/fedex.services-module.html
similarity index 100%
rename from docs/fedex.services-module.html
rename to epydoc_source/docs/1.0.0/fedex.services-module.html
diff --git a/docs/fedex.services-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services-pysrc.html
similarity index 100%
rename from docs/fedex.services-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.services-pysrc.html
diff --git a/docs/fedex.services.address_validation_service-module.html b/epydoc_source/docs/1.0.0/fedex.services.address_validation_service-module.html
similarity index 100%
rename from docs/fedex.services.address_validation_service-module.html
rename to epydoc_source/docs/1.0.0/fedex.services.address_validation_service-module.html
diff --git a/docs/fedex.services.address_validation_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.address_validation_service-pysrc.html
similarity index 100%
rename from docs/fedex.services.address_validation_service-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.services.address_validation_service-pysrc.html
diff --git a/docs/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html
similarity index 100%
rename from docs/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html
rename to epydoc_source/docs/1.0.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html
diff --git a/docs/fedex.services.package_movement-module.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement-module.html
similarity index 100%
rename from docs/fedex.services.package_movement-module.html
rename to epydoc_source/docs/1.0.0/fedex.services.package_movement-module.html
diff --git a/docs/fedex.services.package_movement-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement-pysrc.html
similarity index 100%
rename from docs/fedex.services.package_movement-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.services.package_movement-pysrc.html
diff --git a/docs/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html
similarity index 100%
rename from docs/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html
rename to epydoc_source/docs/1.0.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html
diff --git a/docs/fedex.services.package_movement.FedexPostalCodeNotFound-class.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html
similarity index 100%
rename from docs/fedex.services.package_movement.FedexPostalCodeNotFound-class.html
rename to epydoc_source/docs/1.0.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html
diff --git a/docs/fedex.services.package_movement.PostalCodeInquiryRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html
similarity index 100%
rename from docs/fedex.services.package_movement.PostalCodeInquiryRequest-class.html
rename to epydoc_source/docs/1.0.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html
diff --git a/docs/fedex.services.rate_service-module.html b/epydoc_source/docs/1.0.0/fedex.services.rate_service-module.html
similarity index 100%
rename from docs/fedex.services.rate_service-module.html
rename to epydoc_source/docs/1.0.0/fedex.services.rate_service-module.html
diff --git a/docs/fedex.services.rate_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.rate_service-pysrc.html
similarity index 100%
rename from docs/fedex.services.rate_service-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.services.rate_service-pysrc.html
diff --git a/docs/fedex.services.rate_service.FedexRateServiceRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.rate_service.FedexRateServiceRequest-class.html
similarity index 100%
rename from docs/fedex.services.rate_service.FedexRateServiceRequest-class.html
rename to epydoc_source/docs/1.0.0/fedex.services.rate_service.FedexRateServiceRequest-class.html
diff --git a/docs/fedex.services.ship_service-module.html b/epydoc_source/docs/1.0.0/fedex.services.ship_service-module.html
similarity index 100%
rename from docs/fedex.services.ship_service-module.html
rename to epydoc_source/docs/1.0.0/fedex.services.ship_service-module.html
diff --git a/docs/fedex.services.ship_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.ship_service-pysrc.html
similarity index 100%
rename from docs/fedex.services.ship_service-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.services.ship_service-pysrc.html
diff --git a/docs/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html
similarity index 100%
rename from docs/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html
rename to epydoc_source/docs/1.0.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html
diff --git a/docs/fedex.services.ship_service.FedexProcessShipmentRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html
similarity index 100%
rename from docs/fedex.services.ship_service.FedexProcessShipmentRequest-class.html
rename to epydoc_source/docs/1.0.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html
diff --git a/docs/fedex.services.track_service-module.html b/epydoc_source/docs/1.0.0/fedex.services.track_service-module.html
similarity index 100%
rename from docs/fedex.services.track_service-module.html
rename to epydoc_source/docs/1.0.0/fedex.services.track_service-module.html
diff --git a/docs/fedex.services.track_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.track_service-pysrc.html
similarity index 100%
rename from docs/fedex.services.track_service-pysrc.html
rename to epydoc_source/docs/1.0.0/fedex.services.track_service-pysrc.html
diff --git a/docs/fedex.services.track_service.FedexInvalidTrackingNumber-class.html b/epydoc_source/docs/1.0.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html
similarity index 100%
rename from docs/fedex.services.track_service.FedexInvalidTrackingNumber-class.html
rename to epydoc_source/docs/1.0.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html
diff --git a/docs/fedex.services.track_service.FedexTrackRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.track_service.FedexTrackRequest-class.html
similarity index 100%
rename from docs/fedex.services.track_service.FedexTrackRequest-class.html
rename to epydoc_source/docs/1.0.0/fedex.services.track_service.FedexTrackRequest-class.html
diff --git a/docs/frames.html b/epydoc_source/docs/1.0.0/frames.html
similarity index 100%
rename from docs/frames.html
rename to epydoc_source/docs/1.0.0/frames.html
diff --git a/docs/help.html b/epydoc_source/docs/1.0.0/help.html
similarity index 100%
rename from docs/help.html
rename to epydoc_source/docs/1.0.0/help.html
diff --git a/docs/identifier-index.html b/epydoc_source/docs/1.0.0/identifier-index.html
similarity index 100%
rename from docs/identifier-index.html
rename to epydoc_source/docs/1.0.0/identifier-index.html
diff --git a/docs/index.html b/epydoc_source/docs/1.0.0/index.html
similarity index 100%
rename from docs/index.html
rename to epydoc_source/docs/1.0.0/index.html
diff --git a/docs/module-tree.html b/epydoc_source/docs/1.0.0/module-tree.html
similarity index 100%
rename from docs/module-tree.html
rename to epydoc_source/docs/1.0.0/module-tree.html
diff --git a/docs/redirect.html b/epydoc_source/docs/1.0.0/redirect.html
similarity index 100%
rename from docs/redirect.html
rename to epydoc_source/docs/1.0.0/redirect.html
diff --git a/docs/toc-everything.html b/epydoc_source/docs/1.0.0/toc-everything.html
similarity index 100%
rename from docs/toc-everything.html
rename to epydoc_source/docs/1.0.0/toc-everything.html
diff --git a/docs/toc-fedex-module.html b/epydoc_source/docs/1.0.0/toc-fedex-module.html
similarity index 100%
rename from docs/toc-fedex-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex-module.html
diff --git a/docs/toc-fedex.base_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.base_service-module.html
similarity index 100%
rename from docs/toc-fedex.base_service-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.base_service-module.html
diff --git a/docs/toc-fedex.config-module.html b/epydoc_source/docs/1.0.0/toc-fedex.config-module.html
similarity index 100%
rename from docs/toc-fedex.config-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.config-module.html
diff --git a/docs/toc-fedex.printers-module.html b/epydoc_source/docs/1.0.0/toc-fedex.printers-module.html
similarity index 100%
rename from docs/toc-fedex.printers-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.printers-module.html
diff --git a/docs/toc-fedex.printers.unix-module.html b/epydoc_source/docs/1.0.0/toc-fedex.printers.unix-module.html
similarity index 100%
rename from docs/toc-fedex.printers.unix-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.printers.unix-module.html
diff --git a/docs/toc-fedex.services-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services-module.html
similarity index 100%
rename from docs/toc-fedex.services-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.services-module.html
diff --git a/docs/toc-fedex.services.address_validation_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.address_validation_service-module.html
similarity index 100%
rename from docs/toc-fedex.services.address_validation_service-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.services.address_validation_service-module.html
diff --git a/docs/toc-fedex.services.package_movement-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.package_movement-module.html
similarity index 100%
rename from docs/toc-fedex.services.package_movement-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.services.package_movement-module.html
diff --git a/docs/toc-fedex.services.rate_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.rate_service-module.html
similarity index 100%
rename from docs/toc-fedex.services.rate_service-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.services.rate_service-module.html
diff --git a/docs/toc-fedex.services.ship_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.ship_service-module.html
similarity index 100%
rename from docs/toc-fedex.services.ship_service-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.services.ship_service-module.html
diff --git a/docs/toc-fedex.services.track_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.track_service-module.html
similarity index 100%
rename from docs/toc-fedex.services.track_service-module.html
rename to epydoc_source/docs/1.0.0/toc-fedex.services.track_service-module.html
diff --git a/docs/toc.html b/epydoc_source/docs/1.0.0/toc.html
similarity index 100%
rename from docs/toc.html
rename to epydoc_source/docs/1.0.0/toc.html
diff --git a/docs/uml_class_diagram_for_fedex_ba.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_ba.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba.gif
diff --git a/docs/uml_class_diagram_for_fedex_ba_2.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_2.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_ba_2.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_2.gif
diff --git a/docs/uml_class_diagram_for_fedex_ba_3.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_3.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_ba_3.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_3.gif
diff --git a/docs/uml_class_diagram_for_fedex_ba_4.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_4.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_ba_4.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_4.gif
diff --git a/docs/uml_class_diagram_for_fedex_ba_5.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_5.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_ba_5.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_5.gif
diff --git a/docs/uml_class_diagram_for_fedex_co.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_co.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_co.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_co.gif
diff --git a/docs/uml_class_diagram_for_fedex_pr.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_pr.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_pr.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_pr.gif
diff --git a/docs/uml_class_diagram_for_fedex_se.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_se.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se.gif
diff --git a/docs/uml_class_diagram_for_fedex_se_2.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_2.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_se_2.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_2.gif
diff --git a/docs/uml_class_diagram_for_fedex_se_3.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_3.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_se_3.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_3.gif
diff --git a/docs/uml_class_diagram_for_fedex_se_4.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_4.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_se_4.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_4.gif
diff --git a/docs/uml_class_diagram_for_fedex_se_5.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_5.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_se_5.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_5.gif
diff --git a/docs/uml_class_diagram_for_fedex_se_6.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_6.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_se_6.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_6.gif
diff --git a/docs/uml_class_diagram_for_fedex_se_7.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_7.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_se_7.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_7.gif
diff --git a/docs/uml_class_diagram_for_fedex_se_8.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_8.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_se_8.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_8.gif
diff --git a/docs/uml_class_diagram_for_fedex_se_9.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_9.gif
similarity index 100%
rename from docs/uml_class_diagram_for_fedex_se_9.gif
rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_9.gif
diff --git a/epydoc_source/docs/2.3.0/api-objects.txt b/epydoc_source/docs/2.3.0/api-objects.txt
new file mode 100644
index 0000000..59c36d7
--- /dev/null
+++ b/epydoc_source/docs/2.3.0/api-objects.txt
@@ -0,0 +1,279 @@
+fedex fedex-module.html
+fedex.VERSION fedex-module.html#VERSION
+fedex.__package__ fedex-module.html#__package__
+fedex.base_service fedex.base_service-module.html
+fedex.base_service.__package__ fedex.base_service-module.html#__package__
+fedex.config fedex.config-module.html
+fedex.config.__package__ fedex.config-module.html#__package__
+fedex.printers fedex.printers-module.html
+fedex.printers.__package__ fedex.printers-module.html#__package__
+fedex.printers.unix fedex.printers.unix-module.html
+fedex.printers.unix.__package__ fedex.printers.unix-module.html#__package__
+fedex.services fedex.services-module.html
+fedex.services.__package__ fedex.services-module.html#__package__
+fedex.services.address_validation_service fedex.services.address_validation_service-module.html
+fedex.services.address_validation_service.__package__ fedex.services.address_validation_service-module.html#__package__
+fedex.services.availability_commitment_service fedex.services.availability_commitment_service-module.html
+fedex.services.availability_commitment_service.__package__ fedex.services.availability_commitment_service-module.html#__package__
+fedex.services.country_service fedex.services.country_service-module.html
+fedex.services.country_service.__package__ fedex.services.country_service-module.html#__package__
+fedex.services.location_service fedex.services.location_service-module.html
+fedex.services.location_service.__package__ fedex.services.location_service-module.html#__package__
+fedex.services.package_movement fedex.services.package_movement-module.html
+fedex.services.package_movement.__package__ fedex.services.package_movement-module.html#__package__
+fedex.services.rate_service fedex.services.rate_service-module.html
+fedex.services.rate_service.__package__ fedex.services.rate_service-module.html#__package__
+fedex.services.ship_service fedex.services.ship_service-module.html
+fedex.services.ship_service.__package__ fedex.services.ship_service-module.html#__package__
+fedex.services.track_service fedex.services.track_service-module.html
+fedex.services.track_service.__package__ fedex.services.track_service-module.html#__package__
+fedex.tools fedex.tools-module.html
+fedex.tools.__package__ fedex.tools-module.html#__package__
+fedex.tools.conversion fedex.tools.conversion-module.html
+fedex.tools.conversion.basic_sobject_to_dict fedex.tools.conversion-module.html#basic_sobject_to_dict
+fedex.tools.conversion.sobject_to_json fedex.tools.conversion-module.html#sobject_to_json
+fedex.tools.conversion.sobject_to_dict fedex.tools.conversion-module.html#sobject_to_dict
+fedex.tools.conversion.__package__ fedex.tools.conversion-module.html#__package__
+fedex.base_service.FedexBaseService fedex.base_service.FedexBaseService-class.html
+fedex.base_service.FedexBaseService.__check_response_for_fedex_error fedex.base_service.FedexBaseService-class.html#__check_response_for_fedex_error
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.base_service.FedexBaseService.__set_web_authentication_detail fedex.base_service.FedexBaseService-class.html#__set_web_authentication_detail
+fedex.base_service.FedexBaseService._prepare_wsdl_objects fedex.base_service.FedexBaseService-class.html#_prepare_wsdl_objects
+fedex.base_service.FedexBaseService.__init__ fedex.base_service.FedexBaseService-class.html#__init__
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.base_service.FedexBaseService._assemble_and_send_request fedex.base_service.FedexBaseService-class.html#_assemble_and_send_request
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.base_service.FedexBaseService.__set_client_detail fedex.base_service.FedexBaseService-class.html#__set_client_detail
+fedex.base_service.FedexBaseService.__set_version_id fedex.base_service.FedexBaseService-class.html#__set_version_id
+fedex.base_service.FedexBaseService.__set_transaction_detail fedex.base_service.FedexBaseService-class.html#__set_transaction_detail
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
+fedex.base_service.FedexBaseServiceException fedex.base_service.FedexBaseServiceException-class.html
+fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
+fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
+fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
+fedex.base_service.FedexError fedex.base_service.FedexError-class.html
+fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
+fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
+fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
+fedex.base_service.FedexFailure fedex.base_service.FedexFailure-class.html
+fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
+fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
+fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
+fedex.base_service.GeneralSudsPlugin fedex.base_service.GeneralSudsPlugin-class.html
+fedex.base_service.GeneralSudsPlugin.sending fedex.base_service.GeneralSudsPlugin-class.html#sending
+fedex.base_service.GeneralSudsPlugin.marshalled fedex.base_service.GeneralSudsPlugin-class.html#marshalled
+fedex.base_service.GeneralSudsPlugin.received fedex.base_service.GeneralSudsPlugin-class.html#received
+fedex.base_service.GeneralSudsPlugin.__init__ fedex.base_service.GeneralSudsPlugin-class.html#__init__
+fedex.base_service.SchemaValidationError fedex.base_service.SchemaValidationError-class.html
+fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
+fedex.base_service.SchemaValidationError.__init__ fedex.base_service.SchemaValidationError-class.html#__init__
+fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
+fedex.config.FedexConfig fedex.config.FedexConfig-class.html
+fedex.config.FedexConfig.use_test_server fedex.config.FedexConfig-class.html#use_test_server
+fedex.config.FedexConfig.express_region_code fedex.config.FedexConfig-class.html#express_region_code
+fedex.config.FedexConfig.__init__ fedex.config.FedexConfig-class.html#__init__
+fedex.config.FedexConfig.integrator_id fedex.config.FedexConfig-class.html#integrator_id
+fedex.config.FedexConfig.meter_number fedex.config.FedexConfig-class.html#meter_number
+fedex.config.FedexConfig.key fedex.config.FedexConfig-class.html#key
+fedex.config.FedexConfig.freight_account_number fedex.config.FedexConfig-class.html#freight_account_number
+fedex.config.FedexConfig.password fedex.config.FedexConfig-class.html#password
+fedex.config.FedexConfig.account_number fedex.config.FedexConfig-class.html#account_number
+fedex.printers.unix.DirectDevicePrinter fedex.printers.unix.DirectDevicePrinter-class.html
+fedex.printers.unix.DirectDevicePrinter.print_label fedex.printers.unix.DirectDevicePrinter-class.html#print_label
+fedex.printers.unix.DirectDevicePrinter.shipment fedex.printers.unix.DirectDevicePrinter-class.html#shipment
+fedex.printers.unix.DirectDevicePrinter.device fedex.printers.unix.DirectDevicePrinter-class.html#device
+fedex.printers.unix.DirectDevicePrinter._print_base64 fedex.printers.unix.DirectDevicePrinter-class.html#_print_base64
+fedex.printers.unix.DirectDevicePrinter.__init__ fedex.printers.unix.DirectDevicePrinter-class.html#__init__
+fedex.services.address_validation_service.FedexAddressValidationRequest fedex.services.address_validation_service.FedexAddressValidationRequest-class.html
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.services.address_validation_service.FedexAddressValidationRequest._prepare_wsdl_objects fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#_prepare_wsdl_objects
+fedex.services.address_validation_service.FedexAddressValidationRequest.__init__ fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#__init__
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.services.address_validation_service.FedexAddressValidationRequest._assemble_and_send_request fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#_assemble_and_send_request
+fedex.services.address_validation_service.FedexAddressValidationRequest.AddressesToValidate fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#AddressesToValidate
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.services.address_validation_service.FedexAddressValidationRequest.add_address fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#add_address
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.Service fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#Service
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.Destination fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#Destination
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.CarrierCode fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#CarrierCode
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest._prepare_wsdl_objects fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#_prepare_wsdl_objects
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.__init__ fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#__init__
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest._assemble_and_send_request fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#_assemble_and_send_request
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.ShipDate fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#ShipDate
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.Origin fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#Origin
+fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.Packaging fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#Packaging
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
+fedex.services.country_service.FedexValidatePostalRequest fedex.services.country_service.FedexValidatePostalRequest-class.html
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.services.country_service.FedexValidatePostalRequest.CarrierCode fedex.services.country_service.FedexValidatePostalRequest-class.html#CarrierCode
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.services.country_service.FedexValidatePostalRequest._prepare_wsdl_objects fedex.services.country_service.FedexValidatePostalRequest-class.html#_prepare_wsdl_objects
+fedex.services.country_service.FedexValidatePostalRequest.__init__ fedex.services.country_service.FedexValidatePostalRequest-class.html#__init__
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.services.country_service.FedexValidatePostalRequest._assemble_and_send_request fedex.services.country_service.FedexValidatePostalRequest-class.html#_assemble_and_send_request
+fedex.services.country_service.FedexValidatePostalRequest.RoutingCode fedex.services.country_service.FedexValidatePostalRequest-class.html#RoutingCode
+fedex.services.country_service.FedexValidatePostalRequest.ShipDateTime fedex.services.country_service.FedexValidatePostalRequest-class.html#ShipDateTime
+fedex.services.country_service.FedexValidatePostalRequest.Address fedex.services.country_service.FedexValidatePostalRequest-class.html#Address
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.services.country_service.FedexValidatePostalRequest.CheckForMismatch fedex.services.country_service.FedexValidatePostalRequest-class.html#CheckForMismatch
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
+fedex.services.location_service.FedexSearchLocationRequest fedex.services.location_service.FedexSearchLocationRequest-class.html
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.services.location_service.FedexSearchLocationRequest._prepare_wsdl_objects fedex.services.location_service.FedexSearchLocationRequest-class.html#_prepare_wsdl_objects
+fedex.services.location_service.FedexSearchLocationRequest.__init__ fedex.services.location_service.FedexSearchLocationRequest-class.html#__init__
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.services.location_service.FedexSearchLocationRequest.MultipleMatchesAction fedex.services.location_service.FedexSearchLocationRequest-class.html#MultipleMatchesAction
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.services.location_service.FedexSearchLocationRequest._assemble_and_send_request fedex.services.location_service.FedexSearchLocationRequest-class.html#_assemble_and_send_request
+fedex.services.location_service.FedexSearchLocationRequest.Address fedex.services.location_service.FedexSearchLocationRequest-class.html#Address
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.services.location_service.FedexSearchLocationRequest.LocationsSearchCriterion fedex.services.location_service.FedexSearchLocationRequest-class.html#LocationsSearchCriterion
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.services.location_service.FedexSearchLocationRequest.PhoneNumber fedex.services.location_service.FedexSearchLocationRequest-class.html#PhoneNumber
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.services.location_service.FedexSearchLocationRequest.Constraints fedex.services.location_service.FedexSearchLocationRequest-class.html#Constraints
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.services.location_service.FedexSearchLocationRequest.SortDetail fedex.services.location_service.FedexSearchLocationRequest-class.html#SortDetail
+fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
+fedex.services.package_movement.FedexInvalidPostalCodeFormat fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html
+fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
+fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
+fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
+fedex.services.package_movement.FedexPostalCodeNotFound fedex.services.package_movement.FedexPostalCodeNotFound-class.html
+fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
+fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
+fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
+fedex.services.package_movement.PostalCodeInquiryRequest fedex.services.package_movement.PostalCodeInquiryRequest-class.html
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.services.package_movement.PostalCodeInquiryRequest._prepare_wsdl_objects fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_prepare_wsdl_objects
+fedex.services.package_movement.PostalCodeInquiryRequest.__init__ fedex.services.package_movement.PostalCodeInquiryRequest-class.html#__init__
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.services.package_movement.PostalCodeInquiryRequest._assemble_and_send_request fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_assemble_and_send_request
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.services.package_movement.PostalCodeInquiryRequest._check_response_for_request_errors fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_check_response_for_request_errors
+fedex.services.rate_service.FedexRateServiceRequest fedex.services.rate_service.FedexRateServiceRequest-class.html
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.services.rate_service.FedexRateServiceRequest._prepare_wsdl_objects fedex.services.rate_service.FedexRateServiceRequest-class.html#_prepare_wsdl_objects
+fedex.services.rate_service.FedexRateServiceRequest.__init__ fedex.services.rate_service.FedexRateServiceRequest-class.html#__init__
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.services.rate_service.FedexRateServiceRequest._assemble_and_send_request fedex.services.rate_service.FedexRateServiceRequest-class.html#_assemble_and_send_request
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.services.rate_service.FedexRateServiceRequest.RequestedShipment fedex.services.rate_service.FedexRateServiceRequest-class.html#RequestedShipment
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.services.rate_service.FedexRateServiceRequest.add_package fedex.services.rate_service.FedexRateServiceRequest-class.html#add_package
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
+fedex.services.ship_service.FedexDeleteShipmentRequest fedex.services.ship_service.FedexDeleteShipmentRequest-class.html
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.services.ship_service.FedexDeleteShipmentRequest._prepare_wsdl_objects fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#_prepare_wsdl_objects
+fedex.services.ship_service.FedexDeleteShipmentRequest.__init__ fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#__init__
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.services.ship_service.FedexDeleteShipmentRequest._assemble_and_send_request fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#_assemble_and_send_request
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.services.ship_service.FedexDeleteShipmentRequest.DeletionControlType fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#DeletionControlType
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.services.ship_service.FedexDeleteShipmentRequest.TrackingId fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#TrackingId
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
+fedex.services.ship_service.FedexProcessShipmentRequest fedex.services.ship_service.FedexProcessShipmentRequest-class.html
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.services.ship_service.FedexProcessShipmentRequest._prepare_wsdl_objects fedex.services.ship_service.FedexProcessShipmentRequest-class.html#_prepare_wsdl_objects
+fedex.services.ship_service.FedexProcessShipmentRequest.__init__ fedex.services.ship_service.FedexProcessShipmentRequest-class.html#__init__
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.services.ship_service.FedexProcessShipmentRequest.send_validation_request fedex.services.ship_service.FedexProcessShipmentRequest-class.html#send_validation_request
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.services.ship_service.FedexProcessShipmentRequest._assemble_and_send_request fedex.services.ship_service.FedexProcessShipmentRequest-class.html#_assemble_and_send_request
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.services.ship_service.FedexProcessShipmentRequest._assemble_and_send_validation_request fedex.services.ship_service.FedexProcessShipmentRequest-class.html#_assemble_and_send_validation_request
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.services.ship_service.FedexProcessShipmentRequest.RequestedShipment fedex.services.ship_service.FedexProcessShipmentRequest-class.html#RequestedShipment
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.services.ship_service.FedexProcessShipmentRequest.add_package fedex.services.ship_service.FedexProcessShipmentRequest-class.html#add_package
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors
+fedex.services.track_service.FedexInvalidTrackingNumber fedex.services.track_service.FedexInvalidTrackingNumber-class.html
+fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__
+fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__
+fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBaseServiceException-class.html#__init__
+fedex.services.track_service.FedexTrackRequest fedex.services.track_service.FedexTrackRequest-class.html
+fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail
+fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request
+fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info
+fedex.services.track_service.FedexTrackRequest._prepare_wsdl_objects fedex.services.track_service.FedexTrackRequest-class.html#_prepare_wsdl_objects
+fedex.services.track_service.FedexTrackRequest.__init__ fedex.services.track_service.FedexTrackRequest-class.html#__init__
+fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj
+fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail
+fedex.services.track_service.FedexTrackRequest._assemble_and_send_request fedex.services.track_service.FedexTrackRequest-class.html#_assemble_and_send_request
+fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger
+fedex.services.track_service.FedexTrackRequest.SelectionDetails fedex.services.track_service.FedexTrackRequest-class.html#SelectionDetails
+fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings
+fedex.services.track_service.FedexTrackRequest.ProcessingOptions fedex.services.track_service.FedexTrackRequest-class.html#ProcessingOptions
+fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail
+fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type
+fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response
+fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId
+fedex.services.track_service.FedexTrackRequest._check_response_for_request_errors fedex.services.track_service.FedexTrackRequest-class.html#_check_response_for_request_errors
diff --git a/epydoc_source/docs/2.3.0/class-tree.html b/epydoc_source/docs/2.3.0/class-tree.html
new file mode 100644
index 0000000..1fc76eb
--- /dev/null
+++ b/epydoc_source/docs/2.3.0/class-tree.html
@@ -0,0 +1,203 @@
+
+
+
+
+ Class Hierarchy
+
+
+
+
+
+
+
+
+
+
+
diff --git a/epydoc_source/docs/2.3.0/crarr.png b/epydoc_source/docs/2.3.0/crarr.png
new file mode 100644
index 0000000..26b43c5
Binary files /dev/null and b/epydoc_source/docs/2.3.0/crarr.png differ
diff --git a/epydoc_source/docs/2.3.0/epydoc.css b/epydoc_source/docs/2.3.0/epydoc.css
new file mode 100644
index 0000000..86d4170
--- /dev/null
+++ b/epydoc_source/docs/2.3.0/epydoc.css
@@ -0,0 +1,322 @@
+
+
+/* Epydoc CSS Stylesheet
+ *
+ * This stylesheet can be used to customize the appearance of epydoc's
+ * HTML output.
+ *
+ */
+
+/* Default Colors & Styles
+ * - Set the default foreground & background color with 'body'; and
+ * link colors with 'a:link' and 'a:visited'.
+ * - Use bold for decision list terms.
+ * - The heading styles defined here are used for headings *within*
+ * docstring descriptions. All headings used by epydoc itself use
+ * either class='epydoc' or class='toc' (CSS styles for both
+ * defined below).
+ */
+body { background: #ffffff; color: #000000; }
+p { margin-top: 0.5em; margin-bottom: 0.5em; }
+a:link { color: #0000ff; }
+a:visited { color: #204080; }
+dt { font-weight: bold; }
+h1 { font-size: +140%; font-style: italic;
+ font-weight: bold; }
+h2 { font-size: +125%; font-style: italic;
+ font-weight: bold; }
+h3 { font-size: +110%; font-style: italic;
+ font-weight: normal; }
+code { font-size: 100%; }
+/* N.B.: class, not pseudoclass */
+a.link { font-family: monospace; }
+
+/* Page Header & Footer
+ * - The standard page header consists of a navigation bar (with
+ * pointers to standard pages such as 'home' and 'trees'); a
+ * breadcrumbs list, which can be used to navigate to containing
+ * classes or modules; options links, to show/hide private
+ * variables and to show/hide frames; and a page title (using
+ *
). The page title may be followed by a link to the
+ * corresponding source code (using 'span.codelink').
+ * - The footer consists of a navigation bar, a timestamp, and a
+ * pointer to epydoc's homepage.
+ */
+h1.epydoc { margin: 0; font-size: +140%; font-weight: bold; }
+h2.epydoc { font-size: +130%; font-weight: bold; }
+h3.epydoc { font-size: +115%; font-weight: bold;
+ margin-top: 0.2em; }
+td h3.epydoc { font-size: +115%; font-weight: bold;
+ margin-bottom: 0; }
+table.navbar { background: #a0c0ff; color: #000000;
+ border: 2px groove #c0d0d0; }
+table.navbar table { color: #000000; }
+th.navbar-select { background: #70b0ff;
+ color: #000000; }
+table.navbar a { text-decoration: none; }
+table.navbar a:link { color: #0000ff; }
+table.navbar a:visited { color: #204080; }
+span.breadcrumbs { font-size: 85%; font-weight: bold; }
+span.options { font-size: 70%; }
+span.codelink { font-size: 85%; }
+td.footer { font-size: 85%; }
+
+/* Table Headers
+ * - Each summary table and details section begins with a 'header'
+ * row. This row contains a section title (marked by
+ * 'span.table-header') as well as a show/hide private link
+ * (marked by 'span.options', defined above).
+ * - Summary tables that contain user-defined groups mark those
+ * groups using 'group header' rows.
+ */
+td.table-header { background: #70b0ff; color: #000000;
+ border: 1px solid #608090; }
+td.table-header table { color: #000000; }
+td.table-header table a:link { color: #0000ff; }
+td.table-header table a:visited { color: #204080; }
+span.table-header { font-size: 120%; font-weight: bold; }
+th.group-header { background: #c0e0f8; color: #000000;
+ text-align: left; font-style: italic;
+ font-size: 115%;
+ border: 1px solid #608090; }
+
+/* Summary Tables (functions, variables, etc)
+ * - Each object is described by a single row of the table with
+ * two cells. The left cell gives the object's type, and is
+ * marked with 'code.summary-type'. The right cell gives the
+ * object's name and a summary description.
+ * - CSS styles for the table's header and group headers are
+ * defined above, under 'Table Headers'
+ */
+table.summary { border-collapse: collapse;
+ background: #e8f0f8; color: #000000;
+ border: 1px solid #608090;
+ margin-bottom: 0.5em; }
+td.summary { border: 1px solid #608090; }
+code.summary-type { font-size: 85%; }
+table.summary a:link { color: #0000ff; }
+table.summary a:visited { color: #204080; }
+
+
+/* Details Tables (functions, variables, etc)
+ * - Each object is described in its own div.
+ * - A single-row summary table w/ table-header is used as
+ * a header for each details section (CSS style for table-header
+ * is defined above, under 'Table Headers').
+ */
+table.details { border-collapse: collapse;
+ background: #e8f0f8; color: #000000;
+ border: 1px solid #608090;
+ margin: .2em 0 0 0; }
+table.details table { color: #000000; }
+table.details a:link { color: #0000ff; }
+table.details a:visited { color: #204080; }
+
+/* Fields */
+dl.fields { margin-left: 2em; margin-top: 1em;
+ margin-bottom: 1em; }
+dl.fields dd ul { margin-left: 0em; padding-left: 0em; }
+dl.fields dd ul li ul { margin-left: 2em; padding-left: 0em; }
+div.fields { margin-left: 2em; }
+div.fields p { margin-bottom: 0.5em; }
+
+/* Index tables (identifier index, term index, etc)
+ * - link-index is used for indices containing lists of links
+ * (namely, the identifier index & term index).
+ * - index-where is used in link indices for the text indicating
+ * the container/source for each link.
+ * - metadata-index is used for indices containing metadata
+ * extracted from fields (namely, the bug index & todo index).
+ */
+table.link-index { border-collapse: collapse;
+ background: #e8f0f8; color: #000000;
+ border: 1px solid #608090; }
+td.link-index { border-width: 0px; }
+table.link-index a:link { color: #0000ff; }
+table.link-index a:visited { color: #204080; }
+span.index-where { font-size: 70%; }
+table.metadata-index { border-collapse: collapse;
+ background: #e8f0f8; color: #000000;
+ border: 1px solid #608090;
+ margin: .2em 0 0 0; }
+td.metadata-index { border-width: 1px; border-style: solid; }
+table.metadata-index a:link { color: #0000ff; }
+table.metadata-index a:visited { color: #204080; }
+
+/* Function signatures
+ * - sig* is used for the signature in the details section.
+ * - .summary-sig* is used for the signature in the summary
+ * table, and when listing property accessor functions.
+ * */
+.sig-name { color: #006080; }
+.sig-arg { color: #008060; }
+.sig-default { color: #602000; }
+.summary-sig { font-family: monospace; }
+.summary-sig-name { color: #006080; font-weight: bold; }
+table.summary a.summary-sig-name:link
+ { color: #006080; font-weight: bold; }
+table.summary a.summary-sig-name:visited
+ { color: #006080; font-weight: bold; }
+.summary-sig-arg { color: #006040; }
+.summary-sig-default { color: #501800; }
+
+/* Subclass list
+ */
+ul.subclass-list { display: inline; }
+ul.subclass-list li { display: inline; }
+
+/* To render variables, classes etc. like functions */
+table.summary .summary-name { color: #006080; font-weight: bold;
+ font-family: monospace; }
+table.summary
+ a.summary-name:link { color: #006080; font-weight: bold;
+ font-family: monospace; }
+table.summary
+ a.summary-name:visited { color: #006080; font-weight: bold;
+ font-family: monospace; }
+
+/* Variable values
+ * - In the 'variable details' sections, each varaible's value is
+ * listed in a 'pre.variable' box. The width of this box is
+ * restricted to 80 chars; if the value's repr is longer than
+ * this it will be wrapped, using a backslash marked with
+ * class 'variable-linewrap'. If the value's repr is longer
+ * than 3 lines, the rest will be ellided; and an ellipsis
+ * marker ('...' marked with 'variable-ellipsis') will be used.
+ * - If the value is a string, its quote marks will be marked
+ * with 'variable-quote'.
+ * - If the variable is a regexp, it is syntax-highlighted using
+ * the re* CSS classes.
+ */
+pre.variable { padding: .5em; margin: 0;
+ background: #dce4ec; color: #000000;
+ border: 1px solid #708890; }
+.variable-linewrap { color: #604000; font-weight: bold; }
+.variable-ellipsis { color: #604000; font-weight: bold; }
+.variable-quote { color: #604000; font-weight: bold; }
+.variable-group { color: #008000; font-weight: bold; }
+.variable-op { color: #604000; font-weight: bold; }
+.variable-string { color: #006030; }
+.variable-unknown { color: #a00000; font-weight: bold; }
+.re { color: #000000; }
+.re-char { color: #006030; }
+.re-op { color: #600000; }
+.re-group { color: #003060; }
+.re-ref { color: #404040; }
+
+/* Base tree
+ * - Used by class pages to display the base class hierarchy.
+ */
+pre.base-tree { font-size: 80%; margin: 0; }
+
+/* Frames-based table of contents headers
+ * - Consists of two frames: one for selecting modules; and
+ * the other listing the contents of the selected module.
+ * - h1.toc is used for each frame's heading
+ * - h2.toc is used for subheadings within each frame.
+ */
+h1.toc { text-align: center; font-size: 105%;
+ margin: 0; font-weight: bold;
+ padding: 0; }
+h2.toc { font-size: 100%; font-weight: bold;
+ margin: 0.5em 0 0 -0.3em; }
+
+/* Syntax Highlighting for Source Code
+ * - doctest examples are displayed in a 'pre.py-doctest' block.
+ * If the example is in a details table entry, then it will use
+ * the colors specified by the 'table pre.py-doctest' line.
+ * - Source code listings are displayed in a 'pre.py-src' block.
+ * Each line is marked with 'span.py-line' (used to draw a line
+ * down the left margin, separating the code from the line
+ * numbers). Line numbers are displayed with 'span.py-lineno'.
+ * The expand/collapse block toggle button is displayed with
+ * 'a.py-toggle' (Note: the CSS style for 'a.py-toggle' should not
+ * modify the font size of the text.)
+ * - If a source code page is opened with an anchor, then the
+ * corresponding code block will be highlighted. The code
+ * block's header is highlighted with 'py-highlight-hdr'; and
+ * the code block's body is highlighted with 'py-highlight'.
+ * - The remaining py-* classes are used to perform syntax
+ * highlighting (py-string for string literals, py-name for names,
+ * etc.)
+ */
+pre.py-doctest { padding: .5em; margin: 1em;
+ background: #e8f0f8; color: #000000;
+ border: 1px solid #708890; }
+table pre.py-doctest { background: #dce4ec;
+ color: #000000; }
+pre.py-src { border: 2px solid #000000;
+ background: #f0f0f0; color: #000000; }
+.py-line { border-left: 2px solid #000000;
+ margin-left: .2em; padding-left: .4em; }
+.py-lineno { font-style: italic; font-size: 90%;
+ padding-left: .5em; }
+a.py-toggle { text-decoration: none; }
+div.py-highlight-hdr { border-top: 2px solid #000000;
+ border-bottom: 2px solid #000000;
+ background: #d8e8e8; }
+div.py-highlight { border-bottom: 2px solid #000000;
+ background: #d0e0e0; }
+.py-prompt { color: #005050; font-weight: bold;}
+.py-more { color: #005050; font-weight: bold;}
+.py-string { color: #006030; }
+.py-comment { color: #003060; }
+.py-keyword { color: #600000; }
+.py-output { color: #404040; }
+.py-name { color: #000050; }
+.py-name:link { color: #000050 !important; }
+.py-name:visited { color: #000050 !important; }
+.py-number { color: #005000; }
+.py-defname { color: #000060; font-weight: bold; }
+.py-def-name { color: #000060; font-weight: bold; }
+.py-base-class { color: #000060; }
+.py-param { color: #000060; }
+.py-docstring { color: #006030; }
+.py-decorator { color: #804020; }
+/* Use this if you don't want links to names underlined: */
+/*a.py-name { text-decoration: none; }*/
+
+/* Graphs & Diagrams
+ * - These CSS styles are used for graphs & diagrams generated using
+ * Graphviz dot. 'img.graph-without-title' is used for bare
+ * diagrams (to remove the border created by making the image
+ * clickable).
+ */
+img.graph-without-title { border: none; }
+img.graph-with-title { border: 1px solid #000000; }
+span.graph-title { font-weight: bold; }
+span.graph-caption { }
+
+/* General-purpose classes
+ * - 'p.indent-wrapped-lines' defines a paragraph whose first line
+ * is not indented, but whose subsequent lines are.
+ * - The 'nomargin-top' class is used to remove the top margin (e.g.
+ * from lists). The 'nomargin' class is used to remove both the
+ * top and bottom margin (but not the left or right margin --
+ * for lists, that would cause the bullets to disappear.)
+ */
+p.indent-wrapped-lines { padding: 0 0 0 7em; text-indent: -7em;
+ margin: 0; }
+.nomargin-top { margin-top: 0; }
+.nomargin { margin-top: 0; margin-bottom: 0; }
+
+/* HTML Log */
+div.log-block { padding: 0; margin: .5em 0 .5em 0;
+ background: #e8f0f8; color: #000000;
+ border: 1px solid #000000; }
+div.log-error { padding: .1em .3em .1em .3em; margin: 4px;
+ background: #ffb0b0; color: #000000;
+ border: 1px solid #000000; }
+div.log-warning { padding: .1em .3em .1em .3em; margin: 4px;
+ background: #ffffb0; color: #000000;
+ border: 1px solid #000000; }
+div.log-info { padding: .1em .3em .1em .3em; margin: 4px;
+ background: #b0ffb0; color: #000000;
+ border: 1px solid #000000; }
+h2.log-hdr { background: #70b0ff; color: #000000;
+ margin: 0; padding: 0em 0.5em 0em 0.5em;
+ border-bottom: 1px solid #000000; font-size: 110%; }
+p.log { font-weight: bold; margin: .5em 0 .5em 0; }
+tr.opt-changed { color: #000000; font-weight: bold; }
+tr.opt-default { color: #606060; }
+pre.log { margin: 0; padding: 0; padding-left: 1em; }
diff --git a/epydoc_source/docs/2.3.0/epydoc.js b/epydoc_source/docs/2.3.0/epydoc.js
new file mode 100644
index 0000000..119e71e
--- /dev/null
+++ b/epydoc_source/docs/2.3.0/epydoc.js
@@ -0,0 +1,293 @@
+function toggle_private() {
+ // Search for any private/public links on this page. Store
+ // their old text in "cmd," so we will know what action to
+ // take; and change their text to the opposite action.
+ var cmd = "?";
+ var elts = document.getElementsByTagName("a");
+ for(var i=0; i";
+ s += " ";
+ for (var i=0; i... ";
+ elt.innerHTML = s;
+ }
+}
+
+function toggle(id) {
+ elt = document.getElementById(id+"-toggle");
+ if (elt.innerHTML == "-")
+ collapse(id);
+ else
+ expand(id);
+ return false;
+}
+
+function highlight(id) {
+ var elt = document.getElementById(id+"-def");
+ if (elt) elt.className = "py-highlight-hdr";
+ var elt = document.getElementById(id+"-expanded");
+ if (elt) elt.className = "py-highlight";
+ var elt = document.getElementById(id+"-collapsed");
+ if (elt) elt.className = "py-highlight";
+}
+
+function num_lines(s) {
+ var n = 1;
+ var pos = s.indexOf("\n");
+ while ( pos > 0) {
+ n += 1;
+ pos = s.indexOf("\n", pos+1);
+ }
+ return n;
+}
+
+// Collapse all blocks that mave more than `min_lines` lines.
+function collapse_all(min_lines) {
+ var elts = document.getElementsByTagName("div");
+ for (var i=0; i 0)
+ if (elt.id.substring(split, elt.id.length) == "-expanded")
+ if (num_lines(elt.innerHTML) > min_lines)
+ collapse(elt.id.substring(0, split));
+ }
+}
+
+function expandto(href) {
+ var start = href.indexOf("#")+1;
+ if (start != 0 && start != href.length) {
+ if (href.substring(start, href.length) != "-") {
+ collapse_all(4);
+ pos = href.indexOf(".", start);
+ while (pos != -1) {
+ var id = href.substring(start, pos);
+ expand(id);
+ pos = href.indexOf(".", pos+1);
+ }
+ var id = href.substring(start, href.length);
+ expand(id);
+ highlight(id);
+ }
+ }
+}
+
+function kill_doclink(id) {
+ var parent = document.getElementById(id);
+ parent.removeChild(parent.childNodes.item(0));
+}
+function auto_kill_doclink(ev) {
+ if (!ev) var ev = window.event;
+ if (!this.contains(ev.toElement)) {
+ var parent = document.getElementById(this.parentID);
+ parent.removeChild(parent.childNodes.item(0));
+ }
+}
+
+function doclink(id, name, targets_id) {
+ var elt = document.getElementById(id);
+
+ // If we already opened the box, then destroy it.
+ // (This case should never occur, but leave it in just in case.)
+ if (elt.childNodes.length > 1) {
+ elt.removeChild(elt.childNodes.item(0));
+ }
+ else {
+ // The outer box: relative + inline positioning.
+ var box1 = document.createElement("div");
+ box1.style.position = "relative";
+ box1.style.display = "inline";
+ box1.style.top = 0;
+ box1.style.left = 0;
+
+ // A shadow for fun
+ var shadow = document.createElement("div");
+ shadow.style.position = "absolute";
+ shadow.style.left = "-1.3em";
+ shadow.style.top = "-1.3em";
+ shadow.style.background = "#404040";
+
+ // The inner box: absolute positioning.
+ var box2 = document.createElement("div");
+ box2.style.position = "relative";
+ box2.style.border = "1px solid #a0a0a0";
+ box2.style.left = "-.2em";
+ box2.style.top = "-.2em";
+ box2.style.background = "white";
+ box2.style.padding = ".3em .4em .3em .4em";
+ box2.style.fontStyle = "normal";
+ box2.onmouseout=auto_kill_doclink;
+ box2.parentID = id;
+
+ // Get the targets
+ var targets_elt = document.getElementById(targets_id);
+ var targets = targets_elt.getAttribute("targets");
+ var links = "";
+ target_list = targets.split(",");
+ for (var i=0; i" +
+ target[0] + "";
+ }
+
+ // Put it all together.
+ elt.insertBefore(box1, elt.childNodes.item(0));
+ //box1.appendChild(box2);
+ box1.appendChild(shadow);
+ shadow.appendChild(box2);
+ box2.innerHTML =
+ "Which "+name+" do you want to see documentation for?" +
+ "
The python-fedex module is a light wrapper around Fedex's Web
+ Services SOAP API. Using the excellent suds SOAP
+ client, the Fedex requests and responses are trivial to work with.
+
What python-fedex is
+
+
+ A light wrapper around Fedex Web Services SOAP API.
+
+
+ Simple and easy to use.
+
+
+ Minimal by design.
+
+
+
What python-fedex is not
+
+
+ An abstraction layer. python-fedex only assembles the needed SOAP
+ calls and returns a SOAP response through suds. This is easy
+ enough to work with that no abstraction is needed. Doing so would
+ limit your use of the data.
+
+
+ Anything more than a light wrapper.
+
+
+
A note on completeness
+
python-fedex was created for use with various internal projects
+ over the years. Not all services are implemented but only those
+ needed at the time were implemented. If there is missing
+ functionality, please report an issue so that this module can be made more useful
+ to others. Likewise, feel free to submit patches and service
+ implementations as well if you would like to help.
+
Getting Started
+
The best place to get started is by viewing the examples in the
+ 'examples' directory. These should be very self-explanatory. For
+ further details, you may review the API here, or get support by
+ reading the instructions in the appropriately named section
+ below.
+
The services
+ module is also a good place to start looking at the different objects
+ used for issuing Fedex requests.
+
As a general tip, the best way to see which attributes are
+ available on WSDL objects is to simply print them, hitting their
+ __str__() method.
+
Fedex Documentation
+
If you are wondering what attributes or variables are present,
+ you'll want to refer to the Fedex Web Services documentation at
+ http://fedex.com/developer/. Complete specification documents are
+ there, which correspond very closely with what you'll be able to do
+ with python-fedex.
+
Getting Support
+
If you have any questions, problems, ideas, or patch submissions,
+ please visit our Github project and enter an issue in the Issue Tracker.
fedex.printers.unix: This module provides a label printing wrapper class for Unix-based
+ installations.
+
+
+
fedex.services: This module contains the wrappers around Fedex Web Service requests
+ which you will want to instantiate and use with a FedexConfig object supplying your static details.
+
+ 1"""
+ 2python-fedex API Documentation
+ 3==============================
+ 4The python-fedex module is a light wrapper around Fedex's Web Services SOAP API.
+ 5Using the excellent U{suds<https://fedorahosted.org/suds/>} SOAP client,
+ 6the Fedex requests and responses are trivial to work with.
+ 7
+ 8What python-fedex is
+ 9--------------------
+10 - A light wrapper around Fedex Web Services SOAP API.
+11 - Simple and easy to use.
+12 - Minimal by design.
+13
+14What python-fedex is not
+15------------------------
+16 - An abstraction layer. python-fedex only assembles the needed SOAP calls
+17 and returns a SOAP response through suds. This is easy enough to work with
+18 that no abstraction is needed. Doing so would limit your use of the data.
+19 - Anything more than a light wrapper.
+20
+21A note on completeness
+22----------------------
+23python-fedex was created for use with various internal projects over the years.
+24Not all services are implemented but only those needed at the time were implemented.
+25If there is missing functionality, please report an U{issue<http://code.google.com/p/python-fedex/issues/list>}
+26so that this module can be made more useful to others. Likewise, feel free to
+27submit patches and service implementations as well if you would like to help.
+28
+29Getting Started
+30---------------
+31The best place to get started is by viewing the examples in the 'examples'
+32directory. These should be very self-explanatory. For further details, you
+33may review the API here, or get support by reading the instructions in the
+34appropriately named section below.
+35
+36The L{services} module is also a good place to start looking at the different
+37objects used for issuing Fedex requests.
+38
+39As a general tip, the best way to see which attributes are available on WSDL
+40objects is to simply print them, hitting their __str__() method.
+41
+42Fedex Documentation
+43-------------------
+44If you are wondering what attributes or variables are present, you'll want to
+45refer to the Fedex Web Services documentation at http://fedex.com/developer/.
+46Complete specification documents are there, which correspond very closely with
+47what you'll be able to do with python-fedex.
+48
+49Getting Support
+50---------------
+51If you have any questions, problems, ideas, or patch submissions, please visit
+52our U{Github project<http://github.com/gtaylor/python-fedex/>} and enter
+53an issue in the U{Issue Tracker<http://github.com/gtaylor/python-fedex/issues>}.
+54"""
+55VERSION=__version__='2.3.0'
+56
+
The base_service module contains classes that form the low
+ level foundations of the Web Service API. Things that many different
+ kinds of requests have in common may be found here.
+
In particular, the FedexBaseService class handles most of the basic,
+ repetitive setup work that most requests do.
+ 1"""
+ 2The L{base_service} module contains classes that form the low level foundations
+ 3of the Web Service API. Things that many different kinds of requests have in
+ 4common may be found here.
+ 5
+ 6In particular, the L{FedexBaseService} class handles most of the basic,
+ 7repetitive setup work that most requests do.
+ 8"""
+ 9
+ 10importos
+ 11importlogging
+ 12
+ 13importsuds
+ 14fromsuds.clientimportClient
+ 15fromsuds.pluginimportMessagePlugin
+ 16
+ 17
+
75self.error_code=-1
+ 76self.value="suds encountered an error validating your data against this service's WSDL schema. " \
+ 77"Please double-check for missing or invalid values, filling all required fields."
+ 78try:
+ 79self.value+=' Details: {}'.format(fault)
+ 80exceptAttributeError:
+ 81pass
+
85"""
+ 86 This class is the master class for all Fedex request objects. It gets all
+ 87 of the common SOAP objects created via suds and populates them with
+ 88 values from a L{FedexConfig} object, along with keyword arguments
+ 89 via L{__init__}.
+ 90
+ 91 @note: This object should never be used directly, use one of the included
+ 92 sub-classes.
+ 93 """
+ 94
+
96"""
+ 97 This constructor should only be called by children of the class. As is
+ 98 such, only the optional keyword arguments caught by C{**kwargs} will
+ 99 be documented.
+100
+101 @type customer_transaction_id: L{str}
+102 @keyword customer_transaction_id: A user-specified identifier to
+103 differentiate this transaction from others. This value will be
+104 returned with the response from Fedex.
+105 """
+106
+107self.logger=logging.getLogger('fedex')
+108"""@ivar: Python logger instance with name 'fedex'."""
+109
+110self.config_obj=config_obj
+111"""@ivar: The FedexConfig object to pull auth info from."""
+112
+113ifnotself._version_info:
+114self._version_info={}
+115"""#ivar: Set in each service class. Holds version info for the VersionId SOAP object."""
+116
+117# If the config object is set to use the test server, point
+118# suds at the test server WSDL directory.
+119ifconfig_obj.use_test_server:
+120self.logger.info("Using test server.")
+121self.wsdl_path=os.path.join(config_obj.wsdl_path,
+122'test_server_wsdl',wsdl_name)
+123else:
+124self.logger.info("Using production server.")
+125self.wsdl_path=os.path.join(config_obj.wsdl_path,wsdl_name)
+126
+127self.client=Client('file:///%s'%self.wsdl_path.lstrip('/'),plugins=[GeneralSudsPlugin()])
+128# self.client.options.cache.clear() # Clear the cache, then re-init client when changing wsdl file.
+129
+130self.VersionId=None
+131"""@ivar: Holds details on the version numbers of the WSDL."""
+132self.WebAuthenticationDetail=None
+133"""@ivar: WSDL object that holds authentication info."""
+134self.ClientDetail=None
+135"""@ivar: WSDL object that holds client account details."""
+136self.response=None
+137"""@ivar: The response from Fedex. You will want to pick what you
+138 want out here here. This object does have a __str__() method,
+139 you'll want to print or log it to see what possible values
+140 you can pull."""
+141self.TransactionDetail=None
+142"""@ivar: Holds customer-specified transaction IDs."""
+143
+144self.__set_web_authentication_detail()
+145self.__set_client_detail(*args,**kwargs)
+146self.__set_version_id()
+147self.__set_transaction_detail(*args,**kwargs)
+148self._prepare_wsdl_objects()
+
151"""
+152 Sets up the WebAuthenticationDetail node. This is required for all
+153 requests.
+154 """
+155
+156# Start of the authentication stuff.
+157web_authentication_credential=self.client.factory.create('WebAuthenticationCredential')
+158web_authentication_credential.Key=self.config_obj.key
+159web_authentication_credential.Password=self.config_obj.password
+160
+161# Encapsulates the auth credentials.
+162web_authentication_detail=self.client.factory.create('WebAuthenticationDetail')
+163web_authentication_detail.UserCredential=web_authentication_credential
+164
+165# Set Default ParentCredential
+166ifhasattr(web_authentication_detail,'ParentCredential'):
+167web_authentication_detail.ParentCredential=web_authentication_credential
+168
+169self.WebAuthenticationDetail=web_authentication_detail
+
213"""
+214 Pulles the versioning info for the request from the child request.
+215 """
+216
+217version_id=self.client.factory.create('VersionId')
+218version_id.ServiceId=self._version_info['service_id']
+219version_id.Major=self._version_info['major']
+220version_id.Intermediate=self._version_info['intermediate']
+221version_id.Minor=self._version_info['minor']
+222self.logger.debug(version_id)
+223self.VersionId=version_id
+
226"""
+227 This method should be over-ridden on each sub-class. It instantiates
+228 any of the required WSDL objects so the user can just print their
+229 __str__() methods and see what they need to fill in.
+230 """
+231
+232pass
+
235"""
+236 This checks the response for general Fedex errors that aren't related
+237 to any one WSDL.
+238 """
+239
+240ifself.response.HighestSeverity=="FAILURE":
+241fornotificationinself.response.Notifications:
+242ifnotification.Severity=="FAILURE":
+243raiseFedexFailure(notification.Code,
+244notification.Message)
+
247"""
+248 Override this in each service module to check for errors that are
+249 specific to that module. For example, invalid tracking numbers in
+250 a Tracking request.
+251 """
+252
+253ifself.response.HighestSeverity=="ERROR":
+254fornotificationinself.response.Notifications:
+255ifnotification.Severity=="ERROR":
+256raiseFedexError(notification.Code,
+257notification.Message)
+
260"""
+261 Override this in a service module to check for errors that are
+262 specific to that module. For example, changing state/province based
+263 on postal code in a Rate Service request.
+264 """
+265
+266ifself.response.HighestSeverity=="NOTE":
+267fornotificationinself.response.Notifications:
+268ifnotification.Severity=="NOTE":
+269self.logger.warning(FedexFailure(notification.Code,
+270notification.Message))
+
273"""
+274 Creates and returns a WSDL object of the specified type.
+275 :param type_name: specifies the object's type name from WSDL.
+276 """
+277
+278returnself.client.factory.create(type_name)
+
281"""
+282 This method should be over-ridden on each sub-class.
+283 It assembles all required objects
+284 into the specific request object and calls send_request.
+285 Objects that are not set will be pruned before sending
+286 via GeneralSudsPlugin marshalled function.
+287 """
+288
+289pass
+
292"""
+293 Sends the assembled request on the child object.
+294 @type send_function: function reference
+295 @keyword send_function: A function reference (passed without the
+296 parenthesis) to a function that will send the request. This
+297 allows for overriding the default function in cases such as
+298 validation requests.
+299 """
+300
+301# Send the request and get the response back.
+302try:
+303# If the user has overridden the send function, use theirs
+304# instead of the default.
+305ifsend_function:
+306# Follow the overridden function.
+307self.response=send_function()
+308else:
+309# Default scenario, business as usual.
+310self.response=self._assemble_and_send_request()
+311exceptsuds.WebFaultasfault:
+312# When this happens, throw an informative message reminding the
+313# user to check all required variables, making sure they are
+314# populated and valid
+315raiseSchemaValidationError(fault.fault)
+316
+317# Check the response for general Fedex errors/failures that aren't
+318# specific to any given WSDL/request.
+319self.__check_response_for_fedex_error()
+320
+321# Check the response for errors specific to the particular request.
+322# This method can be overridden by a method on the child class object.
+323self._check_response_for_request_errors()
+324
+325# Check the response for errors specific to the particular request.
+326# This method can be overridden by a method on the child class object.
+327self._check_response_for_request_warnings()
+328
+329# Debug output.
+330self.logger.debug("== FEDEX QUERY RESULT ==")
+331self.logger.debug(self.response)
+
This class is the master class for all Fedex request objects. It gets
+ all of the common SOAP objects created via suds and populates them with
+ values from a FedexConfig object, along with keyword arguments via __init__.
+
+
+
Note:
+ This object should never be used directly, use one of the included
+ sub-classes.
+
This constructor should only be called by children of the class. As is
+ such, only the optional keyword arguments caught by **kwargs
+ will be documented.
+
+
Parameters:
+
+
customer_transaction_id (str) - A user-specified identifier to differentiate this transaction
+ from others. This value will be returned with the response from
+ Fedex.
This method should be over-ridden on each sub-class. It instantiates
+ any of the required WSDL objects so the user can just print their
+ __str__() methods and see what they need to fill in.
Override this in each service module to check for errors that are
+ specific to that module. For example, invalid tracking numbers in a
+ Tracking request.
This method should be over-ridden on each sub-class. It assembles all
+ required objects into the specific request object and calls send_request.
+ Objects that are not set will be pruned before sending via
+ GeneralSudsPlugin marshalled function.
send_function (function reference) - A function reference (passed without the parenthesis) to a
+ function that will send the request. This allows for overriding
+ the default function in cases such as validation requests.
Override this in a service module to check for errors that are
+ specific to that module. For example, changing state/province based on
+ postal code in a Rate Service request.
+ The response from Fedex. You will want to pick what you want out here
+ here. This object does have a __str__() method, you'll want to print or
+ log it to see what possible values you can pull.
+
+
+
+
+
+
+
+
+
_version_info
+
#ivar: Set in each service class. Holds version info for the VersionId
+ SOAP object.
The config module
+ contains the FedexConfig class, which is passed to the Fedex API
+ calls. It stores useful information such as your Web Services account
+ numbers and keys.
+
It is strongly suggested that you create a single FedexConfig
+ object in your project and pass that to the various API calls, rather
+ than create new FedexConfig objects haphazardly. This is merely a design
+ suggestion, treat it as such.
+ 1"""
+ 2The L{config} module contains the L{FedexConfig} class, which is passed to
+ 3the Fedex API calls. It stores useful information such as your Web Services
+ 4account numbers and keys.
+ 5
+ 6It is strongly suggested that you create a single L{FedexConfig} object in
+ 7your project and pass that to the various API calls, rather than create new
+ 8L{FedexConfig} objects haphazardly. This is merely a design suggestion,
+ 9treat it as such.
+10"""
+11importos
+12
+13
+
15"""
+16 Base configuration class that is used for the different Fedex SOAP calls.
+17 These are generally passed to the Fedex request classes as arguments.
+18 You may instantiate a L{FedexConfig} object with the minimal C{key} and
+19 C{password} arguments and set the instance variables documented below
+20 at a later time if you must.
+21 """
+22
+
25"""
+26 @type key: L{str}
+27 @param key: Developer test key.
+28 @type password: L{str}
+29 @param password: The Fedex-generated password for your Web Systems
+30 account. This is generally emailed to you after registration.
+31 @type account_number: L{str}
+32 @keyword account_number: The account number sent to you by Fedex after
+33 registering for Web Services.
+34 @type meter_number: L{str}
+35 @keyword meter_number: The meter number sent to you by Fedex after
+36 registering for Web Services.
+37 @type freight_account_number: L{str}
+38 @keyword freight_account_number: The freight account number sent to you
+39 by Fedex after registering for Web Services.
+40 @type integrator_id: L{str}
+41 @keyword integrator_id: The integrator string sent to you by Fedex after
+42 registering for Web Services.
+43 @type wsdl_path: L{str}
+44 @keyword wsdl_path: In the event that you want to override the path to
+45 your WSDL directory, do so with this argument.
+46 @type use_test_server: L{bool}
+47 @keyword use_test_server: When this is True, test server WSDLs are used
+48 instead of the production server. You will also need to make sure
+49 that your L{FedexConfig} object has a production account number,
+50 meter number, authentication key, and password.
+51 """
+52self.key=key
+53"""@ivar: Developer test key."""
+54self.password=password
+55"""@ivar: Fedex Web Services password."""
+56self.account_number=account_number
+57"""@ivar: Web Services account number."""
+58self.meter_number=meter_number
+59"""@ivar: Web services meter number."""
+60self.freight_account_number=freight_account_number
+61"""@ivar: Web Services freight accountnumber."""
+62self.integrator_id=integrator_id
+63"""@ivar: Web services integrator ID."""
+64self.express_region_code=express_region_code
+65"""@ivar: Web services ExpressRegionCode"""
+66self.use_test_server=use_test_server
+67"""@ivar: When True, point to the test server."""
+68
+69# Allow overriding of the WDSL path.
+70ifwsdl_pathisNone:
+71self.wsdl_path=os.path.join(os.path.dirname(os.path.abspath(__file__)),
+72'wsdl')
+73else:# pragma: no cover
+74self.wsdl_path=wsdl_path
+
Base configuration class that is used for the different Fedex SOAP
+ calls. These are generally passed to the Fedex request classes as
+ arguments. You may instantiate a FedexConfig
+ object with the minimal key and password
+ arguments and set the instance variables documented below at a later time
+ if you must.
x.__init__(...) initializes x; see help(type(x)) for signature
+
+
Parameters:
+
+
key (str) - Developer test key.
+
password (str) - The Fedex-generated password for your Web Systems account. This
+ is generally emailed to you after registration.
+
account_number (str) - The account number sent to you by Fedex after registering for Web
+ Services.
+
meter_number (str) - The meter number sent to you by Fedex after registering for Web
+ Services.
+
freight_account_number (str) - The freight account number sent to you by Fedex after registering
+ for Web Services.
+
integrator_id (str) - The integrator string sent to you by Fedex after registering for
+ Web Services.
+
wsdl_path (str) - In the event that you want to override the path to your WSDL
+ directory, do so with this argument.
+
use_test_server (bool) - When this is True, test server WSDLs are used instead of the
+ production server. You will also need to make sure that your FedexConfig object has a production account
+ number, meter number, authentication key, and password.
Optional classes used for the convenient printing of FedEx labels from
+ FedexProcessShipmentRequest objects. Each printer class
+ is more or less the same, following the pattern seen below (unless
+ otherwise documented).:
+
+ from fedex.printers.unix import DirectDevicePrinter
+ # Where shipment is an existing L{FedexProcessShipmentRequest} object.
+ shipment.send_request()
+ device = DirectDevicePrinter(shipment)
+ device.print_label()
+
+ 1"""
+ 2Optional classes used for the convenient printing of FedEx labels from
+ 3L{FedexProcessShipmentRequest} objects. Each printer class is more or less
+ 4the same, following the pattern seen below (unless otherwise documented).::
+ 5 from fedex.printers.unix import DirectDevicePrinter
+ 6 # Where shipment is an existing L{FedexProcessShipmentRequest} object.
+ 7 shipment.send_request()
+ 8 device = DirectDevicePrinter(shipment)
+ 9 device.print_label()
+10"""
+11
+
This module provides a label printing wrapper class for Unix-based
+ installations. By "Unix", we mean Linux, Mac OS, BSD, and
+ various flavors of Unix.
+ 1"""
+ 2This module provides a label printing wrapper class for Unix-based
+ 3installations. By "Unix", we mean Linux, Mac OS, BSD, and various flavors
+ 4of Unix.
+ 5"""
+ 6
+ 7importbinascii
+ 8
+ 9
+
11"""
+12 This class pipes the label data directly through a /dev/* entry.
+13 Consequently, this is very Unix/Linux specific. It *MAY* work on Mac too.
+14 """
+15
+
17"""
+18 Instantiates from a shipment object. You may optionally specify
+19 a path to a /dev/ device. Defaults to /dev/ttyS0.
+20
+21 @type shipment: L{FedexProcessShipmentRequest}
+22 @param shipment: A Fedex ProcessShipmentRequest object to pull the
+23 printed label data from.
+24 """
+25
+26self.device=device
+27"""@ivar: A string with the path to the device to print to."""
+28self.shipment=shipment
+29"""@ivar: A reference to the L{FedexProcessShipmentRequest} to print."""
+
32"""
+33 Prints all of a shipment's labels, or optionally just one.
+34
+35 @type package_num: L{int}
+36 @param package_num: 0-based index of the package to print. This is
+37 only useful for shipments with more than one package.
+38 """
+39
+40ifpackage_num:
+41packages=[
+42self.shipment.response.CompletedShipmentDetail.CompletedPackageDetails[package_num]
+43]
+44else:
+45packages=self.shipment.response.CompletedShipmentDetail.CompletedPackageDetails
+46
+47forpackageinpackages:
+48label_binary=binascii.a2b_base64(package.Label.Parts[0].Image)
+49self._print_base64(label_binary)
+
52"""
+53 Pipe the binary directly to the label printer. Works under Linux
+54 without requiring PySerial. This is not typically something you
+55 should call directly, unless you have special needs.
+56
+57 @type base64_data: L{str}
+58 @param base64_data: The base64 encoded string for the label to print.
+59 """
+60
+61label_file=open(self.device,"w")
+62label_file.write(base64_data)
+63label_file.close()
+
Pipe the binary directly to the label printer. Works under Linux
+ without requiring PySerial. This is not typically something you should
+ call directly, unless you have special needs.
+
+
Parameters:
+
+
base64_data (str) - The base64 encoded string for the label to print.
This module contains the wrappers around Fedex Web Service requests
+ which you will want to instantiate and use with a FedexConfig
+ object supplying your static details. Each module here corresponds to a
+ Fedex WSDL.
+1"""
+2This module contains the wrappers around Fedex Web Service requests which you
+3will want to instantiate and use with a L{FedexConfig} object supplying
+4your static details. Each module here corresponds to a Fedex WSDL.
+5"""
+6
+
This package contains the shipping methods defined by Fedex's
+ AddressValidationService WSDL file. Each is encapsulated in a class for
+ easy access. For more details on each, refer to the respective class's
+ documentation.
+ 1"""
+ 2Address Validation Service Module
+ 3
+ 4This package contains the shipping methods defined by Fedex's
+ 5AddressValidationService WSDL file. Each is encapsulated in a class for
+ 6easy access. For more details on each, refer to the respective class's
+ 7documentation.
+ 8"""
+ 9
+10importdatetime
+11from..base_serviceimportFedexBaseService
+12
+13
+
15"""
+16 This class allows you validate anywhere from one to a hundred addresses
+17 in one go. Create AddressToValidate WSDL objects and add them to each
+18 instance of this request using add_address().
+19 """
+20
+
49"""
+50 Fires off the Fedex request.
+51
+52 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+53 WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+54 """
+55
+56# We get an exception like this when specifying an IntegratorId:
+57# suds.TypeNotFound: Type not found: 'IntegratorId'
+58# Setting it to None does not seem to appease it.
+59delself.ClientDetail.IntegratorId
+60self.logger.debug(self.WebAuthenticationDetail)
+61self.logger.debug(self.ClientDetail)
+62self.logger.debug(self.TransactionDetail)
+63self.logger.debug(self.VersionId)
+64# Fire off the query.
+65returnself.client.service.addressValidation(
+66WebAuthenticationDetail=self.WebAuthenticationDetail,
+67ClientDetail=self.ClientDetail,
+68TransactionDetail=self.TransactionDetail,
+69Version=self.VersionId,
+70InEffectAsOfTimestamp=datetime.datetime.now(),
+71AddressesToValidate=self.AddressesToValidate)
+
74"""
+75 Adds an address to self.AddressesToValidate.
+76
+77 @type address_item: WSDL object, type of AddressToValidate WSDL object.
+78 @keyword address_item: A AddressToValidate, created by
+79 calling create_wsdl_object_of_type('AddressToValidate') on
+80 this FedexAddressValidationRequest object.
+81 See examples/create_shipment.py for more details.
+82 """
+83
+84self.AddressesToValidate.append(address_item)
+
This class allows you validate anywhere from one to a hundred
+ addresses in one go. Create AddressToValidate WSDL objects and add them
+ to each instance of this request using add_address().
This constructor should only be called by children of the class. As is
+ such, only the optional keyword arguments caught by **kwargs
+ will be documented.
+
+
Parameters:
+
+
config_obj (FedexConfig) - A valid FedexConfig object.
address_item (WSDL object, type of AddressToValidate WSDL object.) - A AddressToValidate, created by calling
+ create_wsdl_object_of_type('AddressToValidate') on this
+ FedexAddressValidationRequest object. See
+ examples/create_shipment.py for more details.
This package contains the shipping methods defined by Fedex's
+ ValidationAvailabilityAndCommitmentService WSDL file. Each is
+ encapsulated in a class for easy access. For more details on each, refer
+ to the respective class's documentation.
+ 1"""
+ 2Service Availability and Commitment Module
+ 3
+ 4This package contains the shipping methods defined by Fedex's
+ 5ValidationAvailabilityAndCommitmentService WSDL file. Each is encapsulated in a class for
+ 6easy access. For more details on each, refer to the respective class's
+ 7documentation.
+ 8"""
+ 9
+ 10importdatetime
+ 11from..base_serviceimportFedexBaseService
+ 12
+ 13
+
20"""
+ 21 @type config_obj: L{FedexConfig}
+ 22 @param config_obj: A valid FedexConfig object.
+ 23 """
+ 24
+ 25self._config_obj=config_obj
+ 26# Holds version info for the VersionId SOAP object.
+ 27self._version_info={
+ 28'service_id':'vacs',
+ 29'major':'4',
+ 30'intermediate':'0',
+ 31'minor':'0'
+ 32}
+ 33
+ 34self.CarrierCode=None
+ 35"""ivar: Carrier Code Default to Fedex (FDXE), or can bbe FDXG."""
+ 36
+ 37self.Origin=None
+ 38"""@ivar: Holds Origin Address WSDL object."""
+ 39
+ 40self.Destination=None
+ 41"""@ivar: Holds Destination Address WSDL object."""
+ 42
+ 43self.ShipDate=None
+ 44"""@ivar: Ship Date date WSDL object."""
+ 45
+ 46self.Service=None
+ 47"""@ivar: Service type, if set to None will get all available service information."""
+ 48
+ 49self.Packaging=None
+ 50"""@ivar: Type of packaging to narrow down available shipping options or defaults to YOUR_PACKAGING."""
+ 51
+ 52# Call the parent FedexBaseService class for basic setup work.
+ 53# Shortened the name of the wsdl, otherwise suds did not load it properly.
+ 54# Suds throws the following error when using the long file name from FedEx:
+ 55#
+ 56# File "/Library/Python/2.7/site-packages/suds/wsdl.py", line 878, in resolve
+ 57# raise Exception("binding '%s', not-found" % p.binding)
+ 58# Exception: binding 'ns:ValidationAvailabilityAndCommitmentServiceSoapBinding', not-found
+ 59
+ 60super(FedexAvailabilityCommitmentRequest,self).__init__(
+ 61self._config_obj,'AvailabilityAndCommitmentService_v4.wsdl',*args,**kwargs)
+
64"""
+ 65 Create the data structure and get it ready for the WSDL request.
+ 66 """
+ 67self.CarrierCode='FDXE'
+ 68self.Origin=self.Destination=self.client.factory.create('Address')
+ 69self.ShipDate=datetime.date.today().isoformat()
+ 70self.Service=None
+ 71self.Packaging='YOUR_PACKAGING'
+
74"""
+ 75 Fires off the Fedex request.
+ 76
+ 77 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+ 78 WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+ 79 """
+ 80
+ 81# We get an exception like this when specifying an IntegratorId:
+ 82# suds.TypeNotFound: Type not found: 'IntegratorId'
+ 83# Setting it to None does not seem to appease it.
+ 84delself.ClientDetail.IntegratorId
+ 85self.logger.debug(self.WebAuthenticationDetail)
+ 86self.logger.debug(self.ClientDetail)
+ 87self.logger.debug(self.TransactionDetail)
+ 88self.logger.debug(self.VersionId)
+ 89# Fire off the query.
+ 90returnself.client.service.serviceAvailability(
+ 91WebAuthenticationDetail=self.WebAuthenticationDetail,
+ 92ClientDetail=self.ClientDetail,
+ 93TransactionDetail=self.TransactionDetail,
+ 94Version=self.VersionId,
+ 95Origin=self.Origin,
+ 96Destination=self.Destination,
+ 97ShipDate=self.ShipDate,
+ 98CarrierCode=self.CarrierCode,
+ 99Service=self.Service,
+100Packaging=self.Packaging)
+
This constructor should only be called by children of the class. As is
+ such, only the optional keyword arguments caught by **kwargs
+ will be documented.
+
+
Parameters:
+
+
config_obj (FedexConfig) - A valid FedexConfig object.
This package contains the shipping methods defined by Fedex's
+ CountryService WSDL file. Each is encapsulated in a class for easy
+ access. For more details on each, refer to the respective class's
+ documentation.
+ 1"""
+ 2Country Service Module
+ 3
+ 4This package contains the shipping methods defined by Fedex's
+ 5CountryService WSDL file. Each is encapsulated in a class for
+ 6easy access. For more details on each, refer to the respective class's
+ 7documentation.
+ 8"""
+ 9
+10importdatetime
+11from..base_serviceimportFedexBaseService
+12
+13
+
15"""
+16 This class allows you validate an address.
+17 https://www.fedex.com/us/developer/WebHelp/ws/2015/html/WebServicesHelp/WSDVG/47_Country_Service.htm
+18 """
+19
+
54"""
+55 Create the data structure and get it ready for the WSDL request.
+56 """
+57self.CarrierCode='FDXE'
+58self.RoutingCode='FDSD'
+59self.Address=self.client.factory.create('Address')
+60self.ShipDateTime=datetime.datetime.now().isoformat()
+
63"""
+64 Fires off the Fedex request.
+65
+66 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+67 WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+68 """
+69
+70# We get an exception like this when specifying an IntegratorId:
+71# suds.TypeNotFound: Type not found: 'IntegratorId'
+72# Setting it to None does not seem to appease it.
+73delself.ClientDetail.IntegratorId
+74self.logger.debug(self.WebAuthenticationDetail)
+75self.logger.debug(self.ClientDetail)
+76self.logger.debug(self.TransactionDetail)
+77self.logger.debug(self.VersionId)
+78# Fire off the query.
+79returnself.client.service.validatePostal(
+80WebAuthenticationDetail=self.WebAuthenticationDetail,
+81ClientDetail=self.ClientDetail,
+82TransactionDetail=self.TransactionDetail,
+83Version=self.VersionId,
+84Address=self.Address,
+85ShipDateTime=self.ShipDateTime,
+86CarrierCode=self.CarrierCode,
+87CheckForMismatch=self.CheckForMismatch,
+88RoutingCode=self.RoutingCode)
+
This constructor should only be called by children of the class. As is
+ such, only the optional keyword arguments caught by **kwargs
+ will be documented.
+
+
Parameters:
+
+
config_obj (FedexConfig) - A valid FedexConfig object.
This package contains the shipping methods defined by Fedex's
+ LocationService WSDL file. Each is encapsulated in a class for easy
+ access. For more details on each, refer to the respective class's
+ documentation.
+ FedexSearchLocationRequest
+ This class allows you to figure out a FedEx location closest to a
+ specified location criteria, based on location type.
+
+ 1"""
+ 2Location Service Module
+ 3
+ 4This package contains the shipping methods defined by Fedex's
+ 5LocationService WSDL file. Each is encapsulated in a class for
+ 6easy access. For more details on each, refer to the respective class's
+ 7documentation.
+ 8"""
+ 9
+10from..base_serviceimportFedexBaseService
+11
+12
+
14"""
+15 This class allows you to figure out a FedEx location closest
+16 to a specified location criteria, based on location type.
+17 The response includes location details like operating times,
+18 directions and a map link and more.
+19 """
+20
+
59"""
+60 Create the data structure and get it ready for the WSDL request.
+61 """
+62
+63# Service defaults for objects that are required.
+64self.MultipleMatchesAction='RETURN_ALL'
+65self.Constraints=self.create_wsdl_object_of_type('SearchLocationConstraints')
+66self.Address=self.create_wsdl_object_of_type('Address')
+67self.LocationsSearchCriterion='ADDRESS'
+68self.SortDetail=self.create_wsdl_object_of_type('LocationSortDetail')
+
71"""
+72 Fires off the Fedex request.
+73
+74 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+75 WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+76 """
+77
+78# We get an exception like this when specifying an IntegratorId:
+79# suds.TypeNotFound: Type not found: 'IntegratorId'
+80# Setting it to None does not seem to appease it.
+81delself.ClientDetail.IntegratorId
+82self.logger.debug(self.WebAuthenticationDetail)
+83self.logger.debug(self.ClientDetail)
+84self.logger.debug(self.TransactionDetail)
+85self.logger.debug(self.VersionId)
+86# Fire off the query.
+87returnself.client.service.searchLocations(
+88WebAuthenticationDetail=self.WebAuthenticationDetail,
+89ClientDetail=self.ClientDetail,
+90TransactionDetail=self.TransactionDetail,
+91Version=self.VersionId,
+92LocationsSearchCriterion=self.LocationsSearchCriterion,
+93PhoneNumber=self.PhoneNumber,
+94MultipleMatchesAction=self.MultipleMatchesAction,
+95Constraints=self.Constraints,
+96Address=self.Address,
+97SortDetail=self.SortDetail)
+
This class allows you to figure out a FedEx location closest to a
+ specified location criteria, based on location type. The response
+ includes location details like operating times, directions and a map link
+ and more.
This constructor should only be called by children of the class. As is
+ such, only the optional keyword arguments caught by **kwargs
+ will be documented.
+
+
Parameters:
+
+
config_obj (FedexConfig) - A valid FedexConfig object.
+ 1"""
+ 2Package Movement Information Service
+ 3
+ 4This package contains classes to check service availability, route, and postal
+ 5codes. Defined by the PackageMovementInformationService WSDL file.
+ 6"""
+ 7importwarnings
+ 8
+ 9from..base_serviceimportFedexBaseService,FedexError
+ 10
+ 11
+
33"""
+ 34 Sets up an inquiry request. The optional keyword args
+ 35 detailed on L{FedexBaseService} apply here as well.
+ 36
+ 37 @type config_obj: L{FedexConfig}
+ 38 @param config_obj: A valid FedexConfig object
+ 39 @param postal_code: a valid postal code
+ 40 @param country_code: ISO country code to which the postal code belongs to.
+ 41 """
+ 42self._config_obj=config_obj
+ 43
+ 44# Holds version info for the VersionId SOAP object.
+ 45self._version_info={'service_id':'pmis',
+ 46'major':'4',
+ 47'intermediate':'0',
+ 48'minor':'0'}
+ 49
+ 50self.PostalCode=postal_code
+ 51self.CountryCode=country_code
+ 52
+ 53warnings.warn(
+ 54"Package Movement Service has been deprecated; "
+ 55"please use Country Service for postal code validation requests or "
+ 56"Availability and Commitment Service for service availability "
+ 57"requests instead.",
+ 58DeprecationWarning
+ 59)
+ 60
+ 61# Call the parent FedexBaseService class for basic setup work.
+ 62super(PostalCodeInquiryRequest,self).__init__(self._config_obj,
+ 63'PackageMovementInformationService_v4.wsdl',
+ 64*args,**kwargs)
+
67"""
+ 68 Checks the response to see if there were any errors specific to
+ 69 this WSDL.
+ 70 """
+ 71ifself.response.HighestSeverity=="ERROR":
+ 72fornotificationinself.response.Notifications:# pragma: no cover
+ 73ifnotification.Severity=="ERROR":
+ 74if"Postal Code Not Found"innotification.Message:
+ 75raiseFedexPostalCodeNotFound(notification.Code,
+ 76notification.Message)
+ 77
+ 78elif"Invalid Postal Code Format"inself.response.Notifications:
+ 79raiseFedexInvalidPostalCodeFormat(notification.Code,
+ 80notification.Message)
+ 81else:
+ 82raiseFedexError(notification.Code,
+ 83notification.Message)
+
93"""
+ 94 Fires off the Fedex request.
+ 95
+ 96 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES
+ 97 ON FedexBaseService AND IS INHERITED.
+ 98 """
+ 99
+100client=self.client
+101
+102# We get an exception like this when specifying an IntegratorId:
+103# suds.TypeNotFound: Type not found: 'IntegratorId'
+104# Setting it to None does not seem to appease it.
+105
+106delself.ClientDetail.IntegratorId
+107
+108# Fire off the query.
+109response=client.service.postalCodeInquiry(WebAuthenticationDetail=self.WebAuthenticationDetail,
+110ClientDetail=self.ClientDetail,
+111TransactionDetail=self.TransactionDetail,
+112Version=self.VersionId,
+113PostalCode=self.PostalCode,
+114CountryCode=self.CountryCode,
+115CarrierCode=self.CarrierCode)
+116
+117returnresponse
+
This package contains classes to request pre-ship rating information
+ and to determine estimated or courtesy billing quotes. Time in Transit
+ can be returned with the rates if it is specified in the request.
+ 1"""
+ 2Rate Service Module
+ 3
+ 4This package contains classes to request pre-ship rating information and to
+ 5determine estimated or courtesy billing quotes. Time in Transit can be
+ 6returned with the rates if it is specified in the request.
+ 7"""
+ 8
+ 9importdatetime
+ 10from..base_serviceimportFedexBaseService
+ 11
+ 12
+
14"""
+ 15 This class allows you to get the shipping charges for a particular address.
+ 16 You will need to populate the data structures in self.RequestedShipment,
+ 17 then send the request.
+ 18 """
+ 19
+
44"""
+ 45 This is the data that will be used to create your shipment. Create
+ 46 the data structure and get it ready for the WSDL request.
+ 47 """
+ 48
+ 49# Default behavior is to not request transit information
+ 50self.ReturnTransitAndCommit=False
+ 51
+ 52# This is the primary data structure for processShipment requests.
+ 53self.RequestedShipment=self.client.factory.create('RequestedShipment')
+ 54self.RequestedShipment.ShipTimestamp=datetime.datetime.now()
+ 55
+ 56# Defaults for TotalWeight wsdl object.
+ 57total_weight=self.client.factory.create('Weight')
+ 58# Start at nothing.
+ 59total_weight.Value=0.0
+ 60# Default to pounds.
+ 61total_weight.Units='LB'
+ 62# This is the total weight of the entire shipment. Shipments may
+ 63# contain more than one package.
+ 64self.RequestedShipment.TotalWeight=total_weight
+ 65
+ 66# This is the top level data structure for Shipper information.
+ 67shipper=self.client.factory.create('Party')
+ 68shipper.Address=self.client.factory.create('Address')
+ 69shipper.Contact=self.client.factory.create('Contact')
+ 70
+ 71# Link the ShipperParty to our master data structure.
+ 72self.RequestedShipment.Shipper=shipper
+ 73
+ 74# This is the top level data structure for Recipient information.
+ 75recipient_party=self.client.factory.create('Party')
+ 76recipient_party.Contact=self.client.factory.create('Contact')
+ 77recipient_party.Address=self.client.factory.create('Address')
+ 78# Link the RecipientParty object to our master data structure.
+ 79self.RequestedShipment.Recipient=recipient_party
+ 80
+ 81# Make sender responsible for payment by default.
+ 82self.RequestedShipment.ShippingChargesPayment=self.create_wsdl_object_of_type('Payment')
+ 83self.RequestedShipment.ShippingChargesPayment.PaymentType='SENDER'
+ 84
+ 85# Start with no packages, user must add them.
+ 86self.RequestedShipment.PackageCount=0
+ 87self.RequestedShipment.RequestedPackageLineItems=[]
+ 88
+ 89# This is good to review if you'd like to see what the data structure
+ 90# looks like.
+ 91self.logger.debug(self.RequestedShipment)
+
94"""
+ 95 Fires off the Fedex request.
+ 96
+ 97 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+ 98 WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+ 99 """
+100
+101# Fire off the query.
+102returnself.client.service.getRates(
+103WebAuthenticationDetail=self.WebAuthenticationDetail,
+104ClientDetail=self.ClientDetail,
+105TransactionDetail=self.TransactionDetail,
+106Version=self.VersionId,
+107RequestedShipment=self.RequestedShipment,
+108ReturnTransitAndCommit=self.ReturnTransitAndCommit)
+
111"""
+112 Adds a package to the ship request.
+113
+114 @type package_item: WSDL object, type of RequestedPackageLineItem
+115 WSDL object.
+116 @keyword package_item: A RequestedPackageLineItem, created by
+117 calling create_wsdl_object_of_type('RequestedPackageLineItem') on
+118 this ShipmentRequest object. See examples/create_shipment.py for
+119 more details.
+120 """
+121
+122self.RequestedShipment.RequestedPackageLineItems.append(package_item)
+123package_weight=package_item.Weight.Value
+124self.RequestedShipment.TotalWeight.Value+=package_weight
+125self.RequestedShipment.PackageCount+=1
+
This class allows you to get the shipping charges for a particular
+ address. You will need to populate the data structures in
+ self.RequestedShipment, then send the request.
package_item (WSDL object, type of RequestedPackageLineItem WSDL object.) - A RequestedPackageLineItem, created by calling
+ create_wsdl_object_of_type('RequestedPackageLineItem') on this
+ ShipmentRequest object. See examples/create_shipment.py for more
+ details.
This package contains the shipping methods defined by Fedex's
+ ShipService WSDL file. Each is encapsulated in a class for easy access.
+ For more details on each, refer to the respective class's
+ documentation.
+ 1"""
+ 2Ship Service Module
+ 3
+ 4This package contains the shipping methods defined by Fedex's
+ 5ShipService WSDL file. Each is encapsulated in a class for easy access.
+ 6For more details on each, refer to the respective class's documentation.
+ 7"""
+ 8
+ 9importdatetime
+ 10from..base_serviceimportFedexBaseService
+ 11
+ 12
+
14"""
+ 15 This class allows you to process (create) a new FedEx shipment. You will
+ 16 need to populate the data structures in self.RequestedShipment, then
+ 17 send the request. Label printing is supported and very configurable,
+ 18 returning an ASCII representation with the response as well.
+ 19 """
+ 20
+
45"""
+ 46 This is the data that will be used to create your shipment. Create
+ 47 the data structure and get it ready for the WSDL request.
+ 48 """
+ 49
+ 50# This is the primary data structure for processShipment requests.
+ 51self.RequestedShipment=self.client.factory.create('RequestedShipment')
+ 52self.RequestedShipment.ShipTimestamp=datetime.datetime.now()
+ 53
+ 54# Defaults for TotalWeight wsdl object.
+ 55total_weight=self.client.factory.create('Weight')
+ 56# Start at nothing.
+ 57total_weight.Value=0.0
+ 58# Default to pounds.
+ 59total_weight.Units='LB'
+ 60# This is the total weight of the entire shipment. Shipments may
+ 61# contain more than one package.
+ 62self.RequestedShipment.TotalWeight=total_weight
+ 63
+ 64# This is the top level data structure Shipper Party information.
+ 65shipper_party=self.client.factory.create('Party')
+ 66shipper_party.Address=self.client.factory.create('Address')
+ 67shipper_party.Contact=self.client.factory.create('Contact')
+ 68
+ 69# Link the Shipper Party to our master data structure.
+ 70self.RequestedShipment.Shipper=shipper_party
+ 71
+ 72# This is the top level data structure for RecipientParty information.
+ 73recipient_party=self.client.factory.create('Party')
+ 74recipient_party.Contact=self.client.factory.create('Contact')
+ 75recipient_party.Address=self.client.factory.create('Address')
+ 76
+ 77# Link the RecipientParty object to our master data structure.
+ 78self.RequestedShipment.Recipient=recipient_party
+ 79
+ 80payor=self.client.factory.create('Payor')
+ 81# Grab the account number from the FedexConfig object by default.
+ 82# Assume US.
+ 83payor.ResponsibleParty=self.client.factory.create('Party')
+ 84payor.ResponsibleParty.Address=self.client.factory.create('Address')
+ 85payor.ResponsibleParty.Address.CountryCode='US'
+ 86
+ 87# ShippingChargesPayment WSDL object default values.
+ 88shipping_charges_payment=self.client.factory.create('Payment')
+ 89shipping_charges_payment.Payor=payor
+ 90shipping_charges_payment.PaymentType='SENDER'
+ 91self.RequestedShipment.ShippingChargesPayment=shipping_charges_payment
+ 92
+ 93self.RequestedShipment.LabelSpecification=self.client.factory.create('LabelSpecification')
+ 94
+ 95# NONE, PREFERRED or LIST
+ 96self.RequestedShipment.RateRequestTypes=['PREFERRED']
+ 97
+ 98# Start with no packages, user must add them.
+ 99self.RequestedShipment.PackageCount=0
+100self.RequestedShipment.RequestedPackageLineItems=[]
+101
+102# This is good to review if you'd like to see what the data structure
+103# looks like.
+104self.logger.debug(self.RequestedShipment)
+
107"""
+108 This is very similar to just sending the shipment via the typical
+109 send_request() function, but this doesn't create a shipment. It is
+110 used to make sure "good" values are given by the user or the
+111 application using the library.
+112 """
+113
+114self.send_request(send_function=self._assemble_and_send_validation_request)
+
117"""
+118 Fires off the Fedex shipment validation request.
+119
+120 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL
+121 send_validation_request(), WHICH RESIDES ON FedexBaseService
+122 AND IS INHERITED.
+123 """
+124
+125# Fire off the query.
+126returnself.client.service.validateShipment(
+127WebAuthenticationDetail=self.WebAuthenticationDetail,
+128ClientDetail=self.ClientDetail,
+129TransactionDetail=self.TransactionDetail,
+130Version=self.VersionId,
+131RequestedShipment=self.RequestedShipment)
+
134"""
+135 Fires off the Fedex request.
+136
+137 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+138 WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+139 """
+140
+141# Fire off the query.
+142returnself.client.service.processShipment(
+143WebAuthenticationDetail=self.WebAuthenticationDetail,
+144ClientDetail=self.ClientDetail,
+145TransactionDetail=self.TransactionDetail,
+146Version=self.VersionId,
+147RequestedShipment=self.RequestedShipment)
+
150"""
+151 Adds a package to the ship request.
+152
+153 @type package_item: WSDL object, type of RequestedPackageLineItem
+154 WSDL object.
+155 @keyword package_item: A RequestedPackageLineItem, created by
+156 calling create_wsdl_object_of_type('RequestedPackageLineItem') on
+157 this ShipmentRequest object. See examples/create_shipment.py for
+158 more details.
+159 """
+160
+161self.RequestedShipment.RequestedPackageLineItems.append(package_item)
+162package_weight=package_item.Weight.Value
+163self.RequestedShipment.TotalWeight.Value+=package_weight
+164self.RequestedShipment.PackageCount+=1
+
173"""
+174 Deletes a shipment via a tracking number.
+175 """
+176
+177self._config_obj=config_obj
+178
+179# Holds version info for the VersionId SOAP object.
+180self._version_info={'service_id':'ship','major':'17',
+181'intermediate':'0','minor':'0'}
+182self.DeletionControlType=None
+183"""@ivar: Holds the DeletrionControlType WSDL object."""
+184self.TrackingId=None
+185"""@ivar: Holds the TrackingId WSDL object."""
+186# Call the parent FedexBaseService class for basic setup work.
+187super(FedexDeleteShipmentRequest,self).__init__(self._config_obj,
+188'ShipService_v17.wsdl',
+189*args,**kwargs)
+
192"""
+193 Preps the WSDL data structures for the user.
+194 """
+195
+196self.DeletionControlType=self.client.factory.create('DeletionControlType')
+197self.TrackingId=self.client.factory.create('TrackingId')
+198self.TrackingId.TrackingIdType=self.client.factory.create('TrackingIdType')
+
201"""
+202 Fires off the Fedex request.
+203
+204 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES
+205 ON FedexBaseService AND IS INHERITED.
+206 """
+207
+208client=self.client
+209# Fire off the query.
+210returnclient.service.deleteShipment(
+211WebAuthenticationDetail=self.WebAuthenticationDetail,
+212ClientDetail=self.ClientDetail,
+213TransactionDetail=self.TransactionDetail,
+214Version=self.VersionId,
+215ShipTimestamp=datetime.datetime.now(),
+216TrackingId=self.TrackingId,
+217DeletionControl=self.DeletionControlType)
+
customer_transaction_id - A user-specified identifier to differentiate this transaction
+ from others. This value will be returned with the response from
+ Fedex.
This class allows you to process (create) a new FedEx shipment. You
+ will need to populate the data structures in self.RequestedShipment, then
+ send the request. Label printing is supported and very configurable,
+ returning an ASCII representation with the response as well.
send_validation_request(self)
+ This is very similar to just sending the shipment via the typical
+ send_request() function, but this doesn't create a shipment.
This is very similar to just sending the shipment via the typical
+ send_request() function, but this doesn't create a shipment. It is used
+ to make sure "good" values are given by the user or the
+ application using the library.
package_item (WSDL object, type of RequestedPackageLineItem WSDL object.) - A RequestedPackageLineItem, created by calling
+ create_wsdl_object_of_type('RequestedPackageLineItem') on this
+ ShipmentRequest object. See examples/create_shipment.py for more
+ details.
This package contains the shipment tracking methods defined by Fedex's
+ TrackService WSDL file. Each is encapsulated in a class for easy access.
+ For more details on each, refer to the respective class's
+ documentation.
+ 1"""
+ 2Tracking Service Module
+ 3
+ 4This package contains the shipment tracking methods defined by Fedex's
+ 5TrackService WSDL file. Each is encapsulated in a class for easy access.
+ 6For more details on each, refer to the respective class's documentation.
+ 7"""
+ 8
+ 9from..base_serviceimportFedexBaseService,FedexError
+ 10
+ 11
+
21"""
+ 22 This class allows you to track shipments by providing a tracking
+ 23 number or other identifying features. By default, you
+ 24 can simply pass a tracking number to the constructor. If you would like
+ 25 to query shipments based on something other than tracking number, you will
+ 26 want to read the documentation for the L{__init__} method.
+ 27 Particularly, the tracking_value and package_identifier arguments.
+ 28 """
+ 29
+
61"""
+ 62 This sets the package identifier information. This may be a tracking
+ 63 number or a few different things as per the Fedex spec.
+ 64 """
+ 65
+ 66self.SelectionDetails=self.client.factory.create('TrackSelectionDetail')
+ 67
+ 68# Default to Fedex
+ 69self.SelectionDetails.CarrierCode='FDXE'
+ 70
+ 71track_package_id=self.client.factory.create('TrackPackageIdentifier')
+ 72
+ 73# Default to tracking number.
+ 74track_package_id.Type='TRACKING_NUMBER_OR_DOORTAG'
+ 75
+ 76self.SelectionDetails.PackageIdentifier=track_package_id
+
79"""
+ 80 Checks the response to see if there were any errors specific to
+ 81 this WSDL.
+ 82 """
+ 83ifself.response.HighestSeverity=="ERROR":# pragma: no cover
+ 84fornotificationinself.response.Notifications:
+ 85ifnotification.Severity=="ERROR":
+ 86if"Invalid tracking number"innotification.Message:
+ 87raiseFedexInvalidTrackingNumber(
+ 88notification.Code,notification.Message)
+ 89else:
+ 90raiseFedexError(notification.Code,notification.Message)
+
93"""
+ 94 Fires off the Fedex request.
+ 95
+ 96 @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES
+ 97 ON FedexBaseService AND IS INHERITED.
+ 98 """
+ 99
+100client=self.client
+101# Fire off the query.
+102returnclient.service.track(
+103WebAuthenticationDetail=self.WebAuthenticationDetail,
+104ClientDetail=self.ClientDetail,
+105TransactionDetail=self.TransactionDetail,
+106Version=self.VersionId,
+107SelectionDetails=self.SelectionDetails,
+108ProcessingOptions=self.ProcessingOptions)
+
This class allows you to track shipments by providing a tracking
+ number or other identifying features. By default, you can simply pass a
+ tracking number to the constructor. If you would like to query shipments
+ based on something other than tracking number, you will want to read the
+ documentation for the __init__ method. Particularly, the tracking_value and
+ package_identifier arguments.
Converts a suds object to a dict. :param json_serialize: If set,
+ changes date and time types to iso string. :param key_to_lower: If set,
+ changes index key name to lower case. :param obj: suds object :return:
+ dict object
+ 1"""Response output conversion tools to help parse suds
+ 2response object output.
+ 3"""
+ 4
+ 5
+ 6# This is the suds way of doing this, but its slower.
+ 7# For reference only.
+ 8# from suds.sudsobject import asdict
+ 9# from suds.sax.text import Text
+10#
+11# def response_to_dict(obj):
+12# """ Converts a suds object to a dictionary.
+13# :param obj: object
+14# :return: dictionary
+15# """
+16# out = {}
+17# for k, v in asdict(obj).items(): # k = k.lower()
+18# if hasattr(v, '__keylist__'):
+19# out[k] = response_to_dict(v)
+20# elif isinstance(v, list): # tuple not used
+21# out[k] = []
+22# for item in v:
+23# if hasattr(item, '__keylist__'):
+24# out[k].append(response_to_dict(item))
+25# else:
+26# out[k].append(
+27# item.title() if isinstance(item, Text) else item)
+28# else:
+29# out[k] = v.title() if isinstance(v, Text) else v
+30# return out
+31
+32
+
This document contains the API (Application Programming Interface)
+documentation for this project. Documentation for the Python
+objects defined by the project is divided into separate pages for each
+package, module, and class. The API documentation also includes two
+pages containing information about the project as a whole: a trees
+page, and an index page.
+
+
Object Documentation
+
+
Each Package Documentation page contains:
+
+
A description of the package.
+
A list of the modules and sub-packages contained by the
+ package.
+
A summary of the classes defined by the package.
+
A summary of the functions defined by the package.
+
A summary of the variables defined by the package.
+
A detailed description of each function defined by the
+ package.
+
A detailed description of each variable defined by the
+ package.
+
+
+
Each Module Documentation page contains:
+
+
A description of the module.
+
A summary of the classes defined by the module.
+
A summary of the functions defined by the module.
+
A summary of the variables defined by the module.
+
A detailed description of each function defined by the
+ module.
+
A detailed description of each variable defined by the
+ module.
+
+
+
Each Class Documentation page contains:
+
+
A class inheritance diagram.
+
A list of known subclasses.
+
A description of the class.
+
A summary of the methods defined by the class.
+
A summary of the instance variables defined by the class.
+
A summary of the class (static) variables defined by the
+ class.
+
A detailed description of each method defined by the
+ class.
+
A detailed description of each instance variable defined by the
+ class.
+
A detailed description of each class (static) variable defined
+ by the class.
+
+
+
Project Documentation
+
+
The Trees page contains the module and class hierarchies:
+
+
The module hierarchy lists every package and module, with
+ modules grouped into packages. At the top level, and within each
+ package, modules and sub-packages are listed alphabetically.
+
The class hierarchy lists every class, grouped by base
+ class. If a class has more than one base class, then it will be
+ listed under each base class. At the top level, and under each base
+ class, classes are listed alphabetically.
+
+
+
The Index page contains indices of terms and
+ identifiers:
+
+
The term index lists every term indexed by any object's
+ documentation. For each term, the index provides links to each
+ place where the term is indexed.
+
The identifier index lists the (short) name of every package,
+ module, class, method, function, variable, and parameter. For each
+ identifier, the index provides a short description, and a link to
+ its documentation.
+
+
+
The Table of Contents
+
+
The table of contents occupies the two frames on the left side of
+the window. The upper-left frame displays the project
+contents, and the lower-left frame displays the module
+contents:
+
+
+
+
+ Project Contents...
+
+ API Documentation Frame
+
+
+
+
+ Module Contents ...
+
+
+
+
+
The project contents frame contains a list of all packages
+and modules that are defined by the project. Clicking on an entry
+will display its contents in the module contents frame. Clicking on a
+special entry, labeled "Everything," will display the contents of
+the entire project.
+
+
The module contents frame contains a list of every
+submodule, class, type, exception, function, and variable defined by a
+module or package. Clicking on an entry will display its
+documentation in the API documentation frame. Clicking on the name of
+the module, at the top of the frame, will display the documentation
+for the module itself.
+
+
The "frames" and "no frames" buttons below the top
+navigation bar can be used to control whether the table of contents is
+displayed or not.
+
+
The Navigation Bar
+
+
A navigation bar is located at the top and bottom of every page.
+It indicates what type of page you are currently viewing, and allows
+you to go to related pages. The following table describes the labels
+on the navigation bar. Note that not some labels (such as
+[Parent]) are not displayed on all pages.
+
+
+
+
Label
+
Highlighted when...
+
Links to...
+
+
[Parent]
+
(never highlighted)
+
the parent of the current package
+
[Package]
+
viewing a package
+
the package containing the current object
+
+
[Module]
+
viewing a module
+
the module containing the current object
+
+
[Class]
+
viewing a class
+
the class containing the current object
+
[Trees]
+
viewing the trees page
+
the trees page
+
[Index]
+
viewing the index page
+
the index page
+
[Help]
+
viewing the help page
+
the help page
+
+
+
The "show private" and "hide private" buttons below
+the top navigation bar can be used to control whether documentation
+for private objects is displayed. Private objects are usually defined
+as objects whose (short) names begin with a single underscore, but do
+not end with an underscore. For example, "_x",
+"__pprint", and "epydoc.epytext._tokenize"
+are private objects; but "re.sub",
+"__init__", and "type_" are not. However,
+if a module defines the "__all__" variable, then its
+contents are used to decide which objects are private.
+
+
A timestamp below the bottom navigation bar indicates when each
+page was last updated.
fedex.printers.unix: This module provides a label printing wrapper class for Unix-based
+ installations.
+
+
+
fedex.services: This module contains the wrappers around Fedex Web Service requests
+ which you will want to instantiate and use with a FedexConfig object supplying your static details.
+
When javascript is enabled, this page will redirect URLs of
+the form redirect.html#dotted.name to the
+documentation for the object with the given fully-qualified
+dotted name.
+ fedex fedex.base_service fedex.config fedex.printers fedex.printers.unix fedex.services fedex.services.address_validation_service fedex.services.availability_commitment_service fedex.services.country_service fedex.services.location_service fedex.services.package_movement fedex.services.rate_service fedex.services.ship_service fedex.services.track_service fedex.tools fedex.tools.conversion
+ [hide private]
+
+
+
+
diff --git a/doc_source/epydoc.config b/epydoc_source/epydoc.config
similarity index 100%
rename from doc_source/epydoc.config
rename to epydoc_source/epydoc.config
diff --git a/examples/README.rst b/examples/README.rst
new file mode 100644
index 0000000..29a7be7
--- /dev/null
+++ b/examples/README.rst
@@ -0,0 +1,12 @@
+python-fedex Examples
+=====================
+
+This directory contains a number of examples of how to use python-fedex. For
+these examples to work, you must open example_config.py and enter your
+testing account credentials there.
+
+To run all tests from bash, type:
+
+ for f in *.py; do python "$f"; done
+ # Or use the below to only see response errors:
+ for f in *.py; do python "$f"; done | grep -i error
\ No newline at end of file
diff --git a/examples/README.txt b/examples/README.txt
deleted file mode 100644
index 4650d62..0000000
--- a/examples/README.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-python-fedex Examples
-=====================
-This directory contains a number of examples of how to use python-fedex. For
-these examples to work, you must open example_config.py and enter your
-testing account credentials there.
\ No newline at end of file
diff --git a/examples/address_validation.py b/examples/address_validation.py
index e5b6c35..a4f3fa0 100755
--- a/examples/address_validation.py
+++ b/examples/address_validation.py
@@ -4,16 +4,18 @@
class can handle up to 100 addresses for validation.
"""
import logging
+import sys
+
from example_config import CONFIG_OBJ
from fedex.services.address_validation_service import FedexAddressValidationRequest
# NOTE: TO USE ADDRESS VALIDATION SERVICES, YOU NEED TO REQUEST FEDEX TO ENABLE THIS SERVICE FOR YOUR ACCOUNT.
# BY DEFAULT, THE SERVICE IS DISABLED AND YOU WILL RECEIVE AUTHENTICATION FAILED, 1000 RESPONSE.
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
-# This is the object that will be handling our tracking request.
+# This is the object that will be handling our avs request.
# We're using the FedexConfig object from example_config.py in this dir.
customer_transaction_id = "*** AddressValidation Request v4 using Python ***" # Optional transaction_id
# Optional locale & language client data
@@ -47,48 +49,63 @@ class can handle up to 100 addresses for validation.
address2.Address.CountryCode = 'US'
avs_request.add_address(address2)
-
# If you'd like to see some documentation on the ship service WSDL, un-comment
# this line. (Spammy).
-#print(avs_request.client)
+# print(avs_request.client)
# Un-comment this to see your complete, ready-to-send request as it stands
# before it is actually sent. This is useful for seeing what values you can
# change.
-#print(avs_request.AddressesToValidate)
-#print(avs_request.ClientDetail)
-#print(avs_request.TransactionDetail)
+# print(avs_request.AddressesToValidate)
+# print(avs_request.ClientDetail)
+# print(avs_request.TransactionDetail)
# Fires off the request, sets the 'response' attribute on the object.
avs_request.send_request()
# good to un-comment to see the variables returned by the Fedex reply.
-print(avs_request.response)
+# print(avs_request.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.conversion import basic_sobject_to_dict
+# print(basic_sobject_to_dict(avs_request.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(avs_request.response))
# Overall end result of the query
for i in range(len(avs_request.response.AddressResults)):
- print("Details for Address", i + 1)
- print("The validated street is:", avs_request.response.AddressResults[i].EffectiveAddress.StreetLines)
- print("The validated city is:", avs_request.response.AddressResults[i].EffectiveAddress.City)
- print("The validated state code is:", avs_request.response.AddressResults[i].EffectiveAddress.StateOrProvinceCode)
- print("The validated postal code is:", avs_request.response.AddressResults[i].EffectiveAddress.PostalCode)
- print("The validated country code is:", avs_request.response.AddressResults[i].EffectiveAddress.CountryCode)
+ print("Details for Address {}".format(i + 1))
+ print("The validated street is: {}"
+ "".format(avs_request.response.AddressResults[i].EffectiveAddress.StreetLines))
+ print("The validated city is: {}"
+ "".format(avs_request.response.AddressResults[i].EffectiveAddress.City))
+ print("The validated state code is: {}"
+ "".format(avs_request.response.AddressResults[i].EffectiveAddress.StateOrProvinceCode))
+ print("The validated postal code is: {}"
+ "".format(avs_request.response.AddressResults[i].EffectiveAddress.PostalCode))
+ print("The validated country code is: {}"
+ "".format(avs_request.response.AddressResults[i].EffectiveAddress.CountryCode))
# Can be used to determine the address classification to figure out if Residential fee should apply.
# MIXED, RESIDENTIAL, UNKNOWN, BUSINESS
- print("The validated address is residential:", avs_request.response.AddressResults[i].Classification != 'BUSINESS')
+ print("The validated address is residential: {}"
+ "".format(avs_request.response.AddressResults[i].Classification != 'BUSINESS'))
# Getting the optional attributes if available
for j in range(len(avs_request.response.AddressResults[i].Attributes)):
cur_attribute = avs_request.response.AddressResults[i].Attributes[j]
if cur_attribute.Name == "CountrySupported":
- print("Supported Country:", cur_attribute.Value == 'true')
+ print("Supported Country: {}".format(cur_attribute.Value == 'true'))
if cur_attribute.Name == "SuiteRequiredButMissing":
- print("Missing Suite:", cur_attribute.Value == 'true')
- if cur_attribute.Name == "CountrySupported":
- print("Invalid Suite:", cur_attribute.Value == 'true')
+ print("Missing Suite: {}".format(cur_attribute.Value == 'true'))
+ if cur_attribute.Name == "InvalidSuiteNumber":
+ print("Invalid Suite: {}".format(cur_attribute.Value == 'true'))
if cur_attribute.Name == "MultipleMatches":
- print("Multiple Matches:", cur_attribute.Value == 'true')
+ print("Multiple Matches: {}".format(cur_attribute.Value == 'true'))
if cur_attribute.Name == "POBox":
- print("Is POBox:", cur_attribute.Value == 'true')
+ print("Is POBox: {}".format(cur_attribute.Value == 'true'))
+ print("")
diff --git a/examples/create_freight_shipment.py b/examples/create_freight_shipment.py
index 30a3f28..2fdc016 100644
--- a/examples/create_freight_shipment.py
+++ b/examples/create_freight_shipment.py
@@ -1,6 +1,7 @@
#!/usr/bin/env python
"""
-This example shows how to create shipments. The variables populated below
+This example shows how to create a freight shipment and generate
+a waybill as output. The variables populated below
represents the minimum required values. You will need to fill all of these, or
risk seeing a SchemaValidationError exception thrown.
@@ -8,7 +9,9 @@
label data that is returned with the reply.
"""
import logging
+import sys
import binascii
+
from example_config import CONFIG_OBJ
from fedex.services.ship_service import FedexProcessShipmentRequest
@@ -16,15 +19,13 @@
# Valid choices for this example are PDF, PNG
GENERATE_IMAGE_TYPE = 'PDF'
-
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-#logging.basicConfig(filename="suds.log", level=logging.DEBUG)
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
# NOTE: A VALID 'freight_account_number' REQUIRED IN YOUR 'CONFIB_OBJ' FOR THIS SERVICE TO WORK.
# OTHERWISE YOU WILL GET FEDEX FREIGHT OR ASSOCIATED ADDRESS IS REQUIRED, ERROR 3619.
-# This is the object that will be handling our tracking request.
+# This is the object that will be handling our freight shipment request.
# We're using the FedexConfig object from example_config.py in this dir.
shipment = FedexProcessShipmentRequest(CONFIG_OBJ)
shipment.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
@@ -60,7 +61,7 @@
# This is needed to ensure an accurate rate quote with the response.
shipment.RequestedShipment.Recipient.Address.Residential = False
-shipment.RequestedShipment.FreightShipmentDetail.TotalHandlingUnits = 1
+shipment.RequestedShipment.FreightShipmentDetail.TotalHandlingUnits = 1
shipment.RequestedShipment.ShippingChargesPayment.Payor.ResponsibleParty.AccountNumber = \
CONFIG_OBJ.freight_account_number
@@ -86,7 +87,6 @@
shipment.RequestedShipment.FreightShipmentDetail.Role = role.SHIPPER
shipment.RequestedShipment.FreightShipmentDetail.CollectTermsType = 'STANDARD'
-
# Specifies the label type to be returned.
shipment.RequestedShipment.LabelSpecification.LabelFormatType = 'FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING'
@@ -124,22 +124,21 @@
package1.HazardousMaterials = None
package1.Pieces = 12
-
shipment.RequestedShipment.FreightShipmentDetail.LineItems = package1
# If you'd like to see some documentation on the ship service WSDL, un-comment
# this line. (Spammy).
-#print(shipment.client)
+# print(shipment.client)
# Un-comment this to see your complete, ready-to-send request as it stands
# before it is actually sent. This is useful for seeing what values you can
# change.
-#print(shipment.RequestedShipment)
+# print(shipment.RequestedShipment)
# If you want to make sure that all of your entered details are valid, you
# can call this and parse it just like you would via send_request(). If
# shipment.response.HighestSeverity == "SUCCESS", your shipment is valid.
-#shipment.send_validation_request()
+# shipment.send_validation_request()
# Fires off the request, sets the 'response' attribute on the object.
shipment.send_request()
@@ -147,14 +146,29 @@
# This will show the reply to your shipment being sent. You can access the
# attributes through the response attribute on the request object. This is
# good to un-comment to see the variables returned by the Fedex reply.
-print(shipment.response)
+# print(shipment.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with. Also see basic_sobject_to_dict, it's faster but lacks options.
+# from fedex.tools.conversion import sobject_to_dict
+# response_dict = sobject_to_dict(shipment.response)
+# response_dict['CompletedShipmentDetail']['ShipmentDocuments'][0]['Parts'][0]['Image'] = ''
+# print(response_dict) # Image is empty string for display purposes.
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(shipment.response))
+
# Here is the overall end result of the query.
-# print("HighestSeverity:", shipment.response.HighestSeverity)
-# # Getting the tracking number from the new shipment.
-# print("Tracking #:", shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].TrackingIds[0].TrackingNumber)
-# # Net shipping costs.
-# print("Net Shipping Cost (US$):", shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].PackageRating.PackageRateDetails[0].NetCharge.Amount)
+print("HighestSeverity: {}".format(shipment.response.HighestSeverity))
+
+# Getting the tracking number from the new shipment.
+print("Tracking #: {}"
+ "".format(shipment.response.CompletedShipmentDetail.MasterTrackingId.TrackingNumber))
+# Net shipping costs.
+amount = shipment.response.CompletedShipmentDetail.ShipmentRating.ShipmentRateDetails[0].TotalNetCharge.Amount
+print("Net Shipping Cost (US$): {}".format(amount))
# # Get the label image in ASCII format from the reply. Note the list indices
# we're using. You'll need to adjust or iterate through these if your shipment
@@ -170,7 +184,7 @@
"""
# This will be the file we write the label out to.
out_path = 'example_freight_shipment_label.%s' % GENERATE_IMAGE_TYPE.lower()
-print("Writing to file", out_path)
+print("Writing to file {}".format(out_path))
out_file = open(out_path, 'wb')
out_file.write(label_binary_data)
out_file.close()
@@ -182,17 +196,17 @@
"""
# Pipe the binary directly to the label printer. Works under Linux
# without requiring PySerial. This WILL NOT work on other platforms.
-#label_printer = open("/dev/ttyS0", "w")
-#label_printer.write(label_binary_data)
-#label_printer.close()
+# label_printer = open("/dev/ttyS0", "w")
+# label_printer.write(label_binary_data)
+# label_printer.close()
"""
This is a potential cross-platform solution using pySerial. This has not been
tested in a long time and may or may not work. For Windows, Mac, and other
platforms, you may want to go this route.
"""
-#import serial
-#label_printer = serial.Serial(0)
-#print("SELECTED SERIAL PORT: "+ label_printer.portstr)
-#label_printer.write(label_binary_data)
-#label_printer.close()
+# import serial
+# label_printer = serial.Serial(0)
+# print("SELECTED SERIAL PORT: "+ label_printer.portstr)
+# label_printer.write(label_binary_data)
+# label_printer.close()
diff --git a/examples/create_international_shipment.py b/examples/create_international_shipment.py
new file mode 100644
index 0000000..5489ae4
--- /dev/null
+++ b/examples/create_international_shipment.py
@@ -0,0 +1,407 @@
+"""
+This example shows how to create an international shipment and generate a waybill as output.
+The example takes outset in a real practical use case, where electronic trade documents are
+used and an existing PDF commercial invoice is added along with product descriptions via ETD.
+Further, it adds event notifications to allow for emails to be sent to the end recipient.
+
+The script is comprised of a FedExLabelHelper class with all core functions, and a use case
+example with minimal dummy data
+"""
+from example_config import CONFIG_OBJ
+from pathlib import Path
+import binascii
+import datetime
+from fedex.services.ship_service import FedexProcessShipmentRequest
+
+# ----------------------------------------------------
+# FedEx class for creating shipments
+class FedexLabelHelper:
+ mCommodities = []
+
+ def __init__(self):
+ pass
+
+ # ----------------------------------------------------
+ # set overall shipment configuration
+ def setShipmentConfig(
+ self,
+ CONFIG_OBJ,
+ invoice_info,
+ cust_tran_id="*** ShipService Request v17 using Python ***",
+ dropoffType="BUSINESS_SERVICE_CENTER",
+ shippingPaymentType="SENDER",
+ labelFormatType="COMMON2D",
+ labelSpecificationImageType="PDF",
+ labelSpecificationStockType="PAPER_7X4.75",
+ labelPrintingOrientation="TOP_EDGE_OF_TEXT_FIRST",
+ LabelOrder="SHIPPING_LABEL_FIRST",
+ ):
+ self.invoice_info = invoice_info
+ self.dropoffType = dropoffType
+ self.serviceType = "INTERNATIONAL_PRIORITY" if invoice_info["ShippingExpress"] == True else "INTERNATIONAL_ECONOMY"
+ self.mCommodities.clear()
+ self.CONFIG_OBJ = CONFIG_OBJ
+ self.shipment = FedexProcessShipmentRequest(CONFIG_OBJ, customer_transaction_id=cust_tran_id)
+
+ self.shipment.RequestedShipment.DropoffType = dropoffType
+ self.shipment.RequestedShipment.ServiceType = self.serviceType
+ self.shipment.RequestedShipment.ShippingChargesPayment.Payor.ResponsibleParty.AccountNumber = CONFIG_OBJ.account_number
+ self.shipment.RequestedShipment.ShippingChargesPayment.Payor.ResponsibleParty.Address.CountryCode = "DK"
+ self.shipment.RequestedShipment.ShippingChargesPayment.PaymentType = shippingPaymentType
+
+ labelSpecification = self.shipment.create_wsdl_object_of_type("LabelSpecification")
+ labelSpecification.LabelFormatType = labelFormatType
+ labelSpecification.LabelStockType = labelSpecificationStockType
+ labelSpecification.ImageType = labelSpecificationImageType
+ labelSpecification.LabelOrder = LabelOrder
+ labelSpecification.LabelPrintingOrientation = labelPrintingOrientation
+ self.shipment.RequestedShipment.LabelSpecification = labelSpecification
+
+ # ----------------------------------------------------
+ # set sender information
+ def setSenderInfo(self, sender):
+
+ self.shipment.RequestedShipment.Shipper.Contact.PersonName = sender["Name"]
+ self.shipment.RequestedShipment.Shipper.Contact.CompanyName = sender["Company"]
+ self.shipment.RequestedShipment.Shipper.Contact.PhoneNumber = sender["Phone"]
+ self.shipment.RequestedShipment.Shipper.Contact.EMailAddress = sender["Email"]
+ self.shipment.RequestedShipment.Shipper.Address.StreetLines = sender["Address"]
+ self.shipment.RequestedShipment.Shipper.Address.City = sender["City"]
+ self.shipment.RequestedShipment.Shipper.Address.StateOrProvinceCode = sender["Region"]
+ self.shipment.RequestedShipment.Shipper.Address.PostalCode = sender["Zip"]
+ self.shipment.RequestedShipment.Shipper.Address.CountryCode = sender["CountryCode"]
+ self.shipment.RequestedShipment.Shipper.Address.Residential = sender["Residential"]
+
+ ti = self.shipment.create_wsdl_object_of_type("TaxpayerIdentification")
+ ti.Number = sender["VAT"]
+ ti.TinType = "BUSINESS_NATIONAL"
+ self.shipment.RequestedShipment.Shipper.Tins = ti
+
+ # ----------------------------------------------------
+ # upload all documents (invoice and product information)
+ def upload_all_documents(self):
+ doc_ids = []
+ doc_ids.append(self.upload_document(self.invoice_info["InvoicePath"], "COMMERCIAL_INVOICE"))
+
+ for pdf in self.invoice_info["Pdfs"]:
+ doc_ids.append(self.upload_document(pdf, "OTHER"))
+
+ return doc_ids
+
+ # ----------------------------------------------------
+ # function for uploading documents as electronic trade documents and getting the response doc IDs
+ def upload_document(self, path, type):
+ from fedex.services.document_service import FedexDocumentServiceRequest
+
+ # specify prefix for use in attachment naming
+ if type == "COMMERCIAL_INVOICE":
+ prefix = "invoice_"
+ else:
+ prefix = "product_description_"
+
+ uploadRequest = FedexDocumentServiceRequest(self.CONFIG_OBJ)
+ uploadRequest.OriginCountryCode = "DK"
+ uploadRequest.DestinationCountryCode = self.shipment.RequestedShipment.Recipient.Address.CountryCode
+ uploadRequest.Usage = "ELECTRONIC_TRADE_DOCUMENTS"
+
+ clientdetails = uploadRequest.create_wsdl_object_of_type("ClientDetail")
+ clientdetails.AccountNumber = self.CONFIG_OBJ.account_number
+ clientdetails.MeterNumber = self.CONFIG_OBJ.meter_number
+ uploadRequest.ClientDetail = clientdetails
+
+ webAuthDetails = uploadRequest.create_wsdl_object_of_type("WebAuthenticationDetail")
+ webAuthDetails.ParentCredential.Key = self.CONFIG_OBJ.key
+ webAuthDetails.ParentCredential.Password = self.CONFIG_OBJ.password
+ webAuthDetails.UserCredential.Key = self.CONFIG_OBJ.key
+ webAuthDetails.UserCredential.Password = self.CONFIG_OBJ.password
+ uploadRequest.WebAuthenticationDetail = webAuthDetails
+
+ docdetails = uploadRequest.create_wsdl_object_of_type("UploadDocumentDetail")
+ docdetails.LineNumber = 1
+ docdetails.DocumentType = type
+ docdetails.FileName = prefix + path
+ fileContent = open(path, "rb").read()
+ fileBase64 = binascii.b2a_base64(fileContent)
+ docdetails.DocumentContent = fileBase64.decode("cp1250")
+ uploadRequest.Documents = docdetails
+
+ uploadRequest.send_request()
+
+ doc_id = uploadRequest.response.DocumentStatuses[0].DocumentId
+
+ return doc_id
+
+ # ----------------------------------------------------
+ # set recipient information
+ def setRecipientInfo(self, recipient):
+ self.shipment.RequestedShipment.Recipient.Contact.PersonName = recipient["Name"]
+ self.shipment.RequestedShipment.Recipient.Contact.CompanyName = recipient["Company"]
+ self.shipment.RequestedShipment.Recipient.Contact.PhoneNumber = recipient["Phone"]
+ self.shipment.RequestedShipment.Recipient.Contact.EMailAddress = recipient["Email"]
+ self.shipment.RequestedShipment.Recipient.Address.StreetLines = recipient["Address"]
+ self.shipment.RequestedShipment.Recipient.Address.City = recipient["City"]
+ self.shipment.RequestedShipment.Recipient.Address.StateOrProvinceCode = recipient["Region"]
+ self.shipment.RequestedShipment.Recipient.Address.PostalCode = recipient["Zip"]
+ self.shipment.RequestedShipment.Recipient.Address.CountryCode = recipient["CountryCode"]
+ self.shipment.RequestedShipment.Recipient.Address.Residential = recipient["Residential"]
+
+ ti = self.shipment.create_wsdl_object_of_type("TaxpayerIdentification")
+ ti.Number = recipient["VAT"]
+ ti.TinType = "BUSINESS_NATIONAL"
+ self.shipment.RequestedShipment.Recipient.Tins = ti
+
+ # ----------------------------------------------------
+ # add "commercial invoice" reference as the only commodity
+ def add_ci_commodity(self):
+
+ self.addCommodity(
+ cCustomsValueAmnt=self.invoice_info["Value"],
+ cCustomsValueCurrency=self.invoice_info["Currency"],
+ cWeightValue=self.invoice_info["Weight"],
+ cDescription="See attached commercial invoice",
+ cQuantity=self.invoice_info["Quantity"],
+ cExportLicenseNumber=self.shipment.RequestedShipment.Shipper.Tins.Number,
+ cPartNumber=1,
+ )
+
+ # ----------------------------------------------------
+ # add commodity to shipment (for now, just add 1 commodity to refer to attached CI)
+ def addCommodity(
+ self, cCustomsValueAmnt, cCustomsValueCurrency, cWeightValue, cDescription, cQuantity, cExportLicenseNumber, cPartNumber,
+ ):
+
+ commodity = self.shipment.create_wsdl_object_of_type("Commodity")
+ commodity.NumberOfPieces = str(cQuantity)
+ commodity.Description = cDescription
+ commodity.Quantity = cQuantity
+ commodity.QuantityUnits = "EA"
+ commodity.ExportLicenseNumber = cExportLicenseNumber
+ commodity.PartNumber = cPartNumber
+ commodity.CountryOfManufacture = "DK"
+
+ mCustomsValue = self.shipment.create_wsdl_object_of_type("Money")
+ mCustomsValue.Amount = cCustomsValueAmnt
+ mCustomsValue.Currency = cCustomsValueCurrency
+ commodity.CustomsValue = mCustomsValue
+
+ commodity_weight = self.shipment.create_wsdl_object_of_type("Weight")
+ commodity_weight.Value = cWeightValue
+ commodity_weight.Units = "KG"
+ commodity.Weight = commodity_weight
+
+ munitPrice = self.shipment.create_wsdl_object_of_type("Money")
+ munitPrice.Amount = float(round((cCustomsValueAmnt / cQuantity), 2))
+ munitPrice.Currency = cCustomsValueCurrency
+ commodity.UnitPrice = munitPrice
+
+ self.mCommodities.append(commodity)
+
+ # ----------------------------------------------------
+ # add package to shipment
+ def set_packaging_info(self):
+ weight = self.invoice_info["Weight"]
+
+ type = "BOX" if weight > 0.5 else "ENVELOPE"
+ weight_final = float(round(weight + 0.2, 2)) if weight > 0.5 else 0.4
+
+ self.addShippingPackage(packageWeight=weight_final, physicalPackagingType=type, packagingType=f"FEDEX_{type}")
+
+ # ----------------------------------------------------
+ # add package to shipment
+ def addShippingPackage(self, packageWeight, physicalPackagingType, packagingType, packageWeightUnit="KG"):
+ package_weight = self.shipment.create_wsdl_object_of_type("Weight")
+ package_weight.Value = packageWeight
+ package_weight.Units = packageWeightUnit
+
+ package = self.shipment.create_wsdl_object_of_type("RequestedPackageLineItem")
+ package.PhysicalPackaging = physicalPackagingType
+ package.Weight = package_weight
+
+ self.shipment.add_package(package)
+ self.shipment.RequestedShipment.TotalWeight = package_weight
+ self.shipment.RequestedShipment.PackagingType = packagingType
+
+ # ----------------------------------------------------
+ # add information on duties
+ def setDutiesPaymentInfo(self):
+ mParty = self.shipment.create_wsdl_object_of_type("Party")
+ mParty.AccountNumber = self.CONFIG_OBJ.account_number
+ mParty.Address = self.shipment.RequestedShipment.Recipient.Address
+
+ mPayor = self.shipment.create_wsdl_object_of_type("Payor")
+ mPayor.ResponsibleParty = mParty
+
+ mPayment = self.shipment.create_wsdl_object_of_type("Payment")
+ mPayment.PaymentType = "RECIPIENT" # change if sender should pay duties
+ mPayment.Payor = mPayor
+
+ mCustomsValue = self.shipment.create_wsdl_object_of_type("Money")
+ mCustomsValue.Amount = self.invoice_info["Value"]
+ mCustomsValue.Currency = self.invoice_info["Currency"]
+
+ ccd = self.shipment.create_wsdl_object_of_type("CustomsClearanceDetail")
+ ccd.Commodities = self.mCommodities
+ ccd.CustomsValue = mCustomsValue
+ ccd.DutiesPayment = mPayment
+ self.shipment.RequestedShipment.CustomsClearanceDetail = ccd
+
+ # ----------------------------------------------------
+ # Set ETD (electronic trade documents) settings
+ def setSpecialServices(self, doc_ids):
+ # construct objects
+ ssr = self.shipment.create_wsdl_object_of_type("ShipmentSpecialServicesRequested")
+ ssr.SpecialServiceTypes.append("ELECTRONIC_TRADE_DOCUMENTS")
+ ssr.SpecialServiceTypes.append("EVENT_NOTIFICATION")
+
+ # set up ETD details
+ etd = self.shipment.create_wsdl_object_of_type("EtdDetail")
+ etd.RequestedDocumentCopies = "COMMERCIAL INVOICE"
+
+ for i, doc_id in enumerate(doc_ids, start=0):
+ udrd = self.shipment.create_wsdl_object_of_type("UploadDocumentReferenceDetail")
+ udrd.DocumentType = "COMMERCIAL_INVOICE" if i == 0 else "OTHER"
+ udrd.DocumentId = doc_id
+ udrd.Description = "Commercial_Invoice" if i == 0 else "Product_Description"
+ udrd.DocumentIdProducer = "CUSTOMER"
+ ssr.EtdDetail.DocumentReferences.append(udrd)
+
+ self.shipment.RequestedShipment.SpecialServicesRequested = ssr
+
+ # set Event Notification details
+ send = self.shipment.create_wsdl_object_of_type("ShipmentEventNotificationDetail")
+ send.AggregationType = "PER_SHIPMENT"
+
+ sens = self.shipment.create_wsdl_object_of_type("ShipmentEventNotificationSpecification")
+ sens.NotificationDetail.NotificationType = "EMAIL"
+ sens.NotificationDetail.EmailDetail.EmailAddress = self.shipment.RequestedShipment.Recipient.Contact.EMailAddress
+ sens.NotificationDetail.EmailDetail.Name = self.shipment.RequestedShipment.Recipient.Contact.PersonName
+ sens.NotificationDetail.Localization.LanguageCode = "EN"
+ sens.Role = "SHIPPER"
+ sens.Events.append("ON_SHIPMENT")
+ sens.Events.append("ON_EXCEPTION")
+ sens.Events.append("ON_DELIVERY")
+ sens.FormatSpecification.Type = "HTML"
+ send.EventNotifications = sens
+ self.shipment.RequestedShipment.SpecialServicesRequested.EventNotificationDetail = send
+
+ # ----------------------------------------------------
+ # process the shipment
+ def processInternationalShipment(self):
+ from shutil import copyfile
+
+ self.shipment.RequestedShipment.ShipTimestamp = datetime.datetime.now().replace(microsecond=0).isoformat()
+
+ # print(" ---- **** DETAILS ---- ****")
+ # print(self.shipment.RequestedShipment)
+ # print(self.shipment.ClientDetail)
+ # print(self.shipment.TransactionDetail)
+ # print("REQUESTED SHIPMENT\n\n", self.shipment.RequestedShipment)
+
+ self.shipment.send_request()
+
+ # print("RESPONSE\n\n", self.shipment.response)
+
+ status = self.shipment.response.HighestSeverity
+
+ if status == "SUCCESS" and "CompletedShipmentDetail" in self.shipment.response:
+ shipment_details = self.shipment.response.CompletedShipmentDetail
+ package_details = shipment_details.CompletedPackageDetails[0]
+ tracking_id = package_details.TrackingIds[0].TrackingNumber
+ email = self.shipment.RequestedShipment.Recipient.Contact.EMailAddress
+ fedex_cost = "N/A"
+
+ if hasattr(package_details, "PackageRating"):
+ fedex_cost = package_details.PackageRating.PackageRateDetails[0].NetCharge.Amount
+
+ # create the shipping PDF label
+ ascii_label_data = package_details.Label.Parts[0].Image
+ label_binary_data = binascii.a2b_base64(ascii_label_data)
+ out_path = self.invoice_info["InvoiceId"] + f"_shipment_label_{tracking_id}.pdf"
+
+ out_file = open(out_path, "wb")
+ out_file.write(label_binary_data)
+ out_file.close()
+
+ # print output information
+ print(
+ f"- SUCCESS: Created FedEx label for invoice {self.invoice_info['InvoiceId']}\n tracking ID: {tracking_id}\n email: {email}\n FedEx cost: {fedex_cost}\n Customs value: {self.invoice_info['Value']} {self.invoice_info['Currency']}\n Weight: {self.invoice_info['Weight']}\n output path: {out_path}"
+ )
+
+
+# ----------------------------------------------------
+# main script
+commercial_invoice_path = "commercial_invoice_test.pdf"
+product_description_1_path = "product_description_test.pdf"
+
+sender = {
+ "Company": "Sender Company",
+ "Name": "Mr Smith",
+ "Address": ["Address 1", "Address 2"],
+ "Region": "",
+ "Zip": "8230",
+ "City": "Abyhoj",
+ "Country": "Denmark",
+ "Phone": "12345678",
+ "Email": "mail@mail.com",
+ "CountryCode": "DK",
+ "Currency": "EUR",
+ "VAT": "DK12345678",
+ "Residential": False,
+}
+
+recipient = {
+ "Company": "Recipient Co",
+ "Name": "Contact Name",
+ "Address": ["Adr1, Adr2"],
+ "Region": "MN",
+ "Zip": "55420",
+ "City": "Bloomington",
+ "Country": "United States",
+ "Phone": "0123456789",
+ "Email": "mail@mail.com",
+ "CountryCode": "US",
+ "Currency": "EUR",
+ "VAT": "",
+ "Residential": False,
+}
+
+invoice_info = {
+ "InvoiceId": "14385",
+ "Weight": 0.11,
+ "Quantity": 2,
+ "Value": 20.0,
+ "Shipping": 25.0,
+ "ShippingExpress": True,
+ "Currency": "EUR",
+ "InvoicePath": commercial_invoice_path,
+ "Pdfs": [product_description_1_path],
+}
+
+# print output
+print(f"\n- recipient: {recipient}\n- invoice_info: {invoice_info}\n")
+
+# create FedEx Label Helper and set configuration
+flh = FedexLabelHelper()
+flh.setShipmentConfig(CONFIG_OBJ=CONFIG_OBJ, invoice_info=invoice_info)
+
+# add sender & recipient info to FedEx shipment
+flh.setSenderInfo(sender)
+flh.setRecipientInfo(recipient)
+
+# set packaging based on weight
+flh.set_packaging_info()
+
+# add reference to CI as only commodity info
+flh.add_ci_commodity()
+
+# set duties payment information
+flh.setDutiesPaymentInfo()
+
+# upload documents
+doc_ids = flh.upload_all_documents()
+
+# link uploaded documents as ETD and setup event notifications
+flh.setSpecialServices(doc_ids)
+
+# process shipments and create shipping labels
+flh.processInternationalShipment()
diff --git a/examples/create_pickup.py b/examples/create_pickup.py
new file mode 100755
index 0000000..2c37516
--- /dev/null
+++ b/examples/create_pickup.py
@@ -0,0 +1,81 @@
+#!/usr/bin/env python
+"""
+This example shows how to create a pickup request and then cancel it
+"""
+import datetime
+
+from example_config import CONFIG_OBJ
+from fedex.services.pickup_service import FedexCreatePickupRequest
+
+pickup_date = datetime.datetime.now().replace(microsecond=0)
+
+customer_transaction_id = "*** PickupService Request v11 using Python ***" # Optional transaction_id
+pickup_service = FedexCreatePickupRequest(CONFIG_OBJ, customer_transaction_id)
+
+pickup_service.OriginDetail.PickupLocation.Contact.PersonName = 'Sender Name'
+pickup_service.OriginDetail.PickupLocation.Contact.EMailAddress = 'test@user.com'
+pickup_service.OriginDetail.PickupLocation.Contact.CompanyName = 'Acme Inc.'
+pickup_service.OriginDetail.PickupLocation.Contact.PhoneNumber = '9012638716'
+pickup_service.OriginDetail.PickupLocation.Address.StateOrProvinceCode = 'SC'
+pickup_service.OriginDetail.PickupLocation.Address.PostalCode = '29631'
+pickup_service.OriginDetail.PickupLocation.Address.CountryCode = 'US'
+pickup_service.OriginDetail.PickupLocation.Address.StreetLines = ['155 Old Greenville Hwy', 'Suite 103']
+pickup_service.OriginDetail.PickupLocation.Address.City = 'Clemson'
+# pickup_service.OriginDetail.PickupLocation.Address.UrbanizationCode = '' # For Puerto Rico only
+pickup_service.OriginDetail.PickupLocation.Address.Residential = False
+
+# FRONT, NONE, REAR, SIDE
+# pickup_service.OriginDetail.PackageLocation = 'NONE'
+
+# APARTMENT, BUILDING, DEPARTMENT, FLOOR, ROOM, SUITE
+# pickup_service.OriginDetail.BuildingPart = 'SUITE'
+
+# Identifies the date and time the package will be ready for pickup by FedEx.
+pickup_service.OriginDetail.ReadyTimestamp = pickup_date.isoformat()
+
+# Identifies the latest time at which the driver can gain access to pick up the package(s)
+pickup_service.OriginDetail.CompanyCloseTime = '23:00:00'
+
+pickup_service.CarrierCode = 'FDXE'
+
+pickup_service.TotalWeight.Units = 'LB'
+pickup_service.TotalWeight.Value = '1'
+pickup_service.PackageCount = '1'
+# pickup_service.OversizePackageCount = '1'
+
+# pickup_service.CommodityDescription = ''
+
+# DOMESTIC or INTERNATIONAL
+# pickup_service.CountryRelationship = 'DOMESTIC'
+
+# See PickupServiceCategoryType
+# pickup_service.PickupServiceCategory = 'FEDEX_DISTANCE_DEFERRED'
+
+pickup_service.send_request()
+
+print('Pickup request sent:')
+print(pickup_service.response.HighestSeverity == 'SUCCESS')
+print(pickup_service.response.Notifications[0].Message)
+
+# Cancel the pickup request that we just got confirmation for
+cancel_pickup = FedexCancelPickupRequest(CONFIG_OBJ)
+
+cancel_pickup.PickupConfirmationNumber = pickup_service.response.PickupConfirmationNumber
+# the date for the pickup (eg. '2016-09-26')
+cancel_pickup.ScheduledDate = pickup_date.strftime('%Y-%m-%d')
+cancel_pickup.EndDate = pickup_date.strftime('%Y-%m-%d')
+cancel_pickup.Location = pickup_service.response.Location
+cancel_pickup.Remarks = None
+cancel_pickup.ShippingChargesPayment = None
+cancel_pickup.Reason = ''
+cancel_pickup.ContactName = 'Sender Name'
+cancel_pickup.PhoneNumber = '9012638716'
+cancel_pickup.PhoneExtension = ''
+
+cancel_pickup.CarrierCode = 'FDXE'
+
+cancel_pickup.send_request()
+
+print('Cancel pickup request sent:')
+print('Highest severity:',cancel_pickup.response.HighestSeverity)
+print('Message:',cancel_pickup.response.Notifications[0].Message)
diff --git a/examples/create_shipment.py b/examples/create_shipment.py
index 10e2530..5e18817 100755
--- a/examples/create_shipment.py
+++ b/examples/create_shipment.py
@@ -1,6 +1,6 @@
#!/usr/bin/env python
"""
-This example shows how to create shipments. The variables populated below
+This example shows how to create a shipment and generate a waybill as output. The variables populated below
represents the minimum required values. You will need to fill all of these, or
risk seeing a SchemaValidationError exception thrown.
@@ -10,6 +10,7 @@
import logging
import binascii
import datetime
+import sys
from example_config import CONFIG_OBJ
from fedex.services.ship_service import FedexProcessShipmentRequest
@@ -18,11 +19,10 @@
# Valid choices for this example are PDF, PNG
GENERATE_IMAGE_TYPE = 'PDF'
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
-
-# This is the object that will be handling our tracking request.
+# This is the object that will be handling our shipment request.
# We're using the FedexConfig object from example_config.py in this dir.
customer_transaction_id = "*** ShipService Request v17 using Python ***" # Optional transaction_id
shipment = FedexProcessShipmentRequest(CONFIG_OBJ, customer_transaction_id=customer_transaction_id)
@@ -32,7 +32,8 @@
shipment.RequestedShipment.DropoffType = 'BUSINESS_SERVICE_CENTER'
# See page 355 in WS_ShipService.pdf for a full list. Here are the common ones:
-# STANDARD_OVERNIGHT, PRIORITY_OVERNIGHT, FEDEX_GROUND, FEDEX_EXPRESS_SAVER
+# STANDARD_OVERNIGHT, PRIORITY_OVERNIGHT, FEDEX_GROUND, FEDEX_EXPRESS_SAVER,
+# FEDEX_2_DAY, INTERNATIONAL_PRIORITY, SAME_DAY, INTERNATIONAL_ECONOMY
shipment.RequestedShipment.ServiceType = 'PRIORITY_OVERNIGHT'
# What kind of package this will be shipped in.
@@ -72,7 +73,7 @@
# Who pays for the shipment?
# RECIPIENT, SENDER or THIRD_PARTY
-shipment.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
+shipment.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
# Specifies the label type to be returned.
# LABEL_DATA_ONLY or COMMON2D
@@ -87,13 +88,12 @@
# See documentation for paper types, there quite a few.
shipment.RequestedShipment.LabelSpecification.LabelStockType = 'PAPER_7X4.75'
-# This indicates if the top or bottom of the label comes out of the
-# printer first.
-# BOTTOM_EDGE_OF_TEXT_FIRST or TOP_EDGE_OF_TEXT_FIRST
# Timestamp in YYYY-MM-DDThh:mm:ss format, e.g. 2002-05-30T09:00:00
shipment.RequestedShipment.ShipTimestamp = datetime.datetime.now().replace(microsecond=0).isoformat()
-# BOTTOM_EDGE_OF_TEXT_FIRST, TOP_EDGE_OF_TEXT_FIRST
+# This indicates if the top or bottom of the label comes out of the
+# printer first.
+# BOTTOM_EDGE_OF_TEXT_FIRST or TOP_EDGE_OF_TEXT_FIRST
shipment.RequestedShipment.LabelSpecification.LabelPrintingOrientation = 'TOP_EDGE_OF_TEXT_FIRST'
# Delete the flags we don't want.
@@ -106,13 +106,47 @@
package1_weight.Value = 1.0
package1_weight.Units = "LB"
+# Insured Value
+# package1_insure = shipment.create_wsdl_object_of_type('Money')
+# package1_insure.Currency = 'USD'
+# package1_insure.Amount = 1.0
+
# Create PackageLineItem
package1 = shipment.create_wsdl_object_of_type('RequestedPackageLineItem')
# BAG, BARREL, BASKET, BOX, BUCKET, BUNDLE, CARTON, CASE, CONTAINER, ENVELOPE etc..
package1.PhysicalPackaging = 'ENVELOPE'
package1.Weight = package1_weight
+
+# Add Insured and Total Insured values.
+# package1.InsuredValue = package1_insure
+# shipment.RequestedShipment.TotalInsuredValue = package1_insure
+
+# Add customer reference
+# customer_reference = shipment.create_wsdl_object_of_type('CustomerReference')
+# customer_reference.CustomerReferenceType="CUSTOMER_REFERENCE"
+# customer_reference.Value = "your customer reference number"
+# package1.CustomerReferences.append(customer_reference)
+
+# Add department number
+# department_number = shipment.create_wsdl_object_of_type('CustomerReference')
+# department_number.CustomerReferenceType="DEPARTMENT_NUMBER"
+# department_number.Value = "your department number"
+# package1.CustomerReferences.append(department_number)
+
+# Add invoice number
+# invoice_number = shipment.create_wsdl_object_of_type('CustomerReference')
+# invoice_number.CustomerReferenceType="INVOICE_NUMBER"
+# invoice_number.Value = "your invoice number"
+# package1.CustomerReferences.append(invoice_number)
+
+# Add a signature option for the package using SpecialServicesRequested or comment out.
+# SpecialServiceTypes can be APPOINTMENT_DELIVERY, COD, DANGEROUS_GOODS, DRY_ICE, SIGNATURE_OPTION etc..
+package1.SpecialServicesRequested.SpecialServiceTypes = 'SIGNATURE_OPTION'
+# SignatureOptionType can be ADULT, DIRECT, INDIRECT, NO_SIGNATURE_REQUIRED, SERVICE_DEFAULT
+package1.SpecialServicesRequested.SignatureOptionDetail.OptionType = 'SERVICE_DEFAULT'
+
# Un-comment this to see the other variables you may set on a package.
-#print(package1)
+# print(package1)
# This adds the RequestedPackageLineItem WSDL object to the shipment. It
# increments the package count and total weight of the shipment for you.
@@ -120,19 +154,19 @@
# If you'd like to see some documentation on the ship service WSDL, un-comment
# this line. (Spammy).
-#print(shipment.client)
+# print(shipment.client)
# Un-comment this to see your complete, ready-to-send request as it stands
# before it is actually sent. This is useful for seeing what values you can
# change.
-#print(shipment.RequestedShipment)
-#print(shipment.ClientDetail)
-#print(shipment.TransactionDetail)
+# print(shipment.RequestedShipment)
+# print(shipment.ClientDetail)
+# print(shipment.TransactionDetail)
# If you want to make sure that all of your entered details are valid, you
# can call this and parse it just like you would via send_request(). If
# shipment.response.HighestSeverity == "SUCCESS", your shipment is valid.
-#print(shipment.send_validation_request())
+# print(shipment.send_validation_request())
# Fires off the request, sets the 'response' attribute on the object.
shipment.send_request()
@@ -140,20 +174,33 @@
# This will show the reply to your shipment being sent. You can access the
# attributes through the response attribute on the request object. This is
# good to un-comment to see the variables returned by the Fedex reply.
-print(shipment.response)
+# print(shipment.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with. Also see basic_sobject_to_dict, it's faster but lacks options.
+# from fedex.tools.conversion import sobject_to_dict
+# response_dict = sobject_to_dict(shipment.response)
+# response_dict['CompletedShipmentDetail']['CompletedPackageDetails'][0]['Label']['Parts'][0]['Image'] = ''
+# print(response_dict) # Image is empty string for display purposes.
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(shipment.response))
# Here is the overall end result of the query.
-print("HighestSeverity:", shipment.response.HighestSeverity)
+print("HighestSeverity: {}".format(shipment.response.HighestSeverity))
# Getting the tracking number from the new shipment.
-print("Tracking #:", shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].TrackingIds[0].TrackingNumber)
+print("Tracking #: {}"
+ "".format(shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].TrackingIds[0].TrackingNumber))
# Net shipping costs. Only show if available. Sometimes sandbox will not include this in the response.
CompletedPackageDetails = shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0]
if hasattr(CompletedPackageDetails, 'PackageRating'):
- print("Net Shipping Cost (US$):", CompletedPackageDetails.PackageRating.PackageRateDetails[0].NetCharge.Amount)
+ print("Net Shipping Cost (US$): {}"
+ "".format(CompletedPackageDetails.PackageRating.PackageRateDetails[0].NetCharge.Amount))
else:
- print('WARNING: Unable to get rate.')
+ print('WARNING: Unable to get shipping rate.')
# Get the label image in ASCII format from the reply. Note the list indices
# we're using. You'll need to adjust or iterate through these if your shipment
@@ -169,7 +216,7 @@
"""
# This will be the file we write the label out to.
out_path = 'example_shipment_label.%s' % GENERATE_IMAGE_TYPE.lower()
-print("Writing to file", out_path)
+print("Writing to file {}".format(out_path))
out_file = open(out_path, 'wb')
out_file.write(label_binary_data)
out_file.close()
@@ -181,18 +228,17 @@
"""
# Pipe the binary directly to the label printer. Works under Linux
# without requiring PySerial. This WILL NOT work on other platforms.
-#label_printer = open("/dev/ttyS0", "w")
-#label_printer.write(label_binary_data)
-#label_printer.close()
+# label_printer = open("/dev/ttyS0", "w")
+# label_printer.write(label_binary_data)
+# label_printer.close()
"""
This is a potential cross-platform solution using pySerial. This has not been
tested in a long time and may or may not work. For Windows, Mac, and other
platforms, you may want to go this route.
"""
-#import serial
-#label_printer = serial.Serial(0)
-#print("SELECTED SERIAL PORT: "+ label_printer.portstr)
-#label_printer.write(label_binary_data)
-#label_printer.close()
-
+# import serial
+# label_printer = serial.Serial(0)
+# print("SELECTED SERIAL PORT: "+ label_printer.portstr)
+# label_printer.write(label_binary_data)
+# label_printer.close()
diff --git a/examples/delete_shipment.py b/examples/delete_shipment.py
index f60cbf5..187dccf 100755
--- a/examples/delete_shipment.py
+++ b/examples/delete_shipment.py
@@ -3,13 +3,16 @@
This example shows how to delete existing shipments.
"""
import logging
+import sys
+
from example_config import CONFIG_OBJ
from fedex.services.ship_service import FedexDeleteShipmentRequest
+from fedex.base_service import FedexError
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
-# This is the object that will be handling our tracking request.
+# This is the object that will be handling our request.
# We're using the FedexConfig object from example_config.py in this dir.
del_request = FedexDeleteShipmentRequest(CONFIG_OBJ)
@@ -19,7 +22,7 @@
del_request.DeletionControlType = "DELETE_ALL_PACKAGES"
# The tracking number of the shipment to delete.
-del_request.TrackingId.TrackingNumber = '794798682968'
+del_request.TrackingId.TrackingNumber = '794798682968' # '111111111111' will also not delete
# What kind of shipment the tracking number used.
# Docs say this isn't required, but the WSDL won't validate without it.
@@ -27,7 +30,25 @@
del_request.TrackingId.TrackingIdType = 'EXPRESS'
# Fires off the request, sets the 'response' attribute on the object.
-del_request.send_request()
+try:
+ del_request.send_request()
+except FedexError as e:
+ if 'Unable to retrieve record' in str(e):
+ print "WARNING: Unable to delete the shipment with the provided tracking number."
+ else:
+ print(e)
# See the response printed out.
-print(del_request.response)
+# print(del_request.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.conversion import basic_sobject_to_dict
+# print(basic_sobject_to_dict(del_request.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(del_request.response))
+
+# Here is the overall end result of the query.
+print("HighestSeverity: {}".format(del_request.response.HighestSeverity))
diff --git a/examples/estimate_ground_transit_time.py b/examples/estimate_ground_transit_time.py
new file mode 100644
index 0000000..57073c1
--- /dev/null
+++ b/examples/estimate_ground_transit_time.py
@@ -0,0 +1,36 @@
+import logging
+import sys
+
+from example_config import CONFIG_OBJ
+from fedex.services.availability_commitment_service import FedexAvailabilityCommitmentRequest
+from fedex.tools.conversion import sobject_to_dict
+
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+
+avc_request = FedexAvailabilityCommitmentRequest(CONFIG_OBJ)
+
+# .StateOrProvinceCode available as well
+avc_request.Origin.PostalCode = '60634'
+avc_request.Origin.CountryCode = 'US'
+avc_request.Destination.PostalCode = '19106'
+avc_request.Destination.CountryCode = 'US'
+avc_request.Service = 'FEDEX_GROUND'
+
+avc_request.send_request()
+response_dict = sobject_to_dict(avc_request.response)
+
+# output display formatting
+origin_str = '%s, %s' % (
+ avc_request.Origin.PostalCode,
+ avc_request.Origin.CountryCode)
+destination_str = '%s, %s' % (
+ avc_request.Destination.PostalCode,
+ avc_request.Destination.CountryCode)
+
+logging.info('origin: %s' % origin_str)
+logging.info('destination: %s' % destination_str)
+for option in response_dict['Options']:
+ if option['Service'] == 'FEDEX_GROUND':
+ logging.info('TransitTime: %s' % option['TransitTime'])
+ else:
+ logging.warning('No Fedex Ground Service found.')
diff --git a/examples/example_config.py b/examples/example_config.py
index 3b57c7e..6fbcf51 100644
--- a/examples/example_config.py
+++ b/examples/example_config.py
@@ -5,6 +5,7 @@
"""
import os
import sys
+
# Use the fedex directory included in the downloaded package instead of
# any globally installed versions.
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
@@ -16,4 +17,4 @@
account_number='xxxxxxxxxxx',
meter_number='xxxxxxxxxxx',
freight_account_number='xxxxxxxxxxx',
- use_test_server=True)
\ No newline at end of file
+ use_test_server=True)
diff --git a/examples/freight_rate_request.py b/examples/freight_rate_request.py
index 43a7873..2712c02 100644
--- a/examples/freight_rate_request.py
+++ b/examples/freight_rate_request.py
@@ -9,13 +9,15 @@
is Out of Delivery Area (ODA).
"""
import logging
+import sys
+
from example_config import CONFIG_OBJ
from fedex.services.rate_service import FedexRateServiceRequest
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
-# This is the object that will be handling our tracking request.
+# This is the object that will be handling our request.
# We're using the FedexConfig object from example_config.py in this dir.
rate_request = FedexRateServiceRequest(CONFIG_OBJ)
@@ -29,7 +31,6 @@
rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightAccountNumber = CONFIG_OBJ.freight_account_number
-
# Shipper
rate_request.RequestedShipment.Shipper.AccountNumber = CONFIG_OBJ.freight_account_number
rate_request.RequestedShipment.Shipper.Contact.PersonName = 'Sender Name'
@@ -55,7 +56,7 @@
payment.Payor.ResponsibleParty = rate_request.RequestedShipment.Shipper
rate_request.RequestedShipment.ShippingChargesPayment = payment
-#include estimated duties and taxes in rate quote, can be ALL or NONE
+# include estimated duties and taxes in rate quote, can be ALL or NONE
rate_request.RequestedShipment.EdtRequestType = 'NONE'
# note: in order for this to work in test, you may need to use the
@@ -63,7 +64,8 @@
rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Contact.PersonName = 'Sender Name'
rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Contact.CompanyName = 'Some Company'
rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Contact.PhoneNumber = '9012638716'
-rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Address.StreetLines = ['2000 Freight LTL Testing']
+rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Address.StreetLines = [
+ '2000 Freight LTL Testing']
rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Address.City = 'Harrison'
rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Address.StateOrProvinceCode = 'AR'
rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Address.PostalCode = '72601'
@@ -80,7 +82,7 @@
rate_request.RequestedShipment.FreightShipmentDetail.Role = role.SHIPPER
# Designates the terms of the "collect" payment for a Freight
-#Shipment. Can be NON_RECOURSE_SHIPPER_SIGNED or STANDARD
+# Shipment. Can be NON_RECOURSE_SHIPPER_SIGNED or STANDARD
rate_request.RequestedShipment.FreightShipmentDetail.CollectTermsType = 'STANDARD'
package1_weight = rate_request.create_wsdl_object_of_type('Weight')
@@ -99,12 +101,12 @@
# If you'd like to see some documentation on the ship service WSDL, un-comment
# this line. (Spammy).
-#print(rate_request.client)
+# print(rate_request.client)
# Un-comment this to see your complete, ready-to-send request as it stands
# before it is actually sent. This is useful for seeing what values you can
# change.
-#print(rate_request.RequestedShipment)
+# print(rate_request.RequestedShipment)
# Fires off the request, sets the 'response' attribute on the object.
rate_request.send_request()
@@ -112,20 +114,28 @@
# This will show the reply to your rate_request being sent. You can access the
# attributes through the response attribute on the request object. This is
# good to un-comment to see the variables returned by the FedEx reply.
-print(rate_request.response)
+# print(rate_request.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.conversion import basic_sobject_to_dict
+# print(basic_sobject_to_dict(rate_request.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(rate_request.response))
# Here is the overall end result of the query.
-print("HighestSeverity:", rate_request.response.HighestSeverity)
+print("HighestSeverity: {}".format(rate_request.response.HighestSeverity))
# RateReplyDetails can contain rates for multiple ServiceTypes if ServiceType was set to None
for service in rate_request.response.RateReplyDetails:
for detail in service.RatedShipmentDetails:
for surcharge in detail.ShipmentRateDetail.Surcharges:
if surcharge.SurchargeType == 'OUT_OF_DELIVERY_AREA':
- print("%s: ODA rate_request charge {}".format(service.ServiceType, surcharge.Amount.Amount))
+ print("{}: ODA rate_request charge {}".format(service.ServiceType, surcharge.Amount.Amount))
for rate_detail in service.RatedShipmentDetails:
print("{}: Net FedEx Charge {} {}".format(service.ServiceType,
rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Currency,
rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Amount))
-
diff --git a/examples/location_request.py b/examples/location_request.py
new file mode 100644
index 0000000..1b349f1
--- /dev/null
+++ b/examples/location_request.py
@@ -0,0 +1,141 @@
+#!/usr/bin/env python
+"""
+This example shows how to use the FedEx Location service.
+The variables populated below represents minimum required values as
+well as those that are optional. Read comments for details.
+You will need to specify all required fields, or risk
+seeing a SchemaValidationError
+exception thrown by suds.
+
+"""
+import logging
+import sys
+
+from example_config import CONFIG_OBJ
+from fedex.services.location_service import FedexSearchLocationRequest
+from fedex.tools.conversion import sobject_to_dict
+
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+
+# This is the object that will be handling our request.
+# We're using the FedexConfig object from example_config.py in this dir.
+customer_transaction_id = "*** LocationService Request v3 using Python ***" # Optional transaction_id
+location_request = FedexSearchLocationRequest(CONFIG_OBJ, customer_transaction_id=customer_transaction_id)
+
+# Un-comment to specify the type of search and search criteria.
+# Can be ADDRESS (default), GEOGRAPHIC_COORDINATES, or PHONE_NUMBER
+# location_request.LocationsSearchCriterion = 'PHONE_NUMBER'
+
+# Un-comment when using PHONE_NUMBER search criterion.
+# location_request.PhoneNumber = '4169297819'
+
+# Un-comment when using GEOGRAPHIC_COORDINATES search criterion.
+# location_request.GeographicCoordinates = '43.6357-79.5373'
+
+# Un-comment to specify how to handle multiple matches.
+# Can be set to RETURN_ALL (default), RETURN_ERROR, or RETURN_FIRST
+# location_request.MultipleMatchesAction = 'RETURN_FIRST'
+
+
+# Un-comment to specify FedExLocationType constraint, see FedExLocationType definition.
+# Can be set to FEDEX_AUTHORIZED_SHIP_CENTER, FEDEX_EXPRESS_STATION, FEDEX_FREIGHT_SERVICE_CENTER,
+# FEDEX_GROUND_TERMINAL, FEDEX_HOME_DELIVERY_STATION, FEDEX_OFFICE, FEDEX_SELF_SERVICE_LOCATION,
+# FEDEX_SHIPSITE, or FEDEX_SMART_POST_HUB
+# location_request.Constraints.LocationTypesToInclude = ['FEDEX_SELF_SERVICE_LOCATION',
+# 'FEDEX_AUTHORIZED_SHIP_CENTER']
+
+# Un-comment to to set a maximum radius for location query.
+# This really can narrow down the location results but is not required.
+location_request.Constraints.RadiusDistance.Value = 1.5
+location_request.Constraints.RadiusDistance.Units = "KM" # KM or MI
+
+# Un-comment to specify supported redirect to hold services. Only
+# supported by certain countries,from testing only US is supported.
+# Can be FEDEX_EXPRESS, FEDEX_GROUND, or FEDEX_GROUND_HOME_DELIVERY
+# location_request.Constraints.SupportedRedirectToHoldServices = "FEDEX_GROUND"
+
+# Required even if using phone number search
+location_request.Address.PostalCode = 'M5V 1Z0'
+location_request.Address.CountryCode = 'CA'
+
+# Un-comment to set sort criteria. By default Matching locations sorted by
+# DISTANCE and LOWEST_TO_HIGHEST if no sort criteria is specified.
+# Crieterion can be LATEST_EXPRESS_DROPOFF_TIME, LATEST_GROUND_DROPOFF_TIME,
+# LOCATION_TYPE or DISTANCE (default)
+# Order can be LOWEST_TO_HIGHEST (default) or HIGHEST_TO_LOWEST
+# location_request.SortDetail.Criterion = 'LATEST_GROUND_DROPOFF_TIME'
+# location_request.SortDetail.Order = 'LOWEST_TO_HIGHEST'
+
+# If you'd like to see some documentation on the ship service WSDL, un-comment
+# this line. (Spammy).
+# print(rate_request.client)
+
+# Un-comment this to see your complete, ready-to-send request as it stands
+# before it is actually sent. This is useful for seeing what values you can
+# change.
+# print(location_request.LocationsSearchCriterion)
+
+# Fires off the request, sets the 'response' attribute on the object.
+location_request.send_request()
+
+# This will show the reply to your request being sent. You can access the
+# attributes through the response attribute on the request object. This is
+# good to un-comment to see the variables returned by the FedEx reply.
+# print(location_request.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.conversion import basic_sobject_to_dict
+# print(basic_sobject_to_dict(location_request.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(location_request.response))
+
+# Here is the overall end result of the query.
+print("HighestSeverity: {}".format(location_request.response.HighestSeverity))
+print("TotalResultsAvailable: {}".format(location_request.response.TotalResultsAvailable))
+print("ResultsReturned: {}".format(location_request.response.ResultsReturned))
+
+result = location_request.response.AddressToLocationRelationships[0]
+print("MatchedAddress: {}, {} Residential: {}".format(getattr(result.MatchedAddress, 'PostalCode', ''),
+ getattr(result.MatchedAddress, 'CountryCode', ''),
+ getattr(result.MatchedAddress, 'Residential', '')))
+print("MatchedAddressGeographicCoordinates: {}".format(result.MatchedAddressGeographicCoordinates.strip("/")))
+
+locations = result.DistanceAndLocationDetails
+for location in locations:
+ print("Distance: {}{}".format(location.Distance.Value, location.Distance.Units))
+
+ location_detail = location.LocationDetail
+ print("LocationID: {}".format(location_detail.LocationId))
+ print("StoreNumber: {}".format(location_detail.StoreNumber))
+
+ if hasattr(location_detail, 'LocationContactAndAddress'):
+ contact_and_address = location_detail.LocationContactAndAddress
+ contact_and_address = sobject_to_dict(contact_and_address)
+ print("LocationContactAndAddress Dict: {}".format(contact_and_address))
+
+ print("GeographicCoordinates {}".format(getattr(location_detail, 'GeographicCoordinates', '')))
+ print("LocationType {}".format(getattr(location_detail, 'LocationType', '')))
+
+ if hasattr(location_detail, 'Attributes'):
+ for attribute in location_detail.Attributes:
+ print("Attribute: {}".format(attribute))
+
+ print("MapUrl {}".format(getattr(location_detail, 'MapUrl', '')))
+
+ if hasattr(location_detail, 'NormalHours'):
+ for open_time in location_detail.NormalHours:
+ print("NormalHours Dict: {}".format(sobject_to_dict(open_time)))
+
+ if hasattr(location_detail, 'HoursForEffectiveDate'):
+ for effective_open_time in location_detail.HoursForEffectiveDate:
+ print("HoursForEffectiveDate Dict: {}".format(sobject_to_dict(effective_open_time)))
+
+ if hasattr(location_detail, 'CarrierDetails'):
+ for carrier_detail in location_detail.CarrierDetails:
+ print("CarrierDetails Dict: {}".format(sobject_to_dict(carrier_detail)))
+
+ print("")
diff --git a/examples/postal_inquiry.py b/examples/postal_inquiry.py
index b69e095..844c7e8 100755
--- a/examples/postal_inquiry.py
+++ b/examples/postal_inquiry.py
@@ -1,33 +1,56 @@
#!/usr/bin/env python
"""
-PostalCodeInquiryRequest classes are used to validate and receive additional
+ValidatePostalRequest classes are used to validate and receive additional
information about postal codes.
"""
import logging
from example_config import CONFIG_OBJ
-from fedex.services.package_movement import PostalCodeInquiryRequest
+from fedex.services.country_service import FedexValidatePostalRequest
# Set this to the INFO level to see the response from Fedex printed in stdout.
logging.basicConfig(level=logging.INFO)
# We're using the FedexConfig object from example_config.py in this dir.
-inquiry = PostalCodeInquiryRequest(CONFIG_OBJ)
-inquiry.PostalCode = '29631'
-inquiry.CountryCode = 'US'
+customer_transaction_id = "*** ValidatePostal Request v4 using Python ***" # Optional transaction_id
+inquiry = FedexValidatePostalRequest(CONFIG_OBJ, customer_transaction_id=customer_transaction_id)
+inquiry.Address.PostalCode = '29631'
+inquiry.Address.CountryCode = 'US'
+inquiry.Address.StreetLines = ['104 Knox Road']
+inquiry.Address.City = 'Clemson'
+inquiry.Address.StateOrProvinceCode = 'SC'
-# If you'd like to see some documentation on the ship service WSDL, un-comment
+# If you'd like to see some documentation on the country service WSDL, un-comment
# this line. (Spammy).
-#print(inquiry.client)
+# print(inquiry.client)
# Un-comment this to see your complete, ready-to-send request as it stands
# before it is actually sent. This is useful for seeing what values you can
# change.
-#print(inquiry.CarrierCode)
-#print(inquiry.ClientDetail)
-#print(inquiry.TransactionDetail)
+# print(inquiry.CarrierCode)
+# print(inquiry.Address)
+# print(inquiry.ShipDateTime)
+# print(inquiry.CheckForMismatch)
+# print(inquiry.RoutingCode)
# Fires off the request, sets the 'response' attribute on the object.
inquiry.send_request()
# See the response printed out.
print(inquiry.response)
+
+# Here is the overall end result of the query.
+print("HighestSeverity: {}".format(inquiry.response.HighestSeverity))
+print("")
+
+print("State/Province: {}".format(inquiry.response.PostalDetail.StateOrProvinceCode))
+print("City First Initial: {}".format(inquiry.response.PostalDetail.CityFirstInitials))
+print("Clean Postal Code: {}".format(inquiry.response.PostalDetail.CleanedPostalCode))
+
+for loc_description in inquiry.response.PostalDetail.LocationDescriptions:
+ print("Location ID: {}".format(loc_description.LocationId))
+ print("Location No.: {}".format(loc_description.LocationNumber))
+ print("Country Code: {}".format(loc_description.CountryCode))
+ print("Postal Code: {}".format(loc_description.PostalCode))
+ print("Service Area: {}".format(loc_description.ServiceArea))
+ print("Airport ID: {}".format(loc_description.AirportId))
+ print("FedEx Europe First Origin: {}".format(loc_description.FedExEuropeFirstOrigin))
diff --git a/examples/postal_inquiry_deprecated.py b/examples/postal_inquiry_deprecated.py
new file mode 100755
index 0000000..e721a51
--- /dev/null
+++ b/examples/postal_inquiry_deprecated.py
@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+"""
+PostalCodeInquiryRequest classes are used to validate and receive additional
+information about postal codes.
+"""
+import logging
+import sys
+import warnings
+from example_config import CONFIG_OBJ
+from fedex.services.package_movement import PostalCodeInquiryRequest
+from fedex.tools.conversion import sobject_to_dict
+
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+
+warnings.simplefilter('always', DeprecationWarning) # Show deprecation on this module in py2.7.
+
+# We're using the FedexConfig object from example_config.py in this dir.
+inquiry = PostalCodeInquiryRequest(CONFIG_OBJ)
+inquiry.PostalCode = '29631'
+inquiry.CountryCode = 'US'
+
+# If you'd like to see some documentation on the ship service WSDL, un-comment
+# this line. (Spammy).
+# print(inquiry.client)
+
+# Un-comment this to see your complete, ready-to-send request as it stands
+# before it is actually sent. This is useful for seeing what values you can
+# change.
+# print(inquiry.CarrierCode)
+# print(inquiry.ClientDetail)
+# print(inquiry.TransactionDetail)
+
+# Fires off the request, sets the 'response' attribute on the object.
+inquiry.send_request()
+
+# See the response printed out.
+# print(inquiry.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.conversion import basic_sobject_to_dict
+# print(basic_sobject_to_dict(inquiry.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(inquiry.response))
+
+# Here is the overall end result of the query.
+print("HighestSeverity: {}".format(inquiry.response.HighestSeverity))
+print("ExpressFreightContractorDeliveryArea: {}".format(sobject_to_dict(inquiry.response.ExpressDescription)))
+print("ExpressDescription: {}".format(sobject_to_dict(inquiry.response.ExpressFreightDescription)))
diff --git a/examples/rate_request.py b/examples/rate_request.py
index 35ca25d..8327851 100644
--- a/examples/rate_request.py
+++ b/examples/rate_request.py
@@ -9,14 +9,16 @@
is Out of Delivery Area (ODA).
"""
import logging
+import sys
+
from example_config import CONFIG_OBJ
from fedex.services.rate_service import FedexRateServiceRequest
+from fedex.tools.conversion import sobject_to_dict
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
-
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
-# This is the object that will be handling our tracking request.
+# This is the object that will be handling our request.
# We're using the FedexConfig object from example_config.py in this dir.
customer_transaction_id = "*** RateService Request v18 using Python ***" # Optional transaction_id
rate_request = FedexRateServiceRequest(CONFIG_OBJ, customer_transaction_id=customer_transaction_id)
@@ -39,16 +41,18 @@
rate_request.RequestedShipment.PackagingType = 'YOUR_PACKAGING'
# Shipper's address
+rate_request.RequestedShipment.Shipper.Address.StateOrProvinceCode = 'SC'
rate_request.RequestedShipment.Shipper.Address.PostalCode = '29631'
rate_request.RequestedShipment.Shipper.Address.CountryCode = 'US'
rate_request.RequestedShipment.Shipper.Address.Residential = False
# Recipient address
+rate_request.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'NC'
rate_request.RequestedShipment.Recipient.Address.PostalCode = '27577'
rate_request.RequestedShipment.Recipient.Address.CountryCode = 'US'
# This is needed to ensure an accurate rate quote with the response.
-#rate_request.RequestedShipment.Recipient.Address.Residential = True
-#include estimated duties and taxes in rate quote, can be ALL or NONE
+# rate_request.RequestedShipment.Recipient.Address.Residential = True
+# include estimated duties and taxes in rate quote, can be ALL or NONE
rate_request.RequestedShipment.EdtRequestType = 'NONE'
# Who pays for the rate_request?
@@ -62,7 +66,7 @@
package1 = rate_request.create_wsdl_object_of_type('RequestedPackageLineItem')
package1.Weight = package1_weight
-#can be other values this is probably the most common
+# can be other values this is probably the most common
package1.PhysicalPackaging = 'BOX'
# Required, but according to FedEx docs:
# "Used only with PACKAGE_GROUPS, as a count of packages within a
@@ -74,7 +78,7 @@
# The result will be found in RatedPackageDetail, with specified GroupNumber.
package1.GroupPackageCount = 1
# Un-comment this to see the other variables you may set on a package.
-#print(package1)
+# print(package1)
# This adds the RequestedPackageLineItem WSDL object to the rate_request. It
# increments the package count and total weight of the rate_request for you.
@@ -82,12 +86,12 @@
# If you'd like to see some documentation on the ship service WSDL, un-comment
# this line. (Spammy).
-#print(rate_request.client)
+# print(rate_request.client)
# Un-comment this to see your complete, ready-to-send request as it stands
# before it is actually sent. This is useful for seeing what values you can
# change.
-#print(rate_request.RequestedShipment)
+# print(rate_request.RequestedShipment)
# Fires off the request, sets the 'response' attribute on the object.
rate_request.send_request()
@@ -95,20 +99,34 @@
# This will show the reply to your rate_request being sent. You can access the
# attributes through the response attribute on the request object. This is
# good to un-comment to see the variables returned by the FedEx reply.
-#print(rate_request.response)
+# print(rate_request.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.conversion import basic_sobject_to_dict
+# print(basic_sobject_to_dict(rate_request.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(rate_request.response))
# Here is the overall end result of the query.
-print("HighestSeverity:", rate_request.response.HighestSeverity)
+print("HighestSeverity: {}".format(rate_request.response.HighestSeverity))
# RateReplyDetails can contain rates for multiple ServiceTypes if ServiceType was set to None
for service in rate_request.response.RateReplyDetails:
for detail in service.RatedShipmentDetails:
for surcharge in detail.ShipmentRateDetail.Surcharges:
if surcharge.SurchargeType == 'OUT_OF_DELIVERY_AREA':
- print("%s: ODA rate_request charge %s" % (service.ServiceType, surcharge.Amount.Amount))
+ print("{}: ODA rate_request charge {}".format(service.ServiceType, surcharge.Amount.Amount))
for rate_detail in service.RatedShipmentDetails:
- print("%s: Net FedEx Charge %s %s" % (service.ServiceType,
- rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Currency,
- rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Amount))
-
+ print("{}: Net FedEx Charge {} {}".format(service.ServiceType,
+ rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Currency,
+ rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Amount))
+
+# Check for warnings, this is also logged by the base class.
+if rate_request.response.HighestSeverity == 'NOTE':
+ for notification in rate_request.response.Notifications:
+ if notification.Severity == 'NOTE':
+ print(sobject_to_dict(notification))
diff --git a/examples/service_availability_request.py b/examples/service_availability_request.py
new file mode 100644
index 0000000..5e17367
--- /dev/null
+++ b/examples/service_availability_request.py
@@ -0,0 +1,101 @@
+#!/usr/bin/env python
+"""
+This example shows how to use the FedEx Service Validation,
+Availability and Commitment Service.
+The variables populated below represents common values.
+You will need to fill out the required values or risk seeing a SchemaValidationError
+exception thrown by suds.
+"""
+import logging
+import sys
+import datetime
+
+from example_config import CONFIG_OBJ
+from fedex.services.availability_commitment_service import FedexAvailabilityCommitmentRequest
+
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+
+# This is the object that will be handling our service availability request.
+# We're using the FedexConfig object from example_config.py in this dir.
+customer_transaction_id = "*** AvailabilityAndCommitment Request v4 using Python ***" # Optional transaction_id
+avc_request = FedexAvailabilityCommitmentRequest(CONFIG_OBJ, customer_transaction_id=customer_transaction_id)
+
+# Specify the origin postal code and country code. These fields are required.
+avc_request.Origin.PostalCode = '29631'
+avc_request.Origin.CountryCode = 'US'
+
+# Specify the destination postal code and country code. These fields are required.
+avc_request.Destination.PostalCode = '27577'
+avc_request.Destination.CountryCode = 'US'
+
+# Can be set to FEDEX_TUBE, YOUR_PACKAGING, FEDEX_BOX etc.. Defaults to YOUR_PACKAGING if not set.
+# avc_request.Packaging = 'FEDEX_ENVELOPE'
+
+# Can be set to the expected date. Defaults to today if not set.
+avc_request.ShipDate = datetime.date.today().isoformat()
+
+# Can be set to PRIORITY_OVERNIGHT, FEDEX_2_DAY, STANDARD_OVERNIGHT etc.. Defaults to showing all options if not set.
+# avc_request.Service = 'FEDEX_2_DAY'
+
+# Fires off the request, sets the 'response' attribute on the object.
+avc_request.send_request()
+
+# If you'd like to see some documentation on the ship service WSDL, un-comment this line.
+print(avc_request.client)
+
+# Un-comment this to see your complete, ready-to-send request as it stands
+# before it is actually sent. This is useful for seeing what values you can change.
+# print(avc_request.Origin)
+# print(avc_request.Destination)
+# print(avc_request.ShipDate)
+# print(avc_request.CarrierCode)
+# print(avc_request.Service)
+# print(avc_request.Packaging)
+
+# This will show the reply to your avc_request being sent. You can access the
+# attributes through the response attribute on the request object. This is
+# good to un-comment to see the variables returned by the FedEx reply.
+# print(avc_request.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.conversion import basic_sobject_to_dict
+# print(basic_sobject_to_dict(avc_request.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(basic_sobject_to_dict(avc_request.response))
+
+# Here is the overall end result of the query.
+print("HighestSeverity: {}".format(avc_request.response.HighestSeverity))
+print("")
+
+# Cycle through all the Notifications
+for notification in avc_request.response.Notifications:
+ print("Notification:")
+ print("Severity {} Source {}".format(notification.Severity, notification.Source))
+ if hasattr(notification, 'Code'):
+ print("Code {}".format(notification.Code))
+ if hasattr(notification, 'Message'):
+ print("Message {}".format(notification.Message))
+ if hasattr(notification, 'LocalizedMessage'):
+ print("LocalizedMessage {}".format(notification.LocalizedMessage))
+ print("")
+
+# Cycle through all the shipping options
+for option in avc_request.response.Options:
+ print("Ship Option:")
+ if hasattr(option, 'Service'):
+ print("Service {}".format(option.Service))
+ if hasattr(option, 'DeliveryDate'):
+ print("DeliveryDate {}".format(option.DeliveryDate))
+ if hasattr(option, 'DeliveryDay'):
+ print("DeliveryDay {}".format(option.DeliveryDay))
+ if hasattr(option, 'DestinationStationId'):
+ print("DestinationStationId {}".format(option.DestinationStationId))
+ if hasattr(option, 'DestinationAirportId'):
+ print("DestinationAirportId {}".format(option.DestinationAirportId))
+ if hasattr(option, 'TransitTime'):
+ print("TransitTime {}".format(option.TransitTime))
+ print("")
diff --git a/examples/track_shipment.py b/examples/track_shipment.py
index 1cc5b5b..1fc4b7d 100755
--- a/examples/track_shipment.py
+++ b/examples/track_shipment.py
@@ -3,11 +3,13 @@
This example shows how to track shipments.
"""
import logging
+import sys
+
from example_config import CONFIG_OBJ
from fedex.services.track_service import FedexTrackRequest
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
# NOTE: TRACKING IS VERY ERRATIC ON THE TEST SERVERS. YOU MAY NEED TO USE
# PRODUCTION KEYS/PASSWORDS/ACCOUNT #. THE TEST SERVERS OFTEN RETURN A NOT FOUND ERROR.
@@ -30,30 +32,63 @@
# If you'd like to see some documentation on the ship service WSDL, un-comment
# this line. (Spammy).
-#print(track.client)
+# print(track.client)
# Un-comment this to see your complete, ready-to-send request as it stands
# before it is actually sent. This is useful for seeing what values you can
# change.
-#print(track.SelectionDetails)
-#print(track.ClientDetail)
-#print(track.TransactionDetail)
+# print(track.SelectionDetails)
+# print(track.ClientDetail)
+# print(track.TransactionDetail)
# Fires off the request, sets the 'response' attribute on the object.
track.send_request()
-# See the response printed out.
+# This will show the reply to your track request being sent. You can access the
+# attributes through the response attribute on the request object. This is
+# good to un-comment to see the variables returned by the FedEx reply.
print(track.response)
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.conversion import basic_sobject_to_dict
+# print(basic_sobject_to_dict(track.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.conversion import sobject_to_json
+# print(sobject_to_json(track.response))
+
# Look through the matches (there should only be one for a tracking number
# query), and show a few details about each shipment.
print("== Results ==")
-#print(track.response)
for match in track.response.CompletedTrackDetails[0].TrackDetails:
- print("Tracking #:", match.TrackingNumber)
- print("Tracking # UniqueID:", match.TrackingNumberUniqueIdentifier)
- print("Status:", match.StatusDetail.Description)
- print("Status AncillaryDetails Reason:", match.StatusDetail.AncillaryDetails[-1].Reason)
- print("Status AncillaryDetails Description:", match.StatusDetail.AncillaryDetails[-1].ReasonDescription)
- print("Commit Message:", match.ServiceCommitMessage)
+ print("Tracking #: {}".format(match.TrackingNumber))
+ if hasattr(match, 'TrackingNumberUniqueIdentifier'):
+ print("Tracking # UniqueID: {}".format(match.TrackingNumberUniqueIdentifier))
+ if hasattr(match, 'StatusDetail'):
+ if hasattr(getattr(match, 'StatusDetail'), 'Description'):
+ print("Status Description: {}".format(match.StatusDetail.Description))
+ if hasattr(getattr(match, 'StatusDetail'), 'AncillaryDetails'):
+ print("Status AncillaryDetails Reason: {}".format(match.StatusDetail.AncillaryDetails[-1].Reason))
+ print("Status AncillaryDetails Description: {}"
+ "".format(match.StatusDetail.AncillaryDetails[-1].ReasonDescription))
+ if hasattr(match, 'ServiceCommitMessage'):
+ print("Commit Message: {}".format(match.ServiceCommitMessage))
+ if hasattr(match, 'Notification'):
+ print("Notification Severity: {}".format(match.Notification.Severity))
+ print("Notification Code: {}".format(match.Notification.Code))
+ print("Notification Message: {}".format(match.Notification.Message))
+ print("")
+
+ event_details = []
+ if hasattr(match, 'Events'):
+ for j in range(len(match.Events)):
+ event_match = match.Events[j]
+ event_details.append({'created': event_match.Timestamp, 'type': event_match.EventType,
+ 'description': event_match.EventDescription})
+
+ if hasattr(event_match, 'StatusExceptionDescription'):
+ event_details[j]['exception_description'] = event_match.StatusExceptionDescription
+
+ print("Event {}: {}".format(j + 1, event_details[j]))
diff --git a/fedex/__init__.py b/fedex/__init__.py
index 9526445..4610132 100644
--- a/fedex/__init__.py
+++ b/fedex/__init__.py
@@ -20,11 +20,11 @@
A note on completeness
----------------------
-python-fedex was created for use with some of my internal projects. For the
-initial release, only the things that I needed at the time were implemented.
+python-fedex was created for use with various internal projects over the years.
+Not all services are implemented but only those needed at the time were implemented.
If there is missing functionality, please report an U{issue}
-so that I may make this module more useful to others. Likewise, feel free to
-submit patches as well if you would like to help.
+so that this module can be made more useful to others. Likewise, feel free to
+submit patches and service implementations as well if you would like to help.
Getting Started
---------------
@@ -49,7 +49,7 @@
Getting Support
---------------
If you have any questions, problems, ideas, or patch submissions, please visit
-our U{Google Code project} and enter
-an issue in the U{Issue Tracker}.
+our U{Github project} and enter
+an issue in the U{Issue Tracker}.
"""
-VERSION = __version__ = '2.0.0'
+VERSION = __version__ = '2.4.1'
diff --git a/fedex/base_service.py b/fedex/base_service.py
index b1d4801..90ca7cc 100755
--- a/fedex/base_service.py
+++ b/fedex/base_service.py
@@ -12,22 +12,32 @@
import suds
from suds.client import Client
-from suds.plugin import MessagePlugin
+from suds.plugin import MessagePlugin
class GeneralSudsPlugin(MessagePlugin):
+ """
+ General Suds Plugin: Adds logging request and response functionality
+ and prunes empty WSDL objects before sending.
+ """
def __init__(self, **kwargs):
+ """Initializes the request and response loggers."""
+ self.request_logger = logging.getLogger('fedex.request')
+ self.response_logger = logging.getLogger('fedex.response')
self.kwargs = kwargs
def marshalled(self, context):
+ """Removes the WSDL objects that do not have a value before sending."""
context.envelope = context.envelope.prune()
def sending(self, context):
- logging.info("FedEx Request {}".format(context.envelope))
+ """Logs the sent request."""
+ self.request_logger.info("FedEx Request {}".format(context.envelope))
def received(self, context):
- logging.info("FedEx Response {}".format(context.reply))
+ """Logs the received response."""
+ self.response_logger.info("FedEx Response {}".format(context.reply))
class FedexBaseServiceException(Exception):
@@ -104,9 +114,14 @@ def __init__(self, config_obj, wsdl_name, *args, **kwargs):
self.logger = logging.getLogger('fedex')
"""@ivar: Python logger instance with name 'fedex'."""
+
self.config_obj = config_obj
"""@ivar: The FedexConfig object to pull auth info from."""
+ if not self._version_info:
+ self._version_info = {}
+ """#ivar: Set in each service class. Holds version info for the VersionId SOAP object."""
+
# If the config object is set to use the test server, point
# suds at the test server WSDL directory.
if config_obj.use_test_server:
@@ -117,8 +132,8 @@ def __init__(self, config_obj, wsdl_name, *args, **kwargs):
self.logger.info("Using production server.")
self.wsdl_path = os.path.join(config_obj.wsdl_path, wsdl_name)
- self.client = Client('file:///%s' % self.wsdl_path.lstrip('/'), plugins=[GeneralSudsPlugin()])
- #self.client.options.cache.clear() # Clear the cache, then re-init client when changing wsdl file.
+ self.client = Client('file:///%s' % self.wsdl_path.lstrip('/'), plugins=[GeneralSudsPlugin()], proxy=config_obj.proxy)
+ # self.client.options.cache.clear() # Clear the cache, then re-init client when changing wsdl file.
self.VersionId = None
"""@ivar: Holds details on the version numbers of the WSDL."""
@@ -147,19 +162,19 @@ def __set_web_authentication_detail(self):
"""
# Start of the authentication stuff.
- WebAuthenticationCredential = self.client.factory.create('WebAuthenticationCredential')
- WebAuthenticationCredential.Key = self.config_obj.key
- WebAuthenticationCredential.Password = self.config_obj.password
+ web_authentication_credential = self.client.factory.create('WebAuthenticationCredential')
+ web_authentication_credential.Key = self.config_obj.key
+ web_authentication_credential.Password = self.config_obj.password
# Encapsulates the auth credentials.
- WebAuthenticationDetail = self.client.factory.create('WebAuthenticationDetail')
- WebAuthenticationDetail.UserCredential = WebAuthenticationCredential
+ web_authentication_detail = self.client.factory.create('WebAuthenticationDetail')
+ web_authentication_detail.UserCredential = web_authentication_credential
# Set Default ParentCredential
- if hasattr(WebAuthenticationDetail, 'ParentCredential'):
- WebAuthenticationDetail.ParentCredential = WebAuthenticationCredential
+ if hasattr(web_authentication_detail, 'ParentCredential'):
+ web_authentication_detail.ParentCredential = web_authentication_credential
- self.WebAuthenticationDetail = WebAuthenticationDetail
+ self.WebAuthenticationDetail = web_authentication_detail
def __set_client_detail(self, *args, **kwargs):
"""
@@ -167,28 +182,28 @@ def __set_client_detail(self, *args, **kwargs):
related requests.
"""
- ClientDetail = self.client.factory.create('ClientDetail')
- ClientDetail.AccountNumber = self.config_obj.account_number
- ClientDetail.MeterNumber = self.config_obj.meter_number
- ClientDetail.IntegratorId = self.config_obj.integrator_id
- if hasattr(ClientDetail, 'Region'):
- ClientDetail.Region = self.config_obj.express_region_code
+ client_detail = self.client.factory.create('ClientDetail')
+ client_detail.AccountNumber = self.config_obj.account_number
+ client_detail.MeterNumber = self.config_obj.meter_number
+ client_detail.IntegratorId = self.config_obj.integrator_id
+ if hasattr(client_detail, 'Region'):
+ client_detail.Region = self.config_obj.express_region_code
client_language_code = kwargs.get('client_language_code', None)
client_locale_code = kwargs.get('client_locale_code', None)
- if hasattr(ClientDetail, 'Localization') and (client_language_code or client_locale_code):
- Localization = self.client.factory.create('Localization')
+ if hasattr(client_detail, 'Localization') and (client_language_code or client_locale_code):
+ localization = self.client.factory.create('Localization')
if client_language_code:
- Localization.LanguageCode = client_language_code
+ localization.LanguageCode = client_language_code
if client_locale_code:
- Localization.LocaleCode = client_locale_code
+ localization.LocaleCode = client_locale_code
- ClientDetail.Localization = Localization
+ client_detail.Localization = localization
- self.ClientDetail = ClientDetail
+ self.ClientDetail = client_detail
def __set_transaction_detail(self, *args, **kwargs):
"""
@@ -197,23 +212,23 @@ def __set_transaction_detail(self, *args, **kwargs):
customer_transaction_id = kwargs.get('customer_transaction_id', None)
if customer_transaction_id:
- TransactionDetail = self.client.factory.create('TransactionDetail')
- TransactionDetail.CustomerTransactionId = customer_transaction_id
- self.logger.debug(TransactionDetail)
- self.TransactionDetail = TransactionDetail
+ transaction_detail = self.client.factory.create('TransactionDetail')
+ transaction_detail.CustomerTransactionId = customer_transaction_id
+ self.logger.debug(transaction_detail)
+ self.TransactionDetail = transaction_detail
def __set_version_id(self):
"""
Pulles the versioning info for the request from the child request.
"""
- VersionId = self.client.factory.create('VersionId')
- VersionId.ServiceId = self._version_info['service_id']
- VersionId.Major = self._version_info['major']
- VersionId.Intermediate = self._version_info['intermediate']
- VersionId.Minor = self._version_info['minor']
- self.logger.debug(VersionId)
- self.VersionId = VersionId
+ version_id = self.client.factory.create('VersionId')
+ version_id.ServiceId = self._version_info['service_id']
+ version_id.Major = self._version_info['major']
+ version_id.Intermediate = self._version_info['intermediate']
+ version_id.Minor = self._version_info['minor']
+ self.logger.debug(version_id)
+ self.VersionId = version_id
def _prepare_wsdl_objects(self):
"""
@@ -249,17 +264,34 @@ def _check_response_for_request_errors(self):
raise FedexError(notification.Code,
notification.Message)
+ def _check_response_for_request_warnings(self):
+ """
+ Override this in a service module to check for errors that are
+ specific to that module. For example, changing state/province based
+ on postal code in a Rate Service request.
+ """
+
+ if self.response.HighestSeverity in ("NOTE", "WARNING"):
+ for notification in self.response.Notifications:
+ if notification.Severity in ("NOTE", "WARNING"):
+ self.logger.warning(FedexFailure(notification.Code,
+ notification.Message))
+
def create_wsdl_object_of_type(self, type_name):
"""
Creates and returns a WSDL object of the specified type.
+ :param type_name: specifies the object's type name from WSDL.
"""
return self.client.factory.create(type_name)
def _assemble_and_send_request(self):
"""
- This method should be over-ridden on each sub-class. It assembles all required objects
+ This method should be over-ridden on each sub-class.
+ It assembles all required objects
into the specific request object and calls send_request.
+ Objects that are not set will be pruned before sending
+ via GeneralSudsPlugin marshalled function.
"""
pass
@@ -293,10 +325,15 @@ def send_request(self, send_function=None):
# Check the response for general Fedex errors/failures that aren't
# specific to any given WSDL/request.
self.__check_response_for_fedex_error()
+
# Check the response for errors specific to the particular request.
- # This is handled by an overridden method on the child object.
+ # This method can be overridden by a method on the child class object.
self._check_response_for_request_errors()
- # Debug output.
+ # Check the response for errors specific to the particular request.
+ # This method can be overridden by a method on the child class object.
+ self._check_response_for_request_warnings()
+
+ # Debug output. (See Request and Response output)
self.logger.debug("== FEDEX QUERY RESULT ==")
self.logger.debug(self.response)
diff --git a/fedex/config.py b/fedex/config.py
index 2a82410..3b86983 100644
--- a/fedex/config.py
+++ b/fedex/config.py
@@ -19,8 +19,9 @@ class FedexConfig(object):
C{password} arguments and set the instance variables documented below
at a later time if you must.
"""
+
def __init__(self, key, password, account_number=None, meter_number=None, freight_account_number=None,
- integrator_id=None, wsdl_path=None, express_region_code=None, use_test_server=False):
+ integrator_id=None, wsdl_path=None, express_region_code=None, use_test_server=False, proxy=None):
"""
@type key: L{str}
@param key: Developer test key.
@@ -47,6 +48,10 @@ def __init__(self, key, password, account_number=None, meter_number=None, freigh
instead of the production server. You will also need to make sure
that your L{FedexConfig} object has a production account number,
meter number, authentication key, and password.
+ @type proxy: L{str}
+ @keyword proxy: Enter your list of proxy servers int the format
+ proxy = {'http': "http://......:8080", 'https': "http://.......:8080", }
+ if needed.
"""
self.key = key
"""@ivar: Developer test key."""
@@ -61,13 +66,15 @@ def __init__(self, key, password, account_number=None, meter_number=None, freigh
self.integrator_id = integrator_id
"""@ivar: Web services integrator ID."""
self.express_region_code = express_region_code
- """@icar: Web services ExpressRegionCode"""
+ """@ivar: Web services ExpressRegionCode"""
self.use_test_server = use_test_server
"""@ivar: When True, point to the test server."""
-
+ self.proxy = proxy
+ """@ivar: A list of proxy servers."""
+
# Allow overriding of the WDSL path.
if wsdl_path is None:
- self.wsdl_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),
+ self.wsdl_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),
'wsdl')
- else:
+ else: # pragma: no cover
self.wsdl_path = wsdl_path
diff --git a/fedex/printers/__init__.py b/fedex/printers/__init__.py
index 9a1dd03..ff7679f 100644
--- a/fedex/printers/__init__.py
+++ b/fedex/printers/__init__.py
@@ -7,4 +7,4 @@
shipment.send_request()
device = DirectDevicePrinter(shipment)
device.print_label()
-"""
\ No newline at end of file
+"""
diff --git a/fedex/printers/unix.py b/fedex/printers/unix.py
index 5a8516f..15dfb0a 100644
--- a/fedex/printers/unix.py
+++ b/fedex/printers/unix.py
@@ -27,7 +27,7 @@ def __init__(self, shipment, device="/dev/ttyS0"):
"""@ivar: A string with the path to the device to print to."""
self.shipment = shipment
"""@ivar: A reference to the L{FedexProcessShipmentRequest} to print."""
-
+
def print_label(self, package_num=None):
"""
Prints all of a shipment's labels, or optionally just one.
@@ -47,7 +47,7 @@ def print_label(self, package_num=None):
for package in packages:
label_binary = binascii.a2b_base64(package.Label.Parts[0].Image)
self._print_base64(label_binary)
-
+
def _print_base64(self, base64_data):
"""
Pipe the binary directly to the label printer. Works under Linux
diff --git a/fedex/services/__init__.py b/fedex/services/__init__.py
index 1dc46bb..80687cf 100644
--- a/fedex/services/__init__.py
+++ b/fedex/services/__init__.py
@@ -2,4 +2,4 @@
This module contains the wrappers around Fedex Web Service requests which you
will want to instantiate and use with a L{FedexConfig} object supplying
your static details. Each module here corresponds to a Fedex WSDL.
-"""
\ No newline at end of file
+"""
diff --git a/fedex/services/address_validation_service.py b/fedex/services/address_validation_service.py
index 8d0ec31..2f68bdf 100644
--- a/fedex/services/address_validation_service.py
+++ b/fedex/services/address_validation_service.py
@@ -1,14 +1,14 @@
"""
Address Validation Service Module
-=================================
+
This package contains the shipping methods defined by Fedex's
AddressValidationService WSDL file. Each is encapsulated in a class for
easy access. For more details on each, refer to the respective class's
documentation.
"""
-from datetime import datetime
-from .. base_service import FedexBaseService
+import datetime
+from ..base_service import FedexBaseService
class FedexAddressValidationRequest(FedexBaseService):
@@ -32,21 +32,19 @@ def __init__(self, config_obj, *args, **kwargs):
'intermediate': '0',
'minor': '0'
}
-
- # self.AddressValidationOptions = None
- """@ivar: Holds the AddressValidationOptions WSDL object."""
+
self.AddressesToValidate = []
"""@ivar: Holds the AddressToValidate WSDL object."""
# Call the parent FedexBaseService class for basic setup work.
super(FedexAddressValidationRequest, self).__init__(
- self._config_obj, 'AddressValidationService_v4.wsdl', *args, **kwargs)
-
+ self._config_obj, 'AddressValidationService_v4.wsdl', *args, **kwargs)
+
def _prepare_wsdl_objects(self):
"""
Create the data structure and get it ready for the WSDL request.
"""
pass
-
+
def _assemble_and_send_request(self):
"""
Fires off the Fedex request.
@@ -65,12 +63,12 @@ def _assemble_and_send_request(self):
self.logger.debug(self.VersionId)
# Fire off the query.
return self.client.service.addressValidation(
- WebAuthenticationDetail=self.WebAuthenticationDetail,
- ClientDetail=self.ClientDetail,
- TransactionDetail=self.TransactionDetail,
- Version=self.VersionId,
- InEffectAsOfTimestamp=datetime.now(),
- AddressesToValidate=self.AddressesToValidate)
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ InEffectAsOfTimestamp=datetime.datetime.now(),
+ AddressesToValidate=self.AddressesToValidate)
def add_address(self, address_item):
"""
diff --git a/fedex/services/availability_commitment_service.py b/fedex/services/availability_commitment_service.py
new file mode 100644
index 0000000..e1590f7
--- /dev/null
+++ b/fedex/services/availability_commitment_service.py
@@ -0,0 +1,101 @@
+"""
+Service Availability and Commitment Module
+
+This package contains the shipping methods defined by Fedex's
+ValidationAvailabilityAndCommitmentService WSDL file. Each is encapsulated in a class for
+easy access. For more details on each, refer to the respective class's
+documentation.
+"""
+
+import datetime
+from ..base_service import FedexBaseService
+
+
+class FedexAvailabilityCommitmentRequest(FedexBaseService):
+ """
+ This class allows you validate service availability
+ """
+
+ def __init__(self, config_obj, *args, **kwargs):
+ """
+ @type config_obj: L{FedexConfig}
+ @param config_obj: A valid FedexConfig object.
+ """
+
+ self._config_obj = config_obj
+ # Holds version info for the VersionId SOAP object.
+ self._version_info = {
+ 'service_id': 'vacs',
+ 'major': '8',
+ 'intermediate': '0',
+ 'minor': '0'
+ }
+
+ self.CarrierCode = None
+ """@ivar: Carrier Code Default to Fedex (FDXE), or can bbe FDXG."""
+
+ self.Origin = None
+ """@ivar: Holds Origin Address WSDL object."""
+
+ self.Destination = None
+ """@ivar: Holds Destination Address WSDL object."""
+
+ self.ShipDate = None
+ """@ivar: Ship Date date WSDL object."""
+
+ self.Service = None
+ """@ivar: Service type, if set to None will get all available service information."""
+
+ self.Packaging = None
+ """@ivar: Type of packaging to narrow down available shipping options or defaults to YOUR_PACKAGING."""
+
+ # Call the parent FedexBaseService class for basic setup work.
+ # Shortened the name of the wsdl, otherwise suds did not load it properly.
+ # Suds throws the following error when using the long file name from FedEx:
+ #
+ # File "/Library/Python/2.7/site-packages/suds/wsdl.py", line 878, in resolve
+ # raise Exception("binding '%s', not-found" % p.binding)
+ # Exception: binding 'ns:ValidationAvailabilityAndCommitmentServiceSoapBinding', not-found
+
+ super(FedexAvailabilityCommitmentRequest, self).__init__(
+ self._config_obj, 'ValidationAvailabilityAndCommitmentService_v8.wsdl', *args, **kwargs)
+
+ def _prepare_wsdl_objects(self):
+ """
+ Create the data structure and get it ready for the WSDL request.
+ """
+ self.CarrierCode = 'FDXE'
+ self.Origin = self.client.factory.create('Address')
+ self.Destination = self.client.factory.create('Address')
+ self.ShipDate = datetime.date.today().isoformat()
+ self.Service = None
+ self.Packaging = 'YOUR_PACKAGING'
+
+ def _assemble_and_send_request(self):
+ """
+ Fires off the Fedex request.
+
+ @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+ WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+ """
+
+ # We get an exception like this when specifying an IntegratorId:
+ # suds.TypeNotFound: Type not found: 'IntegratorId'
+ # Setting it to None does not seem to appease it.
+ del self.ClientDetail.IntegratorId
+ self.logger.debug(self.WebAuthenticationDetail)
+ self.logger.debug(self.ClientDetail)
+ self.logger.debug(self.TransactionDetail)
+ self.logger.debug(self.VersionId)
+ # Fire off the query.
+ return self.client.service.serviceAvailability(
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ Origin=self.Origin,
+ Destination=self.Destination,
+ ShipDate=self.ShipDate,
+ CarrierCode=self.CarrierCode,
+ Service=self.Service,
+ Packaging=self.Packaging)
diff --git a/fedex/services/country_service.py b/fedex/services/country_service.py
new file mode 100644
index 0000000..32d039e
--- /dev/null
+++ b/fedex/services/country_service.py
@@ -0,0 +1,88 @@
+"""
+Country Service Module
+
+This package contains the shipping methods defined by Fedex's
+CountryService WSDL file. Each is encapsulated in a class for
+easy access. For more details on each, refer to the respective class's
+documentation.
+"""
+
+import datetime
+from ..base_service import FedexBaseService
+
+
+class FedexValidatePostalRequest(FedexBaseService):
+ """
+ This class allows you validate an address.
+ https://www.fedex.com/us/developer/WebHelp/ws/2015/html/WebServicesHelp/WSDVG/47_Country_Service.htm
+ """
+
+ def __init__(self, config_obj, *args, **kwargs):
+ """
+ @type config_obj: L{FedexConfig}
+ @param config_obj: A valid FedexConfig object.
+ """
+
+ self._config_obj = config_obj
+ # Holds version info for the VersionId SOAP object.
+ self._version_info = {
+ 'service_id': 'cnty',
+ 'major': '8',
+ 'intermediate': '0',
+ 'minor': '0'
+ }
+
+ self.CarrierCode = None
+ """@ivar: Carrier Code Default to Fedex (FDXE), or can bbe FDXG."""
+
+ self.RoutingCode = None
+ """@ivar: Routing Code Default to FDSD."""
+
+ self.Address = None
+ """@ivar: Holds Address WSDL objects."""
+
+ self.ShipDateTime = None
+ """@ivar: Holds the ShipDateTime date time objects."""
+
+ self.CheckForMismatch = 1
+ """@ivar: Holds the CheckForMismatch boolean objects."""
+
+ super(FedexValidatePostalRequest, self).__init__(
+ self._config_obj, 'CountryService_v8.wsdl', *args, **kwargs)
+
+ def _prepare_wsdl_objects(self):
+ """
+ Create the data structure and get it ready for the WSDL request.
+ """
+ self.CarrierCode = 'FDXE'
+ self.RoutingCode = 'FDSD'
+ self.Address = self.client.factory.create('Address')
+ self.ShipDateTime = datetime.datetime.now().isoformat()
+
+ def _assemble_and_send_request(self):
+ """
+ Fires off the Fedex request.
+
+ @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+ WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+ """
+
+ # We get an exception like this when specifying an IntegratorId:
+ # suds.TypeNotFound: Type not found: 'IntegratorId'
+ # Setting it to None does not seem to appease it.
+ del self.ClientDetail.IntegratorId
+ self.logger.debug(self.WebAuthenticationDetail)
+ self.logger.debug(self.ClientDetail)
+ self.logger.debug(self.TransactionDetail)
+ self.logger.debug(self.VersionId)
+ # Fire off the query.
+ return self.client.service.validatePostal(
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ Address=self.Address,
+ ShipDateTime=self.ShipDateTime,
+ CarrierCode=self.CarrierCode,
+ CheckForMismatch=self.CheckForMismatch,
+ RoutingCode=self.RoutingCode)
diff --git a/fedex/services/document_service.py b/fedex/services/document_service.py
new file mode 100644
index 0000000..1f6446f
--- /dev/null
+++ b/fedex/services/document_service.py
@@ -0,0 +1,149 @@
+"""
+Document Service Module
+
+This package contains the shipping methods defined by Fedex's
+DocumentService WSDL file. Each is encapsulated in a class for
+easy access. For more details on each, refer to the respective class's
+documentation.
+"""
+
+import datetime
+from ..base_service import FedexBaseService
+
+
+class FedexDocumentServiceRequest(FedexBaseService):
+ """
+ This class allows you to submit the document.
+ You will need to populate the data structures in self.UploadDocumentsRequest,
+ then send the request.
+ """
+
+ def __init__(self, config_obj, *args, **kwargs):
+ """
+ The optional keyword args detailed on L{FedexBaseService}
+ apply here as well.
+ @type config_obj: L{FedexConfig}
+ @param config_obj: A valid FedexConfig object.
+ """
+
+ self._config_obj = config_obj
+
+ # Holds version info for the VersionId SOAP object.
+ self._version_info = {'service_id': 'cdus', 'major': '11',
+ 'intermediate': '0', 'minor': '0'}
+
+ self.UploadDocumentsRequest = None
+ """@ivar: Holds the UploadDocumentsRequest WSDL object including the shipper, recipient and shipt time."""
+ super(FedexDocumentServiceRequest, self).__init__(
+ self._config_obj, 'UploadDocumentService_v11.wsdl', *args, **kwargs)
+ """@ivar: Holds the express region code from the config object."""
+
+ def _prepare_wsdl_objects(self):
+ """
+ This is the data that will be used to create your shipment. Create
+ the data structure and get it ready for the WSDL request.
+ """
+ self.UploadDocumentsRequest = self.client.factory.create('UploadDocumentsRequest')
+ self.OriginCountryCode =None
+ self.DestinationCountryCode =None
+ self.Usage ='ELECTRONIC_TRADE_DOCUMENTS'#Default Usage
+ self.Documents = []
+ self.UploadDocumentsRequest.Documents = []
+ self.logger.debug(self.UploadDocumentsRequest)
+
+ def _assemble_and_send_request(self):
+ """
+ Fires off the Fedex request.
+
+ @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+ WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+ """
+
+ # Fire off the query.
+ return self.client.service.uploadDocuments(
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ Documents=self.Documents,
+ Usage = self.Usage,
+ OriginCountryCode = self.OriginCountryCode,
+ DestinationCountryCode = self.DestinationCountryCode,
+ )
+
+ def enable_post_shipment(self,trackingnumber):
+ """
+ Enable post shipment upload - when uploading docs after the shipment has been processed
+ or confirmed, you must provide the tracking number.
+ The shipment also must have been processed with the POST_SHIPMENT_UPLOAD_REQUESTED ETD attribute.
+ """
+ self.ProcessingOptions.Options = ["POST_SHIPMENT_UPLOAD"]
+ self.ProcessingOptions.PostShipmentUploadDetail.TrackingNumber = trackingnumber
+
+ def get_document(self, line_number,customer_reference,
+ document_type , file_name, document_content, expiration_date =None
+ ):
+ document_item = self.client.factory.create('UploadDocumentDetail')
+ document_item.LineNumber = line_number
+ document_item.CustomerReference = customer_reference
+ document_item.DocumentType = document_type
+ document_item.FileName = file_name
+ document_item.DocumentContent = document_content
+ document_item.ExpirationDate = expiration_date
+ return document_item
+
+ def add_documents(self, document_item):
+ self.Documents.append(document_item)
+
+
+class FedexUploadImagesRequest(FedexBaseService):
+ """
+ This class allows you to submit images.
+ You will need to add images to self.Images,
+ then send the request.
+ """
+
+ def __init__(self, config_obj, *args, **kwargs):
+ """
+ The optional keyword args detailed on L{FedexBaseService}
+ apply here as well.
+ @type config_obj: L{FedexConfig}
+ @param config_obj: A valid FedexConfig object.
+ """
+
+ self._config_obj = config_obj
+
+ # Holds version info for the VersionId SOAP object.
+ self._version_info = {'service_id': 'cdus', 'major': '11',
+ 'intermediate': '0', 'minor': '0'}
+
+ super(FedexUploadImagesRequest, self).__init__(
+ self._config_obj, 'UploadDocumentService_v11.wsdl', *args, **kwargs)
+
+ def _prepare_wsdl_objects(self):
+ """
+ This is the data that will be used to create your shipment. Create
+ the data structure and get it ready for the WSDL request.
+ """
+ self.Images = []
+
+ def _assemble_and_send_request(self):
+ """
+ Fires off the Fedex request.
+
+ @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+ WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+ """
+
+ # Fire off the query.
+ return self.client.service.uploadImages(
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ Images=self.Images,
+ )
+
+ def add_image(self, image_item):
+ self.Images.append(image_item)
+
diff --git a/fedex/services/location_service.py b/fedex/services/location_service.py
new file mode 100644
index 0000000..f7db850
--- /dev/null
+++ b/fedex/services/location_service.py
@@ -0,0 +1,102 @@
+"""
+Location Service Module
+
+This package contains the shipping methods defined by Fedex's
+LocationService WSDL file. Each is encapsulated in a class for
+easy access. For more details on each, refer to the respective class's
+documentation.
+"""
+
+from ..base_service import FedexBaseService
+
+
+class FedexSearchLocationRequest(FedexBaseService):
+ """
+ This class allows you to figure out a FedEx location closest
+ to a specified location criteria, based on location type.
+ The response includes location details like operating times,
+ directions and a map link and more.
+ """
+
+ def __init__(self, config_obj, *args, **kwargs):
+ """
+ @type config_obj: L{FedexConfig}
+ @param config_obj: A valid FedexConfig object.
+ """
+
+ self._config_obj = config_obj
+ # Holds version info for the VersionId SOAP object.
+ self._version_info = {
+ 'service_id': 'locs',
+ 'major': '9',
+ 'intermediate': '0',
+ 'minor': '0'
+ }
+
+ # Set default objects.
+ self.Address = None
+ """@ivar: Holds the Address WSDL object."""
+
+ self.PhoneNumber = None
+ """@ivar: Holds the PhoneNumber string object."""
+
+ self.MultipleMatchesAction = None
+ """@ivar: Holds the MultipleMatchesActionType WSDL object."""
+
+ self.Constraints = []
+ """@ivar: Holds a list of SearchLocationConstraints WSDL objects."""
+
+ self.LocationsSearchCriterion = None
+ """@ivar: Holds the LocationsSearchCriteriaType WSDL object."""
+
+ self.SortDetail = None
+ """@ivar: Holds the LocationSortDetail WSDL object."""
+
+ self.GeographicCoordinates = None
+ """@ivar: Holds the GeographicCoordinates WSDL object."""
+
+ super(FedexSearchLocationRequest, self).__init__(
+ self._config_obj, 'LocationsService_v9.wsdl', *args, **kwargs)
+
+ def _prepare_wsdl_objects(self):
+ """
+ Create the data structure and get it ready for the WSDL request.
+ """
+
+ # Service defaults for objects that are required.
+ self.MultipleMatchesAction = 'RETURN_ALL'
+ self.Constraints = self.create_wsdl_object_of_type('SearchLocationConstraints')
+ self.Address = self.create_wsdl_object_of_type('Address')
+ self.LocationsSearchCriterion = 'ADDRESS'
+ self.GeographicCoordinates = None
+ self.SortDetail = self.create_wsdl_object_of_type('LocationSortDetail')
+
+ def _assemble_and_send_request(self):
+ """
+ Fires off the Fedex request.
+
+ @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+ WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+ """
+
+ # We get an exception like this when specifying an IntegratorId:
+ # suds.TypeNotFound: Type not found: 'IntegratorId'
+ # Setting it to None does not seem to appease it.
+ del self.ClientDetail.IntegratorId
+ self.logger.debug(self.WebAuthenticationDetail)
+ self.logger.debug(self.ClientDetail)
+ self.logger.debug(self.TransactionDetail)
+ self.logger.debug(self.VersionId)
+ # Fire off the query.
+ return self.client.service.searchLocations(
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ LocationsSearchCriterion=self.LocationsSearchCriterion,
+ PhoneNumber=self.PhoneNumber,
+ MultipleMatchesAction=self.MultipleMatchesAction,
+ Constraints=self.Constraints,
+ Address=self.Address,
+ SortDetail=self.SortDetail,
+ GeographicCoordinates=self.GeographicCoordinates)
diff --git a/fedex/services/package_movement.py b/fedex/services/package_movement.py
index eb0faf9..3ff4f55 100755
--- a/fedex/services/package_movement.py
+++ b/fedex/services/package_movement.py
@@ -1,10 +1,11 @@
"""
Package Movement Information Service
-====================================
+
This package contains classes to check service availability, route, and postal
codes. Defined by the PackageMovementInformationService WSDL file.
"""
-import logging
+import warnings
+
from ..base_service import FedexBaseService, FedexError
@@ -41,11 +42,22 @@ def __init__(self, config_obj, postal_code=None, country_code=None, *args, **kwa
self._config_obj = config_obj
# Holds version info for the VersionId SOAP object.
- self._version_info = {'service_id': 'pmis', 'major': '4',
- 'intermediate': '0', 'minor': '0'}
+ self._version_info = {'service_id': 'pmis',
+ 'major': '4',
+ 'intermediate': '0',
+ 'minor': '0'}
+
self.PostalCode = postal_code
self.CountryCode = country_code
+ warnings.warn(
+ "Package Movement Service has been deprecated; "
+ "please use Country Service for postal code validation requests or "
+ "Availability and Commitment Service for service availability "
+ "requests instead.",
+ DeprecationWarning
+ )
+
# Call the parent FedexBaseService class for basic setup work.
super(PostalCodeInquiryRequest, self).__init__(self._config_obj,
'PackageMovementInformationService_v4.wsdl',
@@ -57,7 +69,7 @@ def _check_response_for_request_errors(self):
this WSDL.
"""
if self.response.HighestSeverity == "ERROR":
- for notification in self.response.Notifications:
+ for notification in self.response.Notifications: # pragma: no cover
if notification.Severity == "ERROR":
if "Postal Code Not Found" in notification.Message:
raise FedexPostalCodeNotFound(notification.Code,
@@ -84,6 +96,7 @@ def _assemble_and_send_request(self):
@warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES
ON FedexBaseService AND IS INHERITED.
"""
+
client = self.client
# We get an exception like this when specifying an IntegratorId:
diff --git a/fedex/services/pickup_service.py b/fedex/services/pickup_service.py
new file mode 100644
index 0000000..81fac61
--- /dev/null
+++ b/fedex/services/pickup_service.py
@@ -0,0 +1,212 @@
+from fedex.base_service import FedexBaseService
+
+
+class FedexCreatePickupRequest(FedexBaseService):
+
+ def __init__(self, config_obj, *args, **kwargs):
+ self._config_obj = config_obj
+ # Holds version info for the VersionId SOAP object.
+ self._version_info = {
+ 'service_id': 'disp',
+ 'major': '17',
+ 'intermediate': '0',
+ 'minor': '0'
+ }
+ self.OriginDetail = None
+ self.PackageCount = None
+ self.TotalWeight = None
+ self.CarrierCode = None
+ self.OversizePackageCount = None
+ self.Remarks = None
+ self.CommodityDescription = None
+ self.CountryRelationship = None
+ self.PickupServiceCategory = None
+ super(FedexCreatePickupRequest, self).__init__(self._config_obj, 'PickupService_v17.wsdl', *args, **kwargs)
+
+ def _prepare_wsdl_objects(self):
+ self.OriginDetail = self.client.factory.create('PickupOriginDetail')
+
+ self.OriginDetail.PickupLocation = self.client.factory.create('ContactAndAddress')
+ self.OriginDetail.PickupLocation.Contact = self.client.factory.create('Contact')
+ self.OriginDetail.PickupLocation.Address = self.client.factory.create('Address')
+ self.OriginDetail.PackageLocation = None
+ self.OriginDetail.BuildingPart = None
+
+ self.TotalWeight = self.client.factory.create('Weight')
+
+ self.CarrierCode = self.client.factory.create('CarrierCodeType')
+
+ self.logger.debug(self.OriginDetail)
+ self.logger.debug(self.TotalWeight)
+ self.logger.debug(self.CarrierCode)
+
+ def _assemble_and_send_request(self):
+ """
+ Fires off the Fedex request.
+
+ @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+ WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+ """
+
+ # Fire off the query.
+ return self.client.service.createPickup(
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ OriginDetail=self.OriginDetail,
+ PickupServiceCategory=self.PickupServiceCategory,
+ PackageCount=self.PackageCount,
+ TotalWeight=self.TotalWeight,
+ CarrierCode=self.CarrierCode,
+ OversizePackageCount=self.OversizePackageCount,
+ Remarks=self.Remarks,
+ CommodityDescription=self.CommodityDescription,
+ CountryRelationship=self.CountryRelationship
+ )
+
+
+class FedexPickupAvailabilityRequest(FedexBaseService):
+
+ def __init__(self, config_obj, *args, **kwargs):
+ self._config_obj = config_obj
+ # Holds version info for the VersionId SOAP object.
+ self._version_info = {
+ 'service_id': 'disp',
+ 'major': '17',
+ 'intermediate': '0',
+ 'minor': '0'
+ }
+ self.PickupType = None
+ self.AccountNumber = None
+ self.PickupAddress = None
+ self.PickupRequestType = None
+ self.DispatchDate = None
+ self.NumberOfBusinessDays = None
+ self.PackageReadyTime = None
+ self.CustomerCloseTime = None
+ self.Carriers = None
+ self.ShipmentAttributes = None
+ self.PackageDetails = None
+ super(FedexPickupAvailabilityRequest, self).__init__(self._config_obj, 'PickupService_v17.wsdl', *args, **kwargs)
+
+ def _prepare_wsdl_objects(self):
+ self.Carriers = 'FDXE'
+
+ self.AccountNumber = self.client.factory.create('AssociatedAccount')
+ self.AccountNumber.Type = None
+ self.AccountNumber.AccountNumber = None
+
+ self.PickupAddress = self.client.factory.create('Address')
+
+ self.ShipmentAttributes = self.client.factory.create('PickupShipmentAttributes')
+ self.ShipmentAttributes.ServiceType = None
+ self.ShipmentAttributes.PackagingType = None
+
+ self.ShipmentAttributes.Dimensions = self.client.factory.create('Dimensions')
+ self.ShipmentAttributes.Dimensions.Length = None
+ self.ShipmentAttributes.Dimensions.Width = None
+ self.ShipmentAttributes.Dimensions.Height = None
+ self.ShipmentAttributes.Dimensions.Units = None
+
+ self.ShipmentAttributes.Weight = self.client.factory.create('Weight')
+ self.ShipmentAttributes.Weight.Units = None
+ self.ShipmentAttributes.Weight.Value = None
+
+ self.PackageDetails = self.client.factory.create('RequestedPickupPackageDetail')
+ self.PackageDetails.PackageSpecialServices = self.client.factory.create('PickupPackageSpecialServicesRequested')
+ self.PackageDetails.Weight = self.client.factory.create('Weight')
+
+ def _assemble_and_send_request(self):
+ """
+ Fires off the Fedex request.
+
+ @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(),
+ WHICH RESIDES ON FedexBaseService AND IS INHERITED.
+ """
+
+ # Fire off the query.
+ return self.client.service.getPickupAvailability(
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ PickupType=self.PickupType,
+ AccountNumber=self.AccountNumber,
+ PickupAddress=self.PickupAddress,
+ PickupRequestType=self.PickupRequestType,
+ DispatchDate=self.DispatchDate,
+ NumberOfBusinessDays=self.NumberOfBusinessDays,
+ PackageReadyTime=self.PackageReadyTime,
+ CustomerCloseTime=self.CustomerCloseTime,
+ Carriers=self.Carriers,
+ ShipmentAttributes=self.ShipmentAttributes,
+ PackageDetails=self.PackageDetails
+ )
+
+class FedexCancelPickupRequest(FedexBaseService):
+ """
+ This class allows you to cancel a pickup request, given a dispatch confirmation number.
+ """
+
+ def __init__(self, config_obj, *args, **kwargs):
+ """
+ Cancels a pickup request via a dispatch confirmation number.
+ """
+
+ self._config_obj = config_obj
+
+ # Holds version info for the VersionId SOAP object.
+ self._version_info = {'service_id': 'disp', 'major': '17',
+ 'intermediate': '0', 'minor': '0'}
+ self.CarrierCode = None
+ self.PickupConfirmationNumber = None
+ self.ScheduledDate = None
+ self.EndDate = None
+ self.Location = None
+ self.Remarks = None
+ self.ShippingChargesPayment = None
+ self.Reason = None
+ self.ContactName = None
+ self.PhoneNumber = None
+ self.PhoneExtension = None
+ # Call the parent FedexBaseService class for basic setup work.
+ super(FedexCancelPickupRequest, self).__init__(self._config_obj,
+ 'PickupService_v17.wsdl',
+ *args, **kwargs)
+
+ def _prepare_wsdl_objects(self):
+ """
+ Preps the WSDL data structures for the user.
+ """
+
+ self.CarrierCode = self.client.factory.create('CarrierCodeType')
+ self.ShippingChargesPayment = self.client.factory.create('Payment')
+
+ def _assemble_and_send_request(self):
+ """
+ Fires off the Fedex request.
+
+ @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES
+ ON FedexBaseService AND IS INHERITED.
+ """
+
+ # Fire off the query.
+ return self.client.service.cancelPickup(
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ CarrierCode=self.CarrierCode,
+ PickupConfirmationNumber=self.PickupConfirmationNumber,
+ ScheduledDate=self.ScheduledDate,
+ EndDate=self.EndDate,
+ Location=self.Location,
+ Remarks=self.Remarks,
+ ShippingChargesPayment=self.ShippingChargesPayment,
+ Reason=self.Reason,
+ ContactName=self.ContactName,
+ PhoneNumber=self.PhoneNumber,
+ PhoneExtension=self.PhoneExtension
+ )
+
diff --git a/fedex/services/rate_service.py b/fedex/services/rate_service.py
index 7e94159..68fc684 100644
--- a/fedex/services/rate_service.py
+++ b/fedex/services/rate_service.py
@@ -1,12 +1,12 @@
"""
Rate Service Module
-===================
+
This package contains classes to request pre-ship rating information and to
determine estimated or courtesy billing quotes. Time in Transit can be
returned with the rates if it is specified in the request.
"""
-from datetime import datetime
+import datetime
from ..base_service import FedexBaseService
@@ -29,16 +29,16 @@ def __init__(self, config_obj, *args, **kwargs):
self._config_obj = config_obj
# Holds version info for the VersionId SOAP object.
- self._version_info = {'service_id': 'crs', 'major': '18',
+ self._version_info = {'service_id': 'crs', 'major': '28',
'intermediate': '0', 'minor': '0'}
self.RequestedShipment = None
- """@ivar: Holds the RequestedShipment WSDL object."""
+ """@ivar: Holds the RequestedShipment WSDL object including the shipper, recipient and shipt time."""
# Call the parent FedexBaseService class for basic setup work.
- super(FedexRateServiceRequest, self).__init__(self._config_obj,
- 'RateService_v18.wsdl',
- *args, **kwargs)
+ super(FedexRateServiceRequest, self).__init__(
+ self._config_obj, 'RateService_v28.wsdl', *args, **kwargs)
self.ClientDetail.Region = config_obj.express_region_code
+ """@ivar: Holds the express region code from the config object."""
def _prepare_wsdl_objects(self):
"""
@@ -51,38 +51,36 @@ def _prepare_wsdl_objects(self):
# This is the primary data structure for processShipment requests.
self.RequestedShipment = self.client.factory.create('RequestedShipment')
- self.RequestedShipment.ShipTimestamp = datetime.now()
+ self.RequestedShipment.ShipTimestamp = datetime.datetime.now()
- TotalWeight = self.client.factory.create('Weight')
+ # Defaults for TotalWeight wsdl object.
+ total_weight = self.client.factory.create('Weight')
# Start at nothing.
- TotalWeight.Value = 0.0
+ total_weight.Value = 0.0
# Default to pounds.
- TotalWeight.Units = 'LB'
+ total_weight.Units = 'LB'
# This is the total weight of the entire shipment. Shipments may
# contain more than one package.
- self.RequestedShipment.TotalWeight = TotalWeight
+ self.RequestedShipment.TotalWeight = total_weight
# This is the top level data structure for Shipper information.
- ShipperParty = self.client.factory.create('Party')
- ShipperParty.Address = self.client.factory.create('Address')
- ShipperParty.Contact = self.client.factory.create('Contact')
+ shipper = self.client.factory.create('Party')
+ shipper.Address = self.client.factory.create('Address')
+ shipper.Contact = self.client.factory.create('Contact')
# Link the ShipperParty to our master data structure.
- self.RequestedShipment.Shipper = ShipperParty
+ self.RequestedShipment.Shipper = shipper
# This is the top level data structure for Recipient information.
- RecipientParty = self.client.factory.create('Party')
- RecipientParty.Contact = self.client.factory.create('Contact')
- RecipientParty.Address = self.client.factory.create('Address')
-
+ recipient_party = self.client.factory.create('Party')
+ recipient_party.Contact = self.client.factory.create('Contact')
+ recipient_party.Address = self.client.factory.create('Address')
# Link the RecipientParty object to our master data structure.
- self.RequestedShipment.Recipient = RecipientParty
+ self.RequestedShipment.Recipient = recipient_party
- Payor = self.client.factory.create('Payor')
- # Grab the account number from the FedexConfig object by default.
- Payor.AccountNumber = self._config_obj.account_number
- # Assume US.
- Payor.CountryCode = 'US'
+ # Make sender responsible for payment by default.
+ self.RequestedShipment.ShippingChargesPayment = self.create_wsdl_object_of_type('Payment')
+ self.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
# Start with no packages, user must add them.
self.RequestedShipment.PackageCount = 0
@@ -102,12 +100,12 @@ def _assemble_and_send_request(self):
# Fire off the query.
return self.client.service.getRates(
- WebAuthenticationDetail=self.WebAuthenticationDetail,
- ClientDetail=self.ClientDetail,
- TransactionDetail=self.TransactionDetail,
- Version=self.VersionId,
- RequestedShipment=self.RequestedShipment,
- ReturnTransitAndCommit=self.ReturnTransitAndCommit)
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ RequestedShipment=self.RequestedShipment,
+ ReturnTransitAndCommit=self.ReturnTransitAndCommit)
def add_package(self, package_item):
"""
diff --git a/fedex/services/ship_service.py b/fedex/services/ship_service.py
index 97c976e..18a1cdd 100644
--- a/fedex/services/ship_service.py
+++ b/fedex/services/ship_service.py
@@ -1,12 +1,12 @@
"""
Ship Service Module
-===================
+
This package contains the shipping methods defined by Fedex's
ShipService WSDL file. Each is encapsulated in a class for easy access.
For more details on each, refer to the respective class's documentation.
"""
-from datetime import datetime
+import datetime
from ..base_service import FedexBaseService
@@ -31,7 +31,7 @@ def __init__(self, config_obj, *args, **kwargs):
# Holds version info for the VersionId SOAP object.
self._version_info = {
'service_id': 'ship',
- 'major': '17',
+ 'major': '26',
'intermediate': '0',
'minor': '0'
}
@@ -39,7 +39,7 @@ def __init__(self, config_obj, *args, **kwargs):
"""@ivar: Holds the RequestedShipment WSDL object."""
# Call the parent FedexBaseService class for basic setup work.
super(FedexProcessShipmentRequest, self).__init__(
- self._config_obj, 'ShipService_v17.wsdl', *args, **kwargs)
+ self._config_obj, 'ShipService_v26.wsdl', *args, **kwargs)
def _prepare_wsdl_objects(self):
"""
@@ -49,45 +49,47 @@ def _prepare_wsdl_objects(self):
# This is the primary data structure for processShipment requests.
self.RequestedShipment = self.client.factory.create('RequestedShipment')
- self.RequestedShipment.ShipTimestamp = datetime.now()
+ self.RequestedShipment.ShipTimestamp = datetime.datetime.now()
- TotalWeight = self.client.factory.create('Weight')
+ # Defaults for TotalWeight wsdl object.
+ total_weight = self.client.factory.create('Weight')
# Start at nothing.
- TotalWeight.Value = 0.0
+ total_weight.Value = 0.0
# Default to pounds.
- TotalWeight.Units = 'LB'
+ total_weight.Units = 'LB'
# This is the total weight of the entire shipment. Shipments may
# contain more than one package.
- self.RequestedShipment.TotalWeight = TotalWeight
+ self.RequestedShipment.TotalWeight = total_weight
- # This is the top level data structure for Shipper information.
- ShipperParty = self.client.factory.create('Party')
- ShipperParty.Address = self.client.factory.create('Address')
- ShipperParty.Contact = self.client.factory.create('Contact')
+ # This is the top level data structure Shipper Party information.
+ shipper_party = self.client.factory.create('Party')
+ shipper_party.Address = self.client.factory.create('Address')
+ shipper_party.Contact = self.client.factory.create('Contact')
- # Link the ShipperParty to our master data structure.
- self.RequestedShipment.Shipper = ShipperParty
+ # Link the Shipper Party to our master data structure.
+ self.RequestedShipment.Shipper = shipper_party
- # This is the top level data structure for Recipient information.
- RecipientParty = self.client.factory.create('Party')
- RecipientParty.Contact = self.client.factory.create('Contact')
- RecipientParty.Address = self.client.factory.create('Address')
+ # This is the top level data structure for RecipientParty information.
+ recipient_party = self.client.factory.create('Party')
+ recipient_party.Contact = self.client.factory.create('Contact')
+ recipient_party.Address = self.client.factory.create('Address')
# Link the RecipientParty object to our master data structure.
- self.RequestedShipment.Recipient = RecipientParty
+ self.RequestedShipment.Recipient = recipient_party
- Payor = self.client.factory.create('Payor')
+ payor = self.client.factory.create('Payor')
# Grab the account number from the FedexConfig object by default.
# Assume US.
- Payor.ResponsibleParty = self.client.factory.create('Party')
- Payor.ResponsibleParty.Address = self.client.factory.create('Address')
- Payor.ResponsibleParty.Address.CountryCode = 'US'
+ payor.ResponsibleParty = self.client.factory.create('Party')
+ payor.ResponsibleParty.Address = self.client.factory.create('Address')
+ payor.ResponsibleParty.Address.CountryCode = 'US'
- ShippingChargesPayment = self.client.factory.create('Payment')
- ShippingChargesPayment.Payor = Payor
- ShippingChargesPayment.PaymentType = 'SENDER'
+ # ShippingChargesPayment WSDL object default values.
+ shipping_charges_payment = self.client.factory.create('Payment')
+ shipping_charges_payment.Payor = payor
+ shipping_charges_payment.PaymentType = 'SENDER'
+ self.RequestedShipment.ShippingChargesPayment = shipping_charges_payment
- self.RequestedShipment.ShippingChargesPayment = ShippingChargesPayment
self.RequestedShipment.LabelSpecification = self.client.factory.create('LabelSpecification')
# NONE, PREFERRED or LIST
@@ -122,11 +124,11 @@ def _assemble_and_send_validation_request(self):
# Fire off the query.
return self.client.service.validateShipment(
- WebAuthenticationDetail=self.WebAuthenticationDetail,
- ClientDetail=self.ClientDetail,
- TransactionDetail=self.TransactionDetail,
- Version=self.VersionId,
- RequestedShipment=self.RequestedShipment)
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ RequestedShipment=self.RequestedShipment)
def _assemble_and_send_request(self):
"""
@@ -138,11 +140,11 @@ def _assemble_and_send_request(self):
# Fire off the query.
return self.client.service.processShipment(
- WebAuthenticationDetail=self.WebAuthenticationDetail,
- ClientDetail=self.ClientDetail,
- TransactionDetail=self.TransactionDetail,
- Version=self.VersionId,
- RequestedShipment=self.RequestedShipment)
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ RequestedShipment=self.RequestedShipment)
def add_package(self, package_item):
"""
@@ -175,7 +177,7 @@ def __init__(self, config_obj, *args, **kwargs):
self._config_obj = config_obj
# Holds version info for the VersionId SOAP object.
- self._version_info = {'service_id': 'ship', 'major': '17',
+ self._version_info = {'service_id': 'ship', 'major': '26',
'intermediate': '0', 'minor': '0'}
self.DeletionControlType = None
"""@ivar: Holds the DeletrionControlType WSDL object."""
@@ -183,7 +185,7 @@ def __init__(self, config_obj, *args, **kwargs):
"""@ivar: Holds the TrackingId WSDL object."""
# Call the parent FedexBaseService class for basic setup work.
super(FedexDeleteShipmentRequest, self).__init__(self._config_obj,
- 'ShipService_v17.wsdl',
+ 'ShipService_v26.wsdl',
*args, **kwargs)
def _prepare_wsdl_objects(self):
@@ -206,10 +208,10 @@ def _assemble_and_send_request(self):
client = self.client
# Fire off the query.
return client.service.deleteShipment(
- WebAuthenticationDetail=self.WebAuthenticationDetail,
- ClientDetail=self.ClientDetail,
- TransactionDetail=self.TransactionDetail,
- Version=self.VersionId,
- ShipTimestamp=datetime.now(),
- TrackingId=self.TrackingId,
- DeletionControl=self.DeletionControlType)
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ ShipTimestamp=datetime.datetime.now(),
+ TrackingId=self.TrackingId,
+ DeletionControl=self.DeletionControlType)
diff --git a/fedex/services/track_service.py b/fedex/services/track_service.py
index 6abfc46..20fb219 100644
--- a/fedex/services/track_service.py
+++ b/fedex/services/track_service.py
@@ -1,13 +1,12 @@
"""
Tracking Service Module
-=======================
+
This package contains the shipment tracking methods defined by Fedex's
TrackService WSDL file. Each is encapsulated in a class for easy access.
For more details on each, refer to the respective class's documentation.
"""
-
-from .. base_service import FedexBaseService, FedexError
+from ..base_service import FedexBaseService, FedexError
class FedexInvalidTrackingNumber(FedexError):
@@ -35,28 +34,29 @@ def __init__(self, config_obj, *args, **kwargs):
@type config_obj: L{FedexConfig}
@param config_obj: A valid FedexConfig object.
-
- @type tracking_number_unique_id: str
- @param tracking_number_unique_id: Used to distinguish duplicate FedEx tracking numbers.
"""
self._config_obj = config_obj
-
+
# Holds version info for the VersionId SOAP object.
self._version_info = {
'service_id': 'trck',
- 'major': '10',
+ 'major': '16',
'intermediate': '0',
'minor': '0'
}
self.SelectionDetails = None
- """@ivar: Holds the TrackPackageIdentifier WSDL object."""
+ """@ivar: Holds the SelectionDetails WSDL object that includes tracking type and value."""
+
+ # Set Default as None. 'INCLUDE_DETAILED_SCANS' or None
+ self.ProcessingOptions = None
+ """@ivar: Holds the TrackRequestProcessingOptionType WSDL object that defaults no None."""
# Call the parent FedexBaseService class for basic setup work.
super(FedexTrackRequest, self).__init__(
- self._config_obj, 'TrackService_v10.wsdl', *args, **kwargs)
+ self._config_obj, 'TrackService_v16.wsdl', *args, **kwargs)
self.IncludeDetailedScans = False
-
+
def _prepare_wsdl_objects(self):
"""
This sets the package identifier information. This may be a tracking
@@ -68,30 +68,27 @@ def _prepare_wsdl_objects(self):
# Default to Fedex
self.SelectionDetails.CarrierCode = 'FDXE'
- TrackPackageIdentifier = self.client.factory.create('TrackPackageIdentifier')
+ track_package_id = self.client.factory.create('TrackPackageIdentifier')
# Default to tracking number.
- TrackPackageIdentifier.Type = 'TRACKING_NUMBER_OR_DOORTAG'
+ track_package_id.Type = 'TRACKING_NUMBER_OR_DOORTAG'
- self.SelectionDetails.PackageIdentifier = TrackPackageIdentifier
-
- # Set Default as None. 'INCLUDE_DETAILED_SCANS' or None
- self.TrackRequestProcessingOptionType = None
+ self.SelectionDetails.PackageIdentifier = track_package_id
def _check_response_for_request_errors(self):
"""
Checks the response to see if there were any errors specific to
this WSDL.
"""
- if self.response.HighestSeverity == "ERROR":
+ if self.response.HighestSeverity == "ERROR": # pragma: no cover
for notification in self.response.Notifications:
if notification.Severity == "ERROR":
if "Invalid tracking number" in notification.Message:
raise FedexInvalidTrackingNumber(
- notification.Code, notification.Message)
+ notification.Code, notification.Message)
else:
raise FedexError(notification.Code, notification.Message)
-
+
def _assemble_and_send_request(self):
"""
Fires off the Fedex request.
@@ -103,10 +100,9 @@ def _assemble_and_send_request(self):
client = self.client
# Fire off the query.
return client.service.track(
- WebAuthenticationDetail=self.WebAuthenticationDetail,
- ClientDetail=self.ClientDetail,
- TransactionDetail=self.TransactionDetail,
- Version=self.VersionId,
- SelectionDetails=self.SelectionDetails,
- ProcessingOptions=self.TrackRequestProcessingOptionType)
-
+ WebAuthenticationDetail=self.WebAuthenticationDetail,
+ ClientDetail=self.ClientDetail,
+ TransactionDetail=self.TransactionDetail,
+ Version=self.VersionId,
+ SelectionDetails=self.SelectionDetails,
+ ProcessingOptions=self.ProcessingOptions)
diff --git a/fedex/tools/__init__.py b/fedex/tools/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/fedex/tools/conversion.py b/fedex/tools/conversion.py
new file mode 100644
index 0000000..f7ded41
--- /dev/null
+++ b/fedex/tools/conversion.py
@@ -0,0 +1,93 @@
+"""Response output conversion tools to help parse suds
+response object output.
+"""
+
+
+# This is the suds way of doing this, but its slower.
+# For reference only.
+# from suds.sudsobject import asdict
+# from suds.sax.text import Text
+#
+# def response_to_dict(obj):
+# """ Converts a suds object to a dictionary.
+# :param obj: object
+# :return: dictionary
+# """
+# out = {}
+# for k, v in asdict(obj).items(): # k = k.lower()
+# if hasattr(v, '__keylist__'):
+# out[k] = response_to_dict(v)
+# elif isinstance(v, list): # tuple not used
+# out[k] = []
+# for item in v:
+# if hasattr(item, '__keylist__'):
+# out[k].append(response_to_dict(item))
+# else:
+# out[k].append(
+# item.title() if isinstance(item, Text) else item)
+# else:
+# out[k] = v.title() if isinstance(v, Text) else v
+# return out
+
+
+def basic_sobject_to_dict(obj):
+ """Converts suds object to dict very quickly.
+ Does not serialize date time or normalize key case.
+ :param obj: suds object
+ :return: dict object
+ """
+ if not hasattr(obj, '__keylist__'):
+ return obj
+ data = {}
+ fields = obj.__keylist__
+ for field in fields:
+ val = getattr(obj, field)
+ if isinstance(val, list):
+ data[field] = []
+ for item in val:
+ data[field].append(basic_sobject_to_dict(item))
+ else:
+ data[field] = basic_sobject_to_dict(val)
+ return data
+
+
+def sobject_to_dict(obj, key_to_lower=False, json_serialize=False):
+ """
+ Converts a suds object to a dict. Includes advanced features.
+ :param json_serialize: If set, changes date and time types to iso string.
+ :param key_to_lower: If set, changes index key name to lower case.
+ :param obj: suds object
+ :return: dict object
+ """
+ import datetime
+
+ if not hasattr(obj, '__keylist__'):
+ if json_serialize and isinstance(obj, (datetime.datetime, datetime.time, datetime.date)):
+ return obj.isoformat()
+ else:
+ return obj
+ data = {}
+ fields = obj.__keylist__
+ for field in fields:
+ val = getattr(obj, field)
+ if key_to_lower:
+ field = field.lower()
+ if isinstance(val, list):
+ data[field] = []
+ for item in val:
+ data[field].append(sobject_to_dict(item, json_serialize=json_serialize))
+ else:
+ data[field] = sobject_to_dict(val, json_serialize=json_serialize)
+ return data
+
+
+def sobject_to_json(obj, key_to_lower=False):
+ """
+ Converts a suds object to a JSON string.
+ :param obj: suds object
+ :param key_to_lower: If set, changes index key name to lower case.
+ :return: json object
+ """
+ import json
+ data = sobject_to_dict(obj, key_to_lower=key_to_lower, json_serialize=True)
+ return json.dumps(data)
diff --git a/fedex/wsdl/CountryService_v8.wsdl b/fedex/wsdl/CountryService_v8.wsdl
new file mode 100755
index 0000000..725e4b7
--- /dev/null
+++ b/fedex/wsdl/CountryService_v8.wsdl
@@ -0,0 +1,453 @@
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Package special services prohibited for this location for operational reasons. (Other package special services may or may not be available per shipment for other reasons.)
+
+
+
+
+ Shipment special services prohibited for this location for operational reasons. (Other shipment special services may or may not be available per shipment for other reasons.)
+
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/LocationsService_v9.wsdl b/fedex/wsdl/LocationsService_v9.wsdl
new file mode 100755
index 0000000..507cfe6
--- /dev/null
+++ b/fedex/wsdl/LocationsService_v9.wsdl
@@ -0,0 +1,1120 @@
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Additional information about a physical location, such as suite number, cross street, floor number in a building. These details are not typically a part of a standard address definition; however, these details might help locate the address.
+
+
+
+
+
+
+ Indicates whether how this location can be accessed.
+
+
+
+
+ Specifies building number or name.
+
+
+
+
+ Specifies a department in the company or retail store.
+
+
+
+
+ Specifies the floor number.
+
+
+
+
+
+ Specifies apartment number.
+
+
+
+
+ Specifies the room number, if one is specified.
+
+
+
+
+
+ This is used to specify additional details about the address such as landmark. For e.g. This field is used to capture details such as an address being inside a facility such as, Chilli's Care Center, St. Jude - Inside.
+
+
+
+
+
+
+ Specifies the relationship between the address specificed and the address of the FedEx Location in terms of distance.
+
+
+
+
+ Address as provided in the request.
+
+
+
+
+ Specify the geographic co-ordinates for the matched address.
+
+
+
+
+ Specifies the distance between the matched address and the addresses of matched FedEx locations. Also specifies the details of the FedEx locations.
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This field describe a subset of the carrier's products or services which may have unique characteristics: i.e. latest drop-off times at a particular location vary depending on the destination type.
+
+
+
+
+ Specifies the details about the latest times a drop off can be made at a location most days. These are the normal drop off times.
+
+
+
+
+ Specifies the details about the exceptional latest times a drop off can be made at a location. These are drop off times that are a variation from the normal drop off times.
+
+
+
+
+ Specifies the details about the effective latest times drop off can be made at a location on the date requested. These are drop off times that are derived from the normal and exceptional drop off times, depending upon the date requested.
+
+
+
+
+
+
+
+ Specifies the special services supported at the clearance location for an individual destination country.
+
+
+
+
+ Identifies the country whose special services are specified below.
+
+
+
+
+
+ Identifies the constrained special services supported for the country above.
+
+
+
+
+
+
+ Specifies the details about the countries supported by this location.
+
+
+
+
+ Services supported for clearance
+
+
+
+
+ Identifies the type of consolidation for which these clearance location attributes were extracted.
+
+
+
+
+ Identifies the type of clearance performed at this location.
+
+
+
+
+ Identifies the constrained special services supported at this location.
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data for a point-of-contact person.
+
+
+
+
+ Client provided identifier corresponding to this contact information.
+
+
+
+
+ Identifies the contact person's name.
+
+
+
+
+ Identifies the contact person's title.
+
+
+
+
+ Identifies the company this contact is associated with.
+
+
+
+
+ Identifies the phone number associated with this contact.
+
+
+
+
+ Identifies the phone extension associated with this contact.
+
+
+
+
+ Identifies a toll free number, if any, associated with this contact.
+
+
+
+
+ Identifies the pager number associated with this contact.
+
+
+
+
+ Identifies the fax number associated with this contact.
+
+
+
+
+ Identifies the email address associated with this contact.
+
+
+
+
+
+
+ Describes relationship between origin and destination countries.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Driving or other transportation distances, distinct from dimension measurements.
+
+
+
+
+ Identifies the distance quantity.
+
+
+
+
+ Identifies the unit of measure for the distance value.
+
+
+
+
+
+
+ Specifies the location details and other information relevant to the location that is derived from the inputs provided in the request.
+
+
+
+
+ Distance between an address of a geographic location and an address of a FedEx location.
+
+
+
+
+
+ DEPRECATED as of July 2017; See locationCapabilities.
+
+
+
+
+ Details about a FedEx location such as services offered, working hours and pick and drop off times.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies a kind of FedEx facility.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the latest time by which a package can be dropped off at a FedEx location.
+
+
+
+
+
+
+ Specifies the details about the overlay to the last drop off time for a carrier at a FedEx location.
+
+
+
+
+
+
+ Specifies the reason for the overlay of the daily last drop off time for a carrier.
+
+
+
+
+
+
+
+ Specifies the time and reason to overlay the last drop off time for a carrier at a FedEx location.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ Indicates how this can be accessed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The carrier code for which this capability applies.
+
+
+
+
+
+ The service category for which this capability applies.
+
+
+
+
+ The method by which a package is transferred to the possession of a FedEx location.
+
+
+
+
+ The days of the week for which this capability applies.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes an individual location providing a set of customer service features.
+
+
+
+
+
+
+
+
+
+
+
+ Branded text associated with this location type.
+
+
+
+
+
+
+ The maximum values for various package attributes that are supported at the location.
+
+
+
+
+ Details about the clearance location.
+
+
+
+
+ Details about the FedEx administrative locations that may provide services to this location.
+
+
+
+
+
+
+
+
+ Normal operating hours for the location.
+
+
+
+
+ Operating hours for the location that are exception from the normal hours of operation.
+
+
+
+
+
+
+
+
+ Specifies the location hours for a location.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the crieteria used to filter the location search results.
+
+
+
+
+
+
+
+
+
+ Specifies the criterion to be used to sort the location details.
+
+
+
+
+
+
+
+
+
+
+ Specifies the criterion and order to be used to sort the location details.
+
+
+
+
+ Specifies the criterion to be used to sort the location details.
+
+
+
+
+ Specifies sort order of the location details.
+
+
+
+
+
+
+ Specifies sort order of the location details.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the criteria types that may be used to search for FedEx locations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Attributes about a reservation at a FedEx location.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies additional constraints on the attributes of the locations being searched.
+
+
+
+
+ Specifies value and units of the radius around the address to search for FedEx locations.
+
+
+
+
+
+ Specifies the criteria used to filter the results of locations search.
+
+
+
+
+ DEPRECATED as of July 2017; See requiredLocationCapabilities.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies total number of location results that are available.
+
+
+
+
+ Specifies the number of location results returned in this reply.
+
+
+
+
+ Specifies the address formatted to have correct postal code per USPS standards.
+
+
+
+
+ The details about the relationship between the address requested and the locations returned.
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+ Specifies the criterion that may be used to search for FedEx locations.
+
+
+
+
+ The account number of the shipper. This is the account number for which restrictions and privileges will be applied.
+
+
+
+
+ Tracking number to be used when searching for locations. This tracking number, along with other location search constraints, help to narrow the search for locations.
+
+
+
+
+
+
+
+ Specifies the criterion to be used to return location results when there are mutiple matches.
+
+
+
+
+ Specifies the details on how the location search results be sorted in the reply.
+
+
+
+
+ Contraints to be applied to location attributes.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ DEPRECATED as of July 2017.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data for the heaviness of an object.
+
+
+
+
+ Identifies the unit of measure associated with a weight value.
+
+
+
+
+ Identifies the weight value of a package/shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/PickupService_v17.wsdl b/fedex/wsdl/PickupService_v17.wsdl
new file mode 100755
index 0000000..6b4e67a
--- /dev/null
+++ b/fedex/wsdl/PickupService_v17.wsdl
@@ -0,0 +1,2413 @@
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the role that identifies the permissions the accessor of the pending shipment.
+
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration represents a kind of "legacy" account number from a FedEx operating entity.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Human readable message from dispatch system.
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+ The local date which the pickup was originally scheduled to be picked up on. The date provided is the local to the client of the request. The date specification does not include any time zone designators.
+
+
+
+
+
+
+
+
+ The reason for canceling the pickup request.
+
+
+
+
+ Identifies the name of the person that requested pickup cancellation.
+
+
+
+
+ Identifies the phone number of the person that requested pickup cancellation.
+
+
+
+
+ Identifies the phone extension of the person that requested pickup cancellation.
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+ Select the type of rate used to calculate the percentage value of variable handling.
+
+
+
+
+
+
+ Identifies the type of funds FedEx should collect upon shipment delivery.
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
+
+
+
+
+
+ Specifies the details of the charges are to be added to the COD collect amount.
+
+
+
+
+ Identifies the type of funds FedEx should collect upon package delivery
+
+
+
+
+ For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
+
+
+
+
+ When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
+
+
+
+
+ Specifies the name of person or company receiving the secured/unsecured funds payment
+
+
+
+
+ Indicates which type of reference information to include on the COD return shipping label.
+
+
+
+
+ Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data resulting from the processing of an LTL Freight pickup request.
+
+
+
+
+ Describes the origin service center handling the pickup.
+
+
+
+
+ Describes the results for each line item in the original request.
+
+
+
+
+ Total number of pieces from all line items from request.
+
+
+
+
+ Total weight from all line items from request.
+
+
+
+
+ Total handling units from all line items from request.
+
+
+
+
+ Resulting status of pickup.
+
+
+
+
+
+
+ Data resulting from the processing of an individual line item in a LTL Freight pickup request.
+
+
+
+
+ Identifies the line item, to match reply line with request line.
+
+
+
+
+ Describes the destination service center handling the delivery of this line item.
+
+
+
+
+ Total travel time for this line item.
+
+
+
+
+ Identifies estimated delivery date and time for each line item.
+
+
+
+
+
+
+ The descriptive data for a point-of-contact person.
+
+
+
+
+ Client provided identifier corresponding to this contact information.
+
+
+
+
+ Identifies the contact person's name.
+
+
+
+
+ Identifies the contact person's title.
+
+
+
+
+ Identifies the company this contact is associated with.
+
+
+
+
+ Identifies the phone number associated with this contact.
+
+
+
+
+ Identifies the phone extension associated with this contact.
+
+
+
+
+ Identifies a toll free number, if any, associated with this contact.
+
+
+
+
+ Identifies the pager number associated with this contact.
+
+
+
+
+ Identifies the fax number associated with this contact.
+
+
+
+
+ Identifies the email address associated with this contact.
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes relationship between origin and destination countries.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Coded value supplied by dispatch system.
+
+
+
+
+ Message supplied by dispatch system.
+
+
+
+
+ Package Return Program control number
+
+
+
+
+ Used with "stay late" requests; postal-code specific.
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+ Specifies the tracking number to be used for processing a pickup for a return shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+ This field is being deprecated and will not be removed in the June 2014 load.
+
+
+
+
+
+ Describes the country relationship (domestic and/or international) among the shipments being picked up.
+
+
+
+
+
+
+
+
+ Indicates the type of custom delivery being requested.
+
+
+
+
+ Time by which delivery is requested.
+
+
+
+
+ Range of dates for custom delivery request; only used if type is BETWEEN.
+
+
+
+
+ Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking id for the return, if preassigned.
+
+
+
+
+
+
+ Specifications for pup/set or vehicle delayed for loading or unloading.
+
+
+
+
+ Amount of time involved in the detention.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Driving or other transportation distances, distinct from dimension measurements.
+
+
+
+
+ Identifies the distance quantity.
+
+
+
+
+ Identifies the unit of measure for the distance value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the name associated with the email address.
+
+
+
+
+
+
+
+
+ Content of the email message.
+
+
+
+
+
+
+
+ Information describing the address of of the email recipient, role of the email recipient and languages that are requested to be supported.
+
+
+
+
+ EMail address of the recipient.
+
+
+
+
+ The relationship that the customer has to the pending shipment.
+
+
+
+
+ Specifies how the email notification for the pending shipment need to be processed.
+
+
+
+
+ Localization and language details specified by the recipient of the EMail.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to apply the localization detail to the current context.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies whether to confirm documents prior to processing a shipment with the ELECTRONIC_TRADE_DOCUMENTS special service.
+
+
+
+
+
+
+
+
+ Electronic Trade document references used with the ETD special service.
+
+
+
+
+ Specifies client's intent for whether all documents must be confirmed before shipment processing.
+
+
+
+
+
+ Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Specification for labor time spent handling shipment.
+
+
+
+
+ Total labor time.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies a kind of FedEx facility.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the optional features/characteristics requested for a Freight shipment utilizing a flatbed trailer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Date for all Freight guarantee types.
+
+
+
+
+ Time for GUARANTEED_TIME only.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contact Information of origin service center representative that authorized the pickup
+
+
+
+
+
+
+ Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the line item, to match reply line with request line.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This class describes the relationship between a customer-specified address and the FedEx Freight / FedEx National Freight Service Center that supports that address.
+
+
+
+
+ Freight Industry standard non-FedEx carrier identification
+
+
+
+
+ The name of the Interline carrier.
+
+
+
+
+ Additional time it might take at the origin or destination to pickup or deliver the freight. This is usually due to the remoteness of the location. This time is included in the total transit time.
+
+
+
+
+ Service branding which may be used for local pickup or delivery, distinct from service used for line-haul of customer's shipment.
+
+
+
+
+ Distance between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
+
+
+
+
+ Time to travel between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
+
+
+
+
+ Specifies when/how the customer can arrange for pickup or delivery.
+
+
+
+
+ Specifies days of operation if localServiceScheduling is LIMITED.
+
+
+
+
+ Freight service center that is a gateway on the border of Canada or Mexico.
+
+
+
+
+ Alphabetical code identifying a Freight Service Center
+
+
+
+
+ Freight service center Contact and Address
+
+
+
+
+
+
+ Specifies the type of service scheduling offered from a Freight or National Freight Service Center to a customer-supplied address.
+
+
+
+
+
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+
+
+
+
+ Indicates which kind of hazardous content is being reported.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the source of regulation for hazardous commodity data.
+
+
+
+
+
+
+
+
+
+
+
+
+ Contact phone number for recipient of shipment.
+
+
+
+
+ Contact and address of FedEx facility at which shipment is to be held.
+
+
+
+
+ Type of facility at which package/shipment is to be held.
+
+
+
+
+ Location identification (for facilities identified by an alphanumeric location code).
+
+
+
+
+ Location identification (for facilities identified by an numeric location code).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ Specification for marking or tagging of pieces in shipment.
+
+
+
+
+ Number of pieces to be marked or tagged by FedEx.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for services performed during non-business hours and/or days.
+
+
+
+
+ Total number of person days for full non-business days.
+
+
+
+
+ Total number of person hours (whole or partial hours) for non-business hours.
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Indicates the type of notification that will be sent.
+
+
+
+
+ Specifies the email notification details.
+
+
+
+
+ Specifies the fax notification details.
+
+
+
+
+ Specifies the SMS notification details.
+
+
+
+
+ Specifies the localization for this notification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifications for pallets to be shrinkwrapped as part of a Freight shipment.
+
+
+
+
+ Number of pallets to be shrinkwrapped.
+
+
+
+
+
+
+ Specifications for pallets to be provided on Freight shipment.
+
+
+
+
+ Number of pallets to be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This information describes the kind of pending shipment being requested.
+
+
+
+
+
+ Date after which the pending shipment will no longer be available for completion.
+
+
+
+
+ Only used with type of EMAIL.
+
+
+
+
+
+ These are documents that are recommended to be included with the shipment.
+
+
+
+
+ Upload document details provided by the initator of the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies whether the close time is specified by the customer or is the default time.
+
+
+
+
+ Close time corresponding to the above specified type
+
+
+
+
+
+ Local time of the service center that will service the pickup
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+ Identifies the account number for Freight Pickup Availability
+
+
+
+
+
+
+
+ Number of business days to consider when checking availability.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes the regulation type the pickup dangerous goods.
+
+
+
+
+
+ Specifies the option types of the pickup dangerous goods.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ FedEx USE ONLY (with IVR client)
+
+
+
+
+
+
+
+
+
+
+ FedEx IVR Only. Customer is willing to stay late for pickup.
+
+
+
+
+ FedEx USE ONLY (with IVR client)
+
+
+
+
+ FedEx IVR Only
+
+
+
+
+ Alternate postal code tied to pickup location (European pickups)
+
+
+
+
+ FedEx USE ONLY
+
+
+
+
+ FedEx USE ONLY (with IVR client)
+
+
+
+
+
+ Applies only to Europe
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether residential pickup is available for the requested postal code.
+
+
+
+
+ Describes the country relationship (domestic and/or international) among the shipments being picked up.
+
+
+
+
+
+
+ Specifies the service category for the pick up being scheduled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values indicate the type of pickup being requested.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
+
+
+
+
+
+
+
+ Type of documents that are recommended to be included with the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking number of the master associated with the return shipment.
+
+
+
+
+
+
+
+ These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for assembly performed on shipment.
+
+
+
+
+ Number of pieces or packages to be assembled
+
+
+
+
+ Total weight of pieces or packages to be assembled
+
+
+
+
+
+
+ Shipment-level totals of dry ice data across all packages.
+
+
+
+
+ Total number of packages in the shipment that contain dry ice.
+
+
+
+
+ Total shipment dry ice weight for all packages.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ The types of all special services requested for the enclosing shipment (or other shipment-level transaction).
+
+
+
+
+
+
+
+ This replaces eMailNotificationDetail
+
+
+
+
+
+ This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
+
+
+
+
+
+
+
+
+
+
+ Electronic Trade document references.
+
+
+
+
+ Specification for labor to be performed with the shipment.
+
+
+
+
+ Specifications for pallets to be shrinkwrapped as part of a Freight shipment.
+
+
+
+
+ Specifications for pallets to be provided on Freight shipment.
+
+
+
+
+ Specifications for pup/set or vehicle delayed for loading or unloading.
+
+
+
+
+ Specification for marking or tagging of pieces in shipment.
+
+
+
+
+ Specification for services performed during non-business hours and/or days.
+
+
+
+
+ Specification for assembly performed on shipment.
+
+
+
+
+ Specification for sorting and/or segregating performed on shipment.
+
+
+
+
+ Specification for special equipment used in loading/unloading shipment.
+
+
+
+
+ Specification for storage provided for shipment.
+
+
+
+
+ Specification for weighing services provided for shipment.
+
+
+
+
+ Specification for date or range of dates on which delivery is to be attempted.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for sorting and/or segregating performed on shipment.
+
+
+
+
+ Number of pieces or packages to be sorted/segregated
+
+
+
+
+ Total weight of pieces or packages to be sorted/segregated
+
+
+
+
+
+
+ Specification for special equipment used in loading/unloading shipment.
+
+
+
+
+ Contains an entry for each type of special equipment used with shipment
+
+
+
+
+
+
+ Specifies the usage of a single type of special equipment while loading/unloading a shipment
+
+
+
+
+ Type of equipment used
+
+
+
+
+ Total amount of time the equipment was used
+
+
+
+
+
+
+ Identifies types of special equipment used in loading/unloading Freight shipments
+
+
+
+
+
+
+
+ Specification for storage provided for shipment.
+
+
+
+
+ Total time shipment is held by carrier.
+
+
+
+
+
+
+
+
+
+
+ Identifies the usage of Tax Identification Number in Shipment processing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ For use with SmartPost tracking IDs only
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the date until which the document is available
+
+
+
+
+
+
+ Specifies the application that is responsible for managing the document id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Description of the uploaded document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies a single type of weighing performed on a shipment
+
+
+
+
+ Type of scale used
+
+
+
+
+
+
+ Identifies types of scales used in weighing Freight shipments
+
+
+
+
+
+
+
+
+ The descriptive data for the heaviness of an object.
+
+
+
+
+ Identifies the unit of measure associated with a weight value.
+
+
+
+
+ Identifies the weight value of a package/shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/RateService_v18.wsdl b/fedex/wsdl/RateService_v28.wsdl
old mode 100755
new mode 100644
similarity index 93%
rename from fedex/wsdl/RateService_v18.wsdl
rename to fedex/wsdl/RateService_v28.wsdl
index ba05949..1f318dd
--- a/fedex/wsdl/RateService_v18.wsdl
+++ b/fedex/wsdl/RateService_v28.wsdl
@@ -1,4944 +1,5058 @@
-
-
-
-
-
-
-
- Specifies the role that identifies the permissions the accessor of the pending shipment.
-
-
-
-
-
-
-
-
- Specifies additional labels to be produced. All required labels for shipments will be produced without the need to request additional labels. These are only available as thermal labels.
-
-
-
-
- The type of additional labels to return.
-
-
-
-
- The number of this type label to return
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
-
-
-
-
- Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
-
-
-
-
- Name of city, town, etc.
-
-
-
-
- Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
-
-
-
-
- Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
-
-
-
-
- Relevant only to addresses in Puerto Rico.
-
-
-
-
- The two-letter code used to identify a country.
-
-
-
-
- The fully spelt out name of a country.
-
-
-
-
- Indicates whether this address residential (as opposed to commercial).
-
-
-
-
-
-
- Specifies details for a package containing alcohol
-
-
-
-
- The license type that the recipient of the alcohol package.
-
-
-
-
-
-
- Specifies the type of license that the recipient of the alcohol shipment has.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identification of the type of barcode (symbology) used on FedEx documents and labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identification of a FedEx operating company (transportation).
-
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the type of brokerage to be applied to a shipment.
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for the client submitting a transaction.
-
-
-
-
- The FedEx account number associated with this transaction.
-
-
-
-
- This number is assigned by FedEx and identifies the unique device from which the request is originating
-
-
-
-
- Only used in transactions which require identification of the FedEx Office integrator.
-
-
-
-
- Indicates the region from which the transaction is submitted.
-
-
-
-
- The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
- Identifies the type of funds FedEx should collect upon shipment delivery.
-
-
-
-
-
-
-
-
-
- Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
-
-
-
-
-
- Specifies the details of the charges are to be added to the COD collect amount.
-
-
-
-
- Identifies the type of funds FedEx should collect upon package delivery
-
-
-
-
- For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
-
-
-
-
- When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
-
-
-
-
- Specifies the name of person or company receiving the secured/unsecured funds payment
-
-
-
-
- Indicates which type of reference information to include on the COD return shipping label.
-
-
-
-
- Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through the FedEx Systems. Customers are responsible for printing their own Commercial Invoice.If you would likeFedEx to generate a Commercial Invoice and transmit it to Customs. for clearance purposes, you need to specify that in the ShippingDocumentSpecification element. If you would like a copy of the Commercial Invoice that FedEx generated returned to you in reply it needs to be specified in the ETDDetail/RequestedDocumentCopies element. Commercial Invoice support consists of maximum of 99 commodity line items.
-
-
-
-
- Any comments that need to be communicated about this shipment.
-
-
-
-
- Any freight charges that are associated with this shipment.
-
-
-
-
- Any taxes or miscellaneous charges(other than Freight charges or Insurance charges) that are associated with this shipment.
-
-
-
-
- Specifies which kind of charge is being recorded in the preceding field.
-
-
-
-
- Any packing costs that are associated with this shipment.
-
-
-
-
- Any handling costs that are associated with this shipment.
-
-
-
-
- Free-form text.
-
-
-
-
- Free-form text.
-
-
-
-
- Free-form text.
-
-
-
-
- The reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.
-
-
-
-
- Name of the International Expert that completed the Commercial Invoice different from Sender.
-
-
-
-
- Required for dutiable international Express or Ground shipments. This field is not applicable to an international PIB(document) or a non-document which does not require a Commercial Invoice.
-
-
-
-
-
-
- The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
-
-
-
-
-
- Specifies the usage and identification of a customer supplied image to be used on this document.
-
-
-
-
-
-
- Information about the transit time and delivery commitment date and time.
-
-
-
-
- The Commodity applicable to this commitment.
-
-
-
-
- The FedEx service type applicable to this commitment.
-
-
-
-
- Shows the specific combination of service options combined with the service type that produced this committment in the set returned to the caller.
-
-
-
-
- Supporting detail for applied options identified in preceding field.
-
-
-
-
-
-
- THe delivery commitment date/time. Express Only.
-
-
-
-
- The delivery commitment day of the week.
-
-
-
-
- The number of transit days; applies to Ground and LTL Freight; indicates minimum transit time for SmartPost.
-
-
-
-
- Maximum number of transit days, for SmartPost shipments.
-
-
-
-
- The service area code for the destination of this shipment. Express only.
-
-
-
-
- The address of the broker to be used for this shipment.
-
-
-
-
- The FedEx location identifier for the broker.
-
-
-
-
- The delivery commitment date/time the shipment will arrive at the border.
-
-
-
-
- The delivery commitment day of the week the shipment will arrive at the border.
-
-
-
-
- The number of days it will take for the shipment to make it from broker to destination
-
-
-
-
- The delivery commitment date for shipment served by GSP (Global Service Provider)
-
-
-
-
- The delivery commitment day of the week for the shipment served by GSP (Global Service Provider)
-
-
-
-
- Messages concerning the ability to provide an accurate delivery commitment on an International commit quote. These could be messages providing information about why a commitment could not be returned or a successful message such as "REQUEST COMPLETED"
-
-
-
-
- Messages concerning the delivery commitment on an International commit quote such as "0:00 A.M. IF NO CUSTOMS DELAY"
-
-
-
-
- Information about why a shipment delivery is delayed and at what level (country/service etc.).
-
-
-
-
-
- Required documentation for this shipment.
-
-
-
-
- Freight origin and destination city center information and total distance between origin and destination city centers.
-
-
-
-
-
-
- The type of delay this shipment will encounter.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This field is used for enterprise transactions.
-
-
-
-
-
- Contains only additional quantitative information other than weight and quantity to calculate duties and taxes.
-
-
-
-
-
-
- Defines additional characteristic of commodity used to calculate duties and taxes
-
-
-
-
-
-
-
-
- All data required for this commodity in NAFTA Certificate of Origin.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Uniquely identifies a consolidation, which is a logical container for a collection of shipments.
-
-
-
-
- Specifies the type of consolidation.
-
-
-
-
- Uniquely identifies the consolidation, within a given type and date.
-
-
-
-
- The date on which the consolidation was created.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data for a point-of-contact person.
-
-
-
-
- Client provided identifier corresponding to this contact information.
-
-
-
-
- Identifies the contact person's name.
-
-
-
-
- Identifies the contact person's title.
-
-
-
-
- Identifies the company this contact is associated with.
-
-
-
-
- Identifies the phone number associated with this contact.
-
-
-
-
- Identifies the phone extension associated with this contact.
-
-
-
-
- Identifies a toll free number, if any, associated with this contact.
-
-
-
-
- Identifies the pager number associated with this contact.
-
-
-
-
- Identifies the fax number associated with this contact.
-
-
-
-
- Identifies the email address associated with this contact.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The currency code for the original (converted FROM) currency.
-
-
-
-
- The currency code for the final (converted INTO) currency.
-
-
-
-
- Multiplier used to convert fromCurrency units to intoCurrency units.
-
-
-
-
-
-
-
-
- Indicates the type of custom delivery being requested.
-
-
-
-
- Time by which delivery is requested.
-
-
-
-
- Range of dates for custom delivery request; only used if type is BETWEEN.
-
-
-
-
- Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce a custom-specified document, either at shipment or package level.
-
-
-
-
- Common information controlling document production.
-
-
-
-
- Applicable only to documents produced on thermal printers with roll stock.
-
-
-
-
- Applicable only to documents produced on thermal printers with roll stock.
-
-
-
-
- Identifies the formatting specification used to construct this custom document.
-
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified barcode symbology.
-
-
-
-
-
-
-
-
- Width of thinnest bar/space element in the barcode.
-
-
-
-
-
-
-
- Solid (filled) rectangular area on label.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Image to be included from printer's memory, or from a local file for offline clients.
-
-
-
-
-
- Printer-specific index of graphic image to be printed.
-
-
-
-
- Fully-qualified path and file name for graphic image to be printed.
-
-
-
-
-
-
-
-
- Horizontal position, relative to left edge of custom area.
-
-
-
-
- Vertical position, relative to top edge of custom area.
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
-
-
-
-
-
-
-
-
-
- Printer-specific font name for use with thermal printer labels.
-
-
-
-
- Generic font name for use with plain paper labels.
-
-
-
-
- Generic font size for use with plain paper labels.
-
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
-
-
-
-
-
-
-
- Printer-specific font name for use with thermal printer labels.
-
-
-
-
- Generic font name for use with plain paper labels.
-
-
-
-
- Generic font size for use with plain paper labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Allows customer-specified control of label content.
-
-
-
-
- If omitted, no doc tab will be produced (i.e. default is former NONE type).
-
-
-
-
- Controls the position of the customer specified content relative to the FedEx portion.
-
-
-
-
-
-
- Controls which data/sections will be suppressed.
-
-
-
-
- For customers producing their own Ground labels, this field specifies which secondary barcode will be printed on the label; so that the primary barcode produced by FedEx has the correct SCNC.
-
-
-
-
-
-
- Controls the number of additional copies of supplemental labels.
-
-
-
-
- This value reduces the default quantity of destination/consignee air waybill labels. A value of zero indicates no change to default. A minimum of one copy will always be produced.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interacts both with properties of the shipment and contractual relationship with the shipper.
-
-
-
-
-
-
- Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
-
-
-
-
-
-
-
- Identifies responsibilities with respect to loss, damage, etc.
-
-
-
-
- Documents amount paid to third party for coverage of shipment content.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies additional description about customs options. This is a required field when the customs options type is "OTHER".
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Describes an approved container used to package dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container.
-
-
-
-
- Indicates whether there are additional inner receptacles within this container.
-
-
-
-
- Indicates the type of this dangerous goods container, as specified by the IATA packing instructions. For example, steel cylinder, fiberboard box, plastic jerrican and steel drum.
-
-
-
-
- Indicates the packaging type of the container used to package the radioactive materials.
-
-
-
-
- Indicates the number of occurrences of this container with identical dangerous goods configuration.
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current container.
-
-
-
-
-
-
-
-
-
-
- Shipment is packaged/documented for movement ONLY on cargo aircraft.
-
-
-
-
- Indicates which kinds of hazardous content are in the current package.
-
-
-
-
- Indicates whether there is additional customer provided packaging enclosing the approved dangerous goods containers.
-
-
-
-
- Identifies the configuration of this dangerous goods package. The common configuration is represented at the shipment level.
-
-
-
-
- Indicates one or more containers used to pack dangerous goods commodities.
-
-
-
-
- Description of the packaging of this commodity, suitable for use on OP-900 and OP-950 forms.
-
-
-
-
- Name, title and place of the signatory for this shipment.
-
-
-
-
- Telephone number to use for contact in the event of an emergency.
-
-
-
-
- Offeror's name or contract number, per DOT regulation.
-
-
-
-
- Specifies the contact of the party responsible for handling the infectious substances, if any, in the dangerous goods shipment.
-
-
-
-
- Specifies additional handling information for the current package.
-
-
-
-
- Specifies the radioactivity detail for the current package, if the package contains radioactive materials.
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the 1421c form for dangerous goods shipment.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
- Specifies that name, title and place of the signatory responsible for the dangerous goods shipment.
-
-
-
-
-
-
- Indicates the place where the form is signed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Information about why a shipment delivery is delayed and at what level( country/service etc.).
-
-
-
-
- The date of the delay
-
-
-
-
-
- The attribute of the shipment that caused the delay(e.g. Country, City, LocationId, Zip, service area, special handling )
-
-
-
-
- The point where the delay is occurring (e.g. Origin, Destination, Broker location)
-
-
-
-
- The reason for the delay (e.g. holiday, weekend, etc.).
-
-
-
-
- The name of the holiday in that country that is causing the delay.
-
-
-
-
-
-
- The attribute of the shipment that caused the delay(e.g. Country, City, LocationId, Zip, service area, special handling )
-
-
-
-
-
-
-
-
-
-
-
-
-
- The point where the delay is occurring ( e.g. Origin, Destination, Broker location).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking id for the return, if preassigned.
-
-
-
-
-
-
- Data required to complete the Destionation Control Statement for US exports.
-
-
-
-
-
- Comma-separated list of up to four country codes, required for DEPARTMENT_OF_STATE statement.
-
-
-
-
- Name of end user, required for DEPARTMENT_OF_STATE statement.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Driving or other transportation distances, distinct from dimension measurements.
-
-
-
-
- Identifies the distance quantity.
-
-
-
-
- Identifies the unit of measure for the distance value.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Content of the email message.
-
-
-
-
-
-
-
- Information describing email notifications that will be sent in relation to events that occur during package movement
-
-
-
-
- A message that will be included in the email notifications
-
-
-
-
- Information describing the destination of the email, format of the email and events to be notified on
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The format of the email
-
-
-
-
-
-
-
-
-
-
-
- Identifies the relationship this email recipient has to the shipment.
-
-
-
-
- The email address to send the notification to
-
-
-
-
- The types of email notifications being requested for this recipient.
-
-
-
-
- The format of the email notification.
-
-
-
-
- The language/locale to be used in this email notification.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Information describing the address of of the email recipient, role of the email recipient and languages that are requested to be supported.
-
-
-
-
- EMail address of the recipient.
-
-
-
-
- The relationship that the customer has to the pending shipment.
-
-
-
-
- Specifies how the email notification for the pending shipment need to be processed.
-
-
-
-
- Localization and language details specified by the recipient of the EMail.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Customer-declared value, with data type and legal values depending on excise condition, used in defining the taxable value of the item.
-
-
-
-
-
-
- Specifies the types of Estimated Duties and Taxes to be included in a rate quotation for an international shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how to apply the localization detail to the current context.
-
-
-
-
-
-
-
- Electronic Trade document references used with the ETD special service.
-
-
-
-
- Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
-
-
-
-
-
-
-
- The instructions indicating how to print the Export Declaration.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
-
-
-
- General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates a FedEx Express operating region.
-
-
-
-
-
-
-
-
-
-
-
- Identifies a kind of FedEx facility.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the optional features/characteristics requested for a Freight shipment utilizing a flatbed trailer.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce the Freight handling-unit-level address labels. Note that the number of UNIQUE labels (the N as in 1 of N, 2 of N, etc.) is determined by total handling units.
-
-
-
-
-
- Indicates the number of copies to be produced for each unique label.
-
-
-
-
- Specifies the quadrant of the page on which the label printing will start.
-
-
-
-
- If omitted, no doc tab will be produced (i.e. default = former NONE type).
-
-
-
-
- Controls the position of the customer specified content relative to the FedEx portion.
-
-
-
-
-
-
-
- Individual charge which contributes to the total base charge for the shipment.
-
-
-
-
- Freight class for this line item.
-
-
-
-
- Effective freight class used for rating this line item.
-
-
-
-
- NMFC Code for commodity.
-
-
-
-
- Customer-provided description for this commodity or class line.
-
-
-
-
- Weight for this commodity or class line.
-
-
-
-
- Rate or factor applied to this line item.
-
-
-
-
- Identifies the manner in which the chargeRate for this line item was applied.
-
-
-
-
- The net or extended charge for this line item.
-
-
-
-
-
-
- Specifies the way in which base charges for a Freight shipment or shipment leg are calculated.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These values represent the industry-standard freight classes used for FedEx Freight and FedEx National Freight shipment description. (Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms.)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Information about the Freight Service Centers associated with this shipment.
-
-
-
-
- Information about the origin Freight Service Center.
-
-
-
-
- Information about the destination Freight Service Center.
-
-
-
-
- The distance between the origin and destination FreightService Centers
-
-
-
-
-
-
-
-
-
- Date for all Freight guarantee types.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies responsibilities with respect to loss, damage, etc.
-
-
-
-
-
-
-
-
- Rate data specific to FedEx Freight or FedEx National Freight services.
-
-
-
-
- A unique identifier for a specific rate quotation.
-
-
-
-
- Specifies whether the rate quote was automated or manual.
-
-
-
-
- Specifies how total base charge is determined.
-
-
-
-
- Freight charges which accumulate to the total base charge for the shipment.
-
-
-
-
- Human-readable descriptions of additional information on this shipment rating.
-
-
-
-
-
-
- Additional non-monetary data returned with Freight rates.
-
-
-
-
- Unique identifier for notation.
-
-
-
-
- Human-readable explanation of notation.
-
-
-
-
-
-
- Specifies the type of rate quote
-
-
-
-
-
-
-
-
- This class describes the relationship between a customer-specified address and the FedEx Freight / FedEx National Freight Service Center that supports that address.
-
-
-
-
- Freight Industry standard non-FedEx carrier identification
-
-
-
-
- The name of the Interline carrier.
-
-
-
-
- Additional time it might take at the origin or destination to pickup or deliver the freight. This is usually due to the remoteness of the location. This time is included in the total transit time.
-
-
-
-
- Service branding which may be used for local pickup or delivery, distinct from service used for line-haul of customer's shipment.
-
-
-
-
- Distance between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
-
-
-
-
- Time to travel between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
-
-
-
-
- Specifies when/how the customer can arrange for pickup or delivery.
-
-
-
-
- Specifies days of operation if localServiceScheduling is LIMITED.
-
-
-
-
- Freight service center that is a gateway on the border of Canada or Mexico.
-
-
-
-
- Alphabetical code identifying a Freight Service Center
-
-
-
-
- Freight service center Contact and Address
-
-
-
-
-
-
- Specifies the type of service scheduling offered from a Freight or National Freight Service Center to a customer-supplied address.
-
-
-
-
-
-
-
-
-
- Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
-
-
-
-
- Account number used with FEDEX_FREIGHT service.
-
-
-
-
- Used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
-
-
-
-
- Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
-
-
-
-
- Indicates the role of the party submitting the transaction.
-
-
-
-
- Designates the terms of the "collect" payment for a Freight Shipment.
-
-
-
-
- Identifies the declared value for the shipment
-
-
-
-
- Identifies the declared value units corresponding to the above defined declared value
-
-
-
-
-
- Identifiers for promotional discounts offered to customers.
-
-
-
-
- Total number of individual handling units in the entire shipment (for unit pricing).
-
-
-
-
- Estimated discount rate provided by client for unsecured rate quote.
-
-
-
-
- Total weight of pallets used in shipment.
-
-
-
-
- Overall shipment dimensions.
-
-
-
-
- Description for the shipment.
-
-
-
-
- Specifies which party will pay surcharges for any special services which support split billing.
-
-
-
-
-
- Details of the commodities in the shipment.
-
-
-
-
-
-
- Description of an individual commodity or class of content in a shipment.
-
-
-
-
- Freight class for this line item.
-
-
-
-
- Specification of handling-unit packaging for this commodity or class line.
-
-
-
-
- Number of pieces for this commodity or class line.
-
-
-
-
- Customer-provided description for this commodity or class line.
-
-
-
-
- Weight for this commodity or class line.
-
-
-
-
-
- Volume (cubic measure) for this commodity or class line.
-
-
-
-
-
-
- Indicates the role of the party submitting the transaction.
-
-
-
-
-
-
-
-
- Specifies which party will be responsible for payment of any surcharges for Freight special services for which split billing is allowed.
-
-
-
-
- Identifies the special service.
-
-
-
-
- Indicates who will pay for the special service.
-
-
-
-
-
-
- Data required to produce a General Agency Agreement document. Remaining content (business data) to be defined once requirements have been completed.
-
-
-
-
-
-
-
- Documents the kind and quantity of an individual hazardous commodity in a package.
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Specifies the amount of the commodity in alternate units.
-
-
-
-
- This describes the inner receptacle details for a hazardous commodity within the dangerous goods container.
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- Specifies the details of any radio active materials within the commodity.
-
-
-
-
- The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
-
-
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Regulatory identifier for a commodity (e.g. "UN ID" value).
-
-
-
-
- In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates any special processing options to be applied to the description of the dangerous goods commodity.
-
-
-
-
- Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
-
-
-
-
-
-
- Specifies any special processing to be applied to the dangerous goods commodity description validation.
-
-
-
-
-
-
-
- This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container.
-
-
-
-
- This specifies the quantity contained in the inner receptacle.
-
-
-
-
-
-
- Specifies how the commodity is to be labeled.
-
-
-
-
-
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- Specifies how the customer wishes the label text to be handled for this commodity in this package.
-
-
-
-
- Text used in labeling the commodity under control of the labelTextOption field.
-
-
-
-
-
-
- Indicates which kind of hazardous content is being reported.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies number and type of packaging units for hazardous commodities.
-
-
-
-
- Number of units of the type below.
-
-
-
-
- Units in which the hazardous commodity is packaged.
-
-
-
-
-
-
- Specifies documentation and limits for validation of an individual packing group/category.
-
-
-
-
-
- Coded specification for how commodity is to be packed.
-
-
-
-
-
-
- Identifies DOT packing group for a hazardous commodity.
-
-
-
-
-
-
-
-
-
-
- Identifies amount and units for quantity of hazardous commodities.
-
-
-
-
- Number of units of the type below.
-
-
-
-
- Units by which the hazardous commodity is measured. For IATA commodity, the units values are restricted based on regulation type.
-
-
-
-
- Specifies which measure of quantity is to be validated.
-
-
-
-
-
-
- Specifies the measure of quantity to be validated against a prescribed limit.
-
-
-
-
-
-
-
-
- Identifies the source of regulation for hazardous commodity data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Contact phone number for recipient of shipment.
-
-
-
-
- Contact and address of FedEx facility at which shipment is to be held.
-
-
-
-
- Type of facility at which package/shipment is to be held.
-
-
-
-
- Location identification (for facilities identified by an alphanumeric location code).
-
-
-
-
- Location identification (for facilities identified by an numeric location code).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Names for data elements / areas which may be suppressed from printing on labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the order in which the labels will be returned
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Relative to normal orientation for the printer.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the order in which the labels are requested to be returned
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the Liability Coverage Amount. For Jan 2010 this value represents coverage amount per pound
-
-
-
-
-
-
-
-
-
-
-
-
- Represents a one-dimensional measurement in small units (e.g. suitable for measuring a package or document), contrasted with Distance, which represents a large one-dimensional measurement (e.g. distance between cities).
-
-
-
-
- The numerical quantity of this measurement.
-
-
-
-
- The units for this measurement.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the representation of human-readable text.
-
-
-
-
- Two-letter code for language (e.g. EN, FR, etc.)
-
-
-
-
- Two-letter code for the region (e.g. us, ca, etc..).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce a Certificate of Origin document. Remaining content (business data) to be defined once requirements have been completed.
-
-
-
-
-
-
- Indicates which Party (if any) from the shipment is to be used as the source of importer data on the NAFTA COO form.
-
-
-
-
- Contact information for "Authorized Signature" area of form.
-
-
-
-
-
-
-
-
-
-
-
- Defined by NAFTA regulations.
-
-
-
-
- Defined by NAFTA regulations.
-
-
-
-
- Identification of which producer is associated with this commodity (if multiple producers are used in a single shipment).
-
-
-
-
-
- Date range over which RVC net cost was calculated.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- See instructions for NAFTA Certificate of Origin for code definitions.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- See instructions for NAFTA Certificate of Origin for code definitions.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data regarding the result of the submitted transaction.
-
-
-
-
- The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
-
-
-
-
- Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
-
-
-
-
- A code that represents this notification. Combined with the Source it uniquely identifies this notification.
-
-
-
-
- Human-readable text that explains this notification.
-
-
-
-
- The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
-
-
-
-
- A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) witout having to parse the message string.
-
-
-
-
-
-
-
-
- Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
-
-
-
-
- The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the OP-900 form for hazardous materials packages.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Identifies which reference type (from the package's customer references) is to be used as the source for the reference on this OP-900.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
- Data field to be used when a name is to be printed in the document instead of (or in addition to) a signature image.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data for a package's rates, as calculated per a specific rate type.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
-
- The dimensional weight of this package (if greater than actual).
-
-
-
-
- The oversize weight of this package (if the package is oversize).
-
-
-
-
- The transportation charge only (prior to any discounts applied) for this package.
-
-
-
-
- The sum of all discounts on this package.
-
-
-
-
- This package's baseCharge - totalFreightDiscounts.
-
-
-
-
- The sum of all surcharges on this package.
-
-
-
-
- This package's netFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- The sum of all taxes on this package.
-
-
-
-
- This package's netFreight + totalSurcharges + totalTaxes.
-
-
-
-
-
- All rate discounts that apply to this package.
-
-
-
-
- All rebates that apply to this package.
-
-
-
-
- All surcharges that apply to this package (either because of characteristics of the package itself, or because it is carrying per-shipment surcharges for the shipment of which it is a part).
-
-
-
-
- All taxes applicable (or distributed to) this package.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These special services are available at the package level for some or all service types. If the shipper is requesting a special service which requires additional data, the package special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
-
-
-
-
- The types of all special services requested for the enclosing shipment or package.
-
-
-
-
- For use with FedEx Ground services only; COD must be present in shipment's special services.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This information describes the kind of pending shipment being requested.
-
-
-
-
-
- Date after which the pending shipment will no longer be available for completion.
-
-
-
-
- Only used with type of EMAIL.
-
-
-
-
-
- These are documents that are recommended to be included with the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This class describes the pickup characteristics of a shipment (e.g. for use in a tag request).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates the packaging type of the container used to package radioactive hazardous materials.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates whether packaging type "EXCEPTED" or "EXCEPTED_PACKAGE" is for radioactive material in reportable quantity.
-
-
-
-
-
-
-
-
- Indicates the reason that a dim divisor value was chose.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Selects the value from a set of rate data to which the percentage is applied.
-
-
-
-
-
-
-
-
-
-
- The response to a RateRequest. The Notifications indicate whether the request was successful or not.
-
-
-
-
- This indicates the highest level of severity of all the notifications returned in this reply.
-
-
-
-
- The descriptive data regarding the results of the submitted transaction.
-
-
-
-
- Contains the CustomerTransactionId that was sent in the request.
-
-
-
-
- The version of this reply.
-
-
-
-
- Each element contains all rate data for a single service. If service was specified in the request, there will be a single entry in this array; if service was omitted in the request, there will be a separate entry in this array for each service being compared.
-
-
-
-
-
-
-
-
-
-
- Shows the specific combination of service options combined with the service type that produced this committment in the set returned to the caller.
-
-
-
-
- Supporting detail for applied options identified in preceding field.
-
-
-
-
-
-
-
-
-
-
- Not populated by FAST service in Jan07.
-
-
-
-
- Not populated by FAST service in Jan07.
-
-
-
-
- Not populated by FAST service in Jan07.
-
-
-
-
- Maximum expected transit time
-
-
-
-
- Not populated by FAST service in Jan07. Actual signature option applied, to allow for cases in wihch the original value conflicted with other service features in the shipment.
-
-
-
-
-
- Each element contains all rate data for a single rate type.
-
-
-
-
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
-
-
-
- Allows the caller to specify that the transit time and commit data are to be returned in the reply.
-
-
-
-
- Candidate carriers for rate-shopping use case. This field is only considered if requestedShipment/serviceType is omitted.
-
-
-
-
- Contains zero or more service options whose combinations are to be considered when replying with available services.
-
-
-
-
- If provided, identifies the consolidation to which this open shipment should be added after successful creation.
-
-
-
-
- The shipment for which a rate quote (or rate-shopping comparison) is desired.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
-
-
- Echoed from the corresponding package in the rate request (if provided).
-
-
-
-
- Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.
-
-
-
-
- The difference between "list" and "account" net charge.
-
-
-
-
- Ground COD is shipment level.
-
-
-
-
-
- Rate data that are tied to a specific package and rate type combination.
-
-
-
-
-
-
- This class groups the shipment and package rating data for a specific rate type for use in a rating reply, which groups result data by rate type.
-
-
-
-
- The difference between "list" and "account" total net charge.
-
-
-
-
- Express COD is shipment level.
-
-
-
-
- The shipment-level totals for this rate type.
-
-
-
-
- The package-level data for this rate type.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
-
-
-
-
- Specifies the kind of identification being used.
-
-
-
-
- Contains the actual ID value, of the type specified above.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
-
-
-
-
-
-
-
- Type of documents that are recommended to be included with the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies details needed to generate any label artifacts required due to regulatory requirements.
-
-
-
-
-
- Specifies how the customer requested the regulatory label to be generated.
-
-
-
-
-
-
-
-
-
-
-
- Describes the vertical position of an item relative to another item.
-
-
-
-
-
-
-
-
- This class rationalizes RequestedPackage and RequestedPackageSummary from previous interfaces.
-
-
-
-
- Used only with INDIVIDUAL_PACKAGE, as a unique identifier of each requested package.
-
-
-
-
- Used only with PACKAGE_GROUPS, as a unique identifier of each group of identical packages.
-
-
-
-
- Used only with PACKAGE_GROUPS, as a count of packages within a group of identical packages.
-
-
-
-
-
- Specifies the declared value for carriage of the package. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the package. This field is only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for PACKAGE_SUMMARY, in which case totalInsuredValue and packageCount on the shipment will be used to determine this value.
-
-
-
-
- Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for PACKAGE_SUMMARY, in which case total weight and packageCount on the shipment will be used to determine this value.
-
-
-
-
-
- Provides additional detail on how the customer has physically packaged this item. As of June 2009, required for packages moving under international and SmartPost services.
-
-
-
-
- Human-readable text describing the package.
-
-
-
-
- Human-readable text describing the contents of the package to be used for clearance purposes.
-
-
-
-
-
-
- Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS.
-
-
-
-
-
-
-
-
-
-
-
-
- The shipment variations for the current shipment expressed in key-value pairs.
-
-
-
-
-
- Specifies the total declared value for carriage of the shipment. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the shipment.
-
-
-
-
- This attribute indicates the currency the caller requests to have used in all returned monetary values (when a choice is possible).
-
-
-
-
-
-
-
- Physical starting address for the shipment, if different from shipper's address.
-
-
-
-
-
-
-
-
- Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
-
-
-
-
- Used with Ground Home Delivery and Freight.
-
-
-
-
-
- Customs clearance data, used for both international and intra-country shipping.
-
-
-
-
- For use in "process tag" transaction.
-
-
-
-
- Specifies the characteristics of a shipment pertaining to SmartPost services.
-
-
-
-
- If true, only the shipper/payor will have visibility of this shipment.
-
-
-
-
-
- Contains data used to create additional (non-label) shipping documents.
-
-
-
-
- Specifies whether and what kind of rates the customer wishes to have quoted on this shipment. The reply will also be constrained by other data on the shipment and customer.
-
-
-
-
- Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.
-
-
-
-
- The total number of packages in the entire shipment (even when the shipment spans multiple transactions.)
-
-
-
-
- Specifies which package-level data values are provided at the shipment-level only. The package-level data values types specified here will not be provided at the package-level.
-
-
-
-
- Specifies data structures that may be re-used multiple times with s single shipment.
-
-
-
-
- One or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics all packages in the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking number of the master associated with the return shipment.
-
-
-
-
-
-
-
- These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
-
-
-
-
-
-
-
-
-
-
-
- Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
-
-
-
-
-
-
- The instructions indicating how to print the return instructions( e.g. image type) Specifies characteristics of a shipping document to be produced.
-
-
-
-
-
- Specifies additional customer provided text to be inserted into the return document.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The "PAYOR..." rates are expressed in the currency identified in the payor's rate table(s). The "RATED..." rates are expressed in the currency of the origin country. Former "...COUNTER..." values have become "...RETAIL..." values, except for PAYOR_COUNTER and RATED_COUNTER, which have been removed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
-
-
-
-
-
-
-
- Describes the rotation of an item from its default orientation.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These values control the optional features of service that may be combined in a commitment/rate comparision transaction.
-
-
-
-
-
-
-
-
-
-
-
- Supporting detail for applied options identified in a rate quote.
-
-
-
-
- Identifies the type of Freight Guarantee applied, if FREIGHT_GUARANTEE is applied to the rate quote.
-
-
-
-
- Identifies the smartPostHubId used during rate quote, if SMART_POST_HUB_ID is a variable option on the rate request.
-
-
-
-
- Identifies the indicia used during rate quote, if SMART_POST_ALLOWED_INDICIA is a variable option on the rate request.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies data structures that may be re-used multiple times with s single shipment.
-
-
-
-
- Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities.
-
-
-
-
-
-
- Shipment-level totals of dry ice data across all packages.
-
-
-
-
- Total number of packages in the shipment that contain dry ice.
-
-
-
-
- Total shipment dry ice weight for all packages.
-
-
-
-
-
-
- Data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
-
-
-
-
- Human-readable text describing the shipment leg.
-
-
-
-
- Origin for this leg.
-
-
-
-
- Specifies the location id the origin of shipment leg.
-
-
-
-
- Destination for this leg.
-
-
-
-
- Specifies the location id the destination of shipment leg.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates the rate scale used.
-
-
-
-
- Indicates the rate zone used (based on origin and destination).
-
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- Specifies the currency exchange performed on financial amounts for this rate.
-
-
-
-
- Indicates which special rating cases applied to this shipment.
-
-
-
-
-
- Identifies the type of dim divisor that was applied.
-
-
-
-
-
-
- Sum of dimensional weights for all packages.
-
-
-
-
-
-
-
-
- This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- Total of the transportation-based taxes.
-
-
-
-
-
-
- Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
-
-
-
-
- This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
-
-
-
-
- Rate data specific to FedEx Freight and FedEx National Freight services.
-
-
-
-
- All rate discounts that apply to this shipment.
-
-
-
-
- All rebates that apply to this shipment.
-
-
-
-
- All surcharges that apply to this shipment.
-
-
-
-
- All transportation-based taxes applicable to this shipment.
-
-
-
-
- All commodity-based duties and taxes applicable to this shipment.
-
-
-
-
- The "order level" variable handling charges.
-
-
-
-
- The total of all variable handling charges at both shipment (order) and package level.
-
-
-
-
-
-
- These values identify which package-level data values will be provided at the shipment-level.
-
-
-
-
-
-
-
-
-
- Data for a shipment's total/summary rates, as calculated per a specific rate type. The "total..." fields may differ from the sum of corresponding package data for Multiweight or Express MPS.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates the rate scale used.
-
-
-
-
- Indicates the rate zone used (based on origin and destination).
-
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- Specifies the currency exchange performed on financial amounts for this rate.
-
-
-
-
- Indicates which special rating cases applied to this shipment.
-
-
-
-
-
- Identifies the type of dim divisor that was applied.
-
-
-
-
-
-
- Sum of dimensional weights for all packages.
-
-
-
-
-
-
-
-
- This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- Total of the transportation-based taxes.
-
-
-
-
-
-
- Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
-
-
-
-
- This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
-
-
-
-
- Identifies the Rate Details per each leg in a Freight Shipment
-
-
-
-
- Rate data specific to FedEx Freight and FedEx National Freight services.
-
-
-
-
- All rate discounts that apply to this shipment.
-
-
-
-
- All rebates that apply to this shipment.
-
-
-
-
- All surcharges that apply to this shipment.
-
-
-
-
- All transportation-based taxes applicable to this shipment.
-
-
-
-
- All commodity-based duties and taxes applicable to this shipment.
-
-
-
-
- The "order level" variable handling charges.
-
-
-
-
- The total of all variable handling charges at both shipment (order) and package level.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
-
-
-
-
- The types of all special services requested for the enclosing shipment (or other shipment-level transaction).
-
-
-
-
-
-
-
-
-
- This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
-
-
-
-
-
-
-
-
-
-
- Electronic Trade document references.
-
-
-
-
- Specification for date or range of dates on which delivery is to be attempted.
-
-
-
-
-
-
-
-
- Specifies the name or the key for the shipment variation.
-
-
-
-
- The values that are valid for the specified shipment variation in the context of the current shipment.
-
-
-
-
-
-
- Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
-
-
-
-
- Values in this field specify how to create and return the document.
-
-
-
-
- Specifies how to organize all documents of this type.
-
-
-
-
- Specifies how to e-mail document images.
-
-
-
-
- Specifies how a queued document is to be printed.
-
-
-
-
-
-
- Specifies how to return a shipping document to the caller.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how to e-mail shipping documents.
-
-
-
-
- Provides the roles and email addresses for e-mail recipients.
-
-
-
-
- Identifies the convention by which documents are to be grouped as e-mail attachments.
-
-
-
-
- Specifies the language in which the email containing the document is requested to be composed.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies an individual recipient of e-mailed shipping document(s).
-
-
-
-
- Identifies the relationship of this recipient in the shipment.
-
-
-
-
- Address to which the document is to be sent.
-
-
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies how to create, organize, and return the document.
-
-
-
-
- Specifies how far down the page to move the beginning of the image; allows for printing on letterhead and other pre-printed stock.
-
-
-
-
-
-
- For those shipping document types which have both a "form" and "instructions" component (e.g. NAFTA Certificate of Origin and General Agency Agreement), this field indicates whether to provide the instructions.
-
-
-
-
-
- Governs the language to be used for this individual document, independently from other content returned for the same shipment.
-
-
-
-
-
-
- Specifies how to organize all shipping documents of the same type.
-
-
-
-
-
-
-
-
- Specifies the image format used for a shipping document.
-
-
-
-
-
-
-
-
-
-
-
- Specifies printing options for a shipping document.
-
-
-
-
- Provides environment-specific printer identification.
-
-
-
-
-
-
- Contains all data required for additional (non-label) shipping documents to be produced in conjunction with a specific shipment.
-
-
-
-
- Indicates the types of shipping documents requested by the shipper.
-
-
-
-
-
-
- Specifies the production of each package-level custom document (the same specification is used for all packages).
-
-
-
-
- Specifies the production of a shipment-level custom document.
-
-
-
-
-
-
-
- Specifies the production of the OP-900 document for hazardous materials packages.
-
-
-
-
- Specifies the production of the 1421c document for dangerous goods shipment.
-
-
-
-
- Specifies the production of the OP-900 document for hazardous materials.
-
-
-
-
- Specifies the production of the return instructions document.
-
-
-
-
-
-
- Specifies the type of paper (stock) on which a document will be printed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These values are mutually exclusive; at most one of them can be attached to a SmartPost shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required for shipments handled under the SMART_POST and GROUND_SMART_POST service types.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifice the kind of tax or miscellaneous charge being reported on a Commercial Invoice.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the usage of Tax Identification Number in Shipment processing
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Free form text to be echoed back in the reply. Used to match requests and replies.
-
-
-
-
- Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the application that is responsible for managing the document id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Description of the uploaded document.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This definition of variable handling charge detail is intended for use in Jan 2011 corp load.
-
-
-
-
-
- Actual percentage (10 means 10%, which is a mutiplier of 0.1)
-
-
-
-
- Select the value from a set of rate data to which the percentage is applied.
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Three-dimensional volume/cubic measurement.
-
-
-
-
-
-
-
-
- Units of three-dimensional volume/cubic measure.
-
-
-
-
-
-
-
-
- The descriptive data for the heaviness of an object.
-
-
-
-
- Identifies the unit of measure associated with a weight value.
-
-
-
-
- Identifies the weight value of a package/shipment.
-
-
-
-
-
-
-
-
-
-
-
-
- Used in authentication of the sender's identity.
-
-
-
-
- This was renamed from cspCredential.
-
-
-
-
- Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
-
-
-
-
-
-
- Two part authentication string used for the sender's identity
-
-
-
-
- Identifying part of authentication credential. This value is provided by FedEx after registration
-
-
-
-
- Secret part of authentication key. This value is provided by FedEx after registration.
-
-
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Identifies a system or sub-system which performs an operation.
-
-
-
-
- Identifies the service business level.
-
-
-
-
- Identifies the service interface level.
-
-
-
-
- Identifies the service code level.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ Specifies additional labels to be produced. All required labels for shipments will be produced without the need to request additional labels. These are only available as thermal labels.
+
+
+
+
+ The type of additional labels to return.
+
+
+
+
+ The number of this type label to return
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Specifies details for a package containing alcohol
+
+
+
+
+ The license type that the recipient of the alcohol package.
+
+
+
+
+
+
+ Specifies the type of license that the recipient of the alcohol shipment has.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A freight line item identifier referring to a freight shipment line item that describes goods contained within this handling unit.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identification of the type of barcode (symbology) used on FedEx documents and labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes attributes of a battery or cell that are used for classification purposes. Typically this structure would be used to allow customers to declare batteries or cells for which full dangerous goods documentation and procedures are not required.
+
+
+
+
+ Describes the material composition of the battery or cell.
+
+
+
+
+ Describes the packing arrangement of the battery or cell with respect to other items within the same package.
+
+
+
+
+ A regulation specific classification for the battery or cell.
+
+
+
+
+
+
+ Describes the material composition of a battery or cell.
+
+
+
+
+
+
+
+
+ Describes the packing arrangement of a battery or cell with respect to other items within the same package.
+
+
+
+
+
+
+
+
+ A regulation specific classification for a battery or cell.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This represents the internal FedEx-system recognized country code.
+
+
+
+
+ This represents the internal FedEx-system recognized state or province code.
+
+
+
+
+ This represents the internal FedEx-system recognized postal code.
+
+
+
+
+
+ The unique location identifier
+
+
+
+
+ The op-co specific numeric identifier for a location
+
+
+
+
+
+
+
+ Specifies the type of brokerage to be applied to a shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+ Identifies the type of funds FedEx should collect upon shipment delivery.
+
+
+
+
+
+
+
+
+
+ Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
+
+
+
+
+
+ Specifies the details of the charges are to be added to the COD collect amount.
+
+
+
+
+ Identifies the type of funds FedEx should collect upon package delivery
+
+
+
+
+ For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
+
+
+
+
+ When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
+
+
+
+
+ Specifies the name of person or company receiving the secured/unsecured funds payment
+
+
+
+
+ Indicates which type of reference information to include on the COD return shipping label.
+
+
+
+
+ Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through the FedEx Systems. Customers are responsible for printing their own Commercial Invoice.If you would likeFedEx to generate a Commercial Invoice and transmit it to Customs. for clearance purposes, you need to specify that in the ShippingDocumentSpecification element. If you would like a copy of the Commercial Invoice that FedEx generated returned to you in reply it needs to be specified in the ETDDetail/RequestedDocumentCopies element. Commercial Invoice support consists of maximum of 99 commodity line items.
+
+
+
+
+ Any comments that need to be communicated about this shipment.
+
+
+
+
+ Any freight charges that are associated with this shipment.
+
+
+
+
+ Any taxes or miscellaneous charges(other than Freight charges or Insurance charges) that are associated with this shipment.
+
+
+
+
+ Specifies which kind of charge is being recorded in the preceding field.
+
+
+
+
+ Any packing costs that are associated with this shipment.
+
+
+
+
+ Any handling costs that are associated with this shipment.
+
+
+
+
+ Free-form text.
+
+
+
+
+ Free-form text.
+
+
+
+
+ Free-form text.
+
+
+
+
+ The reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.
+
+
+
+
+ Name of the International Expert that completed the Commercial Invoice different from Sender.
+
+
+
+
+ Required for dutiable international Express or Ground shipments. This field is not applicable to an international PIB(document) or a non-document which does not require a Commercial Invoice.
+
+
+
+
+
+
+ The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
+
+
+
+
+
+ Specifies the usage and identification of a customer supplied image to be used on this document.
+
+
+
+
+
+
+ Information about the transit time and delivery commitment date and time.
+
+
+
+
+ The Commodity applicable to this commitment.
+
+
+
+
+
+ Descriptions and alternate identifiers for a service.
+
+
+
+
+ Shows the specific combination of service options combined with the service type that produced this committment in the set returned to the caller.
+
+
+
+
+ Supporting detail for applied options identified in preceding field.
+
+
+
+
+
+
+
+
+ THe delivery commitment date/time. Express Only.
+
+
+
+
+ The delivery commitment day of the week.
+
+
+
+
+ The number of transit days; applies to Ground and LTL Freight; indicates minimum transit time for SmartPost.
+
+
+
+
+ Maximum number of transit days, for SmartPost shipments.
+
+
+
+
+ The service area code for the destination of this shipment. Express only.
+
+
+
+
+ The address of the broker to be used for this shipment.
+
+
+
+
+ The FedEx location identifier for the broker.
+
+
+
+
+ The delivery commitment date/time the shipment will arrive at the border.
+
+
+
+
+ The delivery commitment day of the week the shipment will arrive at the border.
+
+
+
+
+ The number of days it will take for the shipment to make it from broker to destination
+
+
+
+
+ The delivery commitment date for shipment served by GSP (Global Service Provider)
+
+
+
+
+ The delivery commitment day of the week for the shipment served by GSP (Global Service Provider)
+
+
+
+
+ Messages concerning the ability to provide an accurate delivery commitment on an International commit quote. These could be messages providing information about why a commitment could not be returned or a successful message such as "REQUEST COMPLETED"
+
+
+
+
+ Messages concerning the delivery commitment on an International commit quote such as "0:00 A.M. IF NO CUSTOMS DELAY"
+
+
+
+
+ Information about why a shipment delivery is delayed and at what level (country/service etc.).
+
+
+
+
+
+ Required documentation for this shipment.
+
+
+
+
+ Freight origin and destination city center information and total distance between origin and destination city centers.
+
+
+
+
+
+
+ The type of delay this shipment will encounter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ FedEx internal commodity identifier
+
+
+
+
+
+ A free-form description of the commodity, which could be used for customs clearance documentation.
+
+
+
+
+
+
+
+
+
+
+ Contains only additional quantitative information other than weight and quantity to calculate duties and taxes.
+
+
+
+
+
+ The value of the commodity for customs purposes. The field should be the unit price multiplied by the quantity.
+
+
+
+
+ Defines additional characteristic of commodity used to calculate duties and taxes
+
+
+
+
+
+
+
+
+ All data required for this commodity in NAFTA Certificate of Origin.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Uniquely identifies a consolidation, which is a logical container for a collection of shipments.
+
+
+
+
+ Specifies the type of consolidation.
+
+
+
+
+ Uniquely identifies the consolidation, within a given type and date.
+
+
+
+
+ The date on which the consolidation was created.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data for a point-of-contact person.
+
+
+
+
+ Client provided identifier corresponding to this contact information.
+
+
+
+
+ Identifies the contact person's name.
+
+
+
+
+ Identifies the contact person's title.
+
+
+
+
+ Identifies the company this contact is associated with.
+
+
+
+
+ Identifies the phone number associated with this contact.
+
+
+
+
+ Identifies the phone extension associated with this contact.
+
+
+
+
+ Identifies a toll free number, if any, associated with this contact.
+
+
+
+
+ Identifies the pager number associated with this contact.
+
+
+
+
+ Identifies the fax number associated with this contact.
+
+
+
+
+ Identifies the email address associated with this contact.
+
+
+
+
+
+
+
+
+
+
+
+
+ Details the contents of the package.
+
+
+
+
+
+
+
+
+
+
+
+
+ The currency code for the original (converted FROM) currency.
+
+
+
+
+ The currency code for the final (converted INTO) currency.
+
+
+
+
+ Multiplier used to convert fromCurrency units to intoCurrency units.
+
+
+
+
+
+
+
+
+ Indicates the type of custom delivery being requested.
+
+
+
+
+ Time by which delivery is requested.
+
+
+
+
+ Range of dates for custom delivery request; only used if type is BETWEEN.
+
+
+
+
+ Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce a custom-specified document, either at shipment or package level.
+
+
+
+
+ Common information controlling document production.
+
+
+
+
+ Applicable only to documents produced on thermal printers with roll stock.
+
+
+
+
+ Applicable only to documents produced on thermal printers with roll stock.
+
+
+
+
+ Identifies the formatting specification used to construct this custom document.
+
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified barcode symbology.
+
+
+
+
+
+
+
+
+ Width of thinnest bar/space element in the barcode.
+
+
+
+
+
+
+
+ Solid (filled) rectangular area on label.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Image to be included from printer's memory, or from a local file for offline clients.
+
+
+
+
+
+ Printer-specific index of graphic image to be printed.
+
+
+
+
+ Fully-qualified path and file name for graphic image to be printed.
+
+
+
+
+
+
+
+
+ Horizontal position, relative to left edge of custom area.
+
+
+
+
+ Vertical position, relative to top edge of custom area.
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
+
+
+
+
+
+
+
+
+
+ Printer-specific font name for use with thermal printer labels.
+
+
+
+
+ Generic font name for use with plain paper labels.
+
+
+
+
+ Generic font size for use with plain paper labels.
+
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
+
+
+
+
+
+
+
+ Printer-specific font name for use with thermal printer labels.
+
+
+
+
+ Generic font name for use with plain paper labels.
+
+
+
+
+ Generic font size for use with plain paper labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows customer-specified control of label content.
+
+
+
+
+ If omitted, no doc tab will be produced (i.e. default is former NONE type).
+
+
+
+
+ Controls the position of the customer specified content relative to the FedEx portion.
+
+
+
+
+
+
+ Controls which data/sections will be suppressed.
+
+
+
+
+ For customers producing their own Ground labels, this field specifies which secondary barcode will be printed on the label; so that the primary barcode produced by FedEx has the correct SCNC.
+
+
+
+
+
+
+ Controls the number of additional copies of supplemental labels.
+
+
+
+
+ This value reduces the default quantity of destination/consignee air waybill labels. A value of zero indicates no change to default. A minimum of one copy will always be produced.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interacts both with properties of the shipment and contractual relationship with the shipper.
+
+
+
+
+
+
+ Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
+
+
+
+
+
+
+ This represents the total commodity value of the shipment plus the charges required by the destination country.
+
+
+
+
+ Identifies responsibilities with respect to loss, damage, etc.
+
+
+
+
+ Documents amount paid to third party for coverage of shipment content.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies additional description about customs options. This is a required field when the customs options type is "OTHER".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes an approved container used to package dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container.
+
+
+
+
+ Indicates whether there are additional inner receptacles within this container.
+
+
+
+
+ Indicates the type of this dangerous goods container, as specified by the IATA packing instructions. For example, steel cylinder, fiberboard box, plastic jerrican and steel drum.
+
+
+
+
+ Indicates the packaging type of the container used to package the radioactive materials.
+
+
+
+
+ Indicates the number of occurrences of this container with identical dangerous goods configuration.
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current container.
+
+
+
+
+
+
+
+
+
+
+ Shipment is packaged/documented for movement ONLY on cargo aircraft.
+
+
+
+
+ Indicates which kinds of hazardous content are in the current package.
+
+
+
+
+ Indicates whether there is additional customer provided packaging enclosing the approved dangerous goods containers.
+
+
+
+
+ Identifies the configuration of this dangerous goods package. The common configuration is represented at the shipment level.
+
+
+
+
+ Indicates one or more containers used to pack dangerous goods commodities.
+
+
+
+
+ Description of the packaging of this commodity, suitable for use on OP-900 and OP-950 forms.
+
+
+
+
+ Name, title and place of the signatory for this shipment.
+
+
+
+
+ Telephone number to use for contact in the event of an emergency.
+
+
+
+
+ Offeror's name or contract number, per DOT regulation.
+
+
+
+
+ Specifies the contact of the party responsible for handling the infectious substances, if any, in the dangerous goods shipment.
+
+
+
+
+ Specifies additional handling information for the current package.
+
+
+
+
+ Specifies the radioactivity detail for the current package, if the package contains radioactive materials.
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the 1421c form for dangerous goods shipment.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+ Specifies that name, title and place of the signatory responsible for the dangerous goods shipment.
+
+
+
+
+
+
+ Indicates the place where the form is signed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Information about why a shipment delivery is delayed and at what level( country/service etc.).
+
+
+
+
+ The date of the delay
+
+
+
+
+
+ The attribute of the shipment that caused the delay(e.g. Country, City, LocationId, Zip, service area, special handling )
+
+
+
+
+ The point where the delay is occurring (e.g. Origin, Destination, Broker location)
+
+
+
+
+ The reason for the delay (e.g. holiday, weekend, etc.).
+
+
+
+
+ The name of the holiday in that country that is causing the delay.
+
+
+
+
+
+
+ The attribute of the shipment that caused the delay(e.g. Country, City, LocationId, Zip, service area, special handling )
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The point where the delay is occurring ( e.g. Origin, Destination, Broker location).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking id for the return, if preassigned.
+
+
+
+
+
+
+ Data required to complete the Destionation Control Statement for US exports.
+
+
+
+
+
+ Comma-separated list of up to four country codes, required for DEPARTMENT_OF_STATE statement.
+
+
+
+
+ Name of end user, required for DEPARTMENT_OF_STATE statement.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Driving or other transportation distances, distinct from dimension measurements.
+
+
+
+
+ Identifies the distance quantity.
+
+
+
+
+ Identifies the unit of measure for the distance value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the name associated with the email address.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Customer-declared value, with data type and legal values depending on excise condition, used in defining the taxable value of the item.
+
+
+
+
+
+
+ Specifies the types of Estimated Duties and Taxes to be included in a rate quotation for an international shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Electronic Trade document references used with the ETD special service.
+
+
+
+
+
+ Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
+
+
+
+
+
+
+
+ The instructions indicating how to print the Export Declaration.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+
+
+
+ General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies a kind of FedEx facility.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the optional features/characteristics requested for a Freight shipment utilizing a flatbed trailer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce the Freight handling-unit-level address labels. Note that the number of UNIQUE labels (the N as in 1 of N, 2 of N, etc.) is determined by total handling units.
+
+
+
+
+
+ Indicates the number of copies to be produced for each unique label.
+
+
+
+
+ Specifies the quadrant of the page on which the label printing will start.
+
+
+
+
+ If omitted, no doc tab will be produced (i.e. default = former NONE type).
+
+
+
+
+ Controls the position of the customer specified content relative to the FedEx portion.
+
+
+
+
+
+
+
+ Individual charge which contributes to the total base charge for the shipment.
+
+
+
+
+ Freight class for this line item.
+
+
+
+
+ Effective freight class used for rating this line item.
+
+
+
+
+ NMFC Code for commodity.
+
+
+
+
+ Customer-provided description for this commodity or class line.
+
+
+
+
+ Weight for this commodity or class line.
+
+
+
+
+ Rate or factor applied to this line item.
+
+
+
+
+ Identifies the manner in which the chargeRate for this line item was applied.
+
+
+
+
+ The net or extended charge for this line item.
+
+
+
+
+
+
+ Specifies the way in which base charges for a Freight shipment or shipment leg are calculated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values represent the industry-standard freight classes used for FedEx Freight and FedEx National Freight shipment description. (Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Information about the Freight Service Centers associated with this shipment.
+
+
+
+
+ Information about the origin Freight Service Center.
+
+
+
+
+ Information about the destination Freight Service Center.
+
+
+
+
+ The distance between the origin and destination FreightService Centers
+
+
+
+
+
+
+
+
+
+ Date for all Freight guarantee types.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies responsibilities with respect to loss, damage, etc.
+
+
+
+
+
+
+
+
+ Rate data specific to FedEx Freight or FedEx National Freight services.
+
+
+
+
+ A unique identifier for a specific rate quotation.
+
+
+
+
+ Specifies whether the rate quote was automated or manual.
+
+
+
+
+ Specifies how total base charge is determined.
+
+
+
+
+ Freight charges which accumulate to the total base charge for the shipment.
+
+
+
+
+ Human-readable descriptions of additional information on this shipment rating.
+
+
+
+
+
+
+ Additional non-monetary data returned with Freight rates.
+
+
+
+
+ Unique identifier for notation.
+
+
+
+
+ Human-readable explanation of notation.
+
+
+
+
+
+
+ Specifies the type of rate quote
+
+
+
+
+
+
+
+
+ This class describes the relationship between a customer-specified address and the FedEx Freight / FedEx National Freight Service Center that supports that address.
+
+
+
+
+ Freight Industry standard non-FedEx carrier identification
+
+
+
+
+ The name of the Interline carrier.
+
+
+
+
+ Additional time it might take at the origin or destination to pickup or deliver the freight. This is usually due to the remoteness of the location. This time is included in the total transit time.
+
+
+
+
+
+ Distance between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
+
+
+
+
+ Time to travel between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
+
+
+
+
+ Specifies when/how the customer can arrange for pickup or delivery.
+
+
+
+
+ Specifies days of operation if localServiceScheduling is LIMITED.
+
+
+
+
+ Freight service center that is a gateway on the border of Canada or Mexico.
+
+
+
+
+ Alphabetical code identifying a Freight Service Center
+
+
+
+
+ Freight service center Contact and Address
+
+
+
+
+
+
+ Specifies the type of service scheduling offered from a Freight or National Freight Service Center to a customer-supplied address.
+
+
+
+
+
+
+
+
+
+ Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
+
+
+
+
+ Account number used with FEDEX_FREIGHT service.
+
+
+
+
+ Used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
+
+
+
+
+ Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+ Designates the terms of the "collect" payment for a Freight Shipment.
+
+
+
+
+ Identifies the declared value for the shipment
+
+
+
+
+ Identifies the declared value units corresponding to the above defined declared value
+
+
+
+
+
+ Identifiers for promotional discounts offered to customers.
+
+
+
+
+ Total number of individual handling units in the entire shipment (for unit pricing).
+
+
+
+
+ Estimated discount rate provided by client for unsecured rate quote.
+
+
+
+
+ Total weight of pallets used in shipment.
+
+
+
+
+ Overall shipment dimensions.
+
+
+
+
+ Description for the shipment.
+
+
+
+
+ Specifies which party will pay surcharges for any special services which support split billing.
+
+
+
+
+
+ Details of the commodities in the shipment.
+
+
+
+
+
+
+ Description of an individual commodity or class of content in a shipment.
+
+
+
+
+ A unique identifier assigned to this line item.
+
+
+
+
+ Freight class for this line item.
+
+
+
+
+ Specification of handling-unit packaging for this commodity or class line.
+
+
+
+
+ Number of pieces for this commodity or class line.
+
+
+
+
+ Customer-provided description for this commodity or class line.
+
+
+
+
+ Weight for this commodity or class line.
+
+
+
+
+
+ Volume (cubic measure) for this commodity or class line.
+
+
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+
+
+
+
+ Specifies which party will be responsible for payment of any surcharges for Freight special services for which split billing is allowed.
+
+
+
+
+ Identifies the special service.
+
+
+
+
+ Indicates who will pay for the special service.
+
+
+
+
+
+
+ Data required to produce a General Agency Agreement document. Remaining content (business data) to be defined once requirements have been completed.
+
+
+
+
+
+
+
+ Documents the kind and quantity of an individual hazardous commodity in a package.
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Specifies the amount of the commodity in alternate units.
+
+
+
+
+ This describes the inner receptacle details for a hazardous commodity within the dangerous goods container.
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ Specifies the details of any radio active materials within the commodity.
+
+
+
+
+ The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
+
+
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Regulatory identifier for a commodity (e.g. "UN ID" value).
+
+
+
+
+ In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates any special processing options to be applied to the description of the dangerous goods commodity.
+
+
+
+
+ Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
+
+
+
+
+
+
+ Specifies any special processing to be applied to the dangerous goods commodity description validation.
+
+
+
+
+
+
+
+ This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container.
+
+
+
+
+ This specifies the quantity contained in the inner receptacle.
+
+
+
+
+
+
+ Specifies how the commodity is to be labeled.
+
+
+
+
+
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ Specifies how the customer wishes the label text to be handled for this commodity in this package.
+
+
+
+
+ Text used in labeling the commodity under control of the labelTextOption field.
+
+
+
+
+
+
+ Indicates which kind of hazardous content is being reported.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies number and type of packaging units for hazardous commodities.
+
+
+
+
+ Number of units of the type below.
+
+
+
+
+ Units in which the hazardous commodity is packaged.
+
+
+
+
+
+
+ Specifies documentation and limits for validation of an individual packing group/category.
+
+
+
+
+
+ Coded specification for how commodity is to be packed.
+
+
+
+
+
+
+ Identifies DOT packing group for a hazardous commodity.
+
+
+
+
+
+
+
+
+
+
+ Identifies amount and units for quantity of hazardous commodities.
+
+
+
+
+ Number of units of the type below.
+
+
+
+
+ Units by which the hazardous commodity is measured. For IATA commodity, the units values are restricted based on regulation type.
+
+
+
+
+ Specifies which measure of quantity is to be validated.
+
+
+
+
+
+
+ Specifies the measure of quantity to be validated against a prescribed limit.
+
+
+
+
+
+
+
+
+ Identifies the source of regulation for hazardous commodity data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contact phone number for recipient of shipment.
+
+
+
+
+ Contact and address of FedEx facility at which shipment is to be held.
+
+
+
+
+ Type of facility at which package/shipment is to be held.
+
+
+
+
+ Location identification (for facilities identified by an alphanumeric location code).
+
+
+
+
+ Location identification (for facilities identified by an numeric location code).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Names for data elements / areas which may be suppressed from printing on labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the order in which the labels will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Relative to normal orientation for the printer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the order in which the labels are requested to be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the Liability Coverage Amount. For Jan 2010 this value represents coverage amount per pound
+
+
+
+
+
+
+
+
+
+
+
+
+ Represents a one-dimensional measurement in small units (e.g. suitable for measuring a package or document), contrasted with Distance, which represents a large one-dimensional measurement (e.g. distance between cities).
+
+
+
+
+ The numerical quantity of this measurement.
+
+
+
+
+ The units for this measurement.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce a Certificate of Origin document. Remaining content (business data) to be defined once requirements have been completed.
+
+
+
+
+
+
+ Indicates which Party (if any) from the shipment is to be used as the source of importer data on the NAFTA COO form.
+
+
+
+
+ Contact information for "Authorized Signature" area of form.
+
+
+
+
+
+
+
+
+
+
+
+ Defined by NAFTA regulations.
+
+
+
+
+ Defined by NAFTA regulations.
+
+
+
+
+ Identification of which producer is associated with this commodity (if multiple producers are used in a single shipment).
+
+
+
+
+
+ Date range over which RVC net cost was calculated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ See instructions for NAFTA Certificate of Origin for code definitions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ See instructions for NAFTA Certificate of Origin for code definitions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Indicates the type of notification that will be sent.
+
+
+
+
+ Specifies the email notification details.
+
+
+
+
+ Specifies the localization for this notification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the OP-900 form for hazardous materials packages.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Identifies which reference type (from the package's customer references) is to be used as the source for the reference on this OP-900.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+ Data field to be used when a name is to be printed in the document instead of (or in addition to) a signature image.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data for a package's rates, as calculated per a specific rate type.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+
+ The dimensional weight of this package (if greater than actual).
+
+
+
+
+ The oversize weight of this package (if the package is oversize).
+
+
+
+
+ The transportation charge only (prior to any discounts applied) for this package.
+
+
+
+
+ The sum of all discounts on this package.
+
+
+
+
+ This package's baseCharge - totalFreightDiscounts.
+
+
+
+
+ The sum of all surcharges on this package.
+
+
+
+
+ This package's netFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ The sum of all taxes on this package.
+
+
+
+
+ This package's netFreight + totalSurcharges + totalTaxes.
+
+
+
+
+
+ All rate discounts that apply to this package.
+
+
+
+
+ All rebates that apply to this package.
+
+
+
+
+ All surcharges that apply to this package (either because of characteristics of the package itself, or because it is carrying per-shipment surcharges for the shipment of which it is a part).
+
+
+
+
+ All taxes applicable (or distributed to) this package.
+
+
+
+
+
+
+
+ These special services are available at the package level for some or all service types. If the shipper is requesting a special service which requires additional data, the package special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ Indicates the package special service types that are requested on this shipment. For a list of the valid package special service types, please consult your integration documentation or get the list of the available special services from the getAllSpecialServices method of the Validation Availability and Commitment service.
+
+
+
+
+ For use with FedEx Ground services only; COD must be present in shipment's special services.
+
+
+
+
+
+ Provides details about the batteries or cells that are contained within this specific package.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This information describes the kind of pending shipment being requested.
+
+
+
+
+
+ Date after which the pending shipment will no longer be available for completion.
+
+
+
+
+
+ These are documents that are recommended to be included with the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This class describes the pickup characteristics of a shipment (e.g. for use in a tag request).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The type of name (long, medium, short, etc.) to which this value refers.
+
+
+
+
+ The character encoding used to represent this product name. For example, UTF-8.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates the packaging type of the container used to package radioactive hazardous materials.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether packaging type "EXCEPTED" or "EXCEPTED_PACKAGE" is for radioactive material in reportable quantity.
+
+
+
+
+
+
+
+
+ Indicates the reason that a dim divisor value was chose.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Selects the value from a set of rate data to which the percentage is applied.
+
+
+
+
+
+
+
+
+
+
+ The response to a RateRequest. The Notifications indicate whether the request was successful or not.
+
+
+
+
+ This indicates the highest level of severity of all the notifications returned in this reply.
+
+
+
+
+ The descriptive data regarding the results of the submitted transaction.
+
+
+
+
+ Contains the CustomerTransactionId that was sent in the request.
+
+
+
+
+ The version of this reply.
+
+
+
+
+ Each element contains all rate data for a single service. If service was specified in the request, there will be a single entry in this array; if service was omitted in the request, there will be a separate entry in this array for each service being compared.
+
+
+
+
+
+
+
+
+
+ Descriptions and alternate identifiers for a service.
+
+
+
+
+
+ Shows the specific combination of service options combined with the service type that produced this committment in the set returned to the caller.
+
+
+
+
+ Supporting detail for applied options identified in preceding field.
+
+
+
+
+
+
+
+
+
+
+ Not populated by FAST service in Jan07.
+
+
+
+
+ Not populated by FAST service in Jan07.
+
+
+
+
+ Not populated by FAST service in Jan07.
+
+
+
+
+ Maximum expected transit time
+
+
+
+
+ Not populated by FAST service in Jan07. Actual signature option applied, to allow for cases in wihch the original value conflicted with other service features in the shipment.
+
+
+
+
+
+ Each element contains all rate data for a single rate type.
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+ Allows the caller to specify that the transit time and commit data are to be returned in the reply.
+
+
+
+
+ Candidate carriers for rate-shopping use case. This field is only considered if requestedShipment/serviceType is omitted.
+
+
+
+
+ Contains zero or more service options whose combinations are to be considered when replying with available services.
+
+
+
+
+ If provided, identifies the consolidation to which this open shipment should be added after successful creation.
+
+
+
+
+ The shipment for which a rate quote (or rate-shopping comparison) is desired.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+ Echoed from the corresponding package in the rate request (if provided).
+
+
+
+
+ Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.
+
+
+
+
+ The difference between "list" and "account" net charge.
+
+
+
+
+ Ground COD is shipment level.
+
+
+
+
+
+ Rate data that are tied to a specific package and rate type combination.
+
+
+
+
+
+
+ This class groups the shipment and package rating data for a specific rate type for use in a rating reply, which groups result data by rate type.
+
+
+
+
+ The difference between "list" and "account" total net charge.
+
+
+
+
+ Express COD is shipment level.
+
+
+
+
+ The shipment-level totals for this rate type.
+
+
+
+
+ The package-level data for this rate type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
+
+
+
+
+ Specifies the kind of identification being used.
+
+
+
+
+ Contains the actual ID value, of the type specified above.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
+
+
+
+
+
+
+
+ Type of documents that are recommended to be included with the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies details needed to generate any label artifacts required due to regulatory requirements.
+
+
+
+
+
+ Specifies how the customer requested the regulatory label to be generated.
+
+
+
+
+
+
+
+
+
+
+
+ Describes the vertical position of an item relative to another item.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of each requested package line item.
+
+
+
+
+ An identifier of each group of identical packages.
+
+
+
+
+ Used as the number or count of identical packages in a group.
+
+
+
+
+
+ Specifies the declared value for carriage of the package. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the package.
+
+
+
+
+ Represents the gross weight of the package line item.
+
+
+
+
+
+ Provides additional detail on how the customer has physically packaged this item. As of June 2009, required for packages moving under international and SmartPost services.
+
+
+
+
+
+ Human-readable text describing the package.
+
+
+
+
+ Human-readable text describing the contents of the package to be used for clearance purposes.
+
+
+
+
+
+
+ Details the contents of the package.
+
+
+
+
+
+
+
+
+
+
+
+ This field contains the service type values, like PRIORITY_OVERNIGHT and FEDEX_GROUND.
+
+
+
+
+ This field contains the packaging type values, like YOUR_PACKAGING and FEDEX_ENVELOPE.
+
+
+
+
+ The shipment variations for the current shipment expressed in key-value pairs.
+
+
+
+
+
+ Specifies the total declared value for carriage of the shipment. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the shipment.
+
+
+
+
+ This attribute indicates the currency the caller requests to have used in all returned monetary values (when a choice is possible).
+
+
+
+
+ Specifies details about the entity responsible for the shipment.
+
+
+
+
+
+
+
+ Physical starting address for the shipment, if different from shipper's address.
+
+
+
+
+ The sold-to party is used for customs clearance; for example, in support of US import customs rules. The need for this field could vary based on whether a sold-to party was specified on a consolidation.
+
+
+
+
+
+
+
+ Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
+
+
+
+
+ Used with Ground Home Delivery and Freight.
+
+
+
+
+
+ Customs clearance data, used for both international and intra-country shipping.
+
+
+
+
+ For use in "process tag" transaction.
+
+
+
+
+ Specifies the characteristics of a shipment pertaining to SmartPost services.
+
+
+
+
+ If true, only the shipper/payor will have visibility of this shipment.
+
+
+
+
+
+ Contains data used to create additional (non-label) shipping documents.
+
+
+
+
+ Specifies whether and what kind of rates the customer wishes to have quoted on this shipment. The reply will also be constrained by other data on the shipment and customer.
+
+
+
+
+ Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.
+
+
+
+
+ The total number of packages in the entire shipment (even when the shipment spans multiple transactions.)
+
+
+
+
+ Specifies which package-level data values are provided at the shipment-level only. The package-level data values types specified here will not be provided at the package-level.
+
+
+
+
+ Specifies data structures that may be re-used multiple times with s single shipment.
+
+
+
+
+ One or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics all packages in the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking number of the master associated with the return shipment.
+
+
+
+
+
+
+
+ These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
+
+
+
+
+
+
+ The instructions indicating how to print the return instructions( e.g. image type) Specifies characteristics of a shipping document to be produced.
+
+
+
+
+
+ Specifies additional customer provided text to be inserted into the return document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The "PAYOR..." rates are expressed in the currency identified in the payor's rate table(s). The "RATED..." rates are expressed in the currency of the origin country. Former "...COUNTER..." values have become "...RETAIL..." values, except for PAYOR_COUNTER and RATED_COUNTER, which have been removed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
+
+
+
+
+
+
+
+ Describes the rotation of an item from its default orientation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Branded, translated, and/or localized names for this service.
+
+
+
+
+
+
+
+
+ These values control the optional features of service that may be combined in a commitment/rate comparision transaction.
+
+
+
+
+
+
+
+
+
+
+
+ Supporting detail for applied options identified in a rate quote.
+
+
+
+
+ Identifies the type of Freight Guarantee applied, if FREIGHT_GUARANTEE is applied to the rate quote.
+
+
+
+
+ Identifies the smartPostHubId used during rate quote, if SMART_POST_HUB_ID is a variable option on the rate request.
+
+
+
+
+ Identifies the indicia used during rate quote, if SMART_POST_ALLOWED_INDICIA is a variable option on the rate request.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies data structures that may be re-used multiple times with s single shipment.
+
+
+
+
+ Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities.
+
+
+
+
+
+
+ Shipment-level totals of dry ice data across all packages.
+
+
+
+
+ Total number of packages in the shipment that contain dry ice.
+
+
+
+
+ Total shipment dry ice weight for all packages.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
+
+
+
+
+ Human-readable text describing the shipment leg.
+
+
+
+
+ Origin for this leg.
+
+
+
+
+ Specifies the location id the origin of shipment leg.
+
+
+
+
+ Destination for this leg.
+
+
+
+
+ Specifies the location id the destination of shipment leg.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates the rate scale used.
+
+
+
+
+ Indicates the rate zone used (based on origin and destination).
+
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+ Specifies the currency exchange performed on financial amounts for this rate.
+
+
+
+
+ Indicates which special rating cases applied to this shipment.
+
+
+
+
+
+ Identifies the type of dim divisor that was applied.
+
+
+
+
+
+
+ Sum of dimensional weights for all packages.
+
+
+
+
+
+
+
+
+ This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ Total of the transportation-based taxes.
+
+
+
+
+
+
+ Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
+
+
+
+
+ This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
+
+
+
+
+ Rate data specific to FedEx Freight and FedEx National Freight services.
+
+
+
+
+ All rate discounts that apply to this shipment.
+
+
+
+
+ All rebates that apply to this shipment.
+
+
+
+
+ All surcharges that apply to this shipment.
+
+
+
+
+ All transportation-based taxes applicable to this shipment.
+
+
+
+
+ All commodity-based duties and taxes applicable to this shipment.
+
+
+
+
+ The "order level" variable handling charges.
+
+
+
+
+ The total of all variable handling charges at both shipment (order) and package level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values identify which package-level data values will be provided at the shipment-level.
+
+
+
+
+
+
+
+
+
+ Data for a shipment's total/summary rates, as calculated per a specific rate type. The "total..." fields may differ from the sum of corresponding package data for Multiweight or Express MPS.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates the rate scale used.
+
+
+
+
+ Indicates the rate zone used (based on origin and destination).
+
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+ Specifies the currency exchange performed on financial amounts for this rate.
+
+
+
+
+ Indicates which special rating cases applied to this shipment.
+
+
+
+
+
+ Identifies the type of dim divisor that was applied.
+
+
+
+
+
+
+ Sum of dimensional weights for all packages.
+
+
+
+
+
+
+
+
+ This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ Total of the transportation-based taxes.
+
+
+
+
+
+
+ Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
+
+
+
+
+ Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
+
+
+
+
+ The total of the totalDutiesAndTaxes plus the totalAncillaryFeesAndTaxes.
+
+
+
+
+ This shipment's totalNetCharge + totalDutiesTaxesAndFees; some duties and taxes are only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
+
+
+
+
+ Identifies the Rate Details per each leg in a Freight Shipment
+
+
+
+
+ Rate data specific to FedEx Freight and FedEx National Freight services.
+
+
+
+
+ All rate discounts that apply to this shipment.
+
+
+
+
+ All rebates that apply to this shipment.
+
+
+
+
+ All surcharges that apply to this shipment.
+
+
+
+
+ All transportation-based taxes applicable to this shipment.
+
+
+
+
+ All commodity-based duties and taxes applicable to this shipment.
+
+
+
+
+ Identifies the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
+
+
+
+
+ The "order level" variable handling charges.
+
+
+
+
+ The total of all variable handling charges at both shipment (order) and package level.
+
+
+
+
+
+
+ These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ Indicates the shipment special service types that are requested on this shipment. For a list of the valid shipment special service types, please consult your integration documentation or get the list of the available special services from the getAllSpecialServices method of the Validation Availability and Commitment service.
+
+
+
+
+
+
+
+ This replaces eMailNotificationDetail
+
+
+
+
+
+ This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
+
+
+
+
+
+
+
+
+
+
+ Electronic Trade document references.
+
+
+
+
+ Specification for date or range of dates on which delivery is to be attempted.
+
+
+
+
+
+
+
+
+ Specifies the name or the key for the shipment variation.
+
+
+
+
+ The values that are valid for the specified shipment variation in the context of the current shipment.
+
+
+
+
+
+
+
+
+ This indicates the identifier of a conveyance, such as a trailer ID.
+
+
+
+
+
+
+ Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
+
+
+
+
+ Values in this field specify how to create and return the document.
+
+
+
+
+ Specifies how to organize all documents of this type.
+
+
+
+
+ Specifies how to e-mail document images.
+
+
+
+
+ Specifies how a queued document is to be printed.
+
+
+
+
+
+
+ Specifies how to return a shipping document to the caller.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to e-mail shipping documents.
+
+
+
+
+ Provides the roles and email addresses for e-mail recipients.
+
+
+
+
+ Identifies the convention by which documents are to be grouped as e-mail attachments.
+
+
+
+
+ Specifies the language in which the email containing the document is requested to be composed.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies an individual recipient of e-mailed shipping document(s).
+
+
+
+
+ Identifies the relationship of this recipient in the shipment.
+
+
+
+
+ Address to which the document is to be sent.
+
+
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies how to create, organize, and return the document.
+
+
+
+
+ Specifies how far down the page to move the beginning of the image; allows for printing on letterhead and other pre-printed stock.
+
+
+
+
+
+
+ For those shipping document types which have both a "form" and "instructions" component (e.g. NAFTA Certificate of Origin and General Agency Agreement), this field indicates whether to provide the instructions.
+
+
+
+
+
+ Governs the language to be used for this individual document, independently from other content returned for the same shipment.
+
+
+
+
+
+
+ Specifies how to organize all shipping documents of the same type.
+
+
+
+
+
+
+
+
+ Specifies the image format used for a shipping document.
+
+
+
+
+
+
+
+
+
+
+ Specifies printing options for a shipping document.
+
+
+
+
+ Provides environment-specific printer identification.
+
+
+
+
+
+
+ Contains all data required for additional (non-label) shipping documents to be produced in conjunction with a specific shipment.
+
+
+
+
+ Indicates the types of shipping documents requested by the shipper.
+
+
+
+
+
+
+ Specifies the production of each package-level custom document (the same specification is used for all packages).
+
+
+
+
+ Specifies the production of a shipment-level custom document.
+
+
+
+
+
+
+
+ Specifies the production of the OP-900 document for hazardous materials packages.
+
+
+
+
+ Specifies the production of the 1421c document for dangerous goods shipment.
+
+
+
+
+ Specifies the production of the OP-900 document for hazardous materials.
+
+
+
+
+ Specifies the production of the return instructions document.
+
+
+
+
+
+
+ Specifies the type of paper (stock) on which a document will be printed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values are mutually exclusive; at most one of them can be attached to a SmartPost shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required for shipments handled under the SMART_POST and GROUND_SMART_POST service types.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifice the kind of tax or miscellaneous charge being reported on a Commercial Invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the usage of Tax Identification Number in Shipment processing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the application that is responsible for managing the document id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Description of the uploaded document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This definition of variable handling charge detail is intended for use in Jan 2011 corp load.
+
+
+
+
+
+ Actual percentage (10 means 10%, which is a mutiplier of 0.1)
+
+
+
+
+ Select the value from a set of rate data to which the percentage is applied.
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Three-dimensional volume/cubic measurement.
+
+
+
+
+
+
+
+
+ Units of three-dimensional volume/cubic measure.
+
+
+
+
+
+
+
+
+ The descriptive data for the heaviness of an object.
+
+
+
+
+ Identifies the unit of measure associated with a weight value.
+
+
+
+
+ Identifies the weight value of a package/shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/ShipService_v17.wsdl b/fedex/wsdl/ShipService_v26.wsdl
old mode 100755
new mode 100644
similarity index 82%
rename from fedex/wsdl/ShipService_v17.wsdl
rename to fedex/wsdl/ShipService_v26.wsdl
index aaf596a..0150956
--- a/fedex/wsdl/ShipService_v17.wsdl
+++ b/fedex/wsdl/ShipService_v26.wsdl
@@ -1,6431 +1,6614 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the role that identifies the permissions the accessor of the pending shipment.
-
-
-
-
-
-
-
-
- Specifies additional labels to be produced. All required labels for shipments will be produced without the need to request additional labels. These are only available as thermal labels.
-
-
-
-
- The type of additional labels to return.
-
-
-
-
- The number of this type label to return
-
-
-
-
-
-
- Identifies the type of additional labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
-
-
-
-
- Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
-
-
-
-
- Name of city, town, etc.
-
-
-
-
- Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
-
-
-
-
- Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
-
-
-
-
- Relevant only to addresses in Puerto Rico.
-
-
-
-
- The two-letter code used to identify a country.
-
-
-
-
- The fully spelt out name of a country.
-
-
-
-
- Indicates whether this address residential (as opposed to commercial).
-
-
-
-
-
-
- Specifies the details around the ADR license required for shipping.
-
-
-
-
-
-
-
- Specifies details for a package containing alcohol
-
-
-
-
- The license type that the recipient of the alcohol package.
-
-
-
-
-
-
- Specifies the type of license that the recipient of the alcohol shipment has.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking id for the payment on the return.
-
-
-
-
- Specifies additional customer reference data about the associated shipment.
-
-
-
-
- Specifies shipment level operational information.
-
-
-
-
- Specifies package level operational information on the associated shipment. This information is not tied to an individual outbound package.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies which filing option is being exercised by the customer.
- Required for non-document shipments originating in Canada destined for any country other than Canada, the United States, Puerto Rico or the U.S. Virgin Islands.
-
-
-
-
-
-
-
-
-
-
-
-
- Identification of the type of barcode (symbology) used on FedEx documents and labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Each instance of this data type represents a barcode whose content must be represented as binary data (i.e. not ASCII text).
-
-
-
-
- The kind of barcode data in this instance.
-
-
-
-
- The data content of this instance.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identification of a FedEx operating company (transportation).
-
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the type of brokerage to be applied to a shipment.
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for the client submitting a transaction.
-
-
-
-
- The FedEx account number associated with this transaction.
-
-
-
-
- This number is assigned by FedEx and identifies the unique device from which the request is originating
-
-
-
-
- Only used in transactions which require identification of the FedEx Office integrator.
-
-
-
-
- The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
- Specifies the type of adjustment was performed to the COD collection amount during rating.
-
-
-
-
-
-
-
-
- Identifies the type of funds FedEx should collect upon shipment delivery.
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
-
-
-
-
-
- Specifies the details of the charges are to be added to the COD collect amount.
-
-
-
-
- Identifies the type of funds FedEx should collect upon package delivery
-
-
-
-
- For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
-
-
-
-
- When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
-
-
-
-
- Specifies the name of person or company receiving the secured/unsecured funds payment
-
-
-
-
- Indicates which type of reference information to include on the COD return shipping label.
-
-
-
-
- Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
-
-
-
-
-
-
- Specifies the information associated with a package that has COD special service in a ground shipment.
-
-
-
-
- The COD amount (after any accumulations) that must be collected upon delivery of a package shipped using the COD special service.
-
-
-
-
-
-
- Contains the data which form the Astra and 2DCommon barcodes that print on the COD return label.
-
-
-
-
- The label image or printer commands to print the label.
-
-
-
-
-
-
- Indicates which type of reference information to include on the COD return shipping label.
-
-
-
-
-
-
-
-
-
-
- CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through the FedEx Systems. Customers are responsible for printing their own Commercial Invoice.If you would likeFedEx to generate a Commercial Invoice and transmit it to Customs. for clearance purposes, you need to specify that in the ShippingDocumentSpecification element. If you would like a copy of the Commercial Invoice that FedEx generated returned to you in reply it needs to be specified in the ETDDetail/RequestedDocumentCopies element. Commercial Invoice support consists of maximum of 99 commodity line items.
-
-
-
-
- Any comments that need to be communicated about this shipment.
-
-
-
-
- Any freight charges that are associated with this shipment.
-
-
-
-
- Any taxes or miscellaneous charges(other than Freight charges or Insurance charges) that are associated with this shipment.
-
-
-
-
- Specifies which kind of charge is being recorded in the preceding field.
-
-
-
-
- Any packing costs that are associated with this shipment.
-
-
-
-
- Any handling costs that are associated with this shipment.
-
-
-
-
- Free-form text.
-
-
-
-
- Free-form text.
-
-
-
-
- Free-form text.
-
-
-
-
- The reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.
-
-
-
-
- Additional customer reference data.
-
-
-
-
- Name of the International Expert that completed the Commercial Invoice different from Sender.
-
-
-
-
- Required for dutiable international Express or Ground shipments. This field is not applicable to an international PIB(document) or a non-document which does not require a Commercial Invoice.
-
-
-
-
-
-
- The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
-
-
-
-
-
- Specifies the usage and identification of a customer supplied image to be used on this document.
-
-
-
-
-
-
-
- For international multiple piece shipments, commodity information must be passed in the Master and on each child transaction.
- If this shipment cotains more than four commodities line items, the four highest valued should be included in the first 4 occurances for this request.
-
-
-
-
-
- Name of this commodity.
-
-
-
-
- Total number of pieces of this commodity
-
-
-
-
- Complete and accurate description of this commodity.
-
- 450
-
-
-
-
-
- Country code where commodity contents were produced or manufactured in their final form.
-
- 2
-
-
-
-
-
-
- Unique alpha/numeric representing commodity item.
- At least one occurrence is required for US Export shipments if the Customs Value is greater than $2500 or if a valid US Export license is required.
-
-
- 14
-
-
-
-
-
- Total weight of this commodity. 1 explicit decimal position. Max length 11 including decimal.
-
-
-
-
- This field is used for enterprise transactions.
-
-
-
-
- Unit of measure used to express the quantity of this commodity line item.
-
- 3
-
-
-
-
-
- Contains only additional quantitative information other than weight and quantity to calculate duties and taxes.
-
-
-
-
- Value of each unit in Quantity. Six explicit decimal positions, Max length 18 including decimal.
-
-
-
-
-
- Total customs value for this line item.
- It should equal the commodity unit quantity times commodity unit value.
- Six explicit decimal positions, max length 18 including decimal.
-
-
-
-
-
- Defines additional characteristic of commodity used to calculate duties and taxes
-
-
-
-
- Applicable to US export shipping only.
-
- 12
-
-
-
-
-
-
- Date of expiration. Must be at least 1 day into future.
- The date that the Commerce Export License expires. Export License commodities may not be exported from the U.S. on an expired license.
- Applicable to US Export shipping only.
- Required only if commodity is shipped on commerce export license, and Export License Number is supplied.
-
-
-
-
-
-
- An identifying mark or number used on the packaging of a shipment to help customers identify a particular shipment.
-
-
- 15
-
-
-
-
-
-
- All data required for this commodity in NAFTA Certificate of Origin.
-
-
-
-
-
-
- Specifies the results of processing for the COD special service.
-
-
-
-
-
-
-
-
-
-
- The identifier for all clearance documents associated with this shipment.
-
-
-
-
-
-
-
- Completed package-level hazardous commodity information for a single package.
-
-
-
-
- A unique reference id that matches the package to a package configuration. This is populated if the client provided a package configuration for several packages that have the exact same dangerous goods content.
-
-
-
-
-
- When true indicates that the package can be transported only on a cargo aircraft.
-
-
-
-
-
- Specifies the maximum radiation level from the package (measured in microSieverts per hour at a distance of one meter from the external surface of the package, divided by 10).
-
-
-
-
- Specifies the label that is to be put on a package containing radioactive material. The label type is determined in accordance with the Transportation of Dangerous Goods Act and indicates the type of radioactive material being handled as well as the relative risk.
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current package.
-
-
-
-
-
-
- Computed shipment level hazardous commodity information.
-
-
-
-
-
-
- This contains the ADR License information, which identifies the license number and ADR category under which the customer is allowed to ship.
-
-
-
-
-
-
-
-
- Specifies the total number of packages containing hazardous commodities in small exceptions.
-
-
-
-
-
-
-
-
- Identifies the branded location name, the hold at location phone number and the address of the location.
-
-
-
-
- Identifies the type of FedEx location.
-
-
-
-
-
-
-
-
- The package sequence number of this package in a multiple piece shipment.
-
-
-
-
- The Tracking number and form id for this package.
-
-
-
-
- Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.
-
-
-
-
- Oversize class for this package.
-
-
-
-
- All package-level rating data for this package, which may include data for multiple rate types.
-
-
-
-
-
- The label image or printer commands to print the label.
-
-
-
-
- All package-level shipping documents (other than labels and barcodes). For use in loads after January, 2008.
-
-
-
-
- Specifies the information associated with this package that has COD special service in a ground shipment.
-
-
-
-
- Actual signature option applied, to allow for cases in which the original value conflicted with other service features in the shipment.
-
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current package, using updated hazardous commodity description data.
-
-
-
-
-
-
-
-
- Indicates whether or not this is a US Domestic shipment.
-
-
-
-
- Indicates the carrier that will be used to deliver this shipment.
-
-
-
-
- The master tracking number and form id of this multiple piece shipment. This information is to be provided for each subsequent of a multiple piece shipment.
-
-
-
-
- Description of the FedEx service used for this shipment. Currently not supported.
-
- 70
-
-
-
-
-
- Description of the packaging used for this shipment. Currently not supported.
-
- 40
-
-
-
-
-
-
- Only used with pending shipments.
-
-
-
-
- Only used in the reply to tag requests.
-
-
-
-
- Provides reply information specific to SmartPost shipments.
-
-
-
-
- Computed shipment level information about hazarous commodities.
-
-
-
-
- All shipment-level rating data for this shipment, which may include data for multiple rate types.
-
-
-
-
- Returns the default holding location information when HOLD_AT_LOCATION special service is requested and the client does not specify the hold location address.
-
-
-
-
- Returns any defaults or updates applied to RequestedShipment.exportDetail.exportComplianceStatement.
-
-
-
-
-
- All shipment-level shipping documents (other than labels and barcodes).
-
-
-
-
-
-
- Package level details about this package.
-
-
-
-
-
-
- Provides reply information specific to SmartPost shipments.
-
-
-
-
- Identifies the carrier that will pick up the SmartPost shipment.
-
-
-
-
- Indicates whether the shipment is deemed to be machineable, based on dimensions, weight, and packaging.
-
-
-
-
-
-
- Provides reply information specific to a tag request.
-
-
-
-
- .
-
-
-
-
- As of June 2007, returned only for FedEx Express services.
-
-
-
-
- As of June 2007, returned only for FedEx Express services.
-
-
-
-
- As of June 2007, returned only for FedEx Express services.
-
-
-
-
- As of June 2007, returned only for FedEx Express services.
-
-
-
-
- FEDEX INTERNAL USE ONLY: for use by INET.
-
-
-
-
-
-
- Defines additional data to print in the Configurable portion of the label, this allows you to print the same type information on the label that can also be printed on the doc tab.
-
-
-
-
- 1 of 12 possible zones to position data.
-
-
-
-
- The identifiying text for the data in this zone.
-
-
-
-
- A reference to a field in either the request or reply to print in this zone following the header.
-
-
-
-
- A literal value to print after the header in this zone.
-
-
-
-
-
-
- The descriptive data for a point-of-contact person.
-
-
-
-
- Client provided identifier corresponding to this contact information.
-
-
-
-
- Identifies the contact person's name.
-
-
-
-
- Identifies the contact person's title.
-
-
-
-
- Identifies the company this contact is associated with.
-
-
-
-
- Identifies the phone number associated with this contact.
-
-
-
-
- Identifies the phone extension associated with this contact.
-
-
-
-
- Identifies a toll free number, if any, associated with this contact.
-
-
-
-
- Identifies the pager number associated with this contact.
-
-
-
-
- Identifies the fax number associated with this contact.
-
-
-
-
- Identifies the email address associated with this contact.
-
-
-
-
-
-
-
-
-
-
-
-
- Content Record.
-
-
-
-
- Part Number.
-
-
-
-
- Item Number.
-
-
-
-
- Received Quantity.
-
-
-
-
- Description.
-
-
-
-
-
-
- Currency exchange rate information.
-
-
-
-
- The currency code for the original (converted FROM) currency.
-
-
-
-
- The currency code for the final (converted INTO) currency.
-
-
-
-
- Multiplier used to convert fromCurrency units to intoCurrency units.
-
-
-
-
-
-
-
-
- Indicates the type of custom delivery being requested.
-
-
-
-
- Time by which delivery is requested.
-
-
-
-
- Range of dates for custom delivery request; only used if type is BETWEEN.
-
-
-
-
- Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce a custom-specified document, either at shipment or package level.
-
-
-
-
- Common information controlling document production.
-
-
-
-
- Applicable only to documents produced on thermal printers with roll stock.
-
-
-
-
- Applicable only to documents produced on thermal printers with roll stock.
-
-
-
-
- Identifies the formatting specification used to construct this custom document.
-
-
-
-
- Identifies the individual document specified by the client.
-
-
-
-
- If provided, thermal documents will include specified doc tab content. If omitted, document will be produced without doc tab content.
-
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified barcode symbology.
-
-
-
-
-
-
-
-
- Width of thinnest bar/space element in the barcode.
-
-
-
-
-
-
-
- Solid (filled) rectangular area on label.
-
-
-
-
-
-
-
-
- Valid values for CustomLabelCoordinateUnits
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Image to be included from printer's memory, or from a local file for offline clients.
-
-
-
-
-
- Printer-specific index of graphic image to be printed.
-
-
-
-
- Fully-qualified path and file name for graphic image to be printed.
-
-
-
-
-
-
-
-
- Horizontal position, relative to left edge of custom area.
-
-
-
-
- Vertical position, relative to top edge of custom area.
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
-
-
-
-
-
-
-
-
-
- Printer-specific font name for use with thermal printer labels.
-
-
-
-
- Generic font name for use with plain paper labels.
-
-
-
-
- Generic font size for use with plain paper labels.
-
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
-
-
-
-
-
-
-
- Printer-specific font name for use with thermal printer labels.
-
-
-
-
- Generic font name for use with plain paper labels.
-
-
-
-
- Generic font size for use with plain paper labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Reference information to be associated with this package.
-
-
-
-
- The reference type to be associated with this reference data.
-
-
-
-
-
-
-
- The types of references available for use.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Allows customer-specified control of label content.
-
-
-
-
- If omitted, no doc tab will be produced (i.e. default is former NONE type).
-
-
-
-
- Controls the position of the customer specified content relative to the FedEx portion.
-
-
-
-
- Defines any custom content to print on the label.
-
-
-
-
- Defines additional data to print in the Configurable portion of the label, this allows you to print the same type information on the label that can also be printed on the doc tab.
-
-
-
-
- Controls which data/sections will be suppressed.
-
-
-
-
- For customers producing their own Ground labels, this field specifies which secondary barcode will be printed on the label; so that the primary barcode produced by FedEx has the correct SCNC.
-
-
-
-
-
-
- Controls the number of additional copies of supplemental labels.
-
-
-
-
- This value reduces the default quantity of destination/consignee air waybill labels. A value of zero indicates no change to default. A minimum of one copy will always be produced.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interacts both with properties of the shipment and contractual relationship with the shipper.
-
-
-
-
-
-
- Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
-
-
-
-
-
-
-
- Identifies responsibilities with respect to loss, damage, etc.
-
-
-
-
- Documents amount paid to third party for coverage of shipment content.
-
-
-
-
-
-
-
-
-
-
-
-
- This provides the information necessary to identify the different statements, declarations, acts, and/or certifications that apply to this shipment.
-
-
-
-
- This indicates the different statements, declarations, acts, and/or certifications that apply to this shipment.
-
-
-
-
- Specifies the NAFTA low value statement information.
-
-
-
-
-
-
- This indicates the different statements, declarations, acts, and certifications that may apply to a shipment.
-
-
-
-
-
-
-
-
-
-
- Specifies additional description about customs options. This is a required field when the customs options type is "OTHER".
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Describes an approved container used to package dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container.
-
-
-
-
- Indicates whether there are additional inner receptacles within this container.
-
-
-
-
- Indicates the type of this dangerous goods container, as specified by the IATA packing instructions. For example, steel cylinder, fiberboard box, plastic jerrican and steel drum.
-
-
-
-
- Indicates the packaging type of the container used to package the radioactive materials.
-
-
-
-
- Indicates the number of occurrences of this container with identical dangerous goods configuration.
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current container.
-
-
-
-
-
-
- The descriptive data required for a FedEx shipment containing dangerous goods (hazardous materials).
-
-
-
-
-
- Identifies whether or not the products being shipped are required to be accessible during delivery.
-
-
-
-
- Shipment is packaged/documented for movement ONLY on cargo aircraft.
-
-
-
-
- Indicates which kinds of hazardous content are in the current package.
-
-
-
-
- Indicates whether there is additional customer provided packaging enclosing the approved dangerous goods containers.
-
-
-
-
- Identifies the configuration of this dangerous goods package. The common configuration is represented at the shipment level.
-
-
-
-
- Indicates one or more containers used to pack dangerous goods commodities.
-
-
-
-
- Description of the packaging of this commodity, suitable for use on OP-900 and OP-950 forms.
-
-
-
-
- Name, title and place of the signatory for this shipment.
-
-
-
-
- Telephone number to use for contact in the event of an emergency.
-
-
-
-
- Offeror's name or contract number, per DOT regulation.
-
-
-
-
- Specifies the contact of the party responsible for handling the infectious substances, if any, in the dangerous goods shipment.
-
-
-
-
- Specifies additional handling information for the current package.
-
-
-
-
- Specifies the radioactivity detail for the current package, if the package contains radioactive materials.
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the 1421c form for dangerous goods shipment.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
- Specifies that name, title and place of the signatory responsible for the dangerous goods shipment.
-
-
-
-
-
-
- Indicates the place where the form is signed.
-
-
-
-
-
-
-
-
- The beginning date in a date range.
-
-
-
-
- The end date in a date range.
-
-
-
-
-
-
- Valid values for DayofWeekType
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data sent to FedEx by a customer in order to delete a package.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- The timestamp of the shipment request.
-
-
-
-
- Identifies the FedEx tracking number of the package being cancelled.
-
-
-
-
- Determines the type of deletion to be performed in relation to package level vs shipment level.
-
-
-
-
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Only used for tags which had FedEx Express services.
-
-
-
-
- Only used for tags which had FedEx Express services.
-
-
-
-
- If the original ProcessTagRequest specified third-party payment, then the delete request must contain the same pay type and payor account number for security purposes.
-
-
-
-
- Also known as Pickup Confirmation Number or Dispatch Number
-
-
-
-
-
-
- Specifies the type of deletion to be performed on a shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking id for the return, if preassigned.
-
-
-
-
-
-
- Data required to complete the Destionation Control Statement for US exports.
-
-
-
-
- List of applicable Statment types.
-
-
-
-
- Comma-separated list of up to four country codes, required for DEPARTMENT_OF_STATE statement.
-
-
-
-
- Name of end user, required for DEPARTMENT_OF_STATE statement.
-
-
-
-
-
-
- Used to indicate whether the Destination Control Statement is of type Department of Commerce, Department of State or both.
-
-
-
-
-
-
-
-
- The dimensions of this package and the unit type used for the measurements.
-
-
-
-
-
-
-
-
-
-
-
-
- The DocTabContentType options available.
-
-
-
-
- The DocTabContentType should be set to ZONE001 to specify additional Zone details.
-
-
-
-
- The DocTabContentType should be set to BARCODED to specify additional BarCoded details.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Zone number can be between 1 and 12.
-
-
-
-
- Header value on this zone.
-
-
-
-
- Reference path to the element in the request/reply whose value should be printed on this zone.
-
-
-
-
- Free form-text to be printed in this zone.
-
-
-
-
- Justification for the text printed on this zone.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the method by which the package is to be tendered to FedEx. This element does not dispatch a courier for package pickup.
-
-
-
-
-
-
-
-
-
-
-
- Describes specific information about the email label shipment.
-
-
-
-
- Content of the email message.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Information describing email notifications that will be sent in relation to events that occur during package movement
-
-
-
-
- Specifies whether/how email notifications are grouped.
-
-
-
-
- A message that will be included in the email notifications
-
-
-
-
- Information describing the destination of the email, format of the email and events to be notified on
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The format of the email
-
-
-
-
-
-
-
-
-
- The descriptive data for a FedEx email notification recipient.
-
-
-
-
- Identifies the relationship this email recipient has to the shipment.
-
-
-
-
- The email address to send the notification to
-
-
-
-
- The types of email notifications being requested for this recipient.
-
-
-
-
- The format of the email notification.
-
-
-
-
- The language/locale to be used in this email notification.
-
-
-
-
-
-
- Identifies the set of valid email notification recipient types. For SHIPPER, RECIPIENT and BROKER the email address asssociated with their definitions will be used, any email address sent with the email notification for these three email notification recipient types will be ignored.
-
-
-
-
-
-
-
-
-
-
-
- Information describing the address of of the email recipient, role of the email recipient and languages that are requested to be supported.
-
-
-
-
- EMail address of the recipient.
-
-
-
-
- The relationship that the customer has to the pending shipment.
-
-
-
-
- Specifies how the email notification for the pending shipment need to be processed.
-
-
-
-
- Localization and language details specified by the recipient of the EMail.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Customer-declared value, with data type and legal values depending on excise condition, used in defining the taxable value of the item.
-
-
-
-
-
-
- Specifies the types of Estimated Duties and Taxes to be included in a rate quotation for an international shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how to apply the localization detail to the current context.
-
-
-
-
-
-
-
- Electronic Trade document references used with the ETD special service.
-
-
-
-
- Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
-
-
-
-
-
-
-
- The instructions indicating how to print the Export Declaration.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
- Country specific details of an International shipment.
-
-
-
-
-
- Specifies which filing option is being exercised by the customer.
- Required for non-document shipments originating in Canada destined for any country other than Canada, the United States, Puerto Rico or the U.S. Virgin Islands.
-
-
-
-
-
- General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).
-
-
-
-
- This field is applicable only to Canada export non-document shipments of any value to any destination. No special characters allowed.
-
- 10
-
-
-
-
-
- Department of Commerce/Department of State information about this shipment.
-
-
-
-
-
-
- Details specific to an Express freight shipment.
-
-
-
-
- Indicates whether or nor a packing list is enclosed.
-
-
-
-
-
- Total shipment pieces.
- e.g. 3 boxes and 3 pallets of 100 pieces each = Shippers Load and Count of 303.
- Applicable to International Priority Freight and International Economy Freight.
- Values must be in the range of 1 - 99999
-
-
-
-
-
- Required for International Freight shipping. Values must be 8- 12 characters in length.
-
- 12
-
-
-
-
-
-
-
- Identifies a kind of FedEx facility.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce the Freight handling-unit-level address labels. Note that the number of UNIQUE labels (the N as in 1 of N, 2 of N, etc.) is determined by total handling units.
-
-
-
-
-
- Indicates the number of copies to be produced for each unique label.
-
-
-
-
- Specifies the quadrant of the page on which the label printing will start.
-
-
-
-
- If omitted, no doc tab will be produced (i.e. default = former NONE type).
-
-
-
-
- Controls the position of the customer specified content relative to the FedEx portion.
-
-
-
-
-
-
-
- Individual charge which contributes to the total base charge for the shipment.
-
-
-
-
- Freight class for this line item.
-
-
-
-
- Effective freight class used for rating this line item.
-
-
-
-
- NMFC Code for commodity.
-
-
-
-
- Customer-provided description for this commodity or class line.
-
-
-
-
- Weight for this commodity or class line.
-
-
-
-
- Rate or factor applied to this line item.
-
-
-
-
- Identifies the manner in which the chargeRate for this line item was applied.
-
-
-
-
- The net or extended charge for this line item.
-
-
-
-
-
-
- Specifies the way in which base charges for a Freight shipment or shipment leg are calculated.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These values represent the industry-standard freight classes used for FedEx Freight and FedEx National Freight shipment description. (Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms.)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Date for all Freight guarantee types.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies responsibilities with respect to loss, damage, etc.
-
-
-
-
-
-
-
-
- Rate data specific to FedEx Freight or FedEx National Freight services.
-
-
-
-
- A unique identifier for a specific rate quotation.
-
-
-
-
- Specifies whether the rate quote was automated or manual.
-
-
-
-
- Specifies how total base charge is determined.
-
-
-
-
- Freight charges which accumulate to the total base charge for the shipment.
-
-
-
-
- Human-readable descriptions of additional information on this shipment rating.
-
-
-
-
-
-
- Additional non-monetary data returned with Freight rates.
-
-
-
-
- Unique identifier for notation.
-
-
-
-
- Human-readable explanation of notation.
-
-
-
-
-
-
- Specifies the type of rate quote
-
-
-
-
-
-
-
-
- Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
-
-
-
-
- Account number used with FEDEX_FREIGHT service.
-
-
-
-
- Used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
-
-
-
-
- Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
-
-
-
-
- Identification values to be printed during creation of a Freight bill of lading.
-
-
-
-
- Indicates the role of the party submitting the transaction.
-
-
-
-
- Designates the terms of the "collect" payment for a Freight Shipment.
-
-
-
-
- Identifies the declared value for the shipment
-
-
-
-
- Identifies the declared value units corresponding to the above defined declared value
-
-
-
-
-
- Identifiers for promotional discounts offered to customers.
-
-
-
-
- Total number of individual handling units in the entire shipment (for unit pricing).
-
-
-
-
- Estimated discount rate provided by client for unsecured rate quote.
-
-
-
-
- Total weight of pallets used in shipment.
-
-
-
-
- Overall shipment dimensions.
-
-
-
-
- Description for the shipment.
-
-
-
-
- Specifies which party will pay surcharges for any special services which support split billing.
-
-
-
-
- Must be populated if any line items contain hazardous materials.
-
-
-
-
-
- Details of the commodities in the shipment.
-
-
-
-
-
-
- Description of an individual commodity or class of content in a shipment.
-
-
-
-
- Freight class for this line item.
-
-
-
-
- FEDEX INTERNAL USE ONLY: for FedEx system that estimate freight class from customer-provided dimensions and weight.
-
-
-
-
- Number of individual handling units to which this line applies. (NOTE: Total of line-item-level handling units may not balance to shipment-level total handling units.)
-
-
-
-
- Specification of handling-unit packaging for this commodity or class line.
-
-
-
-
- Number of pieces for this commodity or class line.
-
-
-
-
- NMFC Code for commodity.
-
-
-
-
- Indicates the kind of hazardous material content in this line item.
-
-
-
-
- For printed reference per line item.
-
-
-
-
- Customer-provided description for this commodity or class line.
-
-
-
-
- Weight for this commodity or class line.
-
-
-
-
- FED EX INTERNAL USE ONLY - Individual line item dimensions.
-
-
-
-
- Volume (cubic measure) for this commodity or class line.
-
-
-
-
-
-
- Indicates the role of the party submitting the transaction.
-
-
-
-
-
-
-
-
- Specifies which party will be responsible for payment of any surcharges for Freight special services for which split billing is allowed.
-
-
-
-
- Identifies the special service.
-
-
-
-
- Indicates who will pay for the special service.
-
-
-
-
-
-
- Data required to produce a General Agency Agreement document. Remaining content (business data) to be defined once requirements have been completed.
-
-
-
-
-
-
-
- Represents features of FedEx Ground delivery for which the shipment is eligible.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Documents the kind and quantity of an individual hazardous commodity in a package.
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Specifies the amount of the commodity in alternate units.
-
-
-
-
- This describes the inner receptacle details for a hazardous commodity within the dangerous goods container.
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- Specifies the details of any radio active materials within the commodity.
-
-
-
-
- The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
-
-
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Regulatory identifier for a commodity (e.g. "UN ID" value).
-
-
-
-
- In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates any special processing options to be applied to the description of the dangerous goods commodity.
-
-
-
-
- Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
-
-
-
-
-
-
- Specifies any special processing to be applied to the dangerous goods commodity description validation.
-
-
-
-
-
-
-
- This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container.
-
-
-
-
- This specifies the quantity contained in the inner receptacle.
-
-
-
-
-
-
- Specifies how the commodity is to be labeled.
-
-
-
-
-
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- Specifies how the customer wishes the label text to be handled for this commodity in this package.
-
-
-
-
- Text used in labeling the commodity under control of the labelTextOption field.
-
-
-
-
-
-
- Indicates which kind of hazardous content is being reported.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies number and type of packaging units for hazardous commodities.
-
-
-
-
- Number of units of the type below.
-
-
-
-
- Units in which the hazardous commodity is packaged.
-
-
-
-
-
-
- Specifies documentation and limits for validation of an individual packing group/category.
-
-
-
-
-
- Coded specification for how commodity is to be packed.
-
-
-
-
-
-
- Identifies DOT packing group for a hazardous commodity.
-
-
-
-
-
-
-
-
-
-
- Identifies amount and units for quantity of hazardous commodities.
-
-
-
-
- Number of units of the type below.
-
-
-
-
- Units by which the hazardous commodity is measured. For IATA commodity, the units values are restricted based on regulation type.
-
-
-
-
- Specifies which measure of quantity is to be validated.
-
-
-
-
-
-
- Specifies the measure of quantity to be validated against a prescribed limit.
-
-
-
-
-
-
-
-
- Identifies the source of regulation for hazardous commodity data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data required for a FedEx shipment that is to be held at the destination FedEx location for pickup by the recipient.
-
-
-
-
- Contact phone number for recipient of shipment.
-
-
-
-
- Contact and address of FedEx facility at which shipment is to be held.
-
-
-
-
- Type of facility at which package/shipment is to be held.
-
-
-
-
-
-
- The descriptive data required by FedEx for home delivery services.
-
-
-
-
- The type of Home Delivery Premium service being requested.
-
-
-
-
- Required for Date Certain Home Delivery.
-
-
-
-
- Required for Date Certain and Appointment Home Delivery.
-
- 15
-
-
-
-
-
-
-
- The type of Home Delivery Premium service being requested.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The type of International shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the type of label to be returned.
-
-
-
-
-
-
-
-
-
-
- Names for data elements / areas which may be suppressed from printing on labels.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the order in which the labels will be returned
-
-
-
-
-
-
-
-
- This indicates if the top or bottom of the label comes out of the printer first.
-
-
-
-
-
-
-
-
- Relative to normal orientation for the printer.
-
-
-
-
-
-
-
-
-
-
- Description of shipping label to be returned in the reply
-
-
-
-
- Specifies how to create, organize, and return the document.
-
-
-
-
- Specify type of label to be returned
-
-
-
-
- Specifies the image format used for a shipping document.
-
-
-
-
- For thermal printer lables this indicates the size of the label and the location of the doc tab if present.
-
-
-
-
- This indicates if the top or bottom of the label comes out of the printer first.
-
-
-
-
- Specifies the order in which the labels are requested to be returned
-
-
-
-
- If present, this contact and address information will replace the return address information on the label.
-
-
-
-
- Allows customer-specified control of label content.
-
-
-
-
-
-
- For thermal printer labels this indicates the size of the label and the location of the doc tab if present.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the Liability Coverage Amount. For Jan 2010 this value represents coverage amount per pound
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- License or Permit Number.
-
-
-
-
- Specifies the effective date of the license.
-
-
-
-
- Specifies the expiration date of the license.
-
-
-
-
-
-
- Represents a one-dimensional measurement in small units (e.g. suitable for measuring a package or document), contrasted with Distance, which represents a large one-dimensional measurement (e.g. distance between cities).
-
-
-
-
- The numerical quantity of this measurement.
-
-
-
-
- The units for this measurement.
-
-
-
-
-
-
- CM = centimeters, IN = inches
-
-
-
-
-
-
-
-
- Identifies the representation of human-readable text.
-
-
-
-
- Two-letter code for language (e.g. EN, FR, etc.)
-
-
-
-
- Two-letter code for the region (e.g. us, ca, etc..).
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies which type minimum charge was applied.
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data for the medium of exchange for FedEx services.
-
-
-
-
- Identifies the currency of the monetary amount.
-
- 3
-
-
-
-
-
- Identifies the monetary amount.
-
-
-
-
-
-
- Data required to produce a Certificate of Origin document. Remaining content (business data) to be defined once requirements have been completed.
-
-
-
-
-
-
- Indicates which Party (if any) from the shipment is to be used as the source of importer data on the NAFTA COO form.
-
-
-
-
- Contact information for "Authorized Signature" area of form.
-
-
-
-
-
-
-
-
-
- This element is currently not supported and is for the future use.
-
-
-
-
- Defined by NAFTA regulations.
-
-
-
-
- Defined by NAFTA regulations.
-
-
-
-
- Identification of which producer is associated with this commodity (if multiple producers are used in a single shipment).
-
-
-
-
-
- Date range over which RVC net cost was calculated.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the information necessary for printing the NAFTA Low Value statement on customs documentation.
-
-
-
-
- Specifies the NAFTA statement role.
-
-
-
-
-
-
- Net cost method used.
-
-
-
-
-
-
-
-
- See instructions for NAFTA Certificate of Origin for code definitions.
-
-
-
-
-
-
-
-
-
-
-
-
- This element is currently not supported and is for the future use.
-
-
-
-
-
-
-
-
- See instructions for NAFTA Certificate of Origin for code definitions.
-
-
-
-
-
-
-
-
-
-
- This element is currently not supported and is for the future use.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data regarding the result of the submitted transaction.
-
-
-
-
- The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
-
-
-
-
- Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
-
-
-
-
- A code that represents this notification. Combined with the Source it uniquely identifies this notification.
-
-
-
-
- Human-readable text that explains this notification.
-
-
-
-
- The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
-
-
-
-
- A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) witout having to parse the message string.
-
-
-
-
-
-
-
-
- Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
-
-
-
-
- The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
-
-
-
-
-
-
- Identifies the set of severity values for a Notification.
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the OP-900 form for hazardous materials packages.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Identifies which reference type (from the package's customer references) is to be used as the source for the reference on this OP-900.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
- Data field to be used when a name is to be printed in the document instead of (or in addition to) a signature image.
-
-
-
-
-
-
-
-
- Position of operational instruction element.
-
-
-
-
- Content corresponding to the operational instruction.
-
-
-
-
-
-
- The oversize class types.
-
-
-
-
-
-
-
-
-
- Each instance of this data type represents the set of barcodes (of all types) which are associated with a specific package.
-
-
-
-
- Binary-style barcodes for this package.
-
-
-
-
- String-style barcodes for this package.
-
-
-
-
-
-
- Package-level data required for labeling and/or movement.
-
-
-
-
- Human-readable text for pre-January 2011 clients.
-
-
-
-
- Human-readable content for use on a label.
-
-
-
-
- The operational barcodes pertaining to the current package.
-
-
-
-
- The FedEx internal code that represents the service and/or features of service for the current package moving under a FedEx Ground service.
-
-
-
-
-
-
- Data for a package's rates, as calculated per a specific rate type.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- The weight that was used to calculate the rate.
-
-
-
-
- The dimensional weight of this package (if greater than actual).
-
-
-
-
- The oversize weight of this package (if the package is oversize).
-
-
-
-
- The transportation charge only (prior to any discounts applied) for this package.
-
-
-
-
- The sum of all discounts on this package.
-
-
-
-
- This package's baseCharge - totalFreightDiscounts.
-
-
-
-
- The sum of all surcharges on this package.
-
-
-
-
- This package's netFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- The sum of all taxes on this package.
-
-
-
-
- This package's netFreight + totalSurcharges + totalTaxes.
-
-
-
-
- The total sum of all rebates applied to this package.
-
-
-
-
- All rate discounts that apply to this package.
-
-
-
-
- All rebates that apply to this package.
-
-
-
-
- All surcharges that apply to this package (either because of characteristics of the package itself, or because it is carrying per-shipment surcharges for the shipment of which it is a part).
-
-
-
-
- All taxes applicable (or distributed to) this package.
-
-
-
-
- The variable handling charges calculated based on the type variable handling charges requested.
-
-
-
-
-
-
- This class groups together for a single package all package-level rate data (across all rate types) as part of the response to a shipping request, which groups shipment-level data together and groups package-level data by package.
-
-
-
-
- This rate type identifies which entry in the following array is considered as presenting the "actual" rates for the package.
-
-
-
-
- The "list" net charge minus "actual" net charge.
-
-
-
-
- Each element of this field provides package-level rate data for a specific rate type.
-
-
-
-
-
-
- Identifies the collection of special service offered by FedEx. BROKER_SELECT_OPTION should be used for Ground shipments only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These special services are available at the package level for some or all service types. If the shipper is requesting a special service which requires additional data, the package special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
-
-
-
-
- The types of all special services requested for the enclosing shipment or package.
-
-
-
-
- For use with FedEx Ground services only; COD must be present in shipment's special services.
-
-
-
-
- Descriptive data required for a FedEx shipment containing dangerous materials. This element is required when SpecialServiceType.DANGEROUS_GOODS or HAZARDOUS_MATERIAL is present in the SpecialServiceTypes collection.
-
-
-
-
- Descriptive data required for a FedEx shipment containing dry ice. This element is required when SpecialServiceType.DRY_ICE is present in the SpecialServiceTypes collection.
-
-
-
-
- The descriptive data required for FedEx signature services. This element is required when SpecialServiceType.SIGNATURE_OPTION is present in the SpecialServiceTypes collection.
-
-
-
-
- The descriptive data required for FedEx Priority Alert service. This element is required when SpecialServiceType.PRIORITY_ALERT is present in the SpecialServiceTypes collection.
-
-
-
-
-
-
-
- Identifies the collection of available FedEx or customer packaging options.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data for a person or company entitiy doing business with FedEx.
-
-
-
-
- Identifies the FedEx account number assigned to the customer.
-
- 12
-
-
-
-
-
-
- Descriptive data identifying the point-of-contact person.
-
-
-
-
- The descriptive data for a physical location.
-
-
-
-
-
-
- The descriptive data for the monetary compensation given to FedEx for services rendered to the customer.
-
-
-
-
- Identifies the method of payment for a service. See PaymentType for list of valid enumerated values.
-
-
-
-
- Descriptive data identifying the party responsible for payment for a service.
-
-
-
-
-
-
- Identifies the method of payment for a service.
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data identifying the party responsible for payment for a service.
-
-
-
-
-
-
-
- This information describes how and when a pending shipment may be accessed for completion.
-
-
-
-
-
-
-
- Specifies the details to be used by the user of the pending shipment
-
-
-
-
- Specifies the role of the user who is trying to access the pending shipment.
-
-
-
-
-
-
-
-
-
- This information describes the kind of pending shipment being requested.
-
-
-
-
- Identifies the type of FedEx pending shipment
-
-
-
-
- Date after which the pending shipment will no longer be available for completion.
-
-
-
-
- Only used with type of EMAIL.
-
-
-
-
-
- These are documents that are recommended to be included with the shipment.
-
-
-
-
- Upload document details provided by the initator of the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the type of service for a pending shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This class describes the pickup characteristics of a shipment (e.g. for use in a tag request).
-
-
-
-
-
-
-
- Identifies the type of Pickup request
-
-
-
-
- Identifies the type of source for Pickup request
-
-
-
-
-
-
- Identifies the type of source for pickup request service.
-
-
-
-
-
-
-
-
- Identifies the type of pickup request service.
-
-
-
-
-
-
-
-
- Identifies the type of pricing used for this shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents a reference identifier printed on Freight bills of lading
-
-
-
-
-
-
-
-
- Identifies a particular reference identifier printed on a Freight bill of lading.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This indicates the highest level of severity of all the notifications returned in this reply
-
-
-
-
- The descriptive data regarding the results of the submitted transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
-
- The reply payload. All of the returned information about this shipment/package.
-
-
-
-
- Empty unless error label behavior is PACKAGE_ERROR_LABELS and one or more errors occured during transaction processing.
-
-
-
-
-
-
- Descriptive data sent to FedEx by a customer in order to ship a package.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Descriptive data about the shipment being sent by the requestor.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data sent to FedEx by a customer in order to ship a package.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Descriptive data about the shipment being sent by the requestor.
-
-
-
-
-
-
- Test for the Commercial Invoice. Note that Sold is not a valid Purpose for a Proforma Invoice.
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates the packaging type of the container used to package radioactive hazardous materials.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates whether packaging type "EXCEPTED" or "EXCEPTED_PACKAGE" is for radioactive material in reportable quantity.
-
-
-
-
-
-
-
-
- Indicates the reason that a dim divisor value was chose.
-
-
-
-
-
-
-
-
-
-
-
- Identifies a discount applied to the shipment.
-
-
-
-
- Identifies the type of discount applied to the shipment.
-
-
-
-
-
- The amount of the discount applied to the shipment.
-
-
-
-
- The percentage of the discount applied to the shipment.
-
-
-
-
-
-
- The type of the discount.
-
-
-
-
-
-
-
-
-
-
-
-
- Selects the value from a set of rate data to which the percentage is applied.
-
-
-
-
-
-
-
-
-
-
- Identifies the type(s) of rates to be returned in the reply.
-
-
-
-
-
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
- The weight method used to calculate the rate.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
-
-
-
-
- Specifies the kind of identification being used.
-
-
-
-
- Contains the actual ID value, of the type specified above.
-
-
-
-
-
-
- Type of Brazilian taxpayer identifier provided in Recipient/TaxPayerIdentification/Number. For shipments bound for Brazil this overrides the value in Recipient/TaxPayerIdentification/TinType
-
-
-
-
-
-
-
-
-
- Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
-
-
-
-
-
-
-
- Type of documents that are recommended to be included with the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- FOOD_OR_PERISHABLE is required by FDA/BTA; must be true for food/perishable items coming to US or PR from non-US/non-PR origin
-
-
-
-
-
-
-
-
-
-
- Specifies details needed to generate any label artifacts required due to regulatory requirements.
-
-
-
-
-
- Specifies how the customer requested the regulatory label to be generated.
-
-
-
-
-
-
-
-
-
-
-
- Describes the vertical position of an item relative to another item.
-
-
-
-
-
-
-
-
- This class rationalizes RequestedPackage and RequestedPackageSummary from previous interfaces.
-
-
-
-
- Used only with INDIVIDUAL_PACKAGE, as a unique identifier of each requested package.
-
-
-
-
- Used only with PACKAGE_GROUPS, as a unique identifier of each group of identical packages.
-
-
-
-
- Used only with PACKAGE_GROUPS, as a count of packages within a group of identical packages.
-
-
-
-
-
- Specifies the declared value for carriage of the package. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the package. This field is only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for PACKAGE_SUMMARY, in which case totalInsuredValue and packageCount on the shipment will be used to determine this value.
-
-
-
-
- Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for PACKAGE_SUMMARY, in which case total weight and packageCount on the shipment will be used to determine this value.
-
-
-
-
-
- Provides additional detail on how the customer has physically packaged this item. As of June 2009, required for packages moving under international and SmartPost services.
-
-
-
-
- Human-readable text describing the package.
-
-
-
-
- Human-readable text describing the contents of the package to be used for clearance purposes.
-
-
-
-
-
-
- Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS.
-
-
-
-
-
-
- The descriptive data for the shipment being tendered to FedEx.
-
-
-
-
- Identifies the date and time the package is tendered to FedEx. Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local time of the shipment based on the shipper's time zone. The date component must be in the format: YYYY-MM-DD (e.g. 2006-06-26). The time component must be in the format: HH:MM:SS using a 24 hour clock (e.g. 11:00 a.m. is 11:00:00, whereas 5:00 p.m. is 17:00:00). The date and time parts are separated by the letter T (e.g. 2006-06-26T17:00:00). There is also a UTC offset component indicating the number of hours/mainutes from UTC (e.g 2006-06-26T17:00:00-0400 is defined form June 26, 2006 5:00 pm Eastern Time).
-
-
-
-
- Identifies the method by which the package is to be tendered to FedEx. This element does not dispatch a courier for package pickup. See DropoffType for list of valid enumerated values.
-
-
-
-
- Identifies the FedEx service to use in shipping the package. See ServiceType for list of valid enumerated values.
-
-
-
-
- Identifies the packaging used by the requestor for the package. See PackagingType for list of valid enumerated values.
-
-
-
-
- This specifies information related to the manifest associated with the shipment.
-
-
-
-
- Identifies the total weight of the shipment being conveyed to FedEx.This is only applicable to International shipments and should only be used on the first package of a mutiple piece shipment.This value contains 1 explicit decimal position
-
-
-
-
- Specifies the total declared value for carriage of the shipment. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the shipment.
-
-
-
-
- This attribute indicates the currency the caller requests to have used in all returned monetary values (when a choice is possible).
-
-
-
-
- Descriptive data identifying the party responsible for shipping the package. Shipper and Origin should have the same address.
-
-
-
-
- Descriptive data identifying the party receiving the package.
-
-
-
-
- A unique identifier for a recipient location
-
- 10
-
-
-
-
-
- Physical starting address for the shipment, if different from shipper's address.
-
-
-
-
-
- Descriptive data indicating the method and means of payment to FedEx for providing shipping services.
-
-
-
-
- Descriptive data regarding special services requested by the shipper for this shipment. If the shipper is requesting a special service which requires additional data (e.g. COD), the special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object. For example, to request COD, "COD" must be included in the SpecialServiceTypes collection and the CodDetail object must contain the required data.
-
-
-
-
- Details specific to an Express freight shipment.
-
-
-
-
- Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
-
-
-
-
- Used with Ground Home Delivery and Freight.
-
-
-
-
- Details about how to calculate variable handling charges at the shipment level.
-
-
-
-
- Customs clearance data, used for both international and intra-country shipping.
-
-
-
-
- For use in "process tag" transaction.
-
-
-
-
- Specifies the characteristics of a shipment pertaining to SmartPost services.
-
-
-
-
- If true, only the shipper/payor will have visibility of this shipment.
-
-
-
-
- Details about the image format and printer type the label is to returned in.
-
-
-
-
- Contains data used to create additional (non-label) shipping documents.
-
-
-
-
- Specifies whether and what kind of rates the customer wishes to have quoted on this shipment. The reply will also be constrained by other data on the shipment and customer.
-
-
-
-
- Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.
-
-
-
-
- Only used with multiple-transaction shipments, to identify the master package in a multi-piece shipment.
-
-
-
-
- The total number of packages in the entire shipment (even when the shipment spans multiple transactions.)
-
-
-
-
- Specifies data structures that may be re-used multiple times with s single shipment.
-
-
-
-
- One or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics all packages in the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking number of the master associated with the return shipment.
-
-
-
-
-
-
-
- These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
-
-
-
-
-
-
-
-
- Return Email Details
-
-
-
-
- Phone number of the merchant
-
-
-
-
- Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
-
-
-
-
-
-
- The instructions indicating how to print the return instructions( e.g. image type) Specifies characteristics of a shipping document to be produced.
-
-
-
-
-
- Specifies additional customer provided text to be inserted into the return document.
-
-
-
-
-
-
- Information relating to a return shipment.
-
-
-
-
- The type of return shipment that is being requested.
-
-
-
-
- Return Merchant Authorization
-
-
-
-
- Describes specific information about the email label for return shipment.
-
-
-
-
-
-
-
- The type of return shipment that is being requested.
-
-
-
-
-
-
-
-
-
- The "PAYOR..." rates are expressed in the currency identified in the payor's rate table(s). The "RATED..." rates are expressed in the currency of the origin country. Former "...COUNTER..." values have become "...RETAIL..." values, except for PAYOR_COUNTER and RATED_COUNTER, which have been removed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Shipping document type.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
-
-
-
-
- The reason for the return.
-
- 60
-
-
-
-
-
-
-
- Describes the rotation of an item from its default orientation.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the collection of available FedEx service options.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies data structures that may be re-used multiple times with s single shipment.
-
-
-
-
- Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities.
-
-
-
-
-
-
- Shipment-level totals of dry ice data across all packages.
-
-
-
-
- Total number of packages in the shipment that contain dry ice.
-
-
-
-
- Total shipment dry ice weight for all packages.
-
-
-
-
-
-
- Data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
-
-
-
-
- Human-readable text describing the shipment leg.
-
-
-
-
- Origin for this leg.
-
-
-
-
- Specifies the location id the origin of shipment leg.
-
-
-
-
- Destination for this leg.
-
-
-
-
- Specifies the location id the destination of shipment leg.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates the rate scale used.
-
-
-
-
- Indicates the rate zone used (based on origin and destination).
-
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- Specifies the currency exchange performed on financial amounts for this rate.
-
-
-
-
- Indicates which special rating cases applied to this shipment.
-
-
-
-
-
- Identifies the type of dim divisor that was applied.
-
-
-
-
-
-
- Sum of dimensional weights for all packages.
-
-
-
-
-
-
-
-
- This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- Total of the transportation-based taxes.
-
-
-
-
-
-
- Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
-
-
-
-
- This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
-
-
-
-
- Rate data specific to FedEx Freight and FedEx National Freight services.
-
-
-
-
- All rate discounts that apply to this shipment.
-
-
-
-
- All rebates that apply to this shipment.
-
-
-
-
- All surcharges that apply to this shipment.
-
-
-
-
- All transportation-based taxes applicable to this shipment.
-
-
-
-
- All commodity-based duties and taxes applicable to this shipment.
-
-
-
-
- The "order level" variable handling charges.
-
-
-
-
- The total of all variable handling charges at both shipment (order) and package level.
-
-
-
-
-
-
-
-
- This identifies which customer reference field contains the manifest ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This is the state of the destination location ID, and is not necessarily the same as the postal state.
-
-
-
-
- Expected/estimated date of delivery.
-
-
-
-
- Expected/estimated day of week of delivery.
-
-
-
-
- Delivery time, as published in Service Guide.
-
-
-
-
- Committed date of delivery.
-
-
-
-
- Committed day of week of delivery.
-
-
-
-
- Standard transit time per origin, destination, and service.
-
-
-
-
- Maximum expected transit time
-
-
-
-
- Transit time based on customer eligibility.
-
-
-
-
- Indicates that this shipment is not eligible for money back guarantee.
-
-
-
-
- FedEx Ground delivery features for which this shipment may be eligible.
-
-
-
-
- Text describing planned delivery.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data for a shipment's total/summary rates, as calculated per a specific rate type. The "total..." fields may differ from the sum of corresponding package data for Multiweight or Express MPS.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates the rate scale used.
-
-
-
-
- Indicates the rate zone used (based on origin and destination).
-
-
-
-
- Identifies the type of pricing used for this shipment.
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- Specifies the currency exchange performed on financial amounts for this rate.
-
-
-
-
- Indicates which special rating cases applied to this shipment.
-
-
-
-
- The value used to calculate the weight based on the dimensions.
-
-
-
-
- Identifies the type of dim divisor that was applied.
-
-
-
-
- Specifies a fuel surcharge percentage.
-
-
-
-
- The weight used to calculate these rates.
-
-
-
-
- Sum of dimensional weights for all packages.
-
-
-
-
- The total freight charge that was calculated for this package before surcharges, discounts and taxes.
-
-
-
-
- The total discounts used in the rate calculation.
-
-
-
-
- The freight charge minus discounts.
-
-
-
-
- The total amount of all surcharges applied to this shipment.
-
-
-
-
- This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- Total of the transportation-based taxes.
-
-
-
-
- The net charge after applying all discounts and surcharges.
-
-
-
-
- The total sum of all rebates applied to this shipment.
-
-
-
-
- Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
-
-
-
-
- This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
-
-
-
-
- Identifies the Rate Details per each leg in a Freight Shipment
-
-
-
-
- Rate data specific to FedEx Freight and FedEx National Freight services.
-
-
-
-
- All rate discounts that apply to this shipment.
-
-
-
-
- All rebates that apply to this shipment.
-
-
-
-
- All surcharges that apply to this shipment.
-
-
-
-
- All transportation-based taxes applicable to this shipment.
-
-
-
-
- All commodity-based duties and taxes applicable to this shipment.
-
-
-
-
- The "order level" variable handling charges.
-
-
-
-
- The total of all variable handling charges at both shipment (order) and package level.
-
-
-
-
-
-
- This class groups together all shipment-level rate data (across all rate types) as part of the response to a shipping request, which groups shipment-level data together and groups package-level data by package.
-
-
-
-
- This rate type identifies which entry in the following array is considered as presenting the "actual" rates for the shipment.
-
-
-
-
- The "list" total net charge minus "actual" total net charge.
-
-
-
-
- Each element of this field provides shipment-level rate totals for a specific rate type.
-
-
-
-
-
-
-
-
- This indicates the highest level of severity of all the notifications returned in this reply
-
-
-
-
- The descriptive data regarding the results of the submitted transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
-
-
- Identifies the collection of special service offered by FedEx. BROKER_SELECT_OPTION should be used for Express shipments only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
-
-
-
-
- The types of all special services requested for the enclosing shipment (or other shipment-level transaction).
-
-
-
-
- Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment. This element is required when SpecialServiceType.COD is present in the SpecialServiceTypes collection.
-
-
-
-
-
- Descriptive data required for a FedEx shipment that is to be held at the destination FedEx location for pickup by the recipient. This element is required when SpecialServiceType.HOLD_AT_LOCATION is present in the SpecialServiceTypes collection.
-
-
-
-
- Descriptive data required for FedEx to provide email notification to the customer regarding the shipment. This element is required when SpecialServiceType.EMAIL_NOTIFICATION is present in the SpecialServiceTypes collection.
-
-
-
-
- The descriptive data required for FedEx Printed Return Label. This element is required when SpecialServiceType.PRINTED_RETURN_LABEL is present in the SpecialServiceTypes collection
-
-
-
-
- This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
-
-
-
-
-
-
- Number of packages in this shipment which contain dry ice and the total weight of the dry ice for this shipment.
-
-
-
-
- The descriptive data required for FedEx Home Delivery options. This element is required when SpecialServiceType.HOME_DELIVERY_PREMIUM is present in the SpecialServiceTypes collection
-
-
-
-
-
- Electronic Trade document references.
-
-
-
-
- Specification for date or range of dates on which delivery is to be attempted.
-
-
-
-
-
-
- All package-level shipping documents (other than labels and barcodes).
-
-
-
-
- Shipping Document Type
-
-
-
-
- The localizations are populated if multiple language versions of a shipping document are returned.
-
-
-
-
- Specifies how this document image/file is organized.
-
-
-
-
-
- The name under which a STORED, DEFERRED or EMAILED document is written.
-
-
-
-
- Specifies the image type of this shipping document.
-
-
-
-
- Specifies the image resolution in DPI (dots per inch).
-
-
-
-
- Can be zero for documents whose disposition implies that no content is included.
-
-
-
-
- One or more document parts which make up a single logical document, such as multiple pages of a single form.
-
-
-
-
-
-
- Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
-
-
-
-
- Values in this field specify how to create and return the document.
-
-
-
-
- Specifies how to organize all documents of this type.
-
-
-
-
- Specifies how to e-mail document images.
-
-
-
-
- Specifies how a queued document is to be printed.
-
-
-
-
-
-
- Specifies how to return a shipping document to the caller.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how to e-mail shipping documents.
-
-
-
-
- Provides the roles and email addresses for e-mail recipients.
-
-
-
-
- Identifies the convention by which documents are to be grouped as e-mail attachments.
-
-
-
-
- Specifies the language in which the email containing the document is requested to be composed.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies an individual recipient of e-mailed shipping document(s).
-
-
-
-
- Identifies the relationship of this recipient in the shipment.
-
-
-
-
- Address to which the document is to be sent.
-
-
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies how to create, organize, and return the document.
-
-
-
-
- Specifies how far down the page to move the beginning of the image; allows for printing on letterhead and other pre-printed stock.
-
-
-
-
-
-
- For those shipping document types which have both a "form" and "instructions" component (e.g. NAFTA Certificate of Origin and General Agency Agreement), this field indicates whether to provide the instructions.
-
-
-
-
-
- Governs the language to be used for this individual document, independently from other content returned for the same shipment.
-
-
-
-
- Identifies the individual document specified by the client.
-
-
-
-
-
-
- Specifies how to organize all shipping documents of the same type.
-
-
-
-
-
-
-
-
- Specifies the image format used for a shipping document.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- A single part of a shipping document, such as one page of a multiple-page document whose format requires a separate image per page.
-
-
-
-
- The one-origin position of this part within a document.
-
-
-
-
- Graphic or printer commands for this image within a document.
-
-
-
-
-
-
- Specifies printing options for a shipping document.
-
-
-
-
- Provides environment-specific printer identification.
-
-
-
-
-
-
- Contains all data required for additional (non-label) shipping documents to be produced in conjunction with a specific shipment.
-
-
-
-
- Indicates the types of shipping documents requested by the shipper.
-
-
-
-
-
-
- Specifies the production of each package-level custom document (the same specification is used for all packages).
-
-
-
-
- Specifies the production of a shipment-level custom document.
-
-
-
-
-
- This element is currently not supported and is for the future use. (Details pertaining to the GAA.)
-
-
-
-
-
- Specifies the production of the OP-900 document for hazardous materials packages.
-
-
-
-
- Specifies the production of the 1421c document for dangerous goods shipment.
-
-
-
-
- Specifies the production of the OP-900 document for hazardous materials.
-
-
-
-
- Specifies the production of the return instructions document.
-
-
-
-
-
-
- Specifies the type of paper (stock) on which a document will be printed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data required for FedEx delivery signature services.
-
-
-
-
- Identifies the delivery signature services option selected by the customer for this shipment. See OptionType for the list of valid values.
-
-
-
-
- Identifies the delivery signature release authorization number.
-
- 10
-
-
-
-
-
-
-
- Identifies the delivery signature services options offered by FedEx.
-
-
-
-
-
-
-
-
-
-
-
- These values are mutually exclusive; at most one of them can be attached to a SmartPost shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required for shipments handled under the SMART_POST and GROUND_SMART_POST service types.
-
-
-
-
-
-
-
-
-
- The CustomerManifestId is used to group Smart Post packages onto a manifest for each trailer that is being prepared. If you do not have multiple trailers this field can be omitted. If you have multiple trailers, you
- must assign the same Manifest Id to each SmartPost package as determined by its trailer. In other words, all packages on a trailer must have the same Customer Manifest Id. The manifest Id must be unique to your account number for a minimum of 6 months
- and cannot exceed 8 characters in length. We recommend you use the day of year + the trailer id (this could simply be a sequential number for that trailer). So if you had 3 trailers that you started loading on Feb 10
- the 3 manifest ids would be 041001, 041002, 041003 (in this case we used leading zeros on the trailer numbers).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Special circumstance rating used for this shipment.
-
-
-
-
-
-
-
-
-
- Each instance of this data type represents a barcode whose content must be represented as ASCII text (i.e. not binary data).
-
-
-
-
- The kind of barcode data in this instance.
-
-
-
-
- The data content of this instance.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies each surcharge applied to the shipment.
-
-
-
-
- The type of surcharge applied to the shipment.
-
-
-
-
-
-
- The amount of the surcharge applied to the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
- The type of the surcharge.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies each tax applied to the shipment.
-
-
-
-
- The type of tax applied to the shipment.
-
-
-
-
-
- The amount of the tax applied to the shipment.
-
-
-
-
-
-
- The type of the tax.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifice the kind of tax or miscellaneous charge being reported on a Commercial Invoice.
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data for taxpayer identification information.
-
-
-
-
- Identifies the category of the taxpayer identification number. See TinType for the list of values.
-
-
-
-
- Identifies the taxpayer identification number.
-
- 15
-
-
-
-
-
- Identifies the usage of Tax Identification Number in Shipment processing
-
-
-
-
-
-
-
-
- Identifies the category of the taxpayer identification number.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- For use with SmartPost tracking IDs only
-
-
-
-
-
-
-
- TrackingIdType
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Free form text to be echoed back in the reply. Used to match requests and replies.
-
-
-
-
- Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
-
-
-
-
-
-
- Identifies the set of valid shipment transit time values.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the application that is responsible for managing the document id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Description of the uploaded document.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data sent to FedEx by a customer in order to validate a shipment.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Descriptive data about the shipment being sent by the requestor.
-
-
-
-
-
-
- Documents the kind and quantity of an individual hazardous commodity in a package.
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Specifies the amount of the commodity in alternate units.
-
-
-
-
- The mass points are a calculation used by ADR regulations for measuring the risk of a particular hazardous commodity.
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
-
-
-
-
-
-
- Identifies and describes an individual hazardous commodity. For 201001 load, this is based on data from the FedEx Ground Hazardous Materials Shipping Guide.
-
-
-
-
- Regulatory identifier for a commodity (e.g. "UN ID" value).
-
-
-
-
- In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
-
-
-
-
-
-
-
- Fully-expanded descriptive text for a hazardous commodity.
-
-
-
-
-
-
-
- Coded indications for special requirements or constraints.
-
-
-
-
-
-
-
-
-
-
-
- Specifies the concept of a container used to package dangerous goods commodities.
-
-
-
-
- Indicates that the quantity of the dangerous goods packaged is permissible for shipping. This is used to ensure that the dangerous goods commodities do not exceed the net quantity per package restrictions.
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current package.
-
-
-
-
-
-
- This definition of variable handling charge detail is intended for use in Jan 2011 corp load.
-
-
-
-
-
- Used with Variable handling charge type of FIXED_VALUE.
- Contains the amount to be added to the freight charge.
- Contains 2 explicit decimal positions with a total max length of 10 including the decimal.
-
-
-
-
-
- Actual percentage (10 means 10%, which is a mutiplier of 0.1)
-
-
-
-
- Select the value from a set of rate data to which the percentage is applied.
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
- The variable handling charges calculated based on the type variable handling charges requested.
-
-
-
-
- The variable handling charge amount calculated based on the requested variable handling charge detail.
-
-
-
-
-
-
- The calculated varibale handling charge plus the net charge.
-
-
-
-
-
-
- Three-dimensional volume/cubic measurement.
-
-
-
-
-
-
-
-
- Units of three-dimensional volume/cubic measure.
-
-
-
-
-
-
-
-
- The descriptive data for the heaviness of an object.
-
-
-
-
- Identifies the unit of measure associated with a weight value.
-
-
-
-
- Identifies the weight value of a package/shipment.
-
-
-
-
-
-
- Identifies the unit of measure associated with a weight value. See the list of enumerated types for valid values.
-
-
-
-
-
-
-
-
- Used in authentication of the sender's identity.
-
-
-
-
- This was renamed from cspCredential.
-
-
-
-
- Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
-
-
-
-
-
-
- Two part authentication string used for the sender's identity
-
-
-
-
- Identifying part of authentication credential. This value is provided by FedEx after registration
-
-
-
-
- Secret part of authentication key. This value is provided by FedEx after registration.
-
-
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Identifies a system or sub-system which performs an operation.
-
-
-
-
- Identifies the service business level.
-
-
-
-
- Identifies the service interface level.
-
-
-
-
- Identifies the service code level.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the role that identifies the permissions the accessor of the pending shipment.
+
+
+
+
+
+
+
+
+ Specifies additional labels to be produced. All required labels for shipments will be produced without the need to request additional labels. These are only available as thermal labels.
+
+
+
+
+ The type of additional labels to return.
+
+
+
+
+ The number of this type label to return
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Specifies the details around the ADR license required for shipping.
+
+
+
+
+
+
+
+ Specifies details for a package containing alcohol
+
+
+
+
+ The license type that the recipient of the alcohol package.
+
+
+
+
+
+
+ Specifies the type of license that the recipient of the alcohol shipment has.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration represents a kind of "legacy" account number from a FedEx operating entity.
+
+
+
+
+
+
+
+
+
+
+
+
+ A freight line item identifier referring to a freight shipment line item that describes goods contained within this handling unit.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking id for the payment on the return.
+
+
+
+
+ Specifies additional customer reference data about the associated shipment.
+
+
+
+
+ Specifies shipment level operational information.
+
+
+
+
+ Specifies package level operational information on the associated shipment. This information is not tied to an individual outbound package.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identification of the type of barcode (symbology) used on FedEx documents and labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes attributes of a battery or cell that are used for classification purposes. Typically this structure would be used to allow customers to declare batteries or cells for which full dangerous goods documentation and procedures are not required.
+
+
+
+
+ Describes the material composition of the battery or cell.
+
+
+
+
+ Describes the packing arrangement of the battery or cell with respect to other items within the same package.
+
+
+
+
+ A regulation specific classification for the battery or cell.
+
+
+
+
+
+
+ Describes the material composition of a battery or cell.
+
+
+
+
+
+
+
+
+
+ Describes the packing arrangement of a battery or cell with respect to other items within the same package.
+
+
+
+
+
+
+
+
+
+ A regulation specific classification for a battery or cell.
+
+
+
+
+
+
+
+ Each instance of this data type represents a barcode whose content must be represented as binary data (i.e. not ASCII text).
+
+
+
+
+ The kind of barcode data in this instance.
+
+
+
+
+ The data content of this instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the type of brokerage to be applied to a shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ The FedEx Ground account number.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+ FedEx internal use only.
+
+
+
+
+
+ FedEx internal use only. The PassKey company identifier.
+
+
+
+
+ Client software component (e.g. "CAFE", "INET", "WBUS", etc.)
+
+
+
+
+ Client software component version/revision (e.g. "1800", "2630", etc.)
+
+
+
+
+ A FedEx assigned identifier for a third party software product used by customer to do business with FedEx. Such as a Compatible Solution Provider's product.
+
+
+
+
+ The version of the third party product.
+
+
+
+
+ FedEx internal use only.
+
+
+
+
+ FedEx internal use only.
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ Used for off-line uploads only.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+ Specifies the type of adjustment was performed to the COD collection amount during rating.
+
+
+
+
+
+
+
+
+ Identifies the type of funds FedEx should collect upon shipment delivery.
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
+
+
+
+
+
+ Specifies the details of the charges are to be added to the COD collect amount.
+
+
+
+
+ Identifies the type of funds FedEx should collect upon package delivery
+
+
+
+
+ For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
+
+
+
+
+ When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
+
+
+
+
+ Specifies the name of person or company receiving the secured/unsecured funds payment
+
+
+
+
+ Indicates which type of reference information to include on the COD return shipping label.
+
+
+
+
+ Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
+
+
+
+
+
+
+ Specifies the information associated with a package that has COD special service in a ground shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through the FedEx Systems. Customers are responsible for printing their own Commercial Invoice.If you would likeFedEx to generate a Commercial Invoice and transmit it to Customs. for clearance purposes, you need to specify that in the ShippingDocumentSpecification element. If you would like a copy of the Commercial Invoice that FedEx generated returned to you in reply it needs to be specified in the ETDDetail/RequestedDocumentCopies element. Commercial Invoice support consists of maximum of 99 commodity line items.
+
+
+
+
+ Any comments that need to be communicated about this shipment.
+
+
+
+
+ Any freight charges that are associated with this shipment.
+
+
+
+
+ Any taxes or miscellaneous charges(other than Freight charges or Insurance charges) that are associated with this shipment.
+
+
+
+
+ Specifies which kind of charge is being recorded in the preceding field.
+
+
+
+
+ Any packing costs that are associated with this shipment.
+
+
+
+
+ Any handling costs that are associated with this shipment.
+
+
+
+
+ Free-form text.
+
+
+
+
+ Free-form text.
+
+
+
+
+ Free-form text.
+
+
+
+
+ The reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.
+
+
+
+
+ Not exposed to Web Services customers; only present for use in mapping from CTS transactions.
+
+
+
+
+ Additional customer reference data.
+
+
+
+
+ Name of the International Expert that completed the Commercial Invoice different from Sender.
+
+
+
+
+ Required for dutiable international Express or Ground shipments. This field is not applicable to an international PIB(document) or a non-document which does not require a Commercial Invoice.
+
+
+
+
+
+
+ The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
+
+
+
+
+
+ Specifies the usage and identification of a customer supplied image to be used on this document.
+
+
+
+
+
+
+
+
+
+ Value used to identify a commodity description; must be unique within the containing shipment.
+
+
+
+
+ FedEx internal commodity identifier
+
+
+
+
+
+ A free-form description of the commodity, which could be used for customs clearance documentation.
+
+
+
+
+
+
+
+
+
+
+ Contains only additional quantitative information other than weight and quantity to calculate duties and taxes.
+
+
+
+
+
+ The value of the commodity for customs purposes. The field should be the unit price multiplied by the quantity.
+
+
+
+
+ Defines additional characteristic of commodity used to calculate duties and taxes
+
+
+
+
+
+
+
+
+ All data required for this commodity in NAFTA Certificate of Origin.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the results of processing for the COD special service.
+
+
+
+
+
+
+
+
+
+
+ The identifier for all clearance documents associated with this shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Completed package-level hazardous commodity information for a single package.
+
+
+
+
+ A unique reference id that matches the package to a package configuration. This is populated if the client provided a package configuration for several packages that have the exact same dangerous goods content.
+
+
+
+
+
+ When true indicates that the package can be transported only on a cargo aircraft.
+
+
+
+
+
+ Specifies the maximum radiation level from the package (measured in microSieverts per hour at a distance of one meter from the external surface of the package, divided by 10).
+
+
+
+
+ Specifies the label that is to be put on a package containing radioactive material. The label type is determined in accordance with the Transportation of Dangerous Goods Act and indicates the type of radioactive material being handled as well as the relative risk.
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current package.
+
+
+
+
+
+
+ Computed shipment level hazardous commodity information.
+
+
+
+
+
+
+ This contains the ADR License information, which identifies the license number and ADR category under which the customer is allowed to ship.
+
+
+
+
+
+
+
+
+ Specifies the total number of packages containing hazardous commodities in small exceptions.
+
+
+
+
+
+
+
+
+ Identifies the branded location name, the hold at location phone number and the address of the location.
+
+
+
+
+ Identifies the type of FedEx location.
+
+
+
+
+
+
+
+
+
+
+
+ An identifier of each group of identical packages.
+
+
+
+
+
+ All package-level rating data for this package, which may include data for multiple rate types.
+
+
+
+
+
+
+
+ All package-level shipping documents (other than labels and barcodes). For use in loads after January, 2008.
+
+
+
+
+ Specifies the information associated with this package that has COD special service in a ground shipment.
+
+
+
+
+ Actual signature option applied, to allow for cases in which the original value conflicted with other service features in the shipment.
+
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current package, using updated hazardous commodity description data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Only used with pending shipments.
+
+
+
+
+ Only used in the reply to tag requests.
+
+
+
+
+
+ Computed shipment level information about hazarous commodities.
+
+
+
+
+ All shipment-level rating data for this shipment, which may include data for multiple rate types.
+
+
+
+
+ Returns the default holding location information when HOLD_AT_LOCATION special service is requested and the client does not specify the hold location address.
+
+
+
+
+ Returns any defaults or updates applied to RequestedShipment.exportDetail.exportComplianceStatement.
+
+
+
+
+ This specifies what rules or requirements for documents are applicable for this shipment. This may identify required or prohibited documents.
+
+
+
+
+
+ All shipment-level shipping documents (other than labels and barcodes).
+
+
+
+
+
+
+
+
+
+ Provides reply information specific to SmartPost shipments.
+
+
+
+
+ Identifies the carrier that will pick up the SmartPost shipment.
+
+
+
+
+ Indicates whether the shipment is deemed to be machineable, based on dimensions, weight, and packaging.
+
+
+
+
+
+
+ Provides reply information specific to a tag request.
+
+
+
+
+
+ As of June 2007, returned only for FedEx Express services.
+
+
+
+
+ As of June 2007, returned only for FedEx Express services.
+
+
+
+
+ As of June 2007, returned only for FedEx Express services.
+
+
+
+
+ As of June 2007, returned only for FedEx Express services.
+
+
+
+
+ FEDEX INTERNAL USE ONLY: for use by INET.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data for a point-of-contact person.
+
+
+
+
+ Client provided identifier corresponding to this contact information.
+
+
+
+
+ Identifies the contact person's name.
+
+
+
+
+ Identifies the contact person's title.
+
+
+
+
+ Identifies the company this contact is associated with.
+
+
+
+
+ Identifies the phone number associated with this contact.
+
+
+
+
+ Identifies the phone extension associated with this contact.
+
+
+
+
+ Identifies a toll free number, if any, associated with this contact.
+
+
+
+
+ Identifies the pager number associated with this contact.
+
+
+
+
+ Identifies the fax number associated with this contact.
+
+
+
+
+ Identifies the email address associated with this contact.
+
+
+
+
+
+
+
+
+
+
+
+
+ Details the contents of the package.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Must be in one of the following formats: YYMM, YYYYMM, or YYYYMMDD.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies details about the credit card transaction that drive decisions about credit card processing.
+
+
+
+
+
+
+
+ This class represents data tied to the use of a credit card in a specific transaction.
+
+
+
+
+
+
+
+ Specifies details about the credit card transaction that drive decisions about credit card processing.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This class is a rename of the previous VerifyCreditFraudDetail; the name change reflects the fact that it is no longer tied to a "verify" usage.
+
+
+
+
+
+
+
+
+
+
+ The currency code for the original (converted FROM) currency.
+
+
+
+
+ The currency code for the final (converted INTO) currency.
+
+
+
+
+ Multiplier used to convert fromCurrency units to intoCurrency units.
+
+
+
+
+
+
+
+
+ Indicates the type of custom delivery being requested.
+
+
+
+
+ Time by which delivery is requested.
+
+
+
+
+ Range of dates for custom delivery request; only used if type is BETWEEN.
+
+
+
+
+ Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Types of discounts that are excluded.
+
+
+
+
+
+
+ Data required to produce a custom-specified document, either at shipment or package level.
+
+
+
+
+ Common information controlling document production.
+
+
+
+
+ Applicable only to documents produced on thermal printers with roll stock.
+
+
+
+
+ Applicable only to documents produced on thermal printers with roll stock.
+
+
+
+
+ Identifies the formatting specification used to construct this custom document.
+
+
+
+
+ Identifies the individual document specified by the client.
+
+
+
+
+ If provided, thermal documents will include specified doc tab content. If omitted, document will be produced without doc tab content.
+
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified barcode symbology.
+
+
+
+
+
+
+
+
+ Width of thinnest bar/space element in the barcode.
+
+
+
+
+
+
+
+ Solid (filled) rectangular area on label.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Image to be included from printer's memory, or from a local file for offline clients.
+
+
+
+
+
+ Printer-specific index of graphic image to be printed.
+
+
+
+
+ Fully-qualified path and file name for graphic image to be printed.
+
+
+
+
+
+
+
+
+ Horizontal position, relative to left edge of custom area.
+
+
+
+
+ Vertical position, relative to top edge of custom area.
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
+
+
+
+
+
+
+
+
+
+ Printer-specific font name for use with thermal printer labels.
+
+
+
+
+ Generic font name for use with plain paper labels.
+
+
+
+
+ Generic font size for use with plain paper labels.
+
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
+
+
+
+
+
+
+
+ Printer-specific font name for use with thermal printer labels.
+
+
+
+
+ Generic font name for use with plain paper labels.
+
+
+
+
+ Generic font size for use with plain paper labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies custom transit time to be applied to the shipment.
+
+
+
+
+ Identifies options to be applied.
+
+
+
+
+
+
+
+
+
+
+ Internal Id used by INET to identify customer provided images during documents generation. Ex COO etc ...
+
+
+
+
+ Internal image type used by INET to identify customer provided images during documents generation. Ex COO etc ..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows customer-specified control of label content.
+
+
+
+
+ If omitted, no doc tab will be produced (i.e. default is former NONE type).
+
+
+
+
+ Controls the position of the customer specified content relative to the FedEx portion.
+
+
+
+
+
+
+ Controls which data/sections will be suppressed.
+
+
+
+
+ For customers producing their own Ground labels, this field specifies which secondary barcode will be printed on the label; so that the primary barcode produced by FedEx has the correct SCNC.
+
+
+
+
+
+
+ Controls the number of additional copies of supplemental labels.
+
+
+
+
+ This value reduces the default quantity of destination/consignee air waybill labels. A value of zero indicates no change to default. A minimum of one copy will always be produced.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interacts both with properties of the shipment and contractual relationship with the shipper.
+
+
+
+
+
+
+ Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
+
+
+
+
+
+
+ This represents the total commodity value of the shipment plus the charges required by the destination country.
+
+
+
+
+ Identifies responsibilities with respect to loss, damage, etc.
+
+
+
+
+ Documents amount paid to third party for coverage of shipment content.
+
+
+
+
+
+
+
+
+
+
+
+
+ This provides the information necessary to identify the different statements, declarations, acts, and/or certifications that apply to this shipment.
+
+
+
+
+ This indicates the different statements, declarations, acts, and/or certifications that apply to this shipment.
+
+
+
+
+ Specifies the NAFTA low value statement information.
+
+
+
+
+
+
+ This indicates the different statements, declarations, acts, and certifications that may apply to a shipment.
+
+
+
+
+
+
+
+
+
+
+ Specifies additional description about customs options. This is a required field when the customs options type is "OTHER".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes an approved container used to package dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container.
+
+
+
+
+ Indicates whether there are additional inner receptacles within this container.
+
+
+
+
+ Indicates the type of this dangerous goods container, as specified by the IATA packing instructions. For example, steel cylinder, fiberboard box, plastic jerrican and steel drum.
+
+
+
+
+ Indicates the packaging type of the container used to package the radioactive materials.
+
+
+
+
+ Indicates the number of occurrences of this container with identical dangerous goods configuration.
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current container.
+
+
+
+
+
+
+
+
+ This field is used to identify an instance of an uploaded dangerous goods handling unit.
+
+
+
+
+
+
+ Shipment is packaged/documented for movement ONLY on cargo aircraft.
+
+
+
+
+ Indicates which kinds of hazardous content are in the current package.
+
+
+
+
+ Indicates whether there is additional customer provided packaging enclosing the approved dangerous goods containers.
+
+
+
+
+ Identifies the configuration of this dangerous goods package. The common configuration is represented at the shipment level.
+
+
+
+
+ Indicates one or more containers used to pack dangerous goods commodities.
+
+
+
+
+ Description of the packaging of this commodity, suitable for use on OP-900 and OP-950 forms.
+
+
+
+
+ Name, title and place of the signatory for this shipment.
+
+
+
+
+ Telephone number to use for contact in the event of an emergency.
+
+
+
+
+ Offeror's name or contract number, per DOT regulation.
+
+
+
+
+ Specifies the contact of the party responsible for handling the infectious substances, if any, in the dangerous goods shipment.
+
+
+
+
+ Specifies additional handling information for the current package.
+
+
+
+
+ Specifies the radioactivity detail for the current package, if the package contains radioactive materials.
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the 1421c form for dangerous goods shipment.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+ Specifies that name, title and place of the signatory responsible for the dangerous goods shipment.
+
+
+
+
+
+
+ Indicates the place where the form is signed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+ Only used for tags which had FedEx Express services.
+
+
+
+
+ Only used for tags which had FedEx Express services.
+
+
+
+
+ If the original ProcessTagRequest specified third-party payment, then the delete request must contain the same pay type and payor account number for security purposes.
+
+
+
+
+
+
+
+ Specifies the type of deletion to be performed on a shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking id for the return, if preassigned.
+
+
+
+
+
+
+ Data required to complete the Destionation Control Statement for US exports.
+
+
+
+
+
+ Comma-separated list of up to four country codes, required for DEPARTMENT_OF_STATE statement.
+
+
+
+
+ Name of end user, required for DEPARTMENT_OF_STATE statement.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifications for pup/set or vehicle delayed for loading or unloading.
+
+
+
+
+ Amount of time involved in the detention.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Lists the documents that are not accepted by FedEx for this shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the name associated with the email address.
+
+
+
+
+
+
+
+
+ Content of the email message.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Information describing the address of of the email recipient, role of the email recipient and languages that are requested to be supported.
+
+
+
+
+ EMail address of the recipient.
+
+
+
+
+ The relationship that the customer has to the pending shipment.
+
+
+
+
+ Specifies how the email notification for the pending shipment need to be processed.
+
+
+
+
+ Localization and language details specified by the recipient of the EMail.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Customer-declared value, with data type and legal values depending on excise condition, used in defining the taxable value of the item.
+
+
+
+
+
+
+ Specifies the types of Estimated Duties and Taxes to be included in a rate quotation for an international shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to apply the localization detail to the current context.
+
+
+
+
+
+
+
+ This identifies some of the document types recognized by Enterprise Document Management Service.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies whether to confirm documents prior to processing a shipment with the ELECTRONIC_TRADE_DOCUMENTS special service.
+
+
+
+
+
+
+
+
+ Electronic Trade document references used with the ETD special service.
+
+
+
+
+ Specifies client's intent for whether all documents must be confirmed before shipment processing.
+
+
+
+
+
+ Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
+
+
+
+
+
+
+
+ The instructions indicating how to print the Export Declaration.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+
+
+
+ General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Specification for labor time spent handling shipment.
+
+
+
+
+ Total labor time.
+
+
+
+
+
+
+ Identifies a kind of FedEx facility.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the optional features/characteristics requested for a Freight shipment utilizing a flatbed trailer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce the Freight handling-unit-level address labels. Note that the number of UNIQUE labels (the N as in 1 of N, 2 of N, etc.) is determined by total handling units.
+
+
+
+
+
+ Indicates the number of copies to be produced for each unique label.
+
+
+
+
+ Specifies the quadrant of the page on which the label printing will start.
+
+
+
+
+ If omitted, no doc tab will be produced (i.e. default = former NONE type).
+
+
+
+
+ Controls the position of the customer specified content relative to the FedEx portion.
+
+
+
+
+
+
+
+ Individual charge which contributes to the total base charge for the shipment.
+
+
+
+
+ Freight class for this line item.
+
+
+
+
+ Effective freight class used for rating this line item.
+
+
+
+
+ NMFC Code for commodity.
+
+
+
+
+ Customer-provided description for this commodity or class line.
+
+
+
+
+ Weight for this commodity or class line.
+
+
+
+
+ Rate or factor applied to this line item.
+
+
+
+
+ Identifies the manner in which the chargeRate for this line item was applied.
+
+
+
+
+ The net or extended charge for this line item.
+
+
+
+
+
+
+ Specifies the way in which base charges for a Freight shipment or shipment leg are calculated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values represent the industry-standard freight classes used for FedEx Freight and FedEx National Freight shipment description. (Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Date for all Freight guarantee types.
+
+
+
+
+ Time for GUARANTEED_TIME only.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies responsibilities with respect to loss, damage, etc.
+
+
+
+
+
+
+
+
+ Rate data specific to FedEx Freight or FedEx National Freight services.
+
+
+
+
+ A unique identifier for a specific rate quotation.
+
+
+
+
+ Specifies whether the rate quote was automated or manual.
+
+
+
+
+ Specifies how total base charge is determined.
+
+
+
+
+ Freight charges which accumulate to the total base charge for the shipment.
+
+
+
+
+ Human-readable descriptions of additional information on this shipment rating.
+
+
+
+
+
+
+ Additional non-monetary data returned with Freight rates.
+
+
+
+
+ Unique identifier for notation.
+
+
+
+
+ Human-readable explanation of notation.
+
+
+
+
+
+
+ Specifies the type of rate quote
+
+
+
+
+
+
+
+
+ Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
+
+
+
+
+ Account number used with FEDEX_FREIGHT service.
+
+
+
+
+ Used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
+
+
+
+
+ Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
+
+
+
+
+ Identification values to be printed during creation of a Freight bill of lading.
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+ Designates the terms of the "collect" payment for a Freight Shipment.
+
+
+
+
+ Identifies the declared value for the shipment
+
+
+
+
+ Identifies the declared value units corresponding to the above defined declared value
+
+
+
+
+
+ Identifiers for promotional discounts offered to customers.
+
+
+
+
+ Total number of individual handling units in the entire shipment (for unit pricing).
+
+
+
+
+ Estimated discount rate provided by client for unsecured rate quote.
+
+
+
+
+ Total weight of pallets used in shipment.
+
+
+
+
+ Overall shipment dimensions.
+
+
+
+
+ Description for the shipment.
+
+
+
+
+ Specifies which party will pay surcharges for any special services which support split billing.
+
+
+
+
+ Must be populated if any line items contain hazardous materials.
+
+
+
+
+
+ Details of the commodities in the shipment.
+
+
+
+
+
+
+ Description of an individual commodity or class of content in a shipment.
+
+
+
+
+ A unique identifier assigned to this line item.
+
+
+
+
+ Freight class for this line item.
+
+
+
+
+ FEDEX INTERNAL USE ONLY: for FedEx system that estimate freight class from customer-provided dimensions and weight.
+
+
+
+
+ Identifies billing mask, if used to populate this line item.
+
+
+
+
+ Specifies line item level liability coverage.
+
+
+
+
+ Number of individual handling units to which this line applies. (NOTE: Total of line-item-level handling units may not balance to shipment-level total handling units.)
+
+
+
+
+ Specification of handling-unit packaging for this commodity or class line.
+
+
+
+
+ Number of pieces for this commodity or class line.
+
+
+
+
+ NMFC Code for commodity.
+
+
+
+
+ Indicates the kind of hazardous material content in this line item.
+
+
+
+
+ For printed reference per line item.
+
+
+
+
+ Customer-provided description for this commodity or class line.
+
+
+
+
+ Weight for this commodity or class line.
+
+
+
+
+
+ Volume (cubic measure) for this commodity or class line.
+
+
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+
+
+
+
+ Specifies which party will be responsible for payment of any surcharges for Freight special services for which split billing is allowed.
+
+
+
+
+ Identifies the special service.
+
+
+
+
+ Indicates who will pay for the special service.
+
+
+
+
+
+
+ Data required to produce a General Agency Agreement document. Remaining content (business data) to be defined once requirements have been completed.
+
+
+
+
+
+
+
+ Represents features of FedEx Ground delivery for which the shipment is eligible.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Documents the kind and quantity of an individual hazardous commodity in a package.
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Specifies the amount of the commodity in alternate units.
+
+
+
+
+ This describes the inner receptacle details for a hazardous commodity within the dangerous goods container.
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ Specifies the details of any radio active materials within the commodity.
+
+
+
+
+ The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
+
+
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Regulatory identifier for a commodity (e.g. "UN ID" value).
+
+
+
+
+ In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates any special processing options to be applied to the description of the dangerous goods commodity.
+
+
+
+
+ Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
+
+
+
+
+
+
+ Specifies any special processing to be applied to the dangerous goods commodity description validation.
+
+
+
+
+
+
+
+ This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container.
+
+
+
+
+ This specifies the quantity contained in the inner receptacle.
+
+
+
+
+
+
+ Specifies how the commodity is to be labeled.
+
+
+
+
+
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ Specifies how the customer wishes the label text to be handled for this commodity in this package.
+
+
+
+
+ Text used in labeling the commodity under control of the labelTextOption field.
+
+
+
+
+
+
+ Indicates which kind of hazardous content is being reported.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies number and type of packaging units for hazardous commodities.
+
+
+
+
+ Number of units of the type below.
+
+
+
+
+ Units in which the hazardous commodity is packaged.
+
+
+
+
+
+
+ Specifies documentation and limits for validation of an individual packing group/category.
+
+
+
+
+
+ Coded specification for how commodity is to be packed.
+
+
+
+
+
+
+ Identifies DOT packing group for a hazardous commodity.
+
+
+
+
+
+
+
+
+
+
+ Identifies amount and units for quantity of hazardous commodities.
+
+
+
+
+ Number of units of the type below.
+
+
+
+
+ Units by which the hazardous commodity is measured. For IATA commodity, the units values are restricted based on regulation type.
+
+
+
+
+ Specifies which measure of quantity is to be validated.
+
+
+
+
+
+
+ Specifies the measure of quantity to be validated against a prescribed limit.
+
+
+
+
+
+
+
+
+ Identifies the source of regulation for hazardous commodity data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contact phone number for recipient of shipment.
+
+
+
+
+ Contact and address of FedEx facility at which shipment is to be held.
+
+
+
+
+ Type of facility at which package/shipment is to be held.
+
+
+
+
+ Location identification (for facilities identified by an alphanumeric location code).
+
+
+
+
+ Location identification (for facilities identified by an numeric location code).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Names for data elements / areas which may be suppressed from printing on labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the order in which the labels will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Relative to normal orientation for the printer.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to create, organize, and return the document.
+
+
+
+
+
+
+
+
+
+ Specifies the order in which the labels are requested to be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the Liability Coverage Amount. For Jan 2010 this value represents coverage amount per pound
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ License or Permit Number.
+
+
+
+
+ Specifies the effective date of the license.
+
+
+
+
+ Specifies the expiration date of the license.
+
+
+
+
+
+
+ Represents a one-dimensional measurement in small units (e.g. suitable for measuring a package or document), contrasted with Distance, which represents a large one-dimensional measurement (e.g. distance between cities).
+
+
+
+
+ The numerical quantity of this measurement.
+
+
+
+
+ The units for this measurement.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ Specification for marking or tagging of pieces in shipment.
+
+
+
+
+ Number of pieces to be marked or tagged by FedEx.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce a Certificate of Origin document. Remaining content (business data) to be defined once requirements have been completed.
+
+
+
+
+
+
+ Indicates which Party (if any) from the shipment is to be used as the source of importer data on the NAFTA COO form.
+
+
+
+
+ Contact information for "Authorized Signature" area of form.
+
+
+
+
+
+
+
+
+
+
+
+ Defined by NAFTA regulations.
+
+
+
+
+ Defined by NAFTA regulations.
+
+
+
+
+ Identification of which producer is associated with this commodity (if multiple producers are used in a single shipment).
+
+
+
+
+
+ Date range over which RVC net cost was calculated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the information necessary for printing the NAFTA Low Value statement on customs documentation.
+
+
+
+
+ Specifies the NAFTA statement role.
+
+
+
+
+
+
+
+
+
+
+
+
+ See instructions for NAFTA Certificate of Origin for code definitions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ See instructions for NAFTA Certificate of Origin for code definitions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for services performed during non-business hours and/or days.
+
+
+
+
+ Total number of person days for full non-business days.
+
+
+
+
+ Total number of person hours (whole or partial hours) for non-business hours.
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Indicates the type of notification that will be sent.
+
+
+
+
+ Specifies the email notification details.
+
+
+
+
+ Specifies the localization for this notification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Unique identifier for this offering.
+
+
+
+
+ Specifies values like PRIORITY_OVERNIGHT, FEDEX_ENVELOPE, PRIORITY_ALERT, and other values typically used to identify various offerings in transactions.
+
+
+
+
+ Specifies the two character code used for operationalization of this offering.
+
+
+
+
+
+
+ The instructions indicating how to print the OP-900 form for hazardous materials packages.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Identifies which reference type (from the package's customer references) is to be used as the source for the reference on this OP-900.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+ Data field to be used when a name is to be printed in the document instead of (or in addition to) a signature image.
+
+
+
+
+
+
+
+
+ Position of operational instruction element.
+
+
+
+
+ Content corresponding to the operational instruction.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Each instance of this data type represents the set of barcodes (of all types) which are associated with a specific package.
+
+
+
+
+ Binary-style barcodes for this package.
+
+
+
+
+ String-style barcodes for this package.
+
+
+
+
+
+
+ Package-level data required for labeling and/or movement.
+
+
+
+
+ Human-readable text for pre-January 2011 clients.
+
+
+
+
+ Human-readable content for use on a label.
+
+
+
+
+ The operational barcodes pertaining to the current package.
+
+
+
+
+ The FedEx internal code that represents the service and/or features of service for the current package moving under a FedEx Ground service.
+
+
+
+
+
+
+ Data for a package's rates, as calculated per a specific rate type.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+
+ The dimensional weight of this package (if greater than actual).
+
+
+
+
+ The oversize weight of this package (if the package is oversize).
+
+
+
+
+ The transportation charge only (prior to any discounts applied) for this package.
+
+
+
+
+ The sum of all discounts on this package.
+
+
+
+
+ This package's baseCharge - totalFreightDiscounts.
+
+
+
+
+ The sum of all surcharges on this package.
+
+
+
+
+ This package's netFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ The sum of all taxes on this package.
+
+
+
+
+ This package's netFreight + totalSurcharges + totalTaxes.
+
+
+
+
+
+ All rate discounts that apply to this package.
+
+
+
+
+ All rebates that apply to this package.
+
+
+
+
+ All surcharges that apply to this package (either because of characteristics of the package itself, or because it is carrying per-shipment surcharges for the shipment of which it is a part).
+
+
+
+
+ All taxes applicable (or distributed to) this package.
+
+
+
+
+
+
+
+ This class groups together for a single package all package-level rate data (across all rate types) as part of the response to a shipping request, which groups shipment-level data together and groups package-level data by package.
+
+
+
+
+ This rate type identifies which entry in the following array is considered as presenting the "actual" rates for the package.
+
+
+
+
+ The "list" net charge minus "actual" net charge.
+
+
+
+
+ Each element of this field provides package-level rate data for a specific rate type.
+
+
+
+
+
+
+ These special services are available at the package level for some or all service types. If the shipper is requesting a special service which requires additional data, the package special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ Indicates the package special service types that are requested on this shipment. For a list of the valid package special service types, please consult your integration documentation or get the list of the available special services from the getAllSpecialServices method of the Validation Availability and Commitment service.
+
+
+
+
+ For use with FedEx Ground services only; COD must be present in shipment's special services.
+
+
+
+
+
+ Provides details about the batteries or cells that are contained within this specific package.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Branded, translated, and/or localized names for this packaging.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifications for pallets to be shrinkwrapped as part of a Freight shipment.
+
+
+
+
+ Number of pallets to be shrinkwrapped.
+
+
+
+
+
+
+ Specifications for pallets to be provided on Freight shipment.
+
+
+
+
+ Number of pallets to be provided.
+
+
+
+
+
+
+ This type contains equivalent data to Contact, but uses a form of person name with separate first and last names.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This type contains equivalent data to ContactAndAddress, but uses a form of person name with separate first, middle and last names.
+
+
+
+
+
+
+
+
+ The descriptive data for a person's name broken out into individual name elements such as first name, last name.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This information describes how and when a pending shipment may be accessed for completion.
+
+
+
+
+
+
+
+ Specifies the details to be used by the user of the pending shipment
+
+
+
+
+ Specifies the role of the user who is trying to access the pending shipment.
+
+
+
+
+
+
+
+
+
+ This information describes the kind of pending shipment being requested.
+
+
+
+
+
+ Date after which the pending shipment will no longer be available for completion.
+
+
+
+
+ Only used with type of EMAIL.
+
+
+
+
+
+ These are documents that are recommended to be included with the shipment.
+
+
+
+
+ Upload document details provided by the initator of the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This class describes the pickup characteristics of a shipment (e.g. for use in a tag request).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Represents a reference identifier printed on Freight bills of lading
+
+
+
+
+
+
+
+
+ Identifies a particular reference identifier printed on a Freight bill of lading.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Empty unless error label behavior is PACKAGE_ERROR_LABELS and one or more errors occured during transaction processing.
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The type of name (long, medium, short, etc.) to which this value refers.
+
+
+
+
+ The character encoding used to represent this product name. For example, UTF-8.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates the packaging type of the container used to package radioactive hazardous materials.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether packaging type "EXCEPTED" or "EXCEPTED_PACKAGE" is for radioactive material in reportable quantity.
+
+
+
+
+
+
+
+
+ Indicates the reason that a dim divisor value was chose.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Selects the value from a set of rate data to which the percentage is applied.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
+
+
+
+
+ Specifies the kind of identification being used.
+
+
+
+
+ Contains the actual ID value, of the type specified above.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
+
+
+
+
+
+
+
+ Type of documents that are recommended to be included with the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies details needed to generate any label artifacts required due to regulatory requirements.
+
+
+
+
+
+ Specifies how the customer requested the regulatory label to be generated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This is a 1-based index identifying the commodity in the request that resulted in this COMMODITY or DOCUMENT type prohibition.
+
+
+
+
+
+
+
+
+
+
+
+ FOR FEDEX INTERNAL USE ONLY: The id of the waiver.
+
+
+
+
+ FOR FEDEX INTERNAL USE ONLY: The description of the waiver.
+
+
+
+
+
+
+
+ Describes the vertical position of an item relative to another item.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of each requested package line item.
+
+
+
+
+ An identifier of each group of identical packages.
+
+
+
+
+ Used as the number or count of identical packages in a group.
+
+
+
+
+ Only used when clients are assigning a tracking number to this package. Should not be used when groupPackageCount is greater than one.
+
+
+
+
+
+ Specifies the declared value for carriage of the package. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the package.
+
+
+
+
+ Represents the gross weight of the package line item.
+
+
+
+
+ FEDEX INTERNAL USE ONLY.
+
+
+
+
+
+ Provides additional detail on how the customer has physically packaged this item. As of June 2009, required for packages moving under international and SmartPost services.
+
+
+
+
+
+ Human-readable text describing the package.
+
+
+
+
+ Human-readable text describing the contents of the package to be used for clearance purposes.
+
+
+
+
+
+
+ Details the contents of the package.
+
+
+
+
+
+
+
+
+
+
+
+ This field contains the service type values, like PRIORITY_OVERNIGHT and FEDEX_GROUND.
+
+
+
+
+ This field contains the packaging type values, like YOUR_PACKAGING and FEDEX_ENVELOPE.
+
+
+
+
+ The client's shipping cycle to which this shipment belongs.
+
+
+
+
+ This specifies information related to the manifest associated with the shipment.
+
+
+
+
+ The shipment variations for the current shipment expressed in key-value pairs.
+
+
+
+
+
+ Specifies the total declared value for carriage of the shipment. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the shipment.
+
+
+
+
+ This attribute indicates the currency the caller requests to have used in all returned monetary values (when a choice is possible).
+
+
+
+
+ Specifies details about the entity responsible for the shipment.
+
+
+
+
+
+
+
+ Physical starting address for the shipment, if different from shipper's address.
+
+
+
+
+ The sold-to party is used for customs clearance; for example, in support of US import customs rules. The need for this field could vary based on whether a sold-to party was specified on a consolidation.
+
+
+
+
+
+
+ Specifies any custom processing to be applied to this shipment.
+
+
+
+
+
+ Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
+
+
+
+
+ Used with Ground Home Delivery and Freight.
+
+
+
+
+
+ Customs clearance data, used for both international and intra-country shipping.
+
+
+
+
+ For use in "process tag" transaction.
+
+
+
+
+ Specifies the characteristics of a shipment pertaining to SmartPost services.
+
+
+
+
+ If true, only the shipper/payor will have visibility of this shipment.
+
+
+
+
+ Specifies the client-requested response in the event of errors within shipment.
+
+
+
+
+
+ Contains data used to create additional (non-label) shipping documents.
+
+
+
+
+ Specifies whether and what kind of rates the customer wishes to have quoted on this shipment. The reply will also be constrained by other data on the shipment and customer.
+
+
+
+
+ Specifies the type of rate the customer wishes to have used as the actual rate type.
+
+
+
+
+ Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.
+
+
+
+
+ Specifies the details for the custom rates.
+
+
+
+
+ Only used with multiple-transaction shipments, to identify the master package in a multi-piece shipment.
+
+
+
+
+ The total number of packages in the entire shipment (even when the shipment spans multiple transactions.)
+
+
+
+
+ Specifies data structures that may be re-used multiple times with s single shipment.
+
+
+
+
+ One or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics all packages in the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This identifies the document types that can be required. This can also indicate when either a COMMERCIAL_INVOICE or a PRO_FORMA_INVOICE is required through the COMMERCIAL_OR_PRO_FORMA_INVOICE option.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking number of the master associated with the return shipment.
+
+
+
+
+
+
+
+ These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
+
+
+
+
+
+
+ The instructions indicating how to print the return instructions( e.g. image type) Specifies characteristics of a shipping document to be produced.
+
+
+
+
+
+ Specifies additional customer provided text to be inserted into the return document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The "PAYOR..." rates are expressed in the currency identified in the payor's rate table(s). The "RATED..." rates are expressed in the currency of the origin country. Former "...COUNTER..." values have become "...RETAIL..." values, except for PAYOR_COUNTER and RATED_COUNTER, which have been removed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
+
+
+
+
+
+
+
+ Describes the rotation of an item from its default orientation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Branded, translated, and/or localized names for this service.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for assembly performed on shipment.
+
+
+
+
+ Number of pieces or packages to be assembled
+
+
+
+
+ Total weight of pieces or packages to be assembled
+
+
+
+
+
+
+
+
+
+
+
+ Specifies data structures that may be re-used multiple times with s single shipment.
+
+
+
+
+ Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities.
+
+
+
+
+
+
+ Shipment-level totals of dry ice data across all packages.
+
+
+
+
+ Total number of packages in the shipment that contain dry ice.
+
+
+
+
+ Total shipment dry ice weight for all packages.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
+
+
+
+
+ Human-readable text describing the shipment leg.
+
+
+
+
+ Origin for this leg.
+
+
+
+
+ Specifies the location id the origin of shipment leg.
+
+
+
+
+ Destination for this leg.
+
+
+
+
+ Specifies the location id the destination of shipment leg.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates the rate scale used.
+
+
+
+
+ Indicates the rate zone used (based on origin and destination).
+
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+ Specifies the currency exchange performed on financial amounts for this rate.
+
+
+
+
+ Indicates which special rating cases applied to this shipment.
+
+
+
+
+
+ Identifies the type of dim divisor that was applied.
+
+
+
+
+
+
+ Sum of dimensional weights for all packages.
+
+
+
+
+
+
+
+
+ This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ Total of the transportation-based taxes.
+
+
+
+
+
+
+ Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
+
+
+
+
+ This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
+
+
+
+
+ Rate data specific to FedEx Freight and FedEx National Freight services.
+
+
+
+
+ All rate discounts that apply to this shipment.
+
+
+
+
+ All rebates that apply to this shipment.
+
+
+
+
+ All surcharges that apply to this shipment.
+
+
+
+
+ All transportation-based taxes applicable to this shipment.
+
+
+
+
+ All commodity-based duties and taxes applicable to this shipment.
+
+
+
+
+ The "order level" variable handling charges.
+
+
+
+
+ The total of all variable handling charges at both shipment (order) and package level.
+
+
+
+
+
+
+
+
+ This identifies which customer reference field contains the manifest ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This is the state of the destination location ID, and is not necessarily the same as the postal state.
+
+
+
+
+ Expected/estimated date of delivery.
+
+
+
+
+ Expected/estimated day of week of delivery.
+
+
+
+
+ Delivery time, as published in Service Guide.
+
+
+
+
+ Committed date of delivery.
+
+
+
+
+ Committed day of week of delivery.
+
+
+
+
+ Standard transit time per origin, destination, and service.
+
+
+
+
+ Maximum expected transit time
+
+
+
+
+ Transit time based on customer eligibility.
+
+
+
+
+ Indicates that this shipment is not eligible for money back guarantee.
+
+
+
+
+ FedEx Ground delivery features for which this shipment may be eligible.
+
+
+
+
+ Text describing planned delivery.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies special or custom features to be applied to a shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies special or custom features to be applied during the processing of the enclosing RequestedShipment.
+
+
+
+
+ Identifies options to be applied.
+
+
+
+
+ Specifies custom transit time to be applied to the shipment.
+
+
+
+
+
+
+ Data for a shipment's total/summary rates, as calculated per a specific rate type. The "total..." fields may differ from the sum of corresponding package data for Multiweight or Express MPS.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates the rate scale used.
+
+
+
+
+ Indicates the rate zone used (based on origin and destination).
+
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+ FEDEX INTERNAL USE ONLY - the user ID provided when this rate was created
+
+
+
+
+ Specifies the currency exchange performed on financial amounts for this rate.
+
+
+
+
+ Indicates which special rating cases applied to this shipment.
+
+
+
+
+
+ Identifies the type of dim divisor that was applied.
+
+
+
+
+
+
+ Sum of dimensional weights for all packages.
+
+
+
+
+
+
+
+
+ This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ Total of the transportation-based taxes.
+
+
+
+
+
+
+ Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
+
+
+
+
+ Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
+
+
+
+
+ The total of the totalDutiesAndTaxes plus the totalAncillaryFeesAndTaxes.
+
+
+
+
+ This shipment's totalNetCharge + totalDutiesTaxesAndFees; some duties and taxes are only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
+
+
+
+
+ Identifies the Rate Details per each leg in a Freight Shipment
+
+
+
+
+ Rate data specific to FedEx Freight and FedEx National Freight services.
+
+
+
+
+ All rate discounts that apply to this shipment.
+
+
+
+
+ All rebates that apply to this shipment.
+
+
+
+
+ All surcharges that apply to this shipment.
+
+
+
+
+ All transportation-based taxes applicable to this shipment.
+
+
+
+
+ All commodity-based duties and taxes applicable to this shipment.
+
+
+
+
+ Identifies the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
+
+
+
+
+ The "order level" variable handling charges.
+
+
+
+
+ The total of all variable handling charges at both shipment (order) and package level.
+
+
+
+
+
+
+ This class groups together all shipment-level rate data (across all rate types) as part of the response to a shipping request, which groups shipment-level data together and groups package-level data by package.
+
+
+
+
+ This rate type identifies which entry in the following array is considered as presenting the "actual" rates for the shipment.
+
+
+
+
+ The "list" total net charge minus "actual" total net charge.
+
+
+
+
+ Each element of this field provides shipment-level rate totals for a specific rate type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ Indicates the shipment special service types that are requested on this shipment. For a list of the valid shipment special service types, please consult your integration documentation or get the list of the available special services from the getAllSpecialServices method of the Validation Availability and Commitment service.
+
+
+
+
+
+
+
+ This replaces eMailNotificationDetail
+
+
+
+
+
+ This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
+
+
+
+
+
+
+
+
+
+
+ Electronic Trade document references.
+
+
+
+
+ Specification for labor to be performed with the shipment.
+
+
+
+
+ Specifications for pallets to be shrinkwrapped as part of a Freight shipment.
+
+
+
+
+ Specifications for pallets to be provided on Freight shipment.
+
+
+
+
+ Specifications for pup/set or vehicle delayed for loading or unloading.
+
+
+
+
+ Specification for marking or tagging of pieces in shipment.
+
+
+
+
+ Specification for services performed during non-business hours and/or days.
+
+
+
+
+ Specification for assembly performed on shipment.
+
+
+
+
+ Specification for sorting and/or segregating performed on shipment.
+
+
+
+
+ Specification for special equipment used in loading/unloading shipment.
+
+
+
+
+ Specification for storage provided for shipment.
+
+
+
+
+ Specification for weighing services provided for shipment.
+
+
+
+
+ Specification for date or range of dates on which delivery is to be attempted.
+
+
+
+
+
+
+
+
+ Specifies the name or the key for the shipment variation.
+
+
+
+
+ The values that are valid for the specified shipment variation in the context of the current shipment.
+
+
+
+
+
+
+
+
+ This indicates the identifier of a conveyance, such as a trailer ID.
+
+
+
+
+
+
+
+
+
+ The localizations are populated if multiple language versions of a shipping document are returned.
+
+
+
+
+ Specifies how this document image/file is organized.
+
+
+
+
+
+ The name under which a STORED, DEFERRED or EMAILED document is written.
+
+
+
+
+ Specifies the image type of this shipping document.
+
+
+
+
+ Specifies the image resolution in DPI (dots per inch).
+
+
+
+
+ Can be zero for documents whose disposition implies that no content is included.
+
+
+
+
+ One or more document parts which make up a single logical document, such as multiple pages of a single form.
+
+
+
+
+
+
+ Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
+
+
+
+
+ Values in this field specify how to create and return the document.
+
+
+
+
+ Specifies how to organize all documents of this type.
+
+
+
+
+ Specifies how to store document images.
+
+
+
+
+ Specifies how to e-mail document images.
+
+
+
+
+ Specifies how a queued document is to be printed.
+
+
+
+
+
+
+ Specifies how to return a shipping document to the caller.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to e-mail shipping documents.
+
+
+
+
+ Provides the roles and email addresses for e-mail recipients.
+
+
+
+
+ Identifies the convention by which documents are to be grouped as e-mail attachments.
+
+
+
+
+ Specifies the language in which the email containing the document is requested to be composed.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies an individual recipient of e-mailed shipping document(s).
+
+
+
+
+ Identifies the relationship of this recipient in the shipment.
+
+
+
+
+ Address to which the document is to be sent.
+
+
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies how to create, organize, and return the document.
+
+
+
+
+ Specifies how far down the page to move the beginning of the image; allows for printing on letterhead and other pre-printed stock.
+
+
+
+
+
+
+ For those shipping document types which have both a "form" and "instructions" component (e.g. NAFTA Certificate of Origin and General Agency Agreement), this field indicates whether to provide the instructions.
+
+
+
+
+
+ Governs the language to be used for this individual document, independently from other content returned for the same shipment.
+
+
+
+
+ Identifies the individual document specified by the client.
+
+
+
+
+
+
+ Specifies how to organize all shipping documents of the same type.
+
+
+
+
+
+
+
+
+ Specifies the image format used for a shipping document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the convention by which file names are constructed for STORED or DEFERRED documents.
+
+
+
+
+
+
+
+
+ A single part of a shipping document, such as one page of a multiple-page document whose format requires a separate image per page.
+
+
+
+
+ The one-origin position of this part within a document.
+
+
+
+
+ Graphic or printer commands for this image within a document.
+
+
+
+
+
+
+ Specifies printing options for a shipping document.
+
+
+
+
+ Provides environment-specific printer identification.
+
+
+
+
+
+
+ Contains all data required for additional (non-label) shipping documents to be produced in conjunction with a specific shipment.
+
+
+
+
+ Indicates the types of shipping documents requested by the shipper.
+
+
+
+
+
+
+ Specifies the production of each package-level custom document (the same specification is used for all packages).
+
+
+
+
+ Specifies the production of a shipment-level custom document.
+
+
+
+
+
+
+
+ Specifies the production of the OP-900 document for hazardous materials packages.
+
+
+
+
+ Specifies the production of the 1421c document for dangerous goods shipment.
+
+
+
+
+ Specifies the production of the OP-900 document for hazardous materials.
+
+
+
+
+
+ Specifies the production of the return instructions document.
+
+
+
+
+
+
+ Specifies the type of paper (stock) on which a document will be printed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to store shipping documents.
+
+
+
+
+ Indicates the mechanism by which a shipping document will be stored for later retrieval.
+
+
+
+
+ Provides the path to be used for STORED or DEFERRED documents.
+
+
+
+
+ Identifies the convention by which file names are constructed for STORED or DEFERRED documents.
+
+
+
+
+ Suffix to be placed at the end of the file name; required on some platforms to determine file type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values are mutually exclusive; at most one of them can be attached to a SmartPost shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required for shipments handled under the SMART_POST and GROUND_SMART_POST service types.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for sorting and/or segregating performed on shipment.
+
+
+
+
+ Number of pieces or packages to be sorted/segregated
+
+
+
+
+ Total weight of pieces or packages to be sorted/segregated
+
+
+
+
+
+
+ Specification for special equipment used in loading/unloading shipment.
+
+
+
+
+ Contains an entry for each type of special equipment used with shipment
+
+
+
+
+
+
+ Specifies the usage of a single type of special equipment while loading/unloading a shipment
+
+
+
+
+ Type of equipment used
+
+
+
+
+ Total amount of time the equipment was used
+
+
+
+
+
+
+ Identifies types of special equipment used in loading/unloading Freight shipments
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for storage provided for shipment.
+
+
+
+
+ Total time shipment is held by carrier.
+
+
+
+
+
+
+ Each instance of this data type represents a barcode whose content must be represented as ASCII text (i.e. not binary data).
+
+
+
+
+ The kind of barcode data in this instance.
+
+
+
+
+ The data content of this instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifice the kind of tax or miscellaneous charge being reported on a Commercial Invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the usage of Tax Identification Number in Shipment processing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ For use with SmartPost tracking IDs only
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+ Unique identifier assigned/forwarded by internal FAST services only, to associate service transactions comprising a single business work unit.
+
+
+
+
+ Each FAST service should log request/reply pairs for any transaction in which this attribute is true. This is for internal use only (capturing transaction data for diagnostic purposes).
+
+
+
+
+ Indicates the format in which the transaction was presented to FedEx, used to help identify error-translation context.
+
+
+
+
+ Identifies the environment (level) in which the current transaction should be processed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the application that is responsible for managing the document id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Description of the uploaded document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+ Documents the kind and quantity of an individual hazardous commodity in a package.
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Specifies the amount of the commodity in alternate units.
+
+
+
+
+ The mass points are a calculation used by ADR regulations for measuring the risk of a particular hazardous commodity.
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
+
+
+
+
+
+
+ Identifies and describes an individual hazardous commodity. For 201001 load, this is based on data from the FedEx Ground Hazardous Materials Shipping Guide.
+
+
+
+
+ Regulatory identifier for a commodity (e.g. "UN ID" value).
+
+
+
+
+ In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
+
+
+
+
+
+
+
+ Fully-expanded descriptive text for a hazardous commodity.
+
+
+
+
+
+
+
+ Coded indications for special requirements or constraints.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the concept of a container used to package dangerous goods commodities.
+
+
+
+
+ Indicates that the quantity of the dangerous goods packaged is permissible for shipping. This is used to ensure that the dangerous goods commodities do not exceed the net quantity per package restrictions.
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current package.
+
+
+
+
+
+
+ This definition of variable handling charge detail is intended for use in Jan 2011 corp load.
+
+
+
+
+
+ Actual percentage (10 means 10%, which is a mutiplier of 0.1)
+
+
+
+
+ Select the value from a set of rate data to which the percentage is applied.
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Three-dimensional volume/cubic measurement.
+
+
+
+
+
+
+
+
+ Units of three-dimensional volume/cubic measure.
+
+
+
+
+
+
+
+
+ Identifies the environment (level) for which an AuthenticationCredential is valid, and within which transactions are received.
+
+
+
+
+
+
+
+
+ Specifies a single type of weighing performed on a shipment
+
+
+
+
+ Type of scale used
+
+
+
+
+
+
+ Identifies types of scales used in weighing Freight shipments
+
+
+
+
+
+
+
+
+ The descriptive data for the heaviness of an object.
+
+
+
+
+ Identifies the unit of measure associated with a weight value.
+
+
+
+
+ Identifies the weight value of a package/shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/TrackService_v10.wsdl b/fedex/wsdl/TrackService_v16.wsdl
similarity index 83%
rename from fedex/wsdl/TrackService_v10.wsdl
rename to fedex/wsdl/TrackService_v16.wsdl
index a6f3799..009cece 100755
--- a/fedex/wsdl/TrackService_v10.wsdl
+++ b/fedex/wsdl/TrackService_v16.wsdl
@@ -1,12 +1,10 @@
-
+
-
+
+
+
-
-
-
-
@@ -54,6 +52,11 @@
Indicates whether this address residential (as opposed to commercial).
+
+
+ The geographic coordinates cooresponding to this address.
+
+
@@ -132,6 +135,12 @@
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
@@ -179,17 +188,22 @@
Value used to identify a commodity description; must be unique within the containing shipment.
-
+
+
+ FedEx internal commodity identifier
+
+
-
-
-
-
-
+
- This field is used for enterprise transactions.
+ A free-form description of the commodity, which could be used for customs clearance documentation.
+
+
+
+
+
@@ -214,6 +228,12 @@
+
+
+
+
+
+
@@ -382,9 +402,6 @@
-
- The dimensions of this package and the unit type used for the measurements.
-
@@ -410,86 +427,38 @@
-
- Identifies the collection of units of measure that can be associated with a distance value.
-
-
+
- Information describing email notifications that will be sent in relation to events that occur during package movement
+ Successive parts of the document (only one, for PDF documents).
-
+
- A message that will be included in the email notifications
+ The one-origin position of this part within a document.
-
+
- Information describing the destination of the email, format of the email and events to be notified on
+ Graphic or printer commands for this image within a document.
-
-
-
-
-
-
-
-
-
-
- The format of the email
-
-
-
-
-
-
-
-
+
-
+
+
- Identifies the relationship this email recipient has to the shipment.
-
-
-
-
- The email address to send the notification to
-
-
-
-
- The types of email notifications being requested for this recipient.
-
-
-
-
- The format of the email notification.
-
-
-
-
- The language/locale to be used in this email notification.
+ Specifies the name associated with the email address.
-
-
-
-
-
-
-
-
@@ -510,6 +479,11 @@
+
+
+
+
+ Identifies a kind of FedEx facility.
@@ -522,15 +496,43 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
- CM = centimeters, IN = inches
-
@@ -661,11 +663,45 @@
- A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) witout having to parse the message string.
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Indicates the type of notification that will be sent.
+
+
+
+
+ Specifies the email notification details.
+
+
+
+
+ Specifies the localization for this notification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -681,9 +717,6 @@
-
- Identifies the set of severity values for a Notification.
-
@@ -692,6 +725,11 @@
+
+
+
+
+
@@ -720,9 +758,6 @@
-
- The enumerated packaging type used for this package.
-
@@ -751,6 +786,44 @@
+
+
+ This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -764,38 +837,6 @@
-
-
- Tracking number and additional shipment data used to identify a unique shipment for proof of delivery.
-
-
-
-
- FedEx assigned identifier for a package/shipment.
-
-
-
-
- The date the package was shipped.
-
-
-
-
- If the account number used to ship the package is provided in the request the shipper and recipient information is included on the letter or fax.
-
-
-
-
- FedEx operating company that delivered the package.
-
-
-
-
- Only country is used for elimination of duplicate tracking numbers.
-
-
-
-
@@ -898,17 +939,14 @@
Included in the email notification identifying the requester of this notification.
-
+
- Who to send the email notifications to and for which events. The notificationRecipientType and NotifyOnShipment fields are not used in this request.
+ This replaces eMailNotificationDetail
-
- The service type of the package/shipment.
-
@@ -953,6 +991,7 @@
+
@@ -962,177 +1001,45 @@
-
+
-
-
+
+
+
-
-
- FedEx Signature Proof Of Delivery Fax reply.
-
+
-
-
- This contains the severity type of the most severe Notification in the Notifications array.
-
-
-
-
- Information about the request/reply such was the transaction successful or not, and any additional information relevant to the request and/or reply. There may be multiple Notifications in a reply.
-
-
-
-
- Contains the CustomerTransactionDetail that is echoed back to the caller for matching requests and replies and a Localization element for defining the language/translation used in the reply data.
-
-
-
-
- Contains the version of the reply being used.
-
-
-
-
- Confirmation of fax transmission.
-
-
-
-
-
-
- FedEx Signature Proof Of Delivery Fax request.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Contains a free form field that is echoed back in the reply to match requests with replies and data that governs the data payload language/translations.
-
-
-
-
- The version of the request being used.
-
-
-
-
- Tracking number and additional shipment data used to identify a unique shipment for proof of delivery.
-
-
-
-
- Additional customer-supplied text to be added to the body of the letter.
-
-
-
-
- Contact and address information about the person requesting the fax to be sent.
-
-
-
-
- Contact and address information, including the fax number, about the person to receive the fax.
-
-
+
+
+
+
-
-
- Identifies the set of SPOD image types.
-
+
-
-
+
+
-
-
- FedEx Signature Proof Of Delivery Letter reply.
-
+
-
-
- This contains the severity type of the most severe Notification in the Notifications array.
-
-
-
-
- Information about the request/reply such was the transaction successful or not, and any additional information relevant to the request and/or reply. There may be multiple Notifications in a reply.
-
-
-
-
- Contains the CustomerTransactionDetail that is echoed back to the caller for matching requests and replies and a Localization element for defining the language/translation used in the reply data.
-
-
-
-
- Image of letter encoded in Base64 format.
-
-
-
-
- Image of letter encoded in Base64 format.
-
-
+
-
-
- FedEx Signature Proof Of Delivery Letter request.
-
+
+
+
+
+
+
+
+
+
+
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Contains a free form field that is echoed back in the reply to match requests with replies and data that governs the data payload language/translations.
-
-
-
-
- The version of the request being used.
-
-
-
-
- Tracking number and additional shipment data used to identify a unique shipment for proof of delivery.
-
-
-
-
- Additional customer-supplied text to be added to the body of the letter.
-
-
-
-
- Identifies the set of SPOD image types.
-
-
-
-
- If provided this information will be print on the letter.
-
-
+
+
@@ -1214,10 +1121,13 @@
+
+
+
+
+
+
-
- The delivery location at the delivered to address.
-
@@ -1247,9 +1157,6 @@
-
- Detailed tracking information about a particular package.
-
@@ -1272,6 +1179,11 @@
Specifies details about the status of the shipment being tracked.
+
+
+ Notifications to the end user that provide additional information relevant to the tracked shipment. For example, a notification may indicate that a change in behavior has occurred.
+
+
@@ -1310,11 +1222,7 @@
Specifies the FXO production centre contact and address.
-
-
- Other related identifiers for this package such as reference numbers.
-
-
+ (Returned for CSR SL only.)
@@ -1355,6 +1263,7 @@
Strict representation of the Packaging type (e.g. FEDEX_BOX, YOUR_PACKAGING).
+ The sequence number of this package in a shipment. This would be 2 if it was package number 2 of 4.
@@ -1365,6 +1274,11 @@
The number of packages in this shipment.
+
+
+ FOR FEDEX INTERNAL USE ONLY: Specifies the software id of the device that was used to create this tracked shipment.
+
+ Specifies the details about the SPOC details.
@@ -1375,7 +1289,7 @@
-
+
@@ -1386,7 +1300,12 @@
- List of special handlings that applied to this package. (Returned for CSR SL only.)
+ List of special handlings that applied to this package.
+
+
+
+
+ Specifies the details about the payments for the shipment being tracked.
@@ -1399,11 +1318,7 @@
Indicates last-known possession of package (Returned for CSR SL only.)
-
-
- The address information for the shipper.
-
-
+ The address of the FedEx pickup location/facility.
@@ -1414,16 +1329,7 @@
(Returned for CSR SL only.)
-
-
- Estimated package pickup time for shipments that haven't been picked up.
-
-
-
-
- Time package was shipped/tendered over to FedEx. Time portion will be populated if available, otherwise will be set to midnight.
-
-
+ The distance from the origin to the destination. Returned for Custom Critical shipments.
@@ -1472,26 +1378,6 @@
-
-
- Date and time the package should be (or should have been) delivered. (Returned for CSR SL only.)
-
-
-
-
- Date and time the package would be delivered if the package has appointment delivery as a special service.
-
-
-
-
- Projected package delivery time based on ship time stamp, service and destination. Not populated if delivery has already occurred.
-
-
-
-
- The time the package was actually delivered.
-
- Actual address where package was delivered. Differs from destinationAddress, which indicates where the package was to be delivered; This field tells where delivery actually occurred (next door, at station, etc.)
@@ -1532,13 +1418,9 @@
Specifies the total number of unique addresses on the CRNs in a consolidation.
-
+
-
-
- The types of email notifications that are available for the package.
-
-
+ Returned for cargo shipments only when they are currently split across vehicles.
@@ -1609,9 +1491,6 @@
-
- The type of track to be performed.
-
@@ -1640,6 +1519,20 @@
+
+
+
+
+ A code that designates the type of informational message being returned.
+
+
+
+
+ The informational message in human readable form.
+
+
+
+
@@ -1679,11 +1572,7 @@
Options available for a tracking notification recipient.
-
-
- The types of email notifications available for this recipient.
-
-
+
@@ -1710,6 +1599,17 @@
+
+
+
+
+ Indicates the classification of the charges being paid.
+
+
+
+
+
+
@@ -1751,9 +1651,6 @@
-
- The descriptive data returned from a FedEx package tracking request.
-
@@ -1783,9 +1680,6 @@
-
- The descriptive data sent by a client to track a FedEx package.
-
@@ -1931,6 +1825,7 @@
+
@@ -1956,7 +1851,9 @@
+
+
@@ -1997,6 +1894,7 @@
+
@@ -2104,10 +2002,131 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the information used to fax the document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the recipients of the email.
+
+
+
+
+ Identifies the person initiating the email.
+
+
+
+
+ This is the localization of the email content.
+
+
+
+
+ A message included in the body of the email.
+
+
+
+
+
+
+
+
+
+
+
+ The localization for the generated document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
- Descriptive data that governs data payload language/translations. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
@@ -2139,9 +2158,6 @@
-
- Identifies the collection of units of measure that can be associated with a weight value.
-
@@ -2191,7 +2207,7 @@
Identifies a system or sub-system which performs an operation.
-
+ Identifies the service business level.
@@ -2213,17 +2229,11 @@
-
-
-
-
-
-
-
-
+
+
@@ -2231,21 +2241,17 @@
-
-
+
+
-
-
-
-
-
-
-
+
+
+
@@ -2254,17 +2260,8 @@
-
-
-
-
-
-
-
-
+
@@ -2272,8 +2269,8 @@
-
-
+
+
@@ -2282,7 +2279,7 @@
-
+
diff --git a/fedex/wsdl/UploadDocumentService_v11.wsdl b/fedex/wsdl/UploadDocumentService_v11.wsdl
new file mode 100755
index 0000000..0e38e90
--- /dev/null
+++ b/fedex/wsdl/UploadDocumentService_v11.wsdl
@@ -0,0 +1,506 @@
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Lists the documents that are not accepted by FedEx for this shipment.
+
+
+
+
+
+
+ Specifies the usage or intent of the document in the current context.
+
+
+
+
+
+
+
+
+ This identifies some of the document types recognized by Enterprise Document Management Service.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tracking number field should be provided when uploading documents after the shipment has been processed or confirmed. This is only applicable if the shipment has been processed with the POST_SHIPMENT_UPLOAD_REQUESTED ETD attribute.
+
+
+
+
+
+
+ This identifies the document types that can be required. This can also indicate when either a COMMERCIAL_INVOICE or a PRO_FORMA_INVOICE is required through the COMMERCIAL_OR_PRO_FORMA_INVOICE option.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the date until which the document is available
+
+
+
+
+
+
+ Specifies the application that is responsible for managing the document id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Distinct value for reason status was assigned.
+
+
+
+
+ Human-readable explanation of document status.
+
+
+
+
+
+
+
+
+ Each of these values identifies a specific reason why a document or reference could not be uploaded or associated with a shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ For an upload making use of the POST_SHIPMENT_UPLOAD option, this will indicate information about the required documents necessary for package movement.
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the intent or the usage of the documents being uploaded. This provides details about how the documents are relevant to the current transaction.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/ValidationAvailabilityAndCommitmentService_v8.wsdl b/fedex/wsdl/ValidationAvailabilityAndCommitmentService_v8.wsdl
new file mode 100755
index 0000000..722dae4
--- /dev/null
+++ b/fedex/wsdl/ValidationAvailabilityAndCommitmentService_v8.wsdl
@@ -0,0 +1,377 @@
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the commit time for a FedEx Ground shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+ Optionally supplied instead of service to restrict reply to services for a specific carrier.
+
+
+
+
+ Restricts reply to single service, if supplied.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/test_server_wsdl/CountryService_v8.wsdl b/fedex/wsdl/test_server_wsdl/CountryService_v8.wsdl
new file mode 100755
index 0000000..0fd2029
--- /dev/null
+++ b/fedex/wsdl/test_server_wsdl/CountryService_v8.wsdl
@@ -0,0 +1,453 @@
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Package special services prohibited for this location for operational reasons. (Other package special services may or may not be available per shipment for other reasons.)
+
+
+
+
+ Shipment special services prohibited for this location for operational reasons. (Other shipment special services may or may not be available per shipment for other reasons.)
+
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/test_server_wsdl/LocationsService_v9.wsdl b/fedex/wsdl/test_server_wsdl/LocationsService_v9.wsdl
new file mode 100755
index 0000000..ba7189b
--- /dev/null
+++ b/fedex/wsdl/test_server_wsdl/LocationsService_v9.wsdl
@@ -0,0 +1,1120 @@
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Additional information about a physical location, such as suite number, cross street, floor number in a building. These details are not typically a part of a standard address definition; however, these details might help locate the address.
+
+
+
+
+
+
+ Indicates whether how this location can be accessed.
+
+
+
+
+ Specifies building number or name.
+
+
+
+
+ Specifies a department in the company or retail store.
+
+
+
+
+ Specifies the floor number.
+
+
+
+
+
+ Specifies apartment number.
+
+
+
+
+ Specifies the room number, if one is specified.
+
+
+
+
+
+ This is used to specify additional details about the address such as landmark. For e.g. This field is used to capture details such as an address being inside a facility such as, Chilli's Care Center, St. Jude - Inside.
+
+
+
+
+
+
+ Specifies the relationship between the address specificed and the address of the FedEx Location in terms of distance.
+
+
+
+
+ Address as provided in the request.
+
+
+
+
+ Specify the geographic co-ordinates for the matched address.
+
+
+
+
+ Specifies the distance between the matched address and the addresses of matched FedEx locations. Also specifies the details of the FedEx locations.
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This field describe a subset of the carrier's products or services which may have unique characteristics: i.e. latest drop-off times at a particular location vary depending on the destination type.
+
+
+
+
+ Specifies the details about the latest times a drop off can be made at a location most days. These are the normal drop off times.
+
+
+
+
+ Specifies the details about the exceptional latest times a drop off can be made at a location. These are drop off times that are a variation from the normal drop off times.
+
+
+
+
+ Specifies the details about the effective latest times drop off can be made at a location on the date requested. These are drop off times that are derived from the normal and exceptional drop off times, depending upon the date requested.
+
+
+
+
+
+
+
+ Specifies the special services supported at the clearance location for an individual destination country.
+
+
+
+
+ Identifies the country whose special services are specified below.
+
+
+
+
+
+ Identifies the constrained special services supported for the country above.
+
+
+
+
+
+
+ Specifies the details about the countries supported by this location.
+
+
+
+
+ Services supported for clearance
+
+
+
+
+ Identifies the type of consolidation for which these clearance location attributes were extracted.
+
+
+
+
+ Identifies the type of clearance performed at this location.
+
+
+
+
+ Identifies the constrained special services supported at this location.
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data for a point-of-contact person.
+
+
+
+
+ Client provided identifier corresponding to this contact information.
+
+
+
+
+ Identifies the contact person's name.
+
+
+
+
+ Identifies the contact person's title.
+
+
+
+
+ Identifies the company this contact is associated with.
+
+
+
+
+ Identifies the phone number associated with this contact.
+
+
+
+
+ Identifies the phone extension associated with this contact.
+
+
+
+
+ Identifies a toll free number, if any, associated with this contact.
+
+
+
+
+ Identifies the pager number associated with this contact.
+
+
+
+
+ Identifies the fax number associated with this contact.
+
+
+
+
+ Identifies the email address associated with this contact.
+
+
+
+
+
+
+ Describes relationship between origin and destination countries.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Driving or other transportation distances, distinct from dimension measurements.
+
+
+
+
+ Identifies the distance quantity.
+
+
+
+
+ Identifies the unit of measure for the distance value.
+
+
+
+
+
+
+ Specifies the location details and other information relevant to the location that is derived from the inputs provided in the request.
+
+
+
+
+ Distance between an address of a geographic location and an address of a FedEx location.
+
+
+
+
+
+ DEPRECATED as of July 2017; See locationCapabilities.
+
+
+
+
+ Details about a FedEx location such as services offered, working hours and pick and drop off times.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies a kind of FedEx facility.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the latest time by which a package can be dropped off at a FedEx location.
+
+
+
+
+
+
+ Specifies the details about the overlay to the last drop off time for a carrier at a FedEx location.
+
+
+
+
+
+
+ Specifies the reason for the overlay of the daily last drop off time for a carrier.
+
+
+
+
+
+
+
+ Specifies the time and reason to overlay the last drop off time for a carrier at a FedEx location.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ Indicates how this can be accessed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The carrier code for which this capability applies.
+
+
+
+
+
+ The service category for which this capability applies.
+
+
+
+
+ The method by which a package is transferred to the possession of a FedEx location.
+
+
+
+
+ The days of the week for which this capability applies.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes an individual location providing a set of customer service features.
+
+
+
+
+
+
+
+
+
+
+
+ Branded text associated with this location type.
+
+
+
+
+
+
+ The maximum values for various package attributes that are supported at the location.
+
+
+
+
+ Details about the clearance location.
+
+
+
+
+ Details about the FedEx administrative locations that may provide services to this location.
+
+
+
+
+
+
+
+
+ Normal operating hours for the location.
+
+
+
+
+ Operating hours for the location that are exception from the normal hours of operation.
+
+
+
+
+
+
+
+
+ Specifies the location hours for a location.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the crieteria used to filter the location search results.
+
+
+
+
+
+
+
+
+
+ Specifies the criterion to be used to sort the location details.
+
+
+
+
+
+
+
+
+
+
+ Specifies the criterion and order to be used to sort the location details.
+
+
+
+
+ Specifies the criterion to be used to sort the location details.
+
+
+
+
+ Specifies sort order of the location details.
+
+
+
+
+
+
+ Specifies sort order of the location details.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the criteria types that may be used to search for FedEx locations.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Attributes about a reservation at a FedEx location.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies additional constraints on the attributes of the locations being searched.
+
+
+
+
+ Specifies value and units of the radius around the address to search for FedEx locations.
+
+
+
+
+
+ Specifies the criteria used to filter the results of locations search.
+
+
+
+
+ DEPRECATED as of July 2017; See requiredLocationCapabilities.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies total number of location results that are available.
+
+
+
+
+ Specifies the number of location results returned in this reply.
+
+
+
+
+ Specifies the address formatted to have correct postal code per USPS standards.
+
+
+
+
+ The details about the relationship between the address requested and the locations returned.
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+ Specifies the criterion that may be used to search for FedEx locations.
+
+
+
+
+ The account number of the shipper. This is the account number for which restrictions and privileges will be applied.
+
+
+
+
+ Tracking number to be used when searching for locations. This tracking number, along with other location search constraints, help to narrow the search for locations.
+
+
+
+
+
+
+
+ Specifies the criterion to be used to return location results when there are mutiple matches.
+
+
+
+
+ Specifies the details on how the location search results be sorted in the reply.
+
+
+
+
+ Contraints to be applied to location attributes.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ DEPRECATED as of July 2017.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data for the heaviness of an object.
+
+
+
+
+ Identifies the unit of measure associated with a weight value.
+
+
+
+
+ Identifies the weight value of a package/shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/test_server_wsdl/PickupService_v17.wsdl b/fedex/wsdl/test_server_wsdl/PickupService_v17.wsdl
new file mode 100755
index 0000000..63a7732
--- /dev/null
+++ b/fedex/wsdl/test_server_wsdl/PickupService_v17.wsdl
@@ -0,0 +1,2413 @@
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the role that identifies the permissions the accessor of the pending shipment.
+
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration represents a kind of "legacy" account number from a FedEx operating entity.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Human readable message from dispatch system.
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+ The local date which the pickup was originally scheduled to be picked up on. The date provided is the local to the client of the request. The date specification does not include any time zone designators.
+
+
+
+
+
+
+
+
+ The reason for canceling the pickup request.
+
+
+
+
+ Identifies the name of the person that requested pickup cancellation.
+
+
+
+
+ Identifies the phone number of the person that requested pickup cancellation.
+
+
+
+
+ Identifies the phone extension of the person that requested pickup cancellation.
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+ Select the type of rate used to calculate the percentage value of variable handling.
+
+
+
+
+
+
+ Identifies the type of funds FedEx should collect upon shipment delivery.
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
+
+
+
+
+
+ Specifies the details of the charges are to be added to the COD collect amount.
+
+
+
+
+ Identifies the type of funds FedEx should collect upon package delivery
+
+
+
+
+ For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
+
+
+
+
+ When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
+
+
+
+
+ Specifies the name of person or company receiving the secured/unsecured funds payment
+
+
+
+
+ Indicates which type of reference information to include on the COD return shipping label.
+
+
+
+
+ Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data resulting from the processing of an LTL Freight pickup request.
+
+
+
+
+ Describes the origin service center handling the pickup.
+
+
+
+
+ Describes the results for each line item in the original request.
+
+
+
+
+ Total number of pieces from all line items from request.
+
+
+
+
+ Total weight from all line items from request.
+
+
+
+
+ Total handling units from all line items from request.
+
+
+
+
+ Resulting status of pickup.
+
+
+
+
+
+
+ Data resulting from the processing of an individual line item in a LTL Freight pickup request.
+
+
+
+
+ Identifies the line item, to match reply line with request line.
+
+
+
+
+ Describes the destination service center handling the delivery of this line item.
+
+
+
+
+ Total travel time for this line item.
+
+
+
+
+ Identifies estimated delivery date and time for each line item.
+
+
+
+
+
+
+ The descriptive data for a point-of-contact person.
+
+
+
+
+ Client provided identifier corresponding to this contact information.
+
+
+
+
+ Identifies the contact person's name.
+
+
+
+
+ Identifies the contact person's title.
+
+
+
+
+ Identifies the company this contact is associated with.
+
+
+
+
+ Identifies the phone number associated with this contact.
+
+
+
+
+ Identifies the phone extension associated with this contact.
+
+
+
+
+ Identifies a toll free number, if any, associated with this contact.
+
+
+
+
+ Identifies the pager number associated with this contact.
+
+
+
+
+ Identifies the fax number associated with this contact.
+
+
+
+
+ Identifies the email address associated with this contact.
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes relationship between origin and destination countries.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Coded value supplied by dispatch system.
+
+
+
+
+ Message supplied by dispatch system.
+
+
+
+
+ Package Return Program control number
+
+
+
+
+ Used with "stay late" requests; postal-code specific.
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+ Specifies the tracking number to be used for processing a pickup for a return shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+ This field is being deprecated and will not be removed in the June 2014 load.
+
+
+
+
+
+ Describes the country relationship (domestic and/or international) among the shipments being picked up.
+
+
+
+
+
+
+
+
+ Indicates the type of custom delivery being requested.
+
+
+
+
+ Time by which delivery is requested.
+
+
+
+
+ Range of dates for custom delivery request; only used if type is BETWEEN.
+
+
+
+
+ Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking id for the return, if preassigned.
+
+
+
+
+
+
+ Specifications for pup/set or vehicle delayed for loading or unloading.
+
+
+
+
+ Amount of time involved in the detention.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Driving or other transportation distances, distinct from dimension measurements.
+
+
+
+
+ Identifies the distance quantity.
+
+
+
+
+ Identifies the unit of measure for the distance value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the name associated with the email address.
+
+
+
+
+
+
+
+
+ Content of the email message.
+
+
+
+
+
+
+
+ Information describing the address of of the email recipient, role of the email recipient and languages that are requested to be supported.
+
+
+
+
+ EMail address of the recipient.
+
+
+
+
+ The relationship that the customer has to the pending shipment.
+
+
+
+
+ Specifies how the email notification for the pending shipment need to be processed.
+
+
+
+
+ Localization and language details specified by the recipient of the EMail.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to apply the localization detail to the current context.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies whether to confirm documents prior to processing a shipment with the ELECTRONIC_TRADE_DOCUMENTS special service.
+
+
+
+
+
+
+
+
+ Electronic Trade document references used with the ETD special service.
+
+
+
+
+ Specifies client's intent for whether all documents must be confirmed before shipment processing.
+
+
+
+
+
+ Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Specification for labor time spent handling shipment.
+
+
+
+
+ Total labor time.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies a kind of FedEx facility.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the optional features/characteristics requested for a Freight shipment utilizing a flatbed trailer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Date for all Freight guarantee types.
+
+
+
+
+ Time for GUARANTEED_TIME only.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contact Information of origin service center representative that authorized the pickup
+
+
+
+
+
+
+ Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the line item, to match reply line with request line.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This class describes the relationship between a customer-specified address and the FedEx Freight / FedEx National Freight Service Center that supports that address.
+
+
+
+
+ Freight Industry standard non-FedEx carrier identification
+
+
+
+
+ The name of the Interline carrier.
+
+
+
+
+ Additional time it might take at the origin or destination to pickup or deliver the freight. This is usually due to the remoteness of the location. This time is included in the total transit time.
+
+
+
+
+ Service branding which may be used for local pickup or delivery, distinct from service used for line-haul of customer's shipment.
+
+
+
+
+ Distance between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
+
+
+
+
+ Time to travel between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
+
+
+
+
+ Specifies when/how the customer can arrange for pickup or delivery.
+
+
+
+
+ Specifies days of operation if localServiceScheduling is LIMITED.
+
+
+
+
+ Freight service center that is a gateway on the border of Canada or Mexico.
+
+
+
+
+ Alphabetical code identifying a Freight Service Center
+
+
+
+
+ Freight service center Contact and Address
+
+
+
+
+
+
+ Specifies the type of service scheduling offered from a Freight or National Freight Service Center to a customer-supplied address.
+
+
+
+
+
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+
+
+
+
+ Indicates which kind of hazardous content is being reported.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the source of regulation for hazardous commodity data.
+
+
+
+
+
+
+
+
+
+
+
+
+ Contact phone number for recipient of shipment.
+
+
+
+
+ Contact and address of FedEx facility at which shipment is to be held.
+
+
+
+
+ Type of facility at which package/shipment is to be held.
+
+
+
+
+ Location identification (for facilities identified by an alphanumeric location code).
+
+
+
+
+ Location identification (for facilities identified by an numeric location code).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ Specification for marking or tagging of pieces in shipment.
+
+
+
+
+ Number of pieces to be marked or tagged by FedEx.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for services performed during non-business hours and/or days.
+
+
+
+
+ Total number of person days for full non-business days.
+
+
+
+
+ Total number of person hours (whole or partial hours) for non-business hours.
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Indicates the type of notification that will be sent.
+
+
+
+
+ Specifies the email notification details.
+
+
+
+
+ Specifies the fax notification details.
+
+
+
+
+ Specifies the SMS notification details.
+
+
+
+
+ Specifies the localization for this notification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifications for pallets to be shrinkwrapped as part of a Freight shipment.
+
+
+
+
+ Number of pallets to be shrinkwrapped.
+
+
+
+
+
+
+ Specifications for pallets to be provided on Freight shipment.
+
+
+
+
+ Number of pallets to be provided.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This information describes the kind of pending shipment being requested.
+
+
+
+
+
+ Date after which the pending shipment will no longer be available for completion.
+
+
+
+
+ Only used with type of EMAIL.
+
+
+
+
+
+ These are documents that are recommended to be included with the shipment.
+
+
+
+
+ Upload document details provided by the initator of the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies whether the close time is specified by the customer or is the default time.
+
+
+
+
+ Close time corresponding to the above specified type
+
+
+
+
+
+ Local time of the service center that will service the pickup
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+ Identifies the account number for Freight Pickup Availability
+
+
+
+
+
+
+
+ Number of business days to consider when checking availability.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes the regulation type the pickup dangerous goods.
+
+
+
+
+
+ Specifies the option types of the pickup dangerous goods.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ FedEx USE ONLY (with IVR client)
+
+
+
+
+
+
+
+
+
+
+ FedEx IVR Only. Customer is willing to stay late for pickup.
+
+
+
+
+ FedEx USE ONLY (with IVR client)
+
+
+
+
+ FedEx IVR Only
+
+
+
+
+ Alternate postal code tied to pickup location (European pickups)
+
+
+
+
+ FedEx USE ONLY
+
+
+
+
+ FedEx USE ONLY (with IVR client)
+
+
+
+
+
+ Applies only to Europe
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether residential pickup is available for the requested postal code.
+
+
+
+
+ Describes the country relationship (domestic and/or international) among the shipments being picked up.
+
+
+
+
+
+
+ Specifies the service category for the pick up being scheduled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values indicate the type of pickup being requested.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
+
+
+
+
+
+
+
+ Type of documents that are recommended to be included with the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking number of the master associated with the return shipment.
+
+
+
+
+
+
+
+ These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for assembly performed on shipment.
+
+
+
+
+ Number of pieces or packages to be assembled
+
+
+
+
+ Total weight of pieces or packages to be assembled
+
+
+
+
+
+
+ Shipment-level totals of dry ice data across all packages.
+
+
+
+
+ Total number of packages in the shipment that contain dry ice.
+
+
+
+
+ Total shipment dry ice weight for all packages.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ The types of all special services requested for the enclosing shipment (or other shipment-level transaction).
+
+
+
+
+
+
+
+ This replaces eMailNotificationDetail
+
+
+
+
+
+ This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
+
+
+
+
+
+
+
+
+
+
+ Electronic Trade document references.
+
+
+
+
+ Specification for labor to be performed with the shipment.
+
+
+
+
+ Specifications for pallets to be shrinkwrapped as part of a Freight shipment.
+
+
+
+
+ Specifications for pallets to be provided on Freight shipment.
+
+
+
+
+ Specifications for pup/set or vehicle delayed for loading or unloading.
+
+
+
+
+ Specification for marking or tagging of pieces in shipment.
+
+
+
+
+ Specification for services performed during non-business hours and/or days.
+
+
+
+
+ Specification for assembly performed on shipment.
+
+
+
+
+ Specification for sorting and/or segregating performed on shipment.
+
+
+
+
+ Specification for special equipment used in loading/unloading shipment.
+
+
+
+
+ Specification for storage provided for shipment.
+
+
+
+
+ Specification for weighing services provided for shipment.
+
+
+
+
+ Specification for date or range of dates on which delivery is to be attempted.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for sorting and/or segregating performed on shipment.
+
+
+
+
+ Number of pieces or packages to be sorted/segregated
+
+
+
+
+ Total weight of pieces or packages to be sorted/segregated
+
+
+
+
+
+
+ Specification for special equipment used in loading/unloading shipment.
+
+
+
+
+ Contains an entry for each type of special equipment used with shipment
+
+
+
+
+
+
+ Specifies the usage of a single type of special equipment while loading/unloading a shipment
+
+
+
+
+ Type of equipment used
+
+
+
+
+ Total amount of time the equipment was used
+
+
+
+
+
+
+ Identifies types of special equipment used in loading/unloading Freight shipments
+
+
+
+
+
+
+
+ Specification for storage provided for shipment.
+
+
+
+
+ Total time shipment is held by carrier.
+
+
+
+
+
+
+
+
+
+
+ Identifies the usage of Tax Identification Number in Shipment processing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ For use with SmartPost tracking IDs only
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the date until which the document is available
+
+
+
+
+
+
+ Specifies the application that is responsible for managing the document id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Description of the uploaded document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies a single type of weighing performed on a shipment
+
+
+
+
+ Type of scale used
+
+
+
+
+
+
+ Identifies types of scales used in weighing Freight shipments
+
+
+
+
+
+
+
+
+ The descriptive data for the heaviness of an object.
+
+
+
+
+ Identifies the unit of measure associated with a weight value.
+
+
+
+
+ Identifies the weight value of a package/shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/test_server_wsdl/RateService_v18.wsdl b/fedex/wsdl/test_server_wsdl/RateService_v28.wsdl
old mode 100755
new mode 100644
similarity index 93%
rename from fedex/wsdl/test_server_wsdl/RateService_v18.wsdl
rename to fedex/wsdl/test_server_wsdl/RateService_v28.wsdl
index 65934a6..568201c
--- a/fedex/wsdl/test_server_wsdl/RateService_v18.wsdl
+++ b/fedex/wsdl/test_server_wsdl/RateService_v28.wsdl
@@ -1,4944 +1,5058 @@
-
-
-
-
-
-
-
- Specifies the role that identifies the permissions the accessor of the pending shipment.
-
-
-
-
-
-
-
-
- Specifies additional labels to be produced. All required labels for shipments will be produced without the need to request additional labels. These are only available as thermal labels.
-
-
-
-
- The type of additional labels to return.
-
-
-
-
- The number of this type label to return
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
-
-
-
-
- Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
-
-
-
-
- Name of city, town, etc.
-
-
-
-
- Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
-
-
-
-
- Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
-
-
-
-
- Relevant only to addresses in Puerto Rico.
-
-
-
-
- The two-letter code used to identify a country.
-
-
-
-
- The fully spelt out name of a country.
-
-
-
-
- Indicates whether this address residential (as opposed to commercial).
-
-
-
-
-
-
- Specifies details for a package containing alcohol
-
-
-
-
- The license type that the recipient of the alcohol package.
-
-
-
-
-
-
- Specifies the type of license that the recipient of the alcohol shipment has.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identification of the type of barcode (symbology) used on FedEx documents and labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identification of a FedEx operating company (transportation).
-
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the type of brokerage to be applied to a shipment.
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for the client submitting a transaction.
-
-
-
-
- The FedEx account number associated with this transaction.
-
-
-
-
- This number is assigned by FedEx and identifies the unique device from which the request is originating
-
-
-
-
- Only used in transactions which require identification of the FedEx Office integrator.
-
-
-
-
- Indicates the region from which the transaction is submitted.
-
-
-
-
- The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
- Identifies the type of funds FedEx should collect upon shipment delivery.
-
-
-
-
-
-
-
-
-
- Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
-
-
-
-
-
- Specifies the details of the charges are to be added to the COD collect amount.
-
-
-
-
- Identifies the type of funds FedEx should collect upon package delivery
-
-
-
-
- For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
-
-
-
-
- When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
-
-
-
-
- Specifies the name of person or company receiving the secured/unsecured funds payment
-
-
-
-
- Indicates which type of reference information to include on the COD return shipping label.
-
-
-
-
- Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through the FedEx Systems. Customers are responsible for printing their own Commercial Invoice.If you would likeFedEx to generate a Commercial Invoice and transmit it to Customs. for clearance purposes, you need to specify that in the ShippingDocumentSpecification element. If you would like a copy of the Commercial Invoice that FedEx generated returned to you in reply it needs to be specified in the ETDDetail/RequestedDocumentCopies element. Commercial Invoice support consists of maximum of 99 commodity line items.
-
-
-
-
- Any comments that need to be communicated about this shipment.
-
-
-
-
- Any freight charges that are associated with this shipment.
-
-
-
-
- Any taxes or miscellaneous charges(other than Freight charges or Insurance charges) that are associated with this shipment.
-
-
-
-
- Specifies which kind of charge is being recorded in the preceding field.
-
-
-
-
- Any packing costs that are associated with this shipment.
-
-
-
-
- Any handling costs that are associated with this shipment.
-
-
-
-
- Free-form text.
-
-
-
-
- Free-form text.
-
-
-
-
- Free-form text.
-
-
-
-
- The reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.
-
-
-
-
- Name of the International Expert that completed the Commercial Invoice different from Sender.
-
-
-
-
- Required for dutiable international Express or Ground shipments. This field is not applicable to an international PIB(document) or a non-document which does not require a Commercial Invoice.
-
-
-
-
-
-
- The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
-
-
-
-
-
- Specifies the usage and identification of a customer supplied image to be used on this document.
-
-
-
-
-
-
- Information about the transit time and delivery commitment date and time.
-
-
-
-
- The Commodity applicable to this commitment.
-
-
-
-
- The FedEx service type applicable to this commitment.
-
-
-
-
- Shows the specific combination of service options combined with the service type that produced this committment in the set returned to the caller.
-
-
-
-
- Supporting detail for applied options identified in preceding field.
-
-
-
-
-
-
- THe delivery commitment date/time. Express Only.
-
-
-
-
- The delivery commitment day of the week.
-
-
-
-
- The number of transit days; applies to Ground and LTL Freight; indicates minimum transit time for SmartPost.
-
-
-
-
- Maximum number of transit days, for SmartPost shipments.
-
-
-
-
- The service area code for the destination of this shipment. Express only.
-
-
-
-
- The address of the broker to be used for this shipment.
-
-
-
-
- The FedEx location identifier for the broker.
-
-
-
-
- The delivery commitment date/time the shipment will arrive at the border.
-
-
-
-
- The delivery commitment day of the week the shipment will arrive at the border.
-
-
-
-
- The number of days it will take for the shipment to make it from broker to destination
-
-
-
-
- The delivery commitment date for shipment served by GSP (Global Service Provider)
-
-
-
-
- The delivery commitment day of the week for the shipment served by GSP (Global Service Provider)
-
-
-
-
- Messages concerning the ability to provide an accurate delivery commitment on an International commit quote. These could be messages providing information about why a commitment could not be returned or a successful message such as "REQUEST COMPLETED"
-
-
-
-
- Messages concerning the delivery commitment on an International commit quote such as "0:00 A.M. IF NO CUSTOMS DELAY"
-
-
-
-
- Information about why a shipment delivery is delayed and at what level (country/service etc.).
-
-
-
-
-
- Required documentation for this shipment.
-
-
-
-
- Freight origin and destination city center information and total distance between origin and destination city centers.
-
-
-
-
-
-
- The type of delay this shipment will encounter.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This field is used for enterprise transactions.
-
-
-
-
-
- Contains only additional quantitative information other than weight and quantity to calculate duties and taxes.
-
-
-
-
-
-
- Defines additional characteristic of commodity used to calculate duties and taxes
-
-
-
-
-
-
-
-
- All data required for this commodity in NAFTA Certificate of Origin.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Uniquely identifies a consolidation, which is a logical container for a collection of shipments.
-
-
-
-
- Specifies the type of consolidation.
-
-
-
-
- Uniquely identifies the consolidation, within a given type and date.
-
-
-
-
- The date on which the consolidation was created.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data for a point-of-contact person.
-
-
-
-
- Client provided identifier corresponding to this contact information.
-
-
-
-
- Identifies the contact person's name.
-
-
-
-
- Identifies the contact person's title.
-
-
-
-
- Identifies the company this contact is associated with.
-
-
-
-
- Identifies the phone number associated with this contact.
-
-
-
-
- Identifies the phone extension associated with this contact.
-
-
-
-
- Identifies a toll free number, if any, associated with this contact.
-
-
-
-
- Identifies the pager number associated with this contact.
-
-
-
-
- Identifies the fax number associated with this contact.
-
-
-
-
- Identifies the email address associated with this contact.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The currency code for the original (converted FROM) currency.
-
-
-
-
- The currency code for the final (converted INTO) currency.
-
-
-
-
- Multiplier used to convert fromCurrency units to intoCurrency units.
-
-
-
-
-
-
-
-
- Indicates the type of custom delivery being requested.
-
-
-
-
- Time by which delivery is requested.
-
-
-
-
- Range of dates for custom delivery request; only used if type is BETWEEN.
-
-
-
-
- Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce a custom-specified document, either at shipment or package level.
-
-
-
-
- Common information controlling document production.
-
-
-
-
- Applicable only to documents produced on thermal printers with roll stock.
-
-
-
-
- Applicable only to documents produced on thermal printers with roll stock.
-
-
-
-
- Identifies the formatting specification used to construct this custom document.
-
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified barcode symbology.
-
-
-
-
-
-
-
-
- Width of thinnest bar/space element in the barcode.
-
-
-
-
-
-
-
- Solid (filled) rectangular area on label.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Image to be included from printer's memory, or from a local file for offline clients.
-
-
-
-
-
- Printer-specific index of graphic image to be printed.
-
-
-
-
- Fully-qualified path and file name for graphic image to be printed.
-
-
-
-
-
-
-
-
- Horizontal position, relative to left edge of custom area.
-
-
-
-
- Vertical position, relative to top edge of custom area.
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
-
-
-
-
-
-
-
-
-
- Printer-specific font name for use with thermal printer labels.
-
-
-
-
- Generic font name for use with plain paper labels.
-
-
-
-
- Generic font size for use with plain paper labels.
-
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
-
-
-
-
-
-
-
- Printer-specific font name for use with thermal printer labels.
-
-
-
-
- Generic font name for use with plain paper labels.
-
-
-
-
- Generic font size for use with plain paper labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Allows customer-specified control of label content.
-
-
-
-
- If omitted, no doc tab will be produced (i.e. default is former NONE type).
-
-
-
-
- Controls the position of the customer specified content relative to the FedEx portion.
-
-
-
-
-
-
- Controls which data/sections will be suppressed.
-
-
-
-
- For customers producing their own Ground labels, this field specifies which secondary barcode will be printed on the label; so that the primary barcode produced by FedEx has the correct SCNC.
-
-
-
-
-
-
- Controls the number of additional copies of supplemental labels.
-
-
-
-
- This value reduces the default quantity of destination/consignee air waybill labels. A value of zero indicates no change to default. A minimum of one copy will always be produced.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interacts both with properties of the shipment and contractual relationship with the shipper.
-
-
-
-
-
-
- Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
-
-
-
-
-
-
-
- Identifies responsibilities with respect to loss, damage, etc.
-
-
-
-
- Documents amount paid to third party for coverage of shipment content.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies additional description about customs options. This is a required field when the customs options type is "OTHER".
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Describes an approved container used to package dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container.
-
-
-
-
- Indicates whether there are additional inner receptacles within this container.
-
-
-
-
- Indicates the type of this dangerous goods container, as specified by the IATA packing instructions. For example, steel cylinder, fiberboard box, plastic jerrican and steel drum.
-
-
-
-
- Indicates the packaging type of the container used to package the radioactive materials.
-
-
-
-
- Indicates the number of occurrences of this container with identical dangerous goods configuration.
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current container.
-
-
-
-
-
-
-
-
-
-
- Shipment is packaged/documented for movement ONLY on cargo aircraft.
-
-
-
-
- Indicates which kinds of hazardous content are in the current package.
-
-
-
-
- Indicates whether there is additional customer provided packaging enclosing the approved dangerous goods containers.
-
-
-
-
- Identifies the configuration of this dangerous goods package. The common configuration is represented at the shipment level.
-
-
-
-
- Indicates one or more containers used to pack dangerous goods commodities.
-
-
-
-
- Description of the packaging of this commodity, suitable for use on OP-900 and OP-950 forms.
-
-
-
-
- Name, title and place of the signatory for this shipment.
-
-
-
-
- Telephone number to use for contact in the event of an emergency.
-
-
-
-
- Offeror's name or contract number, per DOT regulation.
-
-
-
-
- Specifies the contact of the party responsible for handling the infectious substances, if any, in the dangerous goods shipment.
-
-
-
-
- Specifies additional handling information for the current package.
-
-
-
-
- Specifies the radioactivity detail for the current package, if the package contains radioactive materials.
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the 1421c form for dangerous goods shipment.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
- Specifies that name, title and place of the signatory responsible for the dangerous goods shipment.
-
-
-
-
-
-
- Indicates the place where the form is signed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Information about why a shipment delivery is delayed and at what level( country/service etc.).
-
-
-
-
- The date of the delay
-
-
-
-
-
- The attribute of the shipment that caused the delay(e.g. Country, City, LocationId, Zip, service area, special handling )
-
-
-
-
- The point where the delay is occurring (e.g. Origin, Destination, Broker location)
-
-
-
-
- The reason for the delay (e.g. holiday, weekend, etc.).
-
-
-
-
- The name of the holiday in that country that is causing the delay.
-
-
-
-
-
-
- The attribute of the shipment that caused the delay(e.g. Country, City, LocationId, Zip, service area, special handling )
-
-
-
-
-
-
-
-
-
-
-
-
-
- The point where the delay is occurring ( e.g. Origin, Destination, Broker location).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking id for the return, if preassigned.
-
-
-
-
-
-
- Data required to complete the Destionation Control Statement for US exports.
-
-
-
-
-
- Comma-separated list of up to four country codes, required for DEPARTMENT_OF_STATE statement.
-
-
-
-
- Name of end user, required for DEPARTMENT_OF_STATE statement.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Driving or other transportation distances, distinct from dimension measurements.
-
-
-
-
- Identifies the distance quantity.
-
-
-
-
- Identifies the unit of measure for the distance value.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Content of the email message.
-
-
-
-
-
-
-
- Information describing email notifications that will be sent in relation to events that occur during package movement
-
-
-
-
- A message that will be included in the email notifications
-
-
-
-
- Information describing the destination of the email, format of the email and events to be notified on
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The format of the email
-
-
-
-
-
-
-
-
-
-
-
- Identifies the relationship this email recipient has to the shipment.
-
-
-
-
- The email address to send the notification to
-
-
-
-
- The types of email notifications being requested for this recipient.
-
-
-
-
- The format of the email notification.
-
-
-
-
- The language/locale to be used in this email notification.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Information describing the address of of the email recipient, role of the email recipient and languages that are requested to be supported.
-
-
-
-
- EMail address of the recipient.
-
-
-
-
- The relationship that the customer has to the pending shipment.
-
-
-
-
- Specifies how the email notification for the pending shipment need to be processed.
-
-
-
-
- Localization and language details specified by the recipient of the EMail.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Customer-declared value, with data type and legal values depending on excise condition, used in defining the taxable value of the item.
-
-
-
-
-
-
- Specifies the types of Estimated Duties and Taxes to be included in a rate quotation for an international shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how to apply the localization detail to the current context.
-
-
-
-
-
-
-
- Electronic Trade document references used with the ETD special service.
-
-
-
-
- Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
-
-
-
-
-
-
-
- The instructions indicating how to print the Export Declaration.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
-
-
-
- General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates a FedEx Express operating region.
-
-
-
-
-
-
-
-
-
-
-
- Identifies a kind of FedEx facility.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the optional features/characteristics requested for a Freight shipment utilizing a flatbed trailer.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce the Freight handling-unit-level address labels. Note that the number of UNIQUE labels (the N as in 1 of N, 2 of N, etc.) is determined by total handling units.
-
-
-
-
-
- Indicates the number of copies to be produced for each unique label.
-
-
-
-
- Specifies the quadrant of the page on which the label printing will start.
-
-
-
-
- If omitted, no doc tab will be produced (i.e. default = former NONE type).
-
-
-
-
- Controls the position of the customer specified content relative to the FedEx portion.
-
-
-
-
-
-
-
- Individual charge which contributes to the total base charge for the shipment.
-
-
-
-
- Freight class for this line item.
-
-
-
-
- Effective freight class used for rating this line item.
-
-
-
-
- NMFC Code for commodity.
-
-
-
-
- Customer-provided description for this commodity or class line.
-
-
-
-
- Weight for this commodity or class line.
-
-
-
-
- Rate or factor applied to this line item.
-
-
-
-
- Identifies the manner in which the chargeRate for this line item was applied.
-
-
-
-
- The net or extended charge for this line item.
-
-
-
-
-
-
- Specifies the way in which base charges for a Freight shipment or shipment leg are calculated.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These values represent the industry-standard freight classes used for FedEx Freight and FedEx National Freight shipment description. (Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms.)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Information about the Freight Service Centers associated with this shipment.
-
-
-
-
- Information about the origin Freight Service Center.
-
-
-
-
- Information about the destination Freight Service Center.
-
-
-
-
- The distance between the origin and destination FreightService Centers
-
-
-
-
-
-
-
-
-
- Date for all Freight guarantee types.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies responsibilities with respect to loss, damage, etc.
-
-
-
-
-
-
-
-
- Rate data specific to FedEx Freight or FedEx National Freight services.
-
-
-
-
- A unique identifier for a specific rate quotation.
-
-
-
-
- Specifies whether the rate quote was automated or manual.
-
-
-
-
- Specifies how total base charge is determined.
-
-
-
-
- Freight charges which accumulate to the total base charge for the shipment.
-
-
-
-
- Human-readable descriptions of additional information on this shipment rating.
-
-
-
-
-
-
- Additional non-monetary data returned with Freight rates.
-
-
-
-
- Unique identifier for notation.
-
-
-
-
- Human-readable explanation of notation.
-
-
-
-
-
-
- Specifies the type of rate quote
-
-
-
-
-
-
-
-
- This class describes the relationship between a customer-specified address and the FedEx Freight / FedEx National Freight Service Center that supports that address.
-
-
-
-
- Freight Industry standard non-FedEx carrier identification
-
-
-
-
- The name of the Interline carrier.
-
-
-
-
- Additional time it might take at the origin or destination to pickup or deliver the freight. This is usually due to the remoteness of the location. This time is included in the total transit time.
-
-
-
-
- Service branding which may be used for local pickup or delivery, distinct from service used for line-haul of customer's shipment.
-
-
-
-
- Distance between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
-
-
-
-
- Time to travel between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
-
-
-
-
- Specifies when/how the customer can arrange for pickup or delivery.
-
-
-
-
- Specifies days of operation if localServiceScheduling is LIMITED.
-
-
-
-
- Freight service center that is a gateway on the border of Canada or Mexico.
-
-
-
-
- Alphabetical code identifying a Freight Service Center
-
-
-
-
- Freight service center Contact and Address
-
-
-
-
-
-
- Specifies the type of service scheduling offered from a Freight or National Freight Service Center to a customer-supplied address.
-
-
-
-
-
-
-
-
-
- Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
-
-
-
-
- Account number used with FEDEX_FREIGHT service.
-
-
-
-
- Used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
-
-
-
-
- Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
-
-
-
-
- Indicates the role of the party submitting the transaction.
-
-
-
-
- Designates the terms of the "collect" payment for a Freight Shipment.
-
-
-
-
- Identifies the declared value for the shipment
-
-
-
-
- Identifies the declared value units corresponding to the above defined declared value
-
-
-
-
-
- Identifiers for promotional discounts offered to customers.
-
-
-
-
- Total number of individual handling units in the entire shipment (for unit pricing).
-
-
-
-
- Estimated discount rate provided by client for unsecured rate quote.
-
-
-
-
- Total weight of pallets used in shipment.
-
-
-
-
- Overall shipment dimensions.
-
-
-
-
- Description for the shipment.
-
-
-
-
- Specifies which party will pay surcharges for any special services which support split billing.
-
-
-
-
-
- Details of the commodities in the shipment.
-
-
-
-
-
-
- Description of an individual commodity or class of content in a shipment.
-
-
-
-
- Freight class for this line item.
-
-
-
-
- Specification of handling-unit packaging for this commodity or class line.
-
-
-
-
- Number of pieces for this commodity or class line.
-
-
-
-
- Customer-provided description for this commodity or class line.
-
-
-
-
- Weight for this commodity or class line.
-
-
-
-
-
- Volume (cubic measure) for this commodity or class line.
-
-
-
-
-
-
- Indicates the role of the party submitting the transaction.
-
-
-
-
-
-
-
-
- Specifies which party will be responsible for payment of any surcharges for Freight special services for which split billing is allowed.
-
-
-
-
- Identifies the special service.
-
-
-
-
- Indicates who will pay for the special service.
-
-
-
-
-
-
- Data required to produce a General Agency Agreement document. Remaining content (business data) to be defined once requirements have been completed.
-
-
-
-
-
-
-
- Documents the kind and quantity of an individual hazardous commodity in a package.
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Specifies the amount of the commodity in alternate units.
-
-
-
-
- This describes the inner receptacle details for a hazardous commodity within the dangerous goods container.
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- Specifies the details of any radio active materials within the commodity.
-
-
-
-
- The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
-
-
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Regulatory identifier for a commodity (e.g. "UN ID" value).
-
-
-
-
- In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates any special processing options to be applied to the description of the dangerous goods commodity.
-
-
-
-
- Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
-
-
-
-
-
-
- Specifies any special processing to be applied to the dangerous goods commodity description validation.
-
-
-
-
-
-
-
- This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container.
-
-
-
-
- This specifies the quantity contained in the inner receptacle.
-
-
-
-
-
-
- Specifies how the commodity is to be labeled.
-
-
-
-
-
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- Specifies how the customer wishes the label text to be handled for this commodity in this package.
-
-
-
-
- Text used in labeling the commodity under control of the labelTextOption field.
-
-
-
-
-
-
- Indicates which kind of hazardous content is being reported.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies number and type of packaging units for hazardous commodities.
-
-
-
-
- Number of units of the type below.
-
-
-
-
- Units in which the hazardous commodity is packaged.
-
-
-
-
-
-
- Specifies documentation and limits for validation of an individual packing group/category.
-
-
-
-
-
- Coded specification for how commodity is to be packed.
-
-
-
-
-
-
- Identifies DOT packing group for a hazardous commodity.
-
-
-
-
-
-
-
-
-
-
- Identifies amount and units for quantity of hazardous commodities.
-
-
-
-
- Number of units of the type below.
-
-
-
-
- Units by which the hazardous commodity is measured. For IATA commodity, the units values are restricted based on regulation type.
-
-
-
-
- Specifies which measure of quantity is to be validated.
-
-
-
-
-
-
- Specifies the measure of quantity to be validated against a prescribed limit.
-
-
-
-
-
-
-
-
- Identifies the source of regulation for hazardous commodity data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Contact phone number for recipient of shipment.
-
-
-
-
- Contact and address of FedEx facility at which shipment is to be held.
-
-
-
-
- Type of facility at which package/shipment is to be held.
-
-
-
-
- Location identification (for facilities identified by an alphanumeric location code).
-
-
-
-
- Location identification (for facilities identified by an numeric location code).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Names for data elements / areas which may be suppressed from printing on labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the order in which the labels will be returned
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Relative to normal orientation for the printer.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the order in which the labels are requested to be returned
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the Liability Coverage Amount. For Jan 2010 this value represents coverage amount per pound
-
-
-
-
-
-
-
-
-
-
-
-
- Represents a one-dimensional measurement in small units (e.g. suitable for measuring a package or document), contrasted with Distance, which represents a large one-dimensional measurement (e.g. distance between cities).
-
-
-
-
- The numerical quantity of this measurement.
-
-
-
-
- The units for this measurement.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the representation of human-readable text.
-
-
-
-
- Two-letter code for language (e.g. EN, FR, etc.)
-
-
-
-
- Two-letter code for the region (e.g. us, ca, etc..).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce a Certificate of Origin document. Remaining content (business data) to be defined once requirements have been completed.
-
-
-
-
-
-
- Indicates which Party (if any) from the shipment is to be used as the source of importer data on the NAFTA COO form.
-
-
-
-
- Contact information for "Authorized Signature" area of form.
-
-
-
-
-
-
-
-
-
-
-
- Defined by NAFTA regulations.
-
-
-
-
- Defined by NAFTA regulations.
-
-
-
-
- Identification of which producer is associated with this commodity (if multiple producers are used in a single shipment).
-
-
-
-
-
- Date range over which RVC net cost was calculated.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- See instructions for NAFTA Certificate of Origin for code definitions.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- See instructions for NAFTA Certificate of Origin for code definitions.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data regarding the result of the submitted transaction.
-
-
-
-
- The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
-
-
-
-
- Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
-
-
-
-
- A code that represents this notification. Combined with the Source it uniquely identifies this notification.
-
-
-
-
- Human-readable text that explains this notification.
-
-
-
-
- The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
-
-
-
-
- A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) witout having to parse the message string.
-
-
-
-
-
-
-
-
- Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
-
-
-
-
- The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the OP-900 form for hazardous materials packages.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Identifies which reference type (from the package's customer references) is to be used as the source for the reference on this OP-900.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
- Data field to be used when a name is to be printed in the document instead of (or in addition to) a signature image.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data for a package's rates, as calculated per a specific rate type.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
-
- The dimensional weight of this package (if greater than actual).
-
-
-
-
- The oversize weight of this package (if the package is oversize).
-
-
-
-
- The transportation charge only (prior to any discounts applied) for this package.
-
-
-
-
- The sum of all discounts on this package.
-
-
-
-
- This package's baseCharge - totalFreightDiscounts.
-
-
-
-
- The sum of all surcharges on this package.
-
-
-
-
- This package's netFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- The sum of all taxes on this package.
-
-
-
-
- This package's netFreight + totalSurcharges + totalTaxes.
-
-
-
-
-
- All rate discounts that apply to this package.
-
-
-
-
- All rebates that apply to this package.
-
-
-
-
- All surcharges that apply to this package (either because of characteristics of the package itself, or because it is carrying per-shipment surcharges for the shipment of which it is a part).
-
-
-
-
- All taxes applicable (or distributed to) this package.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These special services are available at the package level for some or all service types. If the shipper is requesting a special service which requires additional data, the package special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
-
-
-
-
- The types of all special services requested for the enclosing shipment or package.
-
-
-
-
- For use with FedEx Ground services only; COD must be present in shipment's special services.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This information describes the kind of pending shipment being requested.
-
-
-
-
-
- Date after which the pending shipment will no longer be available for completion.
-
-
-
-
- Only used with type of EMAIL.
-
-
-
-
-
- These are documents that are recommended to be included with the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This class describes the pickup characteristics of a shipment (e.g. for use in a tag request).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates the packaging type of the container used to package radioactive hazardous materials.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates whether packaging type "EXCEPTED" or "EXCEPTED_PACKAGE" is for radioactive material in reportable quantity.
-
-
-
-
-
-
-
-
- Indicates the reason that a dim divisor value was chose.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Selects the value from a set of rate data to which the percentage is applied.
-
-
-
-
-
-
-
-
-
-
- The response to a RateRequest. The Notifications indicate whether the request was successful or not.
-
-
-
-
- This indicates the highest level of severity of all the notifications returned in this reply.
-
-
-
-
- The descriptive data regarding the results of the submitted transaction.
-
-
-
-
- Contains the CustomerTransactionId that was sent in the request.
-
-
-
-
- The version of this reply.
-
-
-
-
- Each element contains all rate data for a single service. If service was specified in the request, there will be a single entry in this array; if service was omitted in the request, there will be a separate entry in this array for each service being compared.
-
-
-
-
-
-
-
-
-
-
- Shows the specific combination of service options combined with the service type that produced this committment in the set returned to the caller.
-
-
-
-
- Supporting detail for applied options identified in preceding field.
-
-
-
-
-
-
-
-
-
-
- Not populated by FAST service in Jan07.
-
-
-
-
- Not populated by FAST service in Jan07.
-
-
-
-
- Not populated by FAST service in Jan07.
-
-
-
-
- Maximum expected transit time
-
-
-
-
- Not populated by FAST service in Jan07. Actual signature option applied, to allow for cases in wihch the original value conflicted with other service features in the shipment.
-
-
-
-
-
- Each element contains all rate data for a single rate type.
-
-
-
-
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
-
-
-
- Allows the caller to specify that the transit time and commit data are to be returned in the reply.
-
-
-
-
- Candidate carriers for rate-shopping use case. This field is only considered if requestedShipment/serviceType is omitted.
-
-
-
-
- Contains zero or more service options whose combinations are to be considered when replying with available services.
-
-
-
-
- If provided, identifies the consolidation to which this open shipment should be added after successful creation.
-
-
-
-
- The shipment for which a rate quote (or rate-shopping comparison) is desired.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
-
-
- Echoed from the corresponding package in the rate request (if provided).
-
-
-
-
- Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.
-
-
-
-
- The difference between "list" and "account" net charge.
-
-
-
-
- Ground COD is shipment level.
-
-
-
-
-
- Rate data that are tied to a specific package and rate type combination.
-
-
-
-
-
-
- This class groups the shipment and package rating data for a specific rate type for use in a rating reply, which groups result data by rate type.
-
-
-
-
- The difference between "list" and "account" total net charge.
-
-
-
-
- Express COD is shipment level.
-
-
-
-
- The shipment-level totals for this rate type.
-
-
-
-
- The package-level data for this rate type.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
-
-
-
-
- Specifies the kind of identification being used.
-
-
-
-
- Contains the actual ID value, of the type specified above.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
-
-
-
-
-
-
-
- Type of documents that are recommended to be included with the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies details needed to generate any label artifacts required due to regulatory requirements.
-
-
-
-
-
- Specifies how the customer requested the regulatory label to be generated.
-
-
-
-
-
-
-
-
-
-
-
- Describes the vertical position of an item relative to another item.
-
-
-
-
-
-
-
-
- This class rationalizes RequestedPackage and RequestedPackageSummary from previous interfaces.
-
-
-
-
- Used only with INDIVIDUAL_PACKAGE, as a unique identifier of each requested package.
-
-
-
-
- Used only with PACKAGE_GROUPS, as a unique identifier of each group of identical packages.
-
-
-
-
- Used only with PACKAGE_GROUPS, as a count of packages within a group of identical packages.
-
-
-
-
-
- Specifies the declared value for carriage of the package. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the package. This field is only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for PACKAGE_SUMMARY, in which case totalInsuredValue and packageCount on the shipment will be used to determine this value.
-
-
-
-
- Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for PACKAGE_SUMMARY, in which case total weight and packageCount on the shipment will be used to determine this value.
-
-
-
-
-
- Provides additional detail on how the customer has physically packaged this item. As of June 2009, required for packages moving under international and SmartPost services.
-
-
-
-
- Human-readable text describing the package.
-
-
-
-
- Human-readable text describing the contents of the package to be used for clearance purposes.
-
-
-
-
-
-
- Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS.
-
-
-
-
-
-
-
-
-
-
-
-
- The shipment variations for the current shipment expressed in key-value pairs.
-
-
-
-
-
- Specifies the total declared value for carriage of the shipment. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the shipment.
-
-
-
-
- This attribute indicates the currency the caller requests to have used in all returned monetary values (when a choice is possible).
-
-
-
-
-
-
-
- Physical starting address for the shipment, if different from shipper's address.
-
-
-
-
-
-
-
-
- Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
-
-
-
-
- Used with Ground Home Delivery and Freight.
-
-
-
-
-
- Customs clearance data, used for both international and intra-country shipping.
-
-
-
-
- For use in "process tag" transaction.
-
-
-
-
- Specifies the characteristics of a shipment pertaining to SmartPost services.
-
-
-
-
- If true, only the shipper/payor will have visibility of this shipment.
-
-
-
-
-
- Contains data used to create additional (non-label) shipping documents.
-
-
-
-
- Specifies whether and what kind of rates the customer wishes to have quoted on this shipment. The reply will also be constrained by other data on the shipment and customer.
-
-
-
-
- Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.
-
-
-
-
- The total number of packages in the entire shipment (even when the shipment spans multiple transactions.)
-
-
-
-
- Specifies which package-level data values are provided at the shipment-level only. The package-level data values types specified here will not be provided at the package-level.
-
-
-
-
- Specifies data structures that may be re-used multiple times with s single shipment.
-
-
-
-
- One or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics all packages in the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking number of the master associated with the return shipment.
-
-
-
-
-
-
-
- These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
-
-
-
-
-
-
-
-
-
-
-
- Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
-
-
-
-
-
-
- The instructions indicating how to print the return instructions( e.g. image type) Specifies characteristics of a shipping document to be produced.
-
-
-
-
-
- Specifies additional customer provided text to be inserted into the return document.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The "PAYOR..." rates are expressed in the currency identified in the payor's rate table(s). The "RATED..." rates are expressed in the currency of the origin country. Former "...COUNTER..." values have become "...RETAIL..." values, except for PAYOR_COUNTER and RATED_COUNTER, which have been removed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
-
-
-
-
-
-
-
- Describes the rotation of an item from its default orientation.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These values control the optional features of service that may be combined in a commitment/rate comparision transaction.
-
-
-
-
-
-
-
-
-
-
-
- Supporting detail for applied options identified in a rate quote.
-
-
-
-
- Identifies the type of Freight Guarantee applied, if FREIGHT_GUARANTEE is applied to the rate quote.
-
-
-
-
- Identifies the smartPostHubId used during rate quote, if SMART_POST_HUB_ID is a variable option on the rate request.
-
-
-
-
- Identifies the indicia used during rate quote, if SMART_POST_ALLOWED_INDICIA is a variable option on the rate request.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies data structures that may be re-used multiple times with s single shipment.
-
-
-
-
- Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities.
-
-
-
-
-
-
- Shipment-level totals of dry ice data across all packages.
-
-
-
-
- Total number of packages in the shipment that contain dry ice.
-
-
-
-
- Total shipment dry ice weight for all packages.
-
-
-
-
-
-
- Data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
-
-
-
-
- Human-readable text describing the shipment leg.
-
-
-
-
- Origin for this leg.
-
-
-
-
- Specifies the location id the origin of shipment leg.
-
-
-
-
- Destination for this leg.
-
-
-
-
- Specifies the location id the destination of shipment leg.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates the rate scale used.
-
-
-
-
- Indicates the rate zone used (based on origin and destination).
-
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- Specifies the currency exchange performed on financial amounts for this rate.
-
-
-
-
- Indicates which special rating cases applied to this shipment.
-
-
-
-
-
- Identifies the type of dim divisor that was applied.
-
-
-
-
-
-
- Sum of dimensional weights for all packages.
-
-
-
-
-
-
-
-
- This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- Total of the transportation-based taxes.
-
-
-
-
-
-
- Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
-
-
-
-
- This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
-
-
-
-
- Rate data specific to FedEx Freight and FedEx National Freight services.
-
-
-
-
- All rate discounts that apply to this shipment.
-
-
-
-
- All rebates that apply to this shipment.
-
-
-
-
- All surcharges that apply to this shipment.
-
-
-
-
- All transportation-based taxes applicable to this shipment.
-
-
-
-
- All commodity-based duties and taxes applicable to this shipment.
-
-
-
-
- The "order level" variable handling charges.
-
-
-
-
- The total of all variable handling charges at both shipment (order) and package level.
-
-
-
-
-
-
- These values identify which package-level data values will be provided at the shipment-level.
-
-
-
-
-
-
-
-
-
- Data for a shipment's total/summary rates, as calculated per a specific rate type. The "total..." fields may differ from the sum of corresponding package data for Multiweight or Express MPS.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates the rate scale used.
-
-
-
-
- Indicates the rate zone used (based on origin and destination).
-
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- Specifies the currency exchange performed on financial amounts for this rate.
-
-
-
-
- Indicates which special rating cases applied to this shipment.
-
-
-
-
-
- Identifies the type of dim divisor that was applied.
-
-
-
-
-
-
- Sum of dimensional weights for all packages.
-
-
-
-
-
-
-
-
- This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- Total of the transportation-based taxes.
-
-
-
-
-
-
- Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
-
-
-
-
- This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
-
-
-
-
- Identifies the Rate Details per each leg in a Freight Shipment
-
-
-
-
- Rate data specific to FedEx Freight and FedEx National Freight services.
-
-
-
-
- All rate discounts that apply to this shipment.
-
-
-
-
- All rebates that apply to this shipment.
-
-
-
-
- All surcharges that apply to this shipment.
-
-
-
-
- All transportation-based taxes applicable to this shipment.
-
-
-
-
- All commodity-based duties and taxes applicable to this shipment.
-
-
-
-
- The "order level" variable handling charges.
-
-
-
-
- The total of all variable handling charges at both shipment (order) and package level.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
-
-
-
-
- The types of all special services requested for the enclosing shipment (or other shipment-level transaction).
-
-
-
-
-
-
-
-
-
- This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
-
-
-
-
-
-
-
-
-
-
- Electronic Trade document references.
-
-
-
-
- Specification for date or range of dates on which delivery is to be attempted.
-
-
-
-
-
-
-
-
- Specifies the name or the key for the shipment variation.
-
-
-
-
- The values that are valid for the specified shipment variation in the context of the current shipment.
-
-
-
-
-
-
- Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
-
-
-
-
- Values in this field specify how to create and return the document.
-
-
-
-
- Specifies how to organize all documents of this type.
-
-
-
-
- Specifies how to e-mail document images.
-
-
-
-
- Specifies how a queued document is to be printed.
-
-
-
-
-
-
- Specifies how to return a shipping document to the caller.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how to e-mail shipping documents.
-
-
-
-
- Provides the roles and email addresses for e-mail recipients.
-
-
-
-
- Identifies the convention by which documents are to be grouped as e-mail attachments.
-
-
-
-
- Specifies the language in which the email containing the document is requested to be composed.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies an individual recipient of e-mailed shipping document(s).
-
-
-
-
- Identifies the relationship of this recipient in the shipment.
-
-
-
-
- Address to which the document is to be sent.
-
-
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies how to create, organize, and return the document.
-
-
-
-
- Specifies how far down the page to move the beginning of the image; allows for printing on letterhead and other pre-printed stock.
-
-
-
-
-
-
- For those shipping document types which have both a "form" and "instructions" component (e.g. NAFTA Certificate of Origin and General Agency Agreement), this field indicates whether to provide the instructions.
-
-
-
-
-
- Governs the language to be used for this individual document, independently from other content returned for the same shipment.
-
-
-
-
-
-
- Specifies how to organize all shipping documents of the same type.
-
-
-
-
-
-
-
-
- Specifies the image format used for a shipping document.
-
-
-
-
-
-
-
-
-
-
-
- Specifies printing options for a shipping document.
-
-
-
-
- Provides environment-specific printer identification.
-
-
-
-
-
-
- Contains all data required for additional (non-label) shipping documents to be produced in conjunction with a specific shipment.
-
-
-
-
- Indicates the types of shipping documents requested by the shipper.
-
-
-
-
-
-
- Specifies the production of each package-level custom document (the same specification is used for all packages).
-
-
-
-
- Specifies the production of a shipment-level custom document.
-
-
-
-
-
-
-
- Specifies the production of the OP-900 document for hazardous materials packages.
-
-
-
-
- Specifies the production of the 1421c document for dangerous goods shipment.
-
-
-
-
- Specifies the production of the OP-900 document for hazardous materials.
-
-
-
-
- Specifies the production of the return instructions document.
-
-
-
-
-
-
- Specifies the type of paper (stock) on which a document will be printed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These values are mutually exclusive; at most one of them can be attached to a SmartPost shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required for shipments handled under the SMART_POST and GROUND_SMART_POST service types.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifice the kind of tax or miscellaneous charge being reported on a Commercial Invoice.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the usage of Tax Identification Number in Shipment processing
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Free form text to be echoed back in the reply. Used to match requests and replies.
-
-
-
-
- Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the application that is responsible for managing the document id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Description of the uploaded document.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This definition of variable handling charge detail is intended for use in Jan 2011 corp load.
-
-
-
-
-
- Actual percentage (10 means 10%, which is a mutiplier of 0.1)
-
-
-
-
- Select the value from a set of rate data to which the percentage is applied.
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Three-dimensional volume/cubic measurement.
-
-
-
-
-
-
-
-
- Units of three-dimensional volume/cubic measure.
-
-
-
-
-
-
-
-
- The descriptive data for the heaviness of an object.
-
-
-
-
- Identifies the unit of measure associated with a weight value.
-
-
-
-
- Identifies the weight value of a package/shipment.
-
-
-
-
-
-
-
-
-
-
-
-
- Used in authentication of the sender's identity.
-
-
-
-
- This was renamed from cspCredential.
-
-
-
-
- Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
-
-
-
-
-
-
- Two part authentication string used for the sender's identity
-
-
-
-
- Identifying part of authentication credential. This value is provided by FedEx after registration
-
-
-
-
- Secret part of authentication key. This value is provided by FedEx after registration.
-
-
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Identifies a system or sub-system which performs an operation.
-
-
-
-
- Identifies the service business level.
-
-
-
-
- Identifies the service interface level.
-
-
-
-
- Identifies the service code level.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+ Specifies additional labels to be produced. All required labels for shipments will be produced without the need to request additional labels. These are only available as thermal labels.
+
+
+
+
+ The type of additional labels to return.
+
+
+
+
+ The number of this type label to return
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Specifies details for a package containing alcohol
+
+
+
+
+ The license type that the recipient of the alcohol package.
+
+
+
+
+
+
+ Specifies the type of license that the recipient of the alcohol shipment has.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A freight line item identifier referring to a freight shipment line item that describes goods contained within this handling unit.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identification of the type of barcode (symbology) used on FedEx documents and labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes attributes of a battery or cell that are used for classification purposes. Typically this structure would be used to allow customers to declare batteries or cells for which full dangerous goods documentation and procedures are not required.
+
+
+
+
+ Describes the material composition of the battery or cell.
+
+
+
+
+ Describes the packing arrangement of the battery or cell with respect to other items within the same package.
+
+
+
+
+ A regulation specific classification for the battery or cell.
+
+
+
+
+
+
+ Describes the material composition of a battery or cell.
+
+
+
+
+
+
+
+
+ Describes the packing arrangement of a battery or cell with respect to other items within the same package.
+
+
+
+
+
+
+
+
+ A regulation specific classification for a battery or cell.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This represents the internal FedEx-system recognized country code.
+
+
+
+
+ This represents the internal FedEx-system recognized state or province code.
+
+
+
+
+ This represents the internal FedEx-system recognized postal code.
+
+
+
+
+
+ The unique location identifier
+
+
+
+
+ The op-co specific numeric identifier for a location
+
+
+
+
+
+
+
+ Specifies the type of brokerage to be applied to a shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+ Identifies the type of funds FedEx should collect upon shipment delivery.
+
+
+
+
+
+
+
+
+
+ Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
+
+
+
+
+
+ Specifies the details of the charges are to be added to the COD collect amount.
+
+
+
+
+ Identifies the type of funds FedEx should collect upon package delivery
+
+
+
+
+ For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
+
+
+
+
+ When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
+
+
+
+
+ Specifies the name of person or company receiving the secured/unsecured funds payment
+
+
+
+
+ Indicates which type of reference information to include on the COD return shipping label.
+
+
+
+
+ Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through the FedEx Systems. Customers are responsible for printing their own Commercial Invoice.If you would likeFedEx to generate a Commercial Invoice and transmit it to Customs. for clearance purposes, you need to specify that in the ShippingDocumentSpecification element. If you would like a copy of the Commercial Invoice that FedEx generated returned to you in reply it needs to be specified in the ETDDetail/RequestedDocumentCopies element. Commercial Invoice support consists of maximum of 99 commodity line items.
+
+
+
+
+ Any comments that need to be communicated about this shipment.
+
+
+
+
+ Any freight charges that are associated with this shipment.
+
+
+
+
+ Any taxes or miscellaneous charges(other than Freight charges or Insurance charges) that are associated with this shipment.
+
+
+
+
+ Specifies which kind of charge is being recorded in the preceding field.
+
+
+
+
+ Any packing costs that are associated with this shipment.
+
+
+
+
+ Any handling costs that are associated with this shipment.
+
+
+
+
+ Free-form text.
+
+
+
+
+ Free-form text.
+
+
+
+
+ Free-form text.
+
+
+
+
+ The reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.
+
+
+
+
+ Name of the International Expert that completed the Commercial Invoice different from Sender.
+
+
+
+
+ Required for dutiable international Express or Ground shipments. This field is not applicable to an international PIB(document) or a non-document which does not require a Commercial Invoice.
+
+
+
+
+
+
+ The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
+
+
+
+
+
+ Specifies the usage and identification of a customer supplied image to be used on this document.
+
+
+
+
+
+
+ Information about the transit time and delivery commitment date and time.
+
+
+
+
+ The Commodity applicable to this commitment.
+
+
+
+
+
+ Descriptions and alternate identifiers for a service.
+
+
+
+
+ Shows the specific combination of service options combined with the service type that produced this committment in the set returned to the caller.
+
+
+
+
+ Supporting detail for applied options identified in preceding field.
+
+
+
+
+
+
+
+
+ THe delivery commitment date/time. Express Only.
+
+
+
+
+ The delivery commitment day of the week.
+
+
+
+
+ The number of transit days; applies to Ground and LTL Freight; indicates minimum transit time for SmartPost.
+
+
+
+
+ Maximum number of transit days, for SmartPost shipments.
+
+
+
+
+ The service area code for the destination of this shipment. Express only.
+
+
+
+
+ The address of the broker to be used for this shipment.
+
+
+
+
+ The FedEx location identifier for the broker.
+
+
+
+
+ The delivery commitment date/time the shipment will arrive at the border.
+
+
+
+
+ The delivery commitment day of the week the shipment will arrive at the border.
+
+
+
+
+ The number of days it will take for the shipment to make it from broker to destination
+
+
+
+
+ The delivery commitment date for shipment served by GSP (Global Service Provider)
+
+
+
+
+ The delivery commitment day of the week for the shipment served by GSP (Global Service Provider)
+
+
+
+
+ Messages concerning the ability to provide an accurate delivery commitment on an International commit quote. These could be messages providing information about why a commitment could not be returned or a successful message such as "REQUEST COMPLETED"
+
+
+
+
+ Messages concerning the delivery commitment on an International commit quote such as "0:00 A.M. IF NO CUSTOMS DELAY"
+
+
+
+
+ Information about why a shipment delivery is delayed and at what level (country/service etc.).
+
+
+
+
+
+ Required documentation for this shipment.
+
+
+
+
+ Freight origin and destination city center information and total distance between origin and destination city centers.
+
+
+
+
+
+
+ The type of delay this shipment will encounter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ FedEx internal commodity identifier
+
+
+
+
+
+ A free-form description of the commodity, which could be used for customs clearance documentation.
+
+
+
+
+
+
+
+
+
+
+ Contains only additional quantitative information other than weight and quantity to calculate duties and taxes.
+
+
+
+
+
+ The value of the commodity for customs purposes. The field should be the unit price multiplied by the quantity.
+
+
+
+
+ Defines additional characteristic of commodity used to calculate duties and taxes
+
+
+
+
+
+
+
+
+ All data required for this commodity in NAFTA Certificate of Origin.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Uniquely identifies a consolidation, which is a logical container for a collection of shipments.
+
+
+
+
+ Specifies the type of consolidation.
+
+
+
+
+ Uniquely identifies the consolidation, within a given type and date.
+
+
+
+
+ The date on which the consolidation was created.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data for a point-of-contact person.
+
+
+
+
+ Client provided identifier corresponding to this contact information.
+
+
+
+
+ Identifies the contact person's name.
+
+
+
+
+ Identifies the contact person's title.
+
+
+
+
+ Identifies the company this contact is associated with.
+
+
+
+
+ Identifies the phone number associated with this contact.
+
+
+
+
+ Identifies the phone extension associated with this contact.
+
+
+
+
+ Identifies a toll free number, if any, associated with this contact.
+
+
+
+
+ Identifies the pager number associated with this contact.
+
+
+
+
+ Identifies the fax number associated with this contact.
+
+
+
+
+ Identifies the email address associated with this contact.
+
+
+
+
+
+
+
+
+
+
+
+
+ Details the contents of the package.
+
+
+
+
+
+
+
+
+
+
+
+
+ The currency code for the original (converted FROM) currency.
+
+
+
+
+ The currency code for the final (converted INTO) currency.
+
+
+
+
+ Multiplier used to convert fromCurrency units to intoCurrency units.
+
+
+
+
+
+
+
+
+ Indicates the type of custom delivery being requested.
+
+
+
+
+ Time by which delivery is requested.
+
+
+
+
+ Range of dates for custom delivery request; only used if type is BETWEEN.
+
+
+
+
+ Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce a custom-specified document, either at shipment or package level.
+
+
+
+
+ Common information controlling document production.
+
+
+
+
+ Applicable only to documents produced on thermal printers with roll stock.
+
+
+
+
+ Applicable only to documents produced on thermal printers with roll stock.
+
+
+
+
+ Identifies the formatting specification used to construct this custom document.
+
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified barcode symbology.
+
+
+
+
+
+
+
+
+ Width of thinnest bar/space element in the barcode.
+
+
+
+
+
+
+
+ Solid (filled) rectangular area on label.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Image to be included from printer's memory, or from a local file for offline clients.
+
+
+
+
+
+ Printer-specific index of graphic image to be printed.
+
+
+
+
+ Fully-qualified path and file name for graphic image to be printed.
+
+
+
+
+
+
+
+
+ Horizontal position, relative to left edge of custom area.
+
+
+
+
+ Vertical position, relative to top edge of custom area.
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
+
+
+
+
+
+
+
+
+
+ Printer-specific font name for use with thermal printer labels.
+
+
+
+
+ Generic font name for use with plain paper labels.
+
+
+
+
+ Generic font size for use with plain paper labels.
+
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
+
+
+
+
+
+
+
+ Printer-specific font name for use with thermal printer labels.
+
+
+
+
+ Generic font name for use with plain paper labels.
+
+
+
+
+ Generic font size for use with plain paper labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows customer-specified control of label content.
+
+
+
+
+ If omitted, no doc tab will be produced (i.e. default is former NONE type).
+
+
+
+
+ Controls the position of the customer specified content relative to the FedEx portion.
+
+
+
+
+
+
+ Controls which data/sections will be suppressed.
+
+
+
+
+ For customers producing their own Ground labels, this field specifies which secondary barcode will be printed on the label; so that the primary barcode produced by FedEx has the correct SCNC.
+
+
+
+
+
+
+ Controls the number of additional copies of supplemental labels.
+
+
+
+
+ This value reduces the default quantity of destination/consignee air waybill labels. A value of zero indicates no change to default. A minimum of one copy will always be produced.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interacts both with properties of the shipment and contractual relationship with the shipper.
+
+
+
+
+
+
+ Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
+
+
+
+
+
+
+ This represents the total commodity value of the shipment plus the charges required by the destination country.
+
+
+
+
+ Identifies responsibilities with respect to loss, damage, etc.
+
+
+
+
+ Documents amount paid to third party for coverage of shipment content.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies additional description about customs options. This is a required field when the customs options type is "OTHER".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes an approved container used to package dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container.
+
+
+
+
+ Indicates whether there are additional inner receptacles within this container.
+
+
+
+
+ Indicates the type of this dangerous goods container, as specified by the IATA packing instructions. For example, steel cylinder, fiberboard box, plastic jerrican and steel drum.
+
+
+
+
+ Indicates the packaging type of the container used to package the radioactive materials.
+
+
+
+
+ Indicates the number of occurrences of this container with identical dangerous goods configuration.
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current container.
+
+
+
+
+
+
+
+
+
+
+ Shipment is packaged/documented for movement ONLY on cargo aircraft.
+
+
+
+
+ Indicates which kinds of hazardous content are in the current package.
+
+
+
+
+ Indicates whether there is additional customer provided packaging enclosing the approved dangerous goods containers.
+
+
+
+
+ Identifies the configuration of this dangerous goods package. The common configuration is represented at the shipment level.
+
+
+
+
+ Indicates one or more containers used to pack dangerous goods commodities.
+
+
+
+
+ Description of the packaging of this commodity, suitable for use on OP-900 and OP-950 forms.
+
+
+
+
+ Name, title and place of the signatory for this shipment.
+
+
+
+
+ Telephone number to use for contact in the event of an emergency.
+
+
+
+
+ Offeror's name or contract number, per DOT regulation.
+
+
+
+
+ Specifies the contact of the party responsible for handling the infectious substances, if any, in the dangerous goods shipment.
+
+
+
+
+ Specifies additional handling information for the current package.
+
+
+
+
+ Specifies the radioactivity detail for the current package, if the package contains radioactive materials.
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the 1421c form for dangerous goods shipment.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+ Specifies that name, title and place of the signatory responsible for the dangerous goods shipment.
+
+
+
+
+
+
+ Indicates the place where the form is signed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Information about why a shipment delivery is delayed and at what level( country/service etc.).
+
+
+
+
+ The date of the delay
+
+
+
+
+
+ The attribute of the shipment that caused the delay(e.g. Country, City, LocationId, Zip, service area, special handling )
+
+
+
+
+ The point where the delay is occurring (e.g. Origin, Destination, Broker location)
+
+
+
+
+ The reason for the delay (e.g. holiday, weekend, etc.).
+
+
+
+
+ The name of the holiday in that country that is causing the delay.
+
+
+
+
+
+
+ The attribute of the shipment that caused the delay(e.g. Country, City, LocationId, Zip, service area, special handling )
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The point where the delay is occurring ( e.g. Origin, Destination, Broker location).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking id for the return, if preassigned.
+
+
+
+
+
+
+ Data required to complete the Destionation Control Statement for US exports.
+
+
+
+
+
+ Comma-separated list of up to four country codes, required for DEPARTMENT_OF_STATE statement.
+
+
+
+
+ Name of end user, required for DEPARTMENT_OF_STATE statement.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Driving or other transportation distances, distinct from dimension measurements.
+
+
+
+
+ Identifies the distance quantity.
+
+
+
+
+ Identifies the unit of measure for the distance value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the name associated with the email address.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Customer-declared value, with data type and legal values depending on excise condition, used in defining the taxable value of the item.
+
+
+
+
+
+
+ Specifies the types of Estimated Duties and Taxes to be included in a rate quotation for an international shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Electronic Trade document references used with the ETD special service.
+
+
+
+
+
+ Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
+
+
+
+
+
+
+
+ The instructions indicating how to print the Export Declaration.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+
+
+
+ General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies a kind of FedEx facility.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the optional features/characteristics requested for a Freight shipment utilizing a flatbed trailer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce the Freight handling-unit-level address labels. Note that the number of UNIQUE labels (the N as in 1 of N, 2 of N, etc.) is determined by total handling units.
+
+
+
+
+
+ Indicates the number of copies to be produced for each unique label.
+
+
+
+
+ Specifies the quadrant of the page on which the label printing will start.
+
+
+
+
+ If omitted, no doc tab will be produced (i.e. default = former NONE type).
+
+
+
+
+ Controls the position of the customer specified content relative to the FedEx portion.
+
+
+
+
+
+
+
+ Individual charge which contributes to the total base charge for the shipment.
+
+
+
+
+ Freight class for this line item.
+
+
+
+
+ Effective freight class used for rating this line item.
+
+
+
+
+ NMFC Code for commodity.
+
+
+
+
+ Customer-provided description for this commodity or class line.
+
+
+
+
+ Weight for this commodity or class line.
+
+
+
+
+ Rate or factor applied to this line item.
+
+
+
+
+ Identifies the manner in which the chargeRate for this line item was applied.
+
+
+
+
+ The net or extended charge for this line item.
+
+
+
+
+
+
+ Specifies the way in which base charges for a Freight shipment or shipment leg are calculated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values represent the industry-standard freight classes used for FedEx Freight and FedEx National Freight shipment description. (Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Information about the Freight Service Centers associated with this shipment.
+
+
+
+
+ Information about the origin Freight Service Center.
+
+
+
+
+ Information about the destination Freight Service Center.
+
+
+
+
+ The distance between the origin and destination FreightService Centers
+
+
+
+
+
+
+
+
+
+ Date for all Freight guarantee types.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies responsibilities with respect to loss, damage, etc.
+
+
+
+
+
+
+
+
+ Rate data specific to FedEx Freight or FedEx National Freight services.
+
+
+
+
+ A unique identifier for a specific rate quotation.
+
+
+
+
+ Specifies whether the rate quote was automated or manual.
+
+
+
+
+ Specifies how total base charge is determined.
+
+
+
+
+ Freight charges which accumulate to the total base charge for the shipment.
+
+
+
+
+ Human-readable descriptions of additional information on this shipment rating.
+
+
+
+
+
+
+ Additional non-monetary data returned with Freight rates.
+
+
+
+
+ Unique identifier for notation.
+
+
+
+
+ Human-readable explanation of notation.
+
+
+
+
+
+
+ Specifies the type of rate quote
+
+
+
+
+
+
+
+
+ This class describes the relationship between a customer-specified address and the FedEx Freight / FedEx National Freight Service Center that supports that address.
+
+
+
+
+ Freight Industry standard non-FedEx carrier identification
+
+
+
+
+ The name of the Interline carrier.
+
+
+
+
+ Additional time it might take at the origin or destination to pickup or deliver the freight. This is usually due to the remoteness of the location. This time is included in the total transit time.
+
+
+
+
+
+ Distance between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
+
+
+
+
+ Time to travel between customer address (pickup or delivery) and the supporting Freight / National Freight service center.
+
+
+
+
+ Specifies when/how the customer can arrange for pickup or delivery.
+
+
+
+
+ Specifies days of operation if localServiceScheduling is LIMITED.
+
+
+
+
+ Freight service center that is a gateway on the border of Canada or Mexico.
+
+
+
+
+ Alphabetical code identifying a Freight Service Center
+
+
+
+
+ Freight service center Contact and Address
+
+
+
+
+
+
+ Specifies the type of service scheduling offered from a Freight or National Freight Service Center to a customer-supplied address.
+
+
+
+
+
+
+
+
+
+ Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
+
+
+
+
+ Account number used with FEDEX_FREIGHT service.
+
+
+
+
+ Used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
+
+
+
+
+ Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+ Designates the terms of the "collect" payment for a Freight Shipment.
+
+
+
+
+ Identifies the declared value for the shipment
+
+
+
+
+ Identifies the declared value units corresponding to the above defined declared value
+
+
+
+
+
+ Identifiers for promotional discounts offered to customers.
+
+
+
+
+ Total number of individual handling units in the entire shipment (for unit pricing).
+
+
+
+
+ Estimated discount rate provided by client for unsecured rate quote.
+
+
+
+
+ Total weight of pallets used in shipment.
+
+
+
+
+ Overall shipment dimensions.
+
+
+
+
+ Description for the shipment.
+
+
+
+
+ Specifies which party will pay surcharges for any special services which support split billing.
+
+
+
+
+
+ Details of the commodities in the shipment.
+
+
+
+
+
+
+ Description of an individual commodity or class of content in a shipment.
+
+
+
+
+ A unique identifier assigned to this line item.
+
+
+
+
+ Freight class for this line item.
+
+
+
+
+ Specification of handling-unit packaging for this commodity or class line.
+
+
+
+
+ Number of pieces for this commodity or class line.
+
+
+
+
+ Customer-provided description for this commodity or class line.
+
+
+
+
+ Weight for this commodity or class line.
+
+
+
+
+
+ Volume (cubic measure) for this commodity or class line.
+
+
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+
+
+
+
+ Specifies which party will be responsible for payment of any surcharges for Freight special services for which split billing is allowed.
+
+
+
+
+ Identifies the special service.
+
+
+
+
+ Indicates who will pay for the special service.
+
+
+
+
+
+
+ Data required to produce a General Agency Agreement document. Remaining content (business data) to be defined once requirements have been completed.
+
+
+
+
+
+
+
+ Documents the kind and quantity of an individual hazardous commodity in a package.
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Specifies the amount of the commodity in alternate units.
+
+
+
+
+ This describes the inner receptacle details for a hazardous commodity within the dangerous goods container.
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ Specifies the details of any radio active materials within the commodity.
+
+
+
+
+ The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
+
+
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Regulatory identifier for a commodity (e.g. "UN ID" value).
+
+
+
+
+ In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates any special processing options to be applied to the description of the dangerous goods commodity.
+
+
+
+
+ Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
+
+
+
+
+
+
+ Specifies any special processing to be applied to the dangerous goods commodity description validation.
+
+
+
+
+
+
+
+ This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container.
+
+
+
+
+ This specifies the quantity contained in the inner receptacle.
+
+
+
+
+
+
+ Specifies how the commodity is to be labeled.
+
+
+
+
+
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ Specifies how the customer wishes the label text to be handled for this commodity in this package.
+
+
+
+
+ Text used in labeling the commodity under control of the labelTextOption field.
+
+
+
+
+
+
+ Indicates which kind of hazardous content is being reported.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies number and type of packaging units for hazardous commodities.
+
+
+
+
+ Number of units of the type below.
+
+
+
+
+ Units in which the hazardous commodity is packaged.
+
+
+
+
+
+
+ Specifies documentation and limits for validation of an individual packing group/category.
+
+
+
+
+
+ Coded specification for how commodity is to be packed.
+
+
+
+
+
+
+ Identifies DOT packing group for a hazardous commodity.
+
+
+
+
+
+
+
+
+
+
+ Identifies amount and units for quantity of hazardous commodities.
+
+
+
+
+ Number of units of the type below.
+
+
+
+
+ Units by which the hazardous commodity is measured. For IATA commodity, the units values are restricted based on regulation type.
+
+
+
+
+ Specifies which measure of quantity is to be validated.
+
+
+
+
+
+
+ Specifies the measure of quantity to be validated against a prescribed limit.
+
+
+
+
+
+
+
+
+ Identifies the source of regulation for hazardous commodity data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contact phone number for recipient of shipment.
+
+
+
+
+ Contact and address of FedEx facility at which shipment is to be held.
+
+
+
+
+ Type of facility at which package/shipment is to be held.
+
+
+
+
+ Location identification (for facilities identified by an alphanumeric location code).
+
+
+
+
+ Location identification (for facilities identified by an numeric location code).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Names for data elements / areas which may be suppressed from printing on labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the order in which the labels will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Relative to normal orientation for the printer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the order in which the labels are requested to be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the Liability Coverage Amount. For Jan 2010 this value represents coverage amount per pound
+
+
+
+
+
+
+
+
+
+
+
+
+ Represents a one-dimensional measurement in small units (e.g. suitable for measuring a package or document), contrasted with Distance, which represents a large one-dimensional measurement (e.g. distance between cities).
+
+
+
+
+ The numerical quantity of this measurement.
+
+
+
+
+ The units for this measurement.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce a Certificate of Origin document. Remaining content (business data) to be defined once requirements have been completed.
+
+
+
+
+
+
+ Indicates which Party (if any) from the shipment is to be used as the source of importer data on the NAFTA COO form.
+
+
+
+
+ Contact information for "Authorized Signature" area of form.
+
+
+
+
+
+
+
+
+
+
+
+ Defined by NAFTA regulations.
+
+
+
+
+ Defined by NAFTA regulations.
+
+
+
+
+ Identification of which producer is associated with this commodity (if multiple producers are used in a single shipment).
+
+
+
+
+
+ Date range over which RVC net cost was calculated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ See instructions for NAFTA Certificate of Origin for code definitions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ See instructions for NAFTA Certificate of Origin for code definitions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Indicates the type of notification that will be sent.
+
+
+
+
+ Specifies the email notification details.
+
+
+
+
+ Specifies the localization for this notification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the OP-900 form for hazardous materials packages.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Identifies which reference type (from the package's customer references) is to be used as the source for the reference on this OP-900.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+ Data field to be used when a name is to be printed in the document instead of (or in addition to) a signature image.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data for a package's rates, as calculated per a specific rate type.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+
+ The dimensional weight of this package (if greater than actual).
+
+
+
+
+ The oversize weight of this package (if the package is oversize).
+
+
+
+
+ The transportation charge only (prior to any discounts applied) for this package.
+
+
+
+
+ The sum of all discounts on this package.
+
+
+
+
+ This package's baseCharge - totalFreightDiscounts.
+
+
+
+
+ The sum of all surcharges on this package.
+
+
+
+
+ This package's netFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ The sum of all taxes on this package.
+
+
+
+
+ This package's netFreight + totalSurcharges + totalTaxes.
+
+
+
+
+
+ All rate discounts that apply to this package.
+
+
+
+
+ All rebates that apply to this package.
+
+
+
+
+ All surcharges that apply to this package (either because of characteristics of the package itself, or because it is carrying per-shipment surcharges for the shipment of which it is a part).
+
+
+
+
+ All taxes applicable (or distributed to) this package.
+
+
+
+
+
+
+
+ These special services are available at the package level for some or all service types. If the shipper is requesting a special service which requires additional data, the package special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ Indicates the package special service types that are requested on this shipment. For a list of the valid package special service types, please consult your integration documentation or get the list of the available special services from the getAllSpecialServices method of the Validation Availability and Commitment service.
+
+
+
+
+ For use with FedEx Ground services only; COD must be present in shipment's special services.
+
+
+
+
+
+ Provides details about the batteries or cells that are contained within this specific package.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This information describes the kind of pending shipment being requested.
+
+
+
+
+
+ Date after which the pending shipment will no longer be available for completion.
+
+
+
+
+
+ These are documents that are recommended to be included with the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This class describes the pickup characteristics of a shipment (e.g. for use in a tag request).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The type of name (long, medium, short, etc.) to which this value refers.
+
+
+
+
+ The character encoding used to represent this product name. For example, UTF-8.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates the packaging type of the container used to package radioactive hazardous materials.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether packaging type "EXCEPTED" or "EXCEPTED_PACKAGE" is for radioactive material in reportable quantity.
+
+
+
+
+
+
+
+
+ Indicates the reason that a dim divisor value was chose.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Selects the value from a set of rate data to which the percentage is applied.
+
+
+
+
+
+
+
+
+
+
+ The response to a RateRequest. The Notifications indicate whether the request was successful or not.
+
+
+
+
+ This indicates the highest level of severity of all the notifications returned in this reply.
+
+
+
+
+ The descriptive data regarding the results of the submitted transaction.
+
+
+
+
+ Contains the CustomerTransactionId that was sent in the request.
+
+
+
+
+ The version of this reply.
+
+
+
+
+ Each element contains all rate data for a single service. If service was specified in the request, there will be a single entry in this array; if service was omitted in the request, there will be a separate entry in this array for each service being compared.
+
+
+
+
+
+
+
+
+
+ Descriptions and alternate identifiers for a service.
+
+
+
+
+
+ Shows the specific combination of service options combined with the service type that produced this committment in the set returned to the caller.
+
+
+
+
+ Supporting detail for applied options identified in preceding field.
+
+
+
+
+
+
+
+
+
+
+ Not populated by FAST service in Jan07.
+
+
+
+
+ Not populated by FAST service in Jan07.
+
+
+
+
+ Not populated by FAST service in Jan07.
+
+
+
+
+ Maximum expected transit time
+
+
+
+
+ Not populated by FAST service in Jan07. Actual signature option applied, to allow for cases in wihch the original value conflicted with other service features in the shipment.
+
+
+
+
+
+ Each element contains all rate data for a single rate type.
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+ Allows the caller to specify that the transit time and commit data are to be returned in the reply.
+
+
+
+
+ Candidate carriers for rate-shopping use case. This field is only considered if requestedShipment/serviceType is omitted.
+
+
+
+
+ Contains zero or more service options whose combinations are to be considered when replying with available services.
+
+
+
+
+ If provided, identifies the consolidation to which this open shipment should be added after successful creation.
+
+
+
+
+ The shipment for which a rate quote (or rate-shopping comparison) is desired.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+ Echoed from the corresponding package in the rate request (if provided).
+
+
+
+
+ Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.
+
+
+
+
+ The difference between "list" and "account" net charge.
+
+
+
+
+ Ground COD is shipment level.
+
+
+
+
+
+ Rate data that are tied to a specific package and rate type combination.
+
+
+
+
+
+
+ This class groups the shipment and package rating data for a specific rate type for use in a rating reply, which groups result data by rate type.
+
+
+
+
+ The difference between "list" and "account" total net charge.
+
+
+
+
+ Express COD is shipment level.
+
+
+
+
+ The shipment-level totals for this rate type.
+
+
+
+
+ The package-level data for this rate type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
+
+
+
+
+ Specifies the kind of identification being used.
+
+
+
+
+ Contains the actual ID value, of the type specified above.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
+
+
+
+
+
+
+
+ Type of documents that are recommended to be included with the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies details needed to generate any label artifacts required due to regulatory requirements.
+
+
+
+
+
+ Specifies how the customer requested the regulatory label to be generated.
+
+
+
+
+
+
+
+
+
+
+
+ Describes the vertical position of an item relative to another item.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of each requested package line item.
+
+
+
+
+ An identifier of each group of identical packages.
+
+
+
+
+ Used as the number or count of identical packages in a group.
+
+
+
+
+
+ Specifies the declared value for carriage of the package. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the package.
+
+
+
+
+ Represents the gross weight of the package line item.
+
+
+
+
+
+ Provides additional detail on how the customer has physically packaged this item. As of June 2009, required for packages moving under international and SmartPost services.
+
+
+
+
+
+ Human-readable text describing the package.
+
+
+
+
+ Human-readable text describing the contents of the package to be used for clearance purposes.
+
+
+
+
+
+
+ Details the contents of the package.
+
+
+
+
+
+
+
+
+
+
+
+ This field contains the service type values, like PRIORITY_OVERNIGHT and FEDEX_GROUND.
+
+
+
+
+ This field contains the packaging type values, like YOUR_PACKAGING and FEDEX_ENVELOPE.
+
+
+
+
+ The shipment variations for the current shipment expressed in key-value pairs.
+
+
+
+
+
+ Specifies the total declared value for carriage of the shipment. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the shipment.
+
+
+
+
+ This attribute indicates the currency the caller requests to have used in all returned monetary values (when a choice is possible).
+
+
+
+
+ Specifies details about the entity responsible for the shipment.
+
+
+
+
+
+
+
+ Physical starting address for the shipment, if different from shipper's address.
+
+
+
+
+ The sold-to party is used for customs clearance; for example, in support of US import customs rules. The need for this field could vary based on whether a sold-to party was specified on a consolidation.
+
+
+
+
+
+
+
+ Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
+
+
+
+
+ Used with Ground Home Delivery and Freight.
+
+
+
+
+
+ Customs clearance data, used for both international and intra-country shipping.
+
+
+
+
+ For use in "process tag" transaction.
+
+
+
+
+ Specifies the characteristics of a shipment pertaining to SmartPost services.
+
+
+
+
+ If true, only the shipper/payor will have visibility of this shipment.
+
+
+
+
+
+ Contains data used to create additional (non-label) shipping documents.
+
+
+
+
+ Specifies whether and what kind of rates the customer wishes to have quoted on this shipment. The reply will also be constrained by other data on the shipment and customer.
+
+
+
+
+ Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.
+
+
+
+
+ The total number of packages in the entire shipment (even when the shipment spans multiple transactions.)
+
+
+
+
+ Specifies which package-level data values are provided at the shipment-level only. The package-level data values types specified here will not be provided at the package-level.
+
+
+
+
+ Specifies data structures that may be re-used multiple times with s single shipment.
+
+
+
+
+ One or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics all packages in the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking number of the master associated with the return shipment.
+
+
+
+
+
+
+
+ These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
+
+
+
+
+
+
+ The instructions indicating how to print the return instructions( e.g. image type) Specifies characteristics of a shipping document to be produced.
+
+
+
+
+
+ Specifies additional customer provided text to be inserted into the return document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The "PAYOR..." rates are expressed in the currency identified in the payor's rate table(s). The "RATED..." rates are expressed in the currency of the origin country. Former "...COUNTER..." values have become "...RETAIL..." values, except for PAYOR_COUNTER and RATED_COUNTER, which have been removed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
+
+
+
+
+
+
+
+ Describes the rotation of an item from its default orientation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Branded, translated, and/or localized names for this service.
+
+
+
+
+
+
+
+
+ These values control the optional features of service that may be combined in a commitment/rate comparision transaction.
+
+
+
+
+
+
+
+
+
+
+
+ Supporting detail for applied options identified in a rate quote.
+
+
+
+
+ Identifies the type of Freight Guarantee applied, if FREIGHT_GUARANTEE is applied to the rate quote.
+
+
+
+
+ Identifies the smartPostHubId used during rate quote, if SMART_POST_HUB_ID is a variable option on the rate request.
+
+
+
+
+ Identifies the indicia used during rate quote, if SMART_POST_ALLOWED_INDICIA is a variable option on the rate request.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies data structures that may be re-used multiple times with s single shipment.
+
+
+
+
+ Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities.
+
+
+
+
+
+
+ Shipment-level totals of dry ice data across all packages.
+
+
+
+
+ Total number of packages in the shipment that contain dry ice.
+
+
+
+
+ Total shipment dry ice weight for all packages.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
+
+
+
+
+ Human-readable text describing the shipment leg.
+
+
+
+
+ Origin for this leg.
+
+
+
+
+ Specifies the location id the origin of shipment leg.
+
+
+
+
+ Destination for this leg.
+
+
+
+
+ Specifies the location id the destination of shipment leg.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates the rate scale used.
+
+
+
+
+ Indicates the rate zone used (based on origin and destination).
+
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+ Specifies the currency exchange performed on financial amounts for this rate.
+
+
+
+
+ Indicates which special rating cases applied to this shipment.
+
+
+
+
+
+ Identifies the type of dim divisor that was applied.
+
+
+
+
+
+
+ Sum of dimensional weights for all packages.
+
+
+
+
+
+
+
+
+ This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ Total of the transportation-based taxes.
+
+
+
+
+
+
+ Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
+
+
+
+
+ This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
+
+
+
+
+ Rate data specific to FedEx Freight and FedEx National Freight services.
+
+
+
+
+ All rate discounts that apply to this shipment.
+
+
+
+
+ All rebates that apply to this shipment.
+
+
+
+
+ All surcharges that apply to this shipment.
+
+
+
+
+ All transportation-based taxes applicable to this shipment.
+
+
+
+
+ All commodity-based duties and taxes applicable to this shipment.
+
+
+
+
+ The "order level" variable handling charges.
+
+
+
+
+ The total of all variable handling charges at both shipment (order) and package level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values identify which package-level data values will be provided at the shipment-level.
+
+
+
+
+
+
+
+
+
+ Data for a shipment's total/summary rates, as calculated per a specific rate type. The "total..." fields may differ from the sum of corresponding package data for Multiweight or Express MPS.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates the rate scale used.
+
+
+
+
+ Indicates the rate zone used (based on origin and destination).
+
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+ Specifies the currency exchange performed on financial amounts for this rate.
+
+
+
+
+ Indicates which special rating cases applied to this shipment.
+
+
+
+
+
+ Identifies the type of dim divisor that was applied.
+
+
+
+
+
+
+ Sum of dimensional weights for all packages.
+
+
+
+
+
+
+
+
+ This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ Total of the transportation-based taxes.
+
+
+
+
+
+
+ Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
+
+
+
+
+ Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
+
+
+
+
+ The total of the totalDutiesAndTaxes plus the totalAncillaryFeesAndTaxes.
+
+
+
+
+ This shipment's totalNetCharge + totalDutiesTaxesAndFees; some duties and taxes are only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
+
+
+
+
+ Identifies the Rate Details per each leg in a Freight Shipment
+
+
+
+
+ Rate data specific to FedEx Freight and FedEx National Freight services.
+
+
+
+
+ All rate discounts that apply to this shipment.
+
+
+
+
+ All rebates that apply to this shipment.
+
+
+
+
+ All surcharges that apply to this shipment.
+
+
+
+
+ All transportation-based taxes applicable to this shipment.
+
+
+
+
+ All commodity-based duties and taxes applicable to this shipment.
+
+
+
+
+ Identifies the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
+
+
+
+
+ The "order level" variable handling charges.
+
+
+
+
+ The total of all variable handling charges at both shipment (order) and package level.
+
+
+
+
+
+
+ These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ Indicates the shipment special service types that are requested on this shipment. For a list of the valid shipment special service types, please consult your integration documentation or get the list of the available special services from the getAllSpecialServices method of the Validation Availability and Commitment service.
+
+
+
+
+
+
+
+ This replaces eMailNotificationDetail
+
+
+
+
+
+ This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
+
+
+
+
+
+
+
+
+
+
+ Electronic Trade document references.
+
+
+
+
+ Specification for date or range of dates on which delivery is to be attempted.
+
+
+
+
+
+
+
+
+ Specifies the name or the key for the shipment variation.
+
+
+
+
+ The values that are valid for the specified shipment variation in the context of the current shipment.
+
+
+
+
+
+
+
+
+ This indicates the identifier of a conveyance, such as a trailer ID.
+
+
+
+
+
+
+ Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
+
+
+
+
+ Values in this field specify how to create and return the document.
+
+
+
+
+ Specifies how to organize all documents of this type.
+
+
+
+
+ Specifies how to e-mail document images.
+
+
+
+
+ Specifies how a queued document is to be printed.
+
+
+
+
+
+
+ Specifies how to return a shipping document to the caller.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to e-mail shipping documents.
+
+
+
+
+ Provides the roles and email addresses for e-mail recipients.
+
+
+
+
+ Identifies the convention by which documents are to be grouped as e-mail attachments.
+
+
+
+
+ Specifies the language in which the email containing the document is requested to be composed.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies an individual recipient of e-mailed shipping document(s).
+
+
+
+
+ Identifies the relationship of this recipient in the shipment.
+
+
+
+
+ Address to which the document is to be sent.
+
+
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies how to create, organize, and return the document.
+
+
+
+
+ Specifies how far down the page to move the beginning of the image; allows for printing on letterhead and other pre-printed stock.
+
+
+
+
+
+
+ For those shipping document types which have both a "form" and "instructions" component (e.g. NAFTA Certificate of Origin and General Agency Agreement), this field indicates whether to provide the instructions.
+
+
+
+
+
+ Governs the language to be used for this individual document, independently from other content returned for the same shipment.
+
+
+
+
+
+
+ Specifies how to organize all shipping documents of the same type.
+
+
+
+
+
+
+
+
+ Specifies the image format used for a shipping document.
+
+
+
+
+
+
+
+
+
+
+ Specifies printing options for a shipping document.
+
+
+
+
+ Provides environment-specific printer identification.
+
+
+
+
+
+
+ Contains all data required for additional (non-label) shipping documents to be produced in conjunction with a specific shipment.
+
+
+
+
+ Indicates the types of shipping documents requested by the shipper.
+
+
+
+
+
+
+ Specifies the production of each package-level custom document (the same specification is used for all packages).
+
+
+
+
+ Specifies the production of a shipment-level custom document.
+
+
+
+
+
+
+
+ Specifies the production of the OP-900 document for hazardous materials packages.
+
+
+
+
+ Specifies the production of the 1421c document for dangerous goods shipment.
+
+
+
+
+ Specifies the production of the OP-900 document for hazardous materials.
+
+
+
+
+ Specifies the production of the return instructions document.
+
+
+
+
+
+
+ Specifies the type of paper (stock) on which a document will be printed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values are mutually exclusive; at most one of them can be attached to a SmartPost shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required for shipments handled under the SMART_POST and GROUND_SMART_POST service types.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifice the kind of tax or miscellaneous charge being reported on a Commercial Invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the usage of Tax Identification Number in Shipment processing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the application that is responsible for managing the document id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Description of the uploaded document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This definition of variable handling charge detail is intended for use in Jan 2011 corp load.
+
+
+
+
+
+ Actual percentage (10 means 10%, which is a mutiplier of 0.1)
+
+
+
+
+ Select the value from a set of rate data to which the percentage is applied.
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Three-dimensional volume/cubic measurement.
+
+
+
+
+
+
+
+
+ Units of three-dimensional volume/cubic measure.
+
+
+
+
+
+
+
+
+ The descriptive data for the heaviness of an object.
+
+
+
+
+ Identifies the unit of measure associated with a weight value.
+
+
+
+
+ Identifies the weight value of a package/shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/test_server_wsdl/ShipService_v17.wsdl b/fedex/wsdl/test_server_wsdl/ShipService_v26.wsdl
old mode 100755
new mode 100644
similarity index 82%
rename from fedex/wsdl/test_server_wsdl/ShipService_v17.wsdl
rename to fedex/wsdl/test_server_wsdl/ShipService_v26.wsdl
index 637717c..84fb3c1
--- a/fedex/wsdl/test_server_wsdl/ShipService_v17.wsdl
+++ b/fedex/wsdl/test_server_wsdl/ShipService_v26.wsdl
@@ -1,6431 +1,6614 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the role that identifies the permissions the accessor of the pending shipment.
-
-
-
-
-
-
-
-
- Specifies additional labels to be produced. All required labels for shipments will be produced without the need to request additional labels. These are only available as thermal labels.
-
-
-
-
- The type of additional labels to return.
-
-
-
-
- The number of this type label to return
-
-
-
-
-
-
- Identifies the type of additional labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
-
-
-
-
- Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
-
-
-
-
- Name of city, town, etc.
-
-
-
-
- Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
-
-
-
-
- Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
-
-
-
-
- Relevant only to addresses in Puerto Rico.
-
-
-
-
- The two-letter code used to identify a country.
-
-
-
-
- The fully spelt out name of a country.
-
-
-
-
- Indicates whether this address residential (as opposed to commercial).
-
-
-
-
-
-
- Specifies the details around the ADR license required for shipping.
-
-
-
-
-
-
-
- Specifies details for a package containing alcohol
-
-
-
-
- The license type that the recipient of the alcohol package.
-
-
-
-
-
-
- Specifies the type of license that the recipient of the alcohol shipment has.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking id for the payment on the return.
-
-
-
-
- Specifies additional customer reference data about the associated shipment.
-
-
-
-
- Specifies shipment level operational information.
-
-
-
-
- Specifies package level operational information on the associated shipment. This information is not tied to an individual outbound package.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies which filing option is being exercised by the customer.
- Required for non-document shipments originating in Canada destined for any country other than Canada, the United States, Puerto Rico or the U.S. Virgin Islands.
-
-
-
-
-
-
-
-
-
-
-
-
- Identification of the type of barcode (symbology) used on FedEx documents and labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Each instance of this data type represents a barcode whose content must be represented as binary data (i.e. not ASCII text).
-
-
-
-
- The kind of barcode data in this instance.
-
-
-
-
- The data content of this instance.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identification of a FedEx operating company (transportation).
-
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the type of brokerage to be applied to a shipment.
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for the client submitting a transaction.
-
-
-
-
- The FedEx account number associated with this transaction.
-
-
-
-
- This number is assigned by FedEx and identifies the unique device from which the request is originating
-
-
-
-
- Only used in transactions which require identification of the FedEx Office integrator.
-
-
-
-
- The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
- Specifies the type of adjustment was performed to the COD collection amount during rating.
-
-
-
-
-
-
-
-
- Identifies the type of funds FedEx should collect upon shipment delivery.
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
-
-
-
-
-
- Specifies the details of the charges are to be added to the COD collect amount.
-
-
-
-
- Identifies the type of funds FedEx should collect upon package delivery
-
-
-
-
- For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
-
-
-
-
- When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
-
-
-
-
- Specifies the name of person or company receiving the secured/unsecured funds payment
-
-
-
-
- Indicates which type of reference information to include on the COD return shipping label.
-
-
-
-
- Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
-
-
-
-
-
-
- Specifies the information associated with a package that has COD special service in a ground shipment.
-
-
-
-
- The COD amount (after any accumulations) that must be collected upon delivery of a package shipped using the COD special service.
-
-
-
-
-
-
- Contains the data which form the Astra and 2DCommon barcodes that print on the COD return label.
-
-
-
-
- The label image or printer commands to print the label.
-
-
-
-
-
-
- Indicates which type of reference information to include on the COD return shipping label.
-
-
-
-
-
-
-
-
-
-
- CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through the FedEx Systems. Customers are responsible for printing their own Commercial Invoice.If you would likeFedEx to generate a Commercial Invoice and transmit it to Customs. for clearance purposes, you need to specify that in the ShippingDocumentSpecification element. If you would like a copy of the Commercial Invoice that FedEx generated returned to you in reply it needs to be specified in the ETDDetail/RequestedDocumentCopies element. Commercial Invoice support consists of maximum of 99 commodity line items.
-
-
-
-
- Any comments that need to be communicated about this shipment.
-
-
-
-
- Any freight charges that are associated with this shipment.
-
-
-
-
- Any taxes or miscellaneous charges(other than Freight charges or Insurance charges) that are associated with this shipment.
-
-
-
-
- Specifies which kind of charge is being recorded in the preceding field.
-
-
-
-
- Any packing costs that are associated with this shipment.
-
-
-
-
- Any handling costs that are associated with this shipment.
-
-
-
-
- Free-form text.
-
-
-
-
- Free-form text.
-
-
-
-
- Free-form text.
-
-
-
-
- The reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.
-
-
-
-
- Additional customer reference data.
-
-
-
-
- Name of the International Expert that completed the Commercial Invoice different from Sender.
-
-
-
-
- Required for dutiable international Express or Ground shipments. This field is not applicable to an international PIB(document) or a non-document which does not require a Commercial Invoice.
-
-
-
-
-
-
- The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
-
-
-
-
-
- Specifies the usage and identification of a customer supplied image to be used on this document.
-
-
-
-
-
-
-
- For international multiple piece shipments, commodity information must be passed in the Master and on each child transaction.
- If this shipment cotains more than four commodities line items, the four highest valued should be included in the first 4 occurances for this request.
-
-
-
-
-
- Name of this commodity.
-
-
-
-
- Total number of pieces of this commodity
-
-
-
-
- Complete and accurate description of this commodity.
-
- 450
-
-
-
-
-
- Country code where commodity contents were produced or manufactured in their final form.
-
- 2
-
-
-
-
-
-
- Unique alpha/numeric representing commodity item.
- At least one occurrence is required for US Export shipments if the Customs Value is greater than $2500 or if a valid US Export license is required.
-
-
- 14
-
-
-
-
-
- Total weight of this commodity. 1 explicit decimal position. Max length 11 including decimal.
-
-
-
-
- This field is used for enterprise transactions.
-
-
-
-
- Unit of measure used to express the quantity of this commodity line item.
-
- 3
-
-
-
-
-
- Contains only additional quantitative information other than weight and quantity to calculate duties and taxes.
-
-
-
-
- Value of each unit in Quantity. Six explicit decimal positions, Max length 18 including decimal.
-
-
-
-
-
- Total customs value for this line item.
- It should equal the commodity unit quantity times commodity unit value.
- Six explicit decimal positions, max length 18 including decimal.
-
-
-
-
-
- Defines additional characteristic of commodity used to calculate duties and taxes
-
-
-
-
- Applicable to US export shipping only.
-
- 12
-
-
-
-
-
-
- Date of expiration. Must be at least 1 day into future.
- The date that the Commerce Export License expires. Export License commodities may not be exported from the U.S. on an expired license.
- Applicable to US Export shipping only.
- Required only if commodity is shipped on commerce export license, and Export License Number is supplied.
-
-
-
-
-
-
- An identifying mark or number used on the packaging of a shipment to help customers identify a particular shipment.
-
-
- 15
-
-
-
-
-
-
- All data required for this commodity in NAFTA Certificate of Origin.
-
-
-
-
-
-
- Specifies the results of processing for the COD special service.
-
-
-
-
-
-
-
-
-
-
- The identifier for all clearance documents associated with this shipment.
-
-
-
-
-
-
-
- Completed package-level hazardous commodity information for a single package.
-
-
-
-
- A unique reference id that matches the package to a package configuration. This is populated if the client provided a package configuration for several packages that have the exact same dangerous goods content.
-
-
-
-
-
- When true indicates that the package can be transported only on a cargo aircraft.
-
-
-
-
-
- Specifies the maximum radiation level from the package (measured in microSieverts per hour at a distance of one meter from the external surface of the package, divided by 10).
-
-
-
-
- Specifies the label that is to be put on a package containing radioactive material. The label type is determined in accordance with the Transportation of Dangerous Goods Act and indicates the type of radioactive material being handled as well as the relative risk.
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current package.
-
-
-
-
-
-
- Computed shipment level hazardous commodity information.
-
-
-
-
-
-
- This contains the ADR License information, which identifies the license number and ADR category under which the customer is allowed to ship.
-
-
-
-
-
-
-
-
- Specifies the total number of packages containing hazardous commodities in small exceptions.
-
-
-
-
-
-
-
-
- Identifies the branded location name, the hold at location phone number and the address of the location.
-
-
-
-
- Identifies the type of FedEx location.
-
-
-
-
-
-
-
-
- The package sequence number of this package in a multiple piece shipment.
-
-
-
-
- The Tracking number and form id for this package.
-
-
-
-
- Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.
-
-
-
-
- Oversize class for this package.
-
-
-
-
- All package-level rating data for this package, which may include data for multiple rate types.
-
-
-
-
-
- The label image or printer commands to print the label.
-
-
-
-
- All package-level shipping documents (other than labels and barcodes). For use in loads after January, 2008.
-
-
-
-
- Specifies the information associated with this package that has COD special service in a ground shipment.
-
-
-
-
- Actual signature option applied, to allow for cases in which the original value conflicted with other service features in the shipment.
-
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current package, using updated hazardous commodity description data.
-
-
-
-
-
-
-
-
- Indicates whether or not this is a US Domestic shipment.
-
-
-
-
- Indicates the carrier that will be used to deliver this shipment.
-
-
-
-
- The master tracking number and form id of this multiple piece shipment. This information is to be provided for each subsequent of a multiple piece shipment.
-
-
-
-
- Description of the FedEx service used for this shipment. Currently not supported.
-
- 70
-
-
-
-
-
- Description of the packaging used for this shipment. Currently not supported.
-
- 40
-
-
-
-
-
-
- Only used with pending shipments.
-
-
-
-
- Only used in the reply to tag requests.
-
-
-
-
- Provides reply information specific to SmartPost shipments.
-
-
-
-
- Computed shipment level information about hazarous commodities.
-
-
-
-
- All shipment-level rating data for this shipment, which may include data for multiple rate types.
-
-
-
-
- Returns the default holding location information when HOLD_AT_LOCATION special service is requested and the client does not specify the hold location address.
-
-
-
-
- Returns any defaults or updates applied to RequestedShipment.exportDetail.exportComplianceStatement.
-
-
-
-
-
- All shipment-level shipping documents (other than labels and barcodes).
-
-
-
-
-
-
- Package level details about this package.
-
-
-
-
-
-
- Provides reply information specific to SmartPost shipments.
-
-
-
-
- Identifies the carrier that will pick up the SmartPost shipment.
-
-
-
-
- Indicates whether the shipment is deemed to be machineable, based on dimensions, weight, and packaging.
-
-
-
-
-
-
- Provides reply information specific to a tag request.
-
-
-
-
- .
-
-
-
-
- As of June 2007, returned only for FedEx Express services.
-
-
-
-
- As of June 2007, returned only for FedEx Express services.
-
-
-
-
- As of June 2007, returned only for FedEx Express services.
-
-
-
-
- As of June 2007, returned only for FedEx Express services.
-
-
-
-
- FEDEX INTERNAL USE ONLY: for use by INET.
-
-
-
-
-
-
- Defines additional data to print in the Configurable portion of the label, this allows you to print the same type information on the label that can also be printed on the doc tab.
-
-
-
-
- 1 of 12 possible zones to position data.
-
-
-
-
- The identifiying text for the data in this zone.
-
-
-
-
- A reference to a field in either the request or reply to print in this zone following the header.
-
-
-
-
- A literal value to print after the header in this zone.
-
-
-
-
-
-
- The descriptive data for a point-of-contact person.
-
-
-
-
- Client provided identifier corresponding to this contact information.
-
-
-
-
- Identifies the contact person's name.
-
-
-
-
- Identifies the contact person's title.
-
-
-
-
- Identifies the company this contact is associated with.
-
-
-
-
- Identifies the phone number associated with this contact.
-
-
-
-
- Identifies the phone extension associated with this contact.
-
-
-
-
- Identifies a toll free number, if any, associated with this contact.
-
-
-
-
- Identifies the pager number associated with this contact.
-
-
-
-
- Identifies the fax number associated with this contact.
-
-
-
-
- Identifies the email address associated with this contact.
-
-
-
-
-
-
-
-
-
-
-
-
- Content Record.
-
-
-
-
- Part Number.
-
-
-
-
- Item Number.
-
-
-
-
- Received Quantity.
-
-
-
-
- Description.
-
-
-
-
-
-
- Currency exchange rate information.
-
-
-
-
- The currency code for the original (converted FROM) currency.
-
-
-
-
- The currency code for the final (converted INTO) currency.
-
-
-
-
- Multiplier used to convert fromCurrency units to intoCurrency units.
-
-
-
-
-
-
-
-
- Indicates the type of custom delivery being requested.
-
-
-
-
- Time by which delivery is requested.
-
-
-
-
- Range of dates for custom delivery request; only used if type is BETWEEN.
-
-
-
-
- Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce a custom-specified document, either at shipment or package level.
-
-
-
-
- Common information controlling document production.
-
-
-
-
- Applicable only to documents produced on thermal printers with roll stock.
-
-
-
-
- Applicable only to documents produced on thermal printers with roll stock.
-
-
-
-
- Identifies the formatting specification used to construct this custom document.
-
-
-
-
- Identifies the individual document specified by the client.
-
-
-
-
- If provided, thermal documents will include specified doc tab content. If omitted, document will be produced without doc tab content.
-
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified barcode symbology.
-
-
-
-
-
-
-
-
- Width of thinnest bar/space element in the barcode.
-
-
-
-
-
-
-
- Solid (filled) rectangular area on label.
-
-
-
-
-
-
-
-
- Valid values for CustomLabelCoordinateUnits
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Image to be included from printer's memory, or from a local file for offline clients.
-
-
-
-
-
- Printer-specific index of graphic image to be printed.
-
-
-
-
- Fully-qualified path and file name for graphic image to be printed.
-
-
-
-
-
-
-
-
- Horizontal position, relative to left edge of custom area.
-
-
-
-
- Vertical position, relative to top edge of custom area.
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
-
-
-
-
-
-
-
-
-
- Printer-specific font name for use with thermal printer labels.
-
-
-
-
- Generic font name for use with plain paper labels.
-
-
-
-
- Generic font size for use with plain paper labels.
-
-
-
-
-
-
-
- Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
-
-
-
-
-
-
-
- Printer-specific font name for use with thermal printer labels.
-
-
-
-
- Generic font name for use with plain paper labels.
-
-
-
-
- Generic font size for use with plain paper labels.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Reference information to be associated with this package.
-
-
-
-
- The reference type to be associated with this reference data.
-
-
-
-
-
-
-
- The types of references available for use.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Allows customer-specified control of label content.
-
-
-
-
- If omitted, no doc tab will be produced (i.e. default is former NONE type).
-
-
-
-
- Controls the position of the customer specified content relative to the FedEx portion.
-
-
-
-
- Defines any custom content to print on the label.
-
-
-
-
- Defines additional data to print in the Configurable portion of the label, this allows you to print the same type information on the label that can also be printed on the doc tab.
-
-
-
-
- Controls which data/sections will be suppressed.
-
-
-
-
- For customers producing their own Ground labels, this field specifies which secondary barcode will be printed on the label; so that the primary barcode produced by FedEx has the correct SCNC.
-
-
-
-
-
-
- Controls the number of additional copies of supplemental labels.
-
-
-
-
- This value reduces the default quantity of destination/consignee air waybill labels. A value of zero indicates no change to default. A minimum of one copy will always be produced.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interacts both with properties of the shipment and contractual relationship with the shipper.
-
-
-
-
-
-
- Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
-
-
-
-
-
-
-
- Identifies responsibilities with respect to loss, damage, etc.
-
-
-
-
- Documents amount paid to third party for coverage of shipment content.
-
-
-
-
-
-
-
-
-
-
-
-
- This provides the information necessary to identify the different statements, declarations, acts, and/or certifications that apply to this shipment.
-
-
-
-
- This indicates the different statements, declarations, acts, and/or certifications that apply to this shipment.
-
-
-
-
- Specifies the NAFTA low value statement information.
-
-
-
-
-
-
- This indicates the different statements, declarations, acts, and certifications that may apply to a shipment.
-
-
-
-
-
-
-
-
-
-
- Specifies additional description about customs options. This is a required field when the customs options type is "OTHER".
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Describes an approved container used to package dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container.
-
-
-
-
- Indicates whether there are additional inner receptacles within this container.
-
-
-
-
- Indicates the type of this dangerous goods container, as specified by the IATA packing instructions. For example, steel cylinder, fiberboard box, plastic jerrican and steel drum.
-
-
-
-
- Indicates the packaging type of the container used to package the radioactive materials.
-
-
-
-
- Indicates the number of occurrences of this container with identical dangerous goods configuration.
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current container.
-
-
-
-
-
-
- The descriptive data required for a FedEx shipment containing dangerous goods (hazardous materials).
-
-
-
-
-
- Identifies whether or not the products being shipped are required to be accessible during delivery.
-
-
-
-
- Shipment is packaged/documented for movement ONLY on cargo aircraft.
-
-
-
-
- Indicates which kinds of hazardous content are in the current package.
-
-
-
-
- Indicates whether there is additional customer provided packaging enclosing the approved dangerous goods containers.
-
-
-
-
- Identifies the configuration of this dangerous goods package. The common configuration is represented at the shipment level.
-
-
-
-
- Indicates one or more containers used to pack dangerous goods commodities.
-
-
-
-
- Description of the packaging of this commodity, suitable for use on OP-900 and OP-950 forms.
-
-
-
-
- Name, title and place of the signatory for this shipment.
-
-
-
-
- Telephone number to use for contact in the event of an emergency.
-
-
-
-
- Offeror's name or contract number, per DOT regulation.
-
-
-
-
- Specifies the contact of the party responsible for handling the infectious substances, if any, in the dangerous goods shipment.
-
-
-
-
- Specifies additional handling information for the current package.
-
-
-
-
- Specifies the radioactivity detail for the current package, if the package contains radioactive materials.
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the 1421c form for dangerous goods shipment.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
- Specifies that name, title and place of the signatory responsible for the dangerous goods shipment.
-
-
-
-
-
-
- Indicates the place where the form is signed.
-
-
-
-
-
-
-
-
- The beginning date in a date range.
-
-
-
-
- The end date in a date range.
-
-
-
-
-
-
- Valid values for DayofWeekType
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data sent to FedEx by a customer in order to delete a package.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- The timestamp of the shipment request.
-
-
-
-
- Identifies the FedEx tracking number of the package being cancelled.
-
-
-
-
- Determines the type of deletion to be performed in relation to package level vs shipment level.
-
-
-
-
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Only used for tags which had FedEx Express services.
-
-
-
-
- Only used for tags which had FedEx Express services.
-
-
-
-
- If the original ProcessTagRequest specified third-party payment, then the delete request must contain the same pay type and payor account number for security purposes.
-
-
-
-
- Also known as Pickup Confirmation Number or Dispatch Number
-
-
-
-
-
-
- Specifies the type of deletion to be performed on a shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking id for the return, if preassigned.
-
-
-
-
-
-
- Data required to complete the Destionation Control Statement for US exports.
-
-
-
-
- List of applicable Statment types.
-
-
-
-
- Comma-separated list of up to four country codes, required for DEPARTMENT_OF_STATE statement.
-
-
-
-
- Name of end user, required for DEPARTMENT_OF_STATE statement.
-
-
-
-
-
-
- Used to indicate whether the Destination Control Statement is of type Department of Commerce, Department of State or both.
-
-
-
-
-
-
-
-
- The dimensions of this package and the unit type used for the measurements.
-
-
-
-
-
-
-
-
-
-
-
-
- The DocTabContentType options available.
-
-
-
-
- The DocTabContentType should be set to ZONE001 to specify additional Zone details.
-
-
-
-
- The DocTabContentType should be set to BARCODED to specify additional BarCoded details.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Zone number can be between 1 and 12.
-
-
-
-
- Header value on this zone.
-
-
-
-
- Reference path to the element in the request/reply whose value should be printed on this zone.
-
-
-
-
- Free form-text to be printed in this zone.
-
-
-
-
- Justification for the text printed on this zone.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the method by which the package is to be tendered to FedEx. This element does not dispatch a courier for package pickup.
-
-
-
-
-
-
-
-
-
-
-
- Describes specific information about the email label shipment.
-
-
-
-
- Content of the email message.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Information describing email notifications that will be sent in relation to events that occur during package movement
-
-
-
-
- Specifies whether/how email notifications are grouped.
-
-
-
-
- A message that will be included in the email notifications
-
-
-
-
- Information describing the destination of the email, format of the email and events to be notified on
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The format of the email
-
-
-
-
-
-
-
-
-
- The descriptive data for a FedEx email notification recipient.
-
-
-
-
- Identifies the relationship this email recipient has to the shipment.
-
-
-
-
- The email address to send the notification to
-
-
-
-
- The types of email notifications being requested for this recipient.
-
-
-
-
- The format of the email notification.
-
-
-
-
- The language/locale to be used in this email notification.
-
-
-
-
-
-
- Identifies the set of valid email notification recipient types. For SHIPPER, RECIPIENT and BROKER the email address asssociated with their definitions will be used, any email address sent with the email notification for these three email notification recipient types will be ignored.
-
-
-
-
-
-
-
-
-
-
-
- Information describing the address of of the email recipient, role of the email recipient and languages that are requested to be supported.
-
-
-
-
- EMail address of the recipient.
-
-
-
-
- The relationship that the customer has to the pending shipment.
-
-
-
-
- Specifies how the email notification for the pending shipment need to be processed.
-
-
-
-
- Localization and language details specified by the recipient of the EMail.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Customer-declared value, with data type and legal values depending on excise condition, used in defining the taxable value of the item.
-
-
-
-
-
-
- Specifies the types of Estimated Duties and Taxes to be included in a rate quotation for an international shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how to apply the localization detail to the current context.
-
-
-
-
-
-
-
- Electronic Trade document references used with the ETD special service.
-
-
-
-
- Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
-
-
-
-
-
-
-
- The instructions indicating how to print the Export Declaration.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
-
-
- Country specific details of an International shipment.
-
-
-
-
-
- Specifies which filing option is being exercised by the customer.
- Required for non-document shipments originating in Canada destined for any country other than Canada, the United States, Puerto Rico or the U.S. Virgin Islands.
-
-
-
-
-
- General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).
-
-
-
-
- This field is applicable only to Canada export non-document shipments of any value to any destination. No special characters allowed.
-
- 10
-
-
-
-
-
- Department of Commerce/Department of State information about this shipment.
-
-
-
-
-
-
- Details specific to an Express freight shipment.
-
-
-
-
- Indicates whether or nor a packing list is enclosed.
-
-
-
-
-
- Total shipment pieces.
- e.g. 3 boxes and 3 pallets of 100 pieces each = Shippers Load and Count of 303.
- Applicable to International Priority Freight and International Economy Freight.
- Values must be in the range of 1 - 99999
-
-
-
-
-
- Required for International Freight shipping. Values must be 8- 12 characters in length.
-
- 12
-
-
-
-
-
-
-
- Identifies a kind of FedEx facility.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required to produce the Freight handling-unit-level address labels. Note that the number of UNIQUE labels (the N as in 1 of N, 2 of N, etc.) is determined by total handling units.
-
-
-
-
-
- Indicates the number of copies to be produced for each unique label.
-
-
-
-
- Specifies the quadrant of the page on which the label printing will start.
-
-
-
-
- If omitted, no doc tab will be produced (i.e. default = former NONE type).
-
-
-
-
- Controls the position of the customer specified content relative to the FedEx portion.
-
-
-
-
-
-
-
- Individual charge which contributes to the total base charge for the shipment.
-
-
-
-
- Freight class for this line item.
-
-
-
-
- Effective freight class used for rating this line item.
-
-
-
-
- NMFC Code for commodity.
-
-
-
-
- Customer-provided description for this commodity or class line.
-
-
-
-
- Weight for this commodity or class line.
-
-
-
-
- Rate or factor applied to this line item.
-
-
-
-
- Identifies the manner in which the chargeRate for this line item was applied.
-
-
-
-
- The net or extended charge for this line item.
-
-
-
-
-
-
- Specifies the way in which base charges for a Freight shipment or shipment leg are calculated.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These values represent the industry-standard freight classes used for FedEx Freight and FedEx National Freight shipment description. (Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms.)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Date for all Freight guarantee types.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies responsibilities with respect to loss, damage, etc.
-
-
-
-
-
-
-
-
- Rate data specific to FedEx Freight or FedEx National Freight services.
-
-
-
-
- A unique identifier for a specific rate quotation.
-
-
-
-
- Specifies whether the rate quote was automated or manual.
-
-
-
-
- Specifies how total base charge is determined.
-
-
-
-
- Freight charges which accumulate to the total base charge for the shipment.
-
-
-
-
- Human-readable descriptions of additional information on this shipment rating.
-
-
-
-
-
-
- Additional non-monetary data returned with Freight rates.
-
-
-
-
- Unique identifier for notation.
-
-
-
-
- Human-readable explanation of notation.
-
-
-
-
-
-
- Specifies the type of rate quote
-
-
-
-
-
-
-
-
- Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
-
-
-
-
- Account number used with FEDEX_FREIGHT service.
-
-
-
-
- Used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
-
-
-
-
- Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
-
-
-
-
- Identification values to be printed during creation of a Freight bill of lading.
-
-
-
-
- Indicates the role of the party submitting the transaction.
-
-
-
-
- Designates the terms of the "collect" payment for a Freight Shipment.
-
-
-
-
- Identifies the declared value for the shipment
-
-
-
-
- Identifies the declared value units corresponding to the above defined declared value
-
-
-
-
-
- Identifiers for promotional discounts offered to customers.
-
-
-
-
- Total number of individual handling units in the entire shipment (for unit pricing).
-
-
-
-
- Estimated discount rate provided by client for unsecured rate quote.
-
-
-
-
- Total weight of pallets used in shipment.
-
-
-
-
- Overall shipment dimensions.
-
-
-
-
- Description for the shipment.
-
-
-
-
- Specifies which party will pay surcharges for any special services which support split billing.
-
-
-
-
- Must be populated if any line items contain hazardous materials.
-
-
-
-
-
- Details of the commodities in the shipment.
-
-
-
-
-
-
- Description of an individual commodity or class of content in a shipment.
-
-
-
-
- Freight class for this line item.
-
-
-
-
- FEDEX INTERNAL USE ONLY: for FedEx system that estimate freight class from customer-provided dimensions and weight.
-
-
-
-
- Number of individual handling units to which this line applies. (NOTE: Total of line-item-level handling units may not balance to shipment-level total handling units.)
-
-
-
-
- Specification of handling-unit packaging for this commodity or class line.
-
-
-
-
- Number of pieces for this commodity or class line.
-
-
-
-
- NMFC Code for commodity.
-
-
-
-
- Indicates the kind of hazardous material content in this line item.
-
-
-
-
- For printed reference per line item.
-
-
-
-
- Customer-provided description for this commodity or class line.
-
-
-
-
- Weight for this commodity or class line.
-
-
-
-
- FED EX INTERNAL USE ONLY - Individual line item dimensions.
-
-
-
-
- Volume (cubic measure) for this commodity or class line.
-
-
-
-
-
-
- Indicates the role of the party submitting the transaction.
-
-
-
-
-
-
-
-
- Specifies which party will be responsible for payment of any surcharges for Freight special services for which split billing is allowed.
-
-
-
-
- Identifies the special service.
-
-
-
-
- Indicates who will pay for the special service.
-
-
-
-
-
-
- Data required to produce a General Agency Agreement document. Remaining content (business data) to be defined once requirements have been completed.
-
-
-
-
-
-
-
- Represents features of FedEx Ground delivery for which the shipment is eligible.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Documents the kind and quantity of an individual hazardous commodity in a package.
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Specifies the amount of the commodity in alternate units.
-
-
-
-
- This describes the inner receptacle details for a hazardous commodity within the dangerous goods container.
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- Specifies the details of any radio active materials within the commodity.
-
-
-
-
- The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
-
-
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Regulatory identifier for a commodity (e.g. "UN ID" value).
-
-
-
-
- In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates any special processing options to be applied to the description of the dangerous goods commodity.
-
-
-
-
- Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
-
-
-
-
-
-
- Specifies any special processing to be applied to the dangerous goods commodity description validation.
-
-
-
-
-
-
-
- This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container.
-
-
-
-
- This specifies the quantity contained in the inner receptacle.
-
-
-
-
-
-
- Specifies how the commodity is to be labeled.
-
-
-
-
-
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- Specifies how the customer wishes the label text to be handled for this commodity in this package.
-
-
-
-
- Text used in labeling the commodity under control of the labelTextOption field.
-
-
-
-
-
-
- Indicates which kind of hazardous content is being reported.
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies number and type of packaging units for hazardous commodities.
-
-
-
-
- Number of units of the type below.
-
-
-
-
- Units in which the hazardous commodity is packaged.
-
-
-
-
-
-
- Specifies documentation and limits for validation of an individual packing group/category.
-
-
-
-
-
- Coded specification for how commodity is to be packed.
-
-
-
-
-
-
- Identifies DOT packing group for a hazardous commodity.
-
-
-
-
-
-
-
-
-
-
- Identifies amount and units for quantity of hazardous commodities.
-
-
-
-
- Number of units of the type below.
-
-
-
-
- Units by which the hazardous commodity is measured. For IATA commodity, the units values are restricted based on regulation type.
-
-
-
-
- Specifies which measure of quantity is to be validated.
-
-
-
-
-
-
- Specifies the measure of quantity to be validated against a prescribed limit.
-
-
-
-
-
-
-
-
- Identifies the source of regulation for hazardous commodity data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data required for a FedEx shipment that is to be held at the destination FedEx location for pickup by the recipient.
-
-
-
-
- Contact phone number for recipient of shipment.
-
-
-
-
- Contact and address of FedEx facility at which shipment is to be held.
-
-
-
-
- Type of facility at which package/shipment is to be held.
-
-
-
-
-
-
- The descriptive data required by FedEx for home delivery services.
-
-
-
-
- The type of Home Delivery Premium service being requested.
-
-
-
-
- Required for Date Certain Home Delivery.
-
-
-
-
- Required for Date Certain and Appointment Home Delivery.
-
- 15
-
-
-
-
-
-
-
- The type of Home Delivery Premium service being requested.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The type of International shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the type of label to be returned.
-
-
-
-
-
-
-
-
-
-
- Names for data elements / areas which may be suppressed from printing on labels.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the order in which the labels will be returned
-
-
-
-
-
-
-
-
- This indicates if the top or bottom of the label comes out of the printer first.
-
-
-
-
-
-
-
-
- Relative to normal orientation for the printer.
-
-
-
-
-
-
-
-
-
-
- Description of shipping label to be returned in the reply
-
-
-
-
- Specifies how to create, organize, and return the document.
-
-
-
-
- Specify type of label to be returned
-
-
-
-
- Specifies the image format used for a shipping document.
-
-
-
-
- For thermal printer lables this indicates the size of the label and the location of the doc tab if present.
-
-
-
-
- This indicates if the top or bottom of the label comes out of the printer first.
-
-
-
-
- Specifies the order in which the labels are requested to be returned
-
-
-
-
- If present, this contact and address information will replace the return address information on the label.
-
-
-
-
- Allows customer-specified control of label content.
-
-
-
-
-
-
- For thermal printer labels this indicates the size of the label and the location of the doc tab if present.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the Liability Coverage Amount. For Jan 2010 this value represents coverage amount per pound
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- License or Permit Number.
-
-
-
-
- Specifies the effective date of the license.
-
-
-
-
- Specifies the expiration date of the license.
-
-
-
-
-
-
- Represents a one-dimensional measurement in small units (e.g. suitable for measuring a package or document), contrasted with Distance, which represents a large one-dimensional measurement (e.g. distance between cities).
-
-
-
-
- The numerical quantity of this measurement.
-
-
-
-
- The units for this measurement.
-
-
-
-
-
-
- CM = centimeters, IN = inches
-
-
-
-
-
-
-
-
- Identifies the representation of human-readable text.
-
-
-
-
- Two-letter code for language (e.g. EN, FR, etc.)
-
-
-
-
- Two-letter code for the region (e.g. us, ca, etc..).
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies which type minimum charge was applied.
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data for the medium of exchange for FedEx services.
-
-
-
-
- Identifies the currency of the monetary amount.
-
- 3
-
-
-
-
-
- Identifies the monetary amount.
-
-
-
-
-
-
- Data required to produce a Certificate of Origin document. Remaining content (business data) to be defined once requirements have been completed.
-
-
-
-
-
-
- Indicates which Party (if any) from the shipment is to be used as the source of importer data on the NAFTA COO form.
-
-
-
-
- Contact information for "Authorized Signature" area of form.
-
-
-
-
-
-
-
-
-
- This element is currently not supported and is for the future use.
-
-
-
-
- Defined by NAFTA regulations.
-
-
-
-
- Defined by NAFTA regulations.
-
-
-
-
- Identification of which producer is associated with this commodity (if multiple producers are used in a single shipment).
-
-
-
-
-
- Date range over which RVC net cost was calculated.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the information necessary for printing the NAFTA Low Value statement on customs documentation.
-
-
-
-
- Specifies the NAFTA statement role.
-
-
-
-
-
-
- Net cost method used.
-
-
-
-
-
-
-
-
- See instructions for NAFTA Certificate of Origin for code definitions.
-
-
-
-
-
-
-
-
-
-
-
-
- This element is currently not supported and is for the future use.
-
-
-
-
-
-
-
-
- See instructions for NAFTA Certificate of Origin for code definitions.
-
-
-
-
-
-
-
-
-
-
- This element is currently not supported and is for the future use.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data regarding the result of the submitted transaction.
-
-
-
-
- The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
-
-
-
-
- Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
-
-
-
-
- A code that represents this notification. Combined with the Source it uniquely identifies this notification.
-
-
-
-
- Human-readable text that explains this notification.
-
-
-
-
- The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
-
-
-
-
- A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) witout having to parse the message string.
-
-
-
-
-
-
-
-
- Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
-
-
-
-
- The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
-
-
-
-
-
-
- Identifies the set of severity values for a Notification.
-
-
-
-
-
-
-
-
-
-
-
- The instructions indicating how to print the OP-900 form for hazardous materials packages.
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Identifies which reference type (from the package's customer references) is to be used as the source for the reference on this OP-900.
-
-
-
-
- Specifies the usage and identification of customer supplied images to be used on this document.
-
-
-
-
- Data field to be used when a name is to be printed in the document instead of (or in addition to) a signature image.
-
-
-
-
-
-
-
-
- Position of operational instruction element.
-
-
-
-
- Content corresponding to the operational instruction.
-
-
-
-
-
-
- The oversize class types.
-
-
-
-
-
-
-
-
-
- Each instance of this data type represents the set of barcodes (of all types) which are associated with a specific package.
-
-
-
-
- Binary-style barcodes for this package.
-
-
-
-
- String-style barcodes for this package.
-
-
-
-
-
-
- Package-level data required for labeling and/or movement.
-
-
-
-
- Human-readable text for pre-January 2011 clients.
-
-
-
-
- Human-readable content for use on a label.
-
-
-
-
- The operational barcodes pertaining to the current package.
-
-
-
-
- The FedEx internal code that represents the service and/or features of service for the current package moving under a FedEx Ground service.
-
-
-
-
-
-
- Data for a package's rates, as calculated per a specific rate type.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- The weight that was used to calculate the rate.
-
-
-
-
- The dimensional weight of this package (if greater than actual).
-
-
-
-
- The oversize weight of this package (if the package is oversize).
-
-
-
-
- The transportation charge only (prior to any discounts applied) for this package.
-
-
-
-
- The sum of all discounts on this package.
-
-
-
-
- This package's baseCharge - totalFreightDiscounts.
-
-
-
-
- The sum of all surcharges on this package.
-
-
-
-
- This package's netFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- The sum of all taxes on this package.
-
-
-
-
- This package's netFreight + totalSurcharges + totalTaxes.
-
-
-
-
- The total sum of all rebates applied to this package.
-
-
-
-
- All rate discounts that apply to this package.
-
-
-
-
- All rebates that apply to this package.
-
-
-
-
- All surcharges that apply to this package (either because of characteristics of the package itself, or because it is carrying per-shipment surcharges for the shipment of which it is a part).
-
-
-
-
- All taxes applicable (or distributed to) this package.
-
-
-
-
- The variable handling charges calculated based on the type variable handling charges requested.
-
-
-
-
-
-
- This class groups together for a single package all package-level rate data (across all rate types) as part of the response to a shipping request, which groups shipment-level data together and groups package-level data by package.
-
-
-
-
- This rate type identifies which entry in the following array is considered as presenting the "actual" rates for the package.
-
-
-
-
- The "list" net charge minus "actual" net charge.
-
-
-
-
- Each element of this field provides package-level rate data for a specific rate type.
-
-
-
-
-
-
- Identifies the collection of special service offered by FedEx. BROKER_SELECT_OPTION should be used for Ground shipments only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These special services are available at the package level for some or all service types. If the shipper is requesting a special service which requires additional data, the package special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
-
-
-
-
- The types of all special services requested for the enclosing shipment or package.
-
-
-
-
- For use with FedEx Ground services only; COD must be present in shipment's special services.
-
-
-
-
- Descriptive data required for a FedEx shipment containing dangerous materials. This element is required when SpecialServiceType.DANGEROUS_GOODS or HAZARDOUS_MATERIAL is present in the SpecialServiceTypes collection.
-
-
-
-
- Descriptive data required for a FedEx shipment containing dry ice. This element is required when SpecialServiceType.DRY_ICE is present in the SpecialServiceTypes collection.
-
-
-
-
- The descriptive data required for FedEx signature services. This element is required when SpecialServiceType.SIGNATURE_OPTION is present in the SpecialServiceTypes collection.
-
-
-
-
- The descriptive data required for FedEx Priority Alert service. This element is required when SpecialServiceType.PRIORITY_ALERT is present in the SpecialServiceTypes collection.
-
-
-
-
-
-
-
- Identifies the collection of available FedEx or customer packaging options.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data for a person or company entitiy doing business with FedEx.
-
-
-
-
- Identifies the FedEx account number assigned to the customer.
-
- 12
-
-
-
-
-
-
- Descriptive data identifying the point-of-contact person.
-
-
-
-
- The descriptive data for a physical location.
-
-
-
-
-
-
- The descriptive data for the monetary compensation given to FedEx for services rendered to the customer.
-
-
-
-
- Identifies the method of payment for a service. See PaymentType for list of valid enumerated values.
-
-
-
-
- Descriptive data identifying the party responsible for payment for a service.
-
-
-
-
-
-
- Identifies the method of payment for a service.
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data identifying the party responsible for payment for a service.
-
-
-
-
-
-
-
- This information describes how and when a pending shipment may be accessed for completion.
-
-
-
-
-
-
-
- Specifies the details to be used by the user of the pending shipment
-
-
-
-
- Specifies the role of the user who is trying to access the pending shipment.
-
-
-
-
-
-
-
-
-
- This information describes the kind of pending shipment being requested.
-
-
-
-
- Identifies the type of FedEx pending shipment
-
-
-
-
- Date after which the pending shipment will no longer be available for completion.
-
-
-
-
- Only used with type of EMAIL.
-
-
-
-
-
- These are documents that are recommended to be included with the shipment.
-
-
-
-
- Upload document details provided by the initator of the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the type of service for a pending shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This class describes the pickup characteristics of a shipment (e.g. for use in a tag request).
-
-
-
-
-
-
-
- Identifies the type of Pickup request
-
-
-
-
- Identifies the type of source for Pickup request
-
-
-
-
-
-
- Identifies the type of source for pickup request service.
-
-
-
-
-
-
-
-
- Identifies the type of pickup request service.
-
-
-
-
-
-
-
-
- Identifies the type of pricing used for this shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents a reference identifier printed on Freight bills of lading
-
-
-
-
-
-
-
-
- Identifies a particular reference identifier printed on a Freight bill of lading.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This indicates the highest level of severity of all the notifications returned in this reply
-
-
-
-
- The descriptive data regarding the results of the submitted transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
-
- The reply payload. All of the returned information about this shipment/package.
-
-
-
-
- Empty unless error label behavior is PACKAGE_ERROR_LABELS and one or more errors occured during transaction processing.
-
-
-
-
-
-
- Descriptive data sent to FedEx by a customer in order to ship a package.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Descriptive data about the shipment being sent by the requestor.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data sent to FedEx by a customer in order to ship a package.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Descriptive data about the shipment being sent by the requestor.
-
-
-
-
-
-
- Test for the Commercial Invoice. Note that Sold is not a valid Purpose for a Proforma Invoice.
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates the packaging type of the container used to package radioactive hazardous materials.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Indicates whether packaging type "EXCEPTED" or "EXCEPTED_PACKAGE" is for radioactive material in reportable quantity.
-
-
-
-
-
-
-
-
- Indicates the reason that a dim divisor value was chose.
-
-
-
-
-
-
-
-
-
-
-
- Identifies a discount applied to the shipment.
-
-
-
-
- Identifies the type of discount applied to the shipment.
-
-
-
-
-
- The amount of the discount applied to the shipment.
-
-
-
-
- The percentage of the discount applied to the shipment.
-
-
-
-
-
-
- The type of the discount.
-
-
-
-
-
-
-
-
-
-
-
-
- Selects the value from a set of rate data to which the percentage is applied.
-
-
-
-
-
-
-
-
-
-
- Identifies the type(s) of rates to be returned in the reply.
-
-
-
-
-
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
-
-
- The weight method used to calculate the rate.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
-
-
-
-
- Specifies the kind of identification being used.
-
-
-
-
- Contains the actual ID value, of the type specified above.
-
-
-
-
-
-
- Type of Brazilian taxpayer identifier provided in Recipient/TaxPayerIdentification/Number. For shipments bound for Brazil this overrides the value in Recipient/TaxPayerIdentification/TinType
-
-
-
-
-
-
-
-
-
- Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
-
-
-
-
-
-
-
- Type of documents that are recommended to be included with the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- FOOD_OR_PERISHABLE is required by FDA/BTA; must be true for food/perishable items coming to US or PR from non-US/non-PR origin
-
-
-
-
-
-
-
-
-
-
- Specifies details needed to generate any label artifacts required due to regulatory requirements.
-
-
-
-
-
- Specifies how the customer requested the regulatory label to be generated.
-
-
-
-
-
-
-
-
-
-
-
- Describes the vertical position of an item relative to another item.
-
-
-
-
-
-
-
-
- This class rationalizes RequestedPackage and RequestedPackageSummary from previous interfaces.
-
-
-
-
- Used only with INDIVIDUAL_PACKAGE, as a unique identifier of each requested package.
-
-
-
-
- Used only with PACKAGE_GROUPS, as a unique identifier of each group of identical packages.
-
-
-
-
- Used only with PACKAGE_GROUPS, as a count of packages within a group of identical packages.
-
-
-
-
-
- Specifies the declared value for carriage of the package. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the package. This field is only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for PACKAGE_SUMMARY, in which case totalInsuredValue and packageCount on the shipment will be used to determine this value.
-
-
-
-
- Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for PACKAGE_SUMMARY, in which case total weight and packageCount on the shipment will be used to determine this value.
-
-
-
-
-
- Provides additional detail on how the customer has physically packaged this item. As of June 2009, required for packages moving under international and SmartPost services.
-
-
-
-
- Human-readable text describing the package.
-
-
-
-
- Human-readable text describing the contents of the package to be used for clearance purposes.
-
-
-
-
-
-
- Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS.
-
-
-
-
-
-
- The descriptive data for the shipment being tendered to FedEx.
-
-
-
-
- Identifies the date and time the package is tendered to FedEx. Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local time of the shipment based on the shipper's time zone. The date component must be in the format: YYYY-MM-DD (e.g. 2006-06-26). The time component must be in the format: HH:MM:SS using a 24 hour clock (e.g. 11:00 a.m. is 11:00:00, whereas 5:00 p.m. is 17:00:00). The date and time parts are separated by the letter T (e.g. 2006-06-26T17:00:00). There is also a UTC offset component indicating the number of hours/mainutes from UTC (e.g 2006-06-26T17:00:00-0400 is defined form June 26, 2006 5:00 pm Eastern Time).
-
-
-
-
- Identifies the method by which the package is to be tendered to FedEx. This element does not dispatch a courier for package pickup. See DropoffType for list of valid enumerated values.
-
-
-
-
- Identifies the FedEx service to use in shipping the package. See ServiceType for list of valid enumerated values.
-
-
-
-
- Identifies the packaging used by the requestor for the package. See PackagingType for list of valid enumerated values.
-
-
-
-
- This specifies information related to the manifest associated with the shipment.
-
-
-
-
- Identifies the total weight of the shipment being conveyed to FedEx.This is only applicable to International shipments and should only be used on the first package of a mutiple piece shipment.This value contains 1 explicit decimal position
-
-
-
-
- Specifies the total declared value for carriage of the shipment. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the shipment.
-
-
-
-
- This attribute indicates the currency the caller requests to have used in all returned monetary values (when a choice is possible).
-
-
-
-
- Descriptive data identifying the party responsible for shipping the package. Shipper and Origin should have the same address.
-
-
-
-
- Descriptive data identifying the party receiving the package.
-
-
-
-
- A unique identifier for a recipient location
-
- 10
-
-
-
-
-
- Physical starting address for the shipment, if different from shipper's address.
-
-
-
-
-
- Descriptive data indicating the method and means of payment to FedEx for providing shipping services.
-
-
-
-
- Descriptive data regarding special services requested by the shipper for this shipment. If the shipper is requesting a special service which requires additional data (e.g. COD), the special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object. For example, to request COD, "COD" must be included in the SpecialServiceTypes collection and the CodDetail object must contain the required data.
-
-
-
-
- Details specific to an Express freight shipment.
-
-
-
-
- Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
-
-
-
-
- Used with Ground Home Delivery and Freight.
-
-
-
-
- Details about how to calculate variable handling charges at the shipment level.
-
-
-
-
- Customs clearance data, used for both international and intra-country shipping.
-
-
-
-
- For use in "process tag" transaction.
-
-
-
-
- Specifies the characteristics of a shipment pertaining to SmartPost services.
-
-
-
-
- If true, only the shipper/payor will have visibility of this shipment.
-
-
-
-
- Details about the image format and printer type the label is to returned in.
-
-
-
-
- Contains data used to create additional (non-label) shipping documents.
-
-
-
-
- Specifies whether and what kind of rates the customer wishes to have quoted on this shipment. The reply will also be constrained by other data on the shipment and customer.
-
-
-
-
- Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.
-
-
-
-
- Only used with multiple-transaction shipments, to identify the master package in a multi-piece shipment.
-
-
-
-
- The total number of packages in the entire shipment (even when the shipment spans multiple transactions.)
-
-
-
-
- Specifies data structures that may be re-used multiple times with s single shipment.
-
-
-
-
- One or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics all packages in the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the tracking number of the master associated with the return shipment.
-
-
-
-
-
-
-
- These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
-
-
-
-
-
-
-
-
- Return Email Details
-
-
-
-
- Phone number of the merchant
-
-
-
-
- Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
-
-
-
-
-
-
- The instructions indicating how to print the return instructions( e.g. image type) Specifies characteristics of a shipping document to be produced.
-
-
-
-
-
- Specifies additional customer provided text to be inserted into the return document.
-
-
-
-
-
-
- Information relating to a return shipment.
-
-
-
-
- The type of return shipment that is being requested.
-
-
-
-
- Return Merchant Authorization
-
-
-
-
- Describes specific information about the email label for return shipment.
-
-
-
-
-
-
-
- The type of return shipment that is being requested.
-
-
-
-
-
-
-
-
-
- The "PAYOR..." rates are expressed in the currency identified in the payor's rate table(s). The "RATED..." rates are expressed in the currency of the origin country. Former "...COUNTER..." values have become "...RETAIL..." values, except for PAYOR_COUNTER and RATED_COUNTER, which have been removed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Shipping document type.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
-
-
-
-
- The reason for the return.
-
- 60
-
-
-
-
-
-
-
- Describes the rotation of an item from its default orientation.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies the collection of available FedEx service options.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies data structures that may be re-used multiple times with s single shipment.
-
-
-
-
- Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities.
-
-
-
-
-
-
- Shipment-level totals of dry ice data across all packages.
-
-
-
-
- Total number of packages in the shipment that contain dry ice.
-
-
-
-
- Total shipment dry ice weight for all packages.
-
-
-
-
-
-
- Data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
-
-
-
-
- Human-readable text describing the shipment leg.
-
-
-
-
- Origin for this leg.
-
-
-
-
- Specifies the location id the origin of shipment leg.
-
-
-
-
- Destination for this leg.
-
-
-
-
- Specifies the location id the destination of shipment leg.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates the rate scale used.
-
-
-
-
- Indicates the rate zone used (based on origin and destination).
-
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- Specifies the currency exchange performed on financial amounts for this rate.
-
-
-
-
- Indicates which special rating cases applied to this shipment.
-
-
-
-
-
- Identifies the type of dim divisor that was applied.
-
-
-
-
-
-
- Sum of dimensional weights for all packages.
-
-
-
-
-
-
-
-
- This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- Total of the transportation-based taxes.
-
-
-
-
-
-
- Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
-
-
-
-
- This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
-
-
-
-
- Rate data specific to FedEx Freight and FedEx National Freight services.
-
-
-
-
- All rate discounts that apply to this shipment.
-
-
-
-
- All rebates that apply to this shipment.
-
-
-
-
- All surcharges that apply to this shipment.
-
-
-
-
- All transportation-based taxes applicable to this shipment.
-
-
-
-
- All commodity-based duties and taxes applicable to this shipment.
-
-
-
-
- The "order level" variable handling charges.
-
-
-
-
- The total of all variable handling charges at both shipment (order) and package level.
-
-
-
-
-
-
-
-
- This identifies which customer reference field contains the manifest ID.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- This is the state of the destination location ID, and is not necessarily the same as the postal state.
-
-
-
-
- Expected/estimated date of delivery.
-
-
-
-
- Expected/estimated day of week of delivery.
-
-
-
-
- Delivery time, as published in Service Guide.
-
-
-
-
- Committed date of delivery.
-
-
-
-
- Committed day of week of delivery.
-
-
-
-
- Standard transit time per origin, destination, and service.
-
-
-
-
- Maximum expected transit time
-
-
-
-
- Transit time based on customer eligibility.
-
-
-
-
- Indicates that this shipment is not eligible for money back guarantee.
-
-
-
-
- FedEx Ground delivery features for which this shipment may be eligible.
-
-
-
-
- Text describing planned delivery.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data for a shipment's total/summary rates, as calculated per a specific rate type. The "total..." fields may differ from the sum of corresponding package data for Multiweight or Express MPS.
-
-
-
-
- Type used for this specific set of rate data.
-
-
-
-
- Indicates the rate scale used.
-
-
-
-
- Indicates the rate zone used (based on origin and destination).
-
-
-
-
- Identifies the type of pricing used for this shipment.
-
-
-
-
- Indicates which weight was used.
-
-
-
-
- INTERNAL FEDEX USE ONLY.
-
-
-
-
- Specifies the currency exchange performed on financial amounts for this rate.
-
-
-
-
- Indicates which special rating cases applied to this shipment.
-
-
-
-
- The value used to calculate the weight based on the dimensions.
-
-
-
-
- Identifies the type of dim divisor that was applied.
-
-
-
-
- Specifies a fuel surcharge percentage.
-
-
-
-
- The weight used to calculate these rates.
-
-
-
-
- Sum of dimensional weights for all packages.
-
-
-
-
- The total freight charge that was calculated for this package before surcharges, discounts and taxes.
-
-
-
-
- The total discounts used in the rate calculation.
-
-
-
-
- The freight charge minus discounts.
-
-
-
-
- The total amount of all surcharges applied to this shipment.
-
-
-
-
- This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
-
-
-
-
- Total of the transportation-based taxes.
-
-
-
-
- The net charge after applying all discounts and surcharges.
-
-
-
-
- The total sum of all rebates applied to this shipment.
-
-
-
-
- Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
-
-
-
-
- This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
-
-
-
-
- Identifies the Rate Details per each leg in a Freight Shipment
-
-
-
-
- Rate data specific to FedEx Freight and FedEx National Freight services.
-
-
-
-
- All rate discounts that apply to this shipment.
-
-
-
-
- All rebates that apply to this shipment.
-
-
-
-
- All surcharges that apply to this shipment.
-
-
-
-
- All transportation-based taxes applicable to this shipment.
-
-
-
-
- All commodity-based duties and taxes applicable to this shipment.
-
-
-
-
- The "order level" variable handling charges.
-
-
-
-
- The total of all variable handling charges at both shipment (order) and package level.
-
-
-
-
-
-
- This class groups together all shipment-level rate data (across all rate types) as part of the response to a shipping request, which groups shipment-level data together and groups package-level data by package.
-
-
-
-
- This rate type identifies which entry in the following array is considered as presenting the "actual" rates for the shipment.
-
-
-
-
- The "list" total net charge minus "actual" total net charge.
-
-
-
-
- Each element of this field provides shipment-level rate totals for a specific rate type.
-
-
-
-
-
-
-
-
- This indicates the highest level of severity of all the notifications returned in this reply
-
-
-
-
- The descriptive data regarding the results of the submitted transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
-
-
- Identifies the collection of special service offered by FedEx. BROKER_SELECT_OPTION should be used for Express shipments only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
-
-
-
-
- The types of all special services requested for the enclosing shipment (or other shipment-level transaction).
-
-
-
-
- Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment. This element is required when SpecialServiceType.COD is present in the SpecialServiceTypes collection.
-
-
-
-
-
- Descriptive data required for a FedEx shipment that is to be held at the destination FedEx location for pickup by the recipient. This element is required when SpecialServiceType.HOLD_AT_LOCATION is present in the SpecialServiceTypes collection.
-
-
-
-
- Descriptive data required for FedEx to provide email notification to the customer regarding the shipment. This element is required when SpecialServiceType.EMAIL_NOTIFICATION is present in the SpecialServiceTypes collection.
-
-
-
-
- The descriptive data required for FedEx Printed Return Label. This element is required when SpecialServiceType.PRINTED_RETURN_LABEL is present in the SpecialServiceTypes collection
-
-
-
-
- This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
-
-
-
-
-
-
- Number of packages in this shipment which contain dry ice and the total weight of the dry ice for this shipment.
-
-
-
-
- The descriptive data required for FedEx Home Delivery options. This element is required when SpecialServiceType.HOME_DELIVERY_PREMIUM is present in the SpecialServiceTypes collection
-
-
-
-
-
- Electronic Trade document references.
-
-
-
-
- Specification for date or range of dates on which delivery is to be attempted.
-
-
-
-
-
-
- All package-level shipping documents (other than labels and barcodes).
-
-
-
-
- Shipping Document Type
-
-
-
-
- The localizations are populated if multiple language versions of a shipping document are returned.
-
-
-
-
- Specifies how this document image/file is organized.
-
-
-
-
-
- The name under which a STORED, DEFERRED or EMAILED document is written.
-
-
-
-
- Specifies the image type of this shipping document.
-
-
-
-
- Specifies the image resolution in DPI (dots per inch).
-
-
-
-
- Can be zero for documents whose disposition implies that no content is included.
-
-
-
-
- One or more document parts which make up a single logical document, such as multiple pages of a single form.
-
-
-
-
-
-
- Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
-
-
-
-
- Values in this field specify how to create and return the document.
-
-
-
-
- Specifies how to organize all documents of this type.
-
-
-
-
- Specifies how to e-mail document images.
-
-
-
-
- Specifies how a queued document is to be printed.
-
-
-
-
-
-
- Specifies how to return a shipping document to the caller.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies how to e-mail shipping documents.
-
-
-
-
- Provides the roles and email addresses for e-mail recipients.
-
-
-
-
- Identifies the convention by which documents are to be grouped as e-mail attachments.
-
-
-
-
- Specifies the language in which the email containing the document is requested to be composed.
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies an individual recipient of e-mailed shipping document(s).
-
-
-
-
- Identifies the relationship of this recipient in the shipment.
-
-
-
-
- Address to which the document is to be sent.
-
-
-
-
-
-
- Specifies characteristics of a shipping document to be produced.
-
-
-
-
- Specifies how to create, organize, and return the document.
-
-
-
-
- Specifies how far down the page to move the beginning of the image; allows for printing on letterhead and other pre-printed stock.
-
-
-
-
-
-
- For those shipping document types which have both a "form" and "instructions" component (e.g. NAFTA Certificate of Origin and General Agency Agreement), this field indicates whether to provide the instructions.
-
-
-
-
-
- Governs the language to be used for this individual document, independently from other content returned for the same shipment.
-
-
-
-
- Identifies the individual document specified by the client.
-
-
-
-
-
-
- Specifies how to organize all shipping documents of the same type.
-
-
-
-
-
-
-
-
- Specifies the image format used for a shipping document.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- A single part of a shipping document, such as one page of a multiple-page document whose format requires a separate image per page.
-
-
-
-
- The one-origin position of this part within a document.
-
-
-
-
- Graphic or printer commands for this image within a document.
-
-
-
-
-
-
- Specifies printing options for a shipping document.
-
-
-
-
- Provides environment-specific printer identification.
-
-
-
-
-
-
- Contains all data required for additional (non-label) shipping documents to be produced in conjunction with a specific shipment.
-
-
-
-
- Indicates the types of shipping documents requested by the shipper.
-
-
-
-
-
-
- Specifies the production of each package-level custom document (the same specification is used for all packages).
-
-
-
-
- Specifies the production of a shipment-level custom document.
-
-
-
-
-
- This element is currently not supported and is for the future use. (Details pertaining to the GAA.)
-
-
-
-
-
- Specifies the production of the OP-900 document for hazardous materials packages.
-
-
-
-
- Specifies the production of the 1421c document for dangerous goods shipment.
-
-
-
-
- Specifies the production of the OP-900 document for hazardous materials.
-
-
-
-
- Specifies the production of the return instructions document.
-
-
-
-
-
-
- Specifies the type of paper (stock) on which a document will be printed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data required for FedEx delivery signature services.
-
-
-
-
- Identifies the delivery signature services option selected by the customer for this shipment. See OptionType for the list of valid values.
-
-
-
-
- Identifies the delivery signature release authorization number.
-
- 10
-
-
-
-
-
-
-
- Identifies the delivery signature services options offered by FedEx.
-
-
-
-
-
-
-
-
-
-
-
- These values are mutually exclusive; at most one of them can be attached to a SmartPost shipment.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Data required for shipments handled under the SMART_POST and GROUND_SMART_POST service types.
-
-
-
-
-
-
-
-
-
- The CustomerManifestId is used to group Smart Post packages onto a manifest for each trailer that is being prepared. If you do not have multiple trailers this field can be omitted. If you have multiple trailers, you
- must assign the same Manifest Id to each SmartPost package as determined by its trailer. In other words, all packages on a trailer must have the same Customer Manifest Id. The manifest Id must be unique to your account number for a minimum of 6 months
- and cannot exceed 8 characters in length. We recommend you use the day of year + the trailer id (this could simply be a sequential number for that trailer). So if you had 3 trailers that you started loading on Feb 10
- the 3 manifest ids would be 041001, 041002, 041003 (in this case we used leading zeros on the trailer numbers).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Special circumstance rating used for this shipment.
-
-
-
-
-
-
-
-
-
- Each instance of this data type represents a barcode whose content must be represented as ASCII text (i.e. not binary data).
-
-
-
-
- The kind of barcode data in this instance.
-
-
-
-
- The data content of this instance.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies each surcharge applied to the shipment.
-
-
-
-
- The type of surcharge applied to the shipment.
-
-
-
-
-
-
- The amount of the surcharge applied to the shipment.
-
-
-
-
-
-
-
-
-
-
-
-
- The type of the surcharge.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Identifies each tax applied to the shipment.
-
-
-
-
- The type of tax applied to the shipment.
-
-
-
-
-
- The amount of the tax applied to the shipment.
-
-
-
-
-
-
- The type of the tax.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifice the kind of tax or miscellaneous charge being reported on a Commercial Invoice.
-
-
-
-
-
-
-
-
-
-
-
-
- The descriptive data for taxpayer identification information.
-
-
-
-
- Identifies the category of the taxpayer identification number. See TinType for the list of values.
-
-
-
-
- Identifies the taxpayer identification number.
-
- 15
-
-
-
-
-
- Identifies the usage of Tax Identification Number in Shipment processing
-
-
-
-
-
-
-
-
- Identifies the category of the taxpayer identification number.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- For use with SmartPost tracking IDs only
-
-
-
-
-
-
-
- TrackingIdType
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Free form text to be echoed back in the reply. Used to match requests and replies.
-
-
-
-
- Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
-
-
-
-
-
-
- Identifies the set of valid shipment transit time values.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Specifies the application that is responsible for managing the document id.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Description of the uploaded document.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Descriptive data sent to FedEx by a customer in order to validate a shipment.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Descriptive data for this customer transaction. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Descriptive data about the shipment being sent by the requestor.
-
-
-
-
-
-
- Documents the kind and quantity of an individual hazardous commodity in a package.
-
-
-
-
- Identifies and describes an individual hazardous commodity.
-
-
-
-
- Specifies the amount of the commodity in alternate units.
-
-
-
-
- The mass points are a calculation used by ADR regulations for measuring the risk of a particular hazardous commodity.
-
-
-
-
- Customer-provided specifications for handling individual commodities.
-
-
-
-
- The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
-
-
-
-
-
-
- Identifies and describes an individual hazardous commodity. For 201001 load, this is based on data from the FedEx Ground Hazardous Materials Shipping Guide.
-
-
-
-
- Regulatory identifier for a commodity (e.g. "UN ID" value).
-
-
-
-
- In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
-
-
-
-
-
-
-
- Fully-expanded descriptive text for a hazardous commodity.
-
-
-
-
-
-
-
- Coded indications for special requirements or constraints.
-
-
-
-
-
-
-
-
-
-
-
- Specifies the concept of a container used to package dangerous goods commodities.
-
-
-
-
- Indicates that the quantity of the dangerous goods packaged is permissible for shipping. This is used to ensure that the dangerous goods commodities do not exceed the net quantity per package restrictions.
-
-
-
-
- Documents the kinds and quantities of all hazardous commodities in the current package.
-
-
-
-
-
-
- This definition of variable handling charge detail is intended for use in Jan 2011 corp load.
-
-
-
-
-
- Used with Variable handling charge type of FIXED_VALUE.
- Contains the amount to be added to the freight charge.
- Contains 2 explicit decimal positions with a total max length of 10 including the decimal.
-
-
-
-
-
- Actual percentage (10 means 10%, which is a mutiplier of 0.1)
-
-
-
-
- Select the value from a set of rate data to which the percentage is applied.
-
-
-
-
- Select the type of rate from which the element is to be selected.
-
-
-
-
-
-
- The variable handling charges calculated based on the type variable handling charges requested.
-
-
-
-
- The variable handling charge amount calculated based on the requested variable handling charge detail.
-
-
-
-
-
-
- The calculated varibale handling charge plus the net charge.
-
-
-
-
-
-
- Three-dimensional volume/cubic measurement.
-
-
-
-
-
-
-
-
- Units of three-dimensional volume/cubic measure.
-
-
-
-
-
-
-
-
- The descriptive data for the heaviness of an object.
-
-
-
-
- Identifies the unit of measure associated with a weight value.
-
-
-
-
- Identifies the weight value of a package/shipment.
-
-
-
-
-
-
- Identifies the unit of measure associated with a weight value. See the list of enumerated types for valid values.
-
-
-
-
-
-
-
-
- Used in authentication of the sender's identity.
-
-
-
-
- This was renamed from cspCredential.
-
-
-
-
- Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
-
-
-
-
-
-
- Two part authentication string used for the sender's identity
-
-
-
-
- Identifying part of authentication credential. This value is provided by FedEx after registration
-
-
-
-
- Secret part of authentication key. This value is provided by FedEx after registration.
-
-
-
-
-
-
- Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
-
-
-
-
- Identifies a system or sub-system which performs an operation.
-
-
-
-
- Identifies the service business level.
-
-
-
-
- Identifies the service interface level.
-
-
-
-
- Identifies the service code level.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the role that identifies the permissions the accessor of the pending shipment.
+
+
+
+
+
+
+
+
+ Specifies additional labels to be produced. All required labels for shipments will be produced without the need to request additional labels. These are only available as thermal labels.
+
+
+
+
+ The type of additional labels to return.
+
+
+
+
+ The number of this type label to return
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Combination of number, street name, etc. At least one line is required for a valid physical address; empty lines should not be included.
+
+
+
+
+ Name of city, town, etc.
+
+
+
+
+ Identifying abbreviation for US state, Canada province, etc. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ Relevant only to addresses in Puerto Rico.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The fully spelt out name of a country.
+
+
+
+
+ Indicates whether this address residential (as opposed to commercial).
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Specifies the details around the ADR license required for shipping.
+
+
+
+
+
+
+
+ Specifies details for a package containing alcohol
+
+
+
+
+ The license type that the recipient of the alcohol package.
+
+
+
+
+
+
+ Specifies the type of license that the recipient of the alcohol shipment has.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration represents a kind of "legacy" account number from a FedEx operating entity.
+
+
+
+
+
+
+
+
+
+
+
+
+ A freight line item identifier referring to a freight shipment line item that describes goods contained within this handling unit.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking id for the payment on the return.
+
+
+
+
+ Specifies additional customer reference data about the associated shipment.
+
+
+
+
+ Specifies shipment level operational information.
+
+
+
+
+ Specifies package level operational information on the associated shipment. This information is not tied to an individual outbound package.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identification of the type of barcode (symbology) used on FedEx documents and labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes attributes of a battery or cell that are used for classification purposes. Typically this structure would be used to allow customers to declare batteries or cells for which full dangerous goods documentation and procedures are not required.
+
+
+
+
+ Describes the material composition of the battery or cell.
+
+
+
+
+ Describes the packing arrangement of the battery or cell with respect to other items within the same package.
+
+
+
+
+ A regulation specific classification for the battery or cell.
+
+
+
+
+
+
+ Describes the material composition of a battery or cell.
+
+
+
+
+
+
+
+
+
+ Describes the packing arrangement of a battery or cell with respect to other items within the same package.
+
+
+
+
+
+
+
+
+
+ A regulation specific classification for a battery or cell.
+
+
+
+
+
+
+
+ Each instance of this data type represents a barcode whose content must be represented as binary data (i.e. not ASCII text).
+
+
+
+
+ The kind of barcode data in this instance.
+
+
+
+
+ The data content of this instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the Certificate of Origin ( e.g. whether or not to include the instructions, image type, etc ...)
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the type of brokerage to be applied to a shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ The FedEx Ground account number.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+ FedEx internal use only.
+
+
+
+
+
+ FedEx internal use only. The PassKey company identifier.
+
+
+
+
+ Client software component (e.g. "CAFE", "INET", "WBUS", etc.)
+
+
+
+
+ Client software component version/revision (e.g. "1800", "2630", etc.)
+
+
+
+
+ A FedEx assigned identifier for a third party software product used by customer to do business with FedEx. Such as a Compatible Solution Provider's product.
+
+
+
+
+ The version of the third party product.
+
+
+
+
+ FedEx internal use only.
+
+
+
+
+ FedEx internal use only.
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ Indicates the region from which the transaction is submitted.
+
+
+
+
+ Used for off-line uploads only.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+ Specifies the type of adjustment was performed to the COD collection amount during rating.
+
+
+
+
+
+
+
+
+ Identifies the type of funds FedEx should collect upon shipment delivery.
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
+
+
+
+
+
+ Specifies the details of the charges are to be added to the COD collect amount.
+
+
+
+
+ Identifies the type of funds FedEx should collect upon package delivery
+
+
+
+
+ For Express this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground this is the descriptive data for the party to receive the payment that prints the COD receipt.
+
+
+
+
+ When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD.
+
+
+
+
+ Specifies the name of person or company receiving the secured/unsecured funds payment
+
+
+
+
+ Indicates which type of reference information to include on the COD return shipping label.
+
+
+
+
+ Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only.
+
+
+
+
+
+
+ Specifies the information associated with a package that has COD special service in a ground shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through the FedEx Systems. Customers are responsible for printing their own Commercial Invoice.If you would likeFedEx to generate a Commercial Invoice and transmit it to Customs. for clearance purposes, you need to specify that in the ShippingDocumentSpecification element. If you would like a copy of the Commercial Invoice that FedEx generated returned to you in reply it needs to be specified in the ETDDetail/RequestedDocumentCopies element. Commercial Invoice support consists of maximum of 99 commodity line items.
+
+
+
+
+ Any comments that need to be communicated about this shipment.
+
+
+
+
+ Any freight charges that are associated with this shipment.
+
+
+
+
+ Any taxes or miscellaneous charges(other than Freight charges or Insurance charges) that are associated with this shipment.
+
+
+
+
+ Specifies which kind of charge is being recorded in the preceding field.
+
+
+
+
+ Any packing costs that are associated with this shipment.
+
+
+
+
+ Any handling costs that are associated with this shipment.
+
+
+
+
+ Free-form text.
+
+
+
+
+ Free-form text.
+
+
+
+
+ Free-form text.
+
+
+
+
+ The reason for the shipment. Note: SOLD is not a valid purpose for a Proforma Invoice.
+
+
+
+
+ Not exposed to Web Services customers; only present for use in mapping from CTS transactions.
+
+
+
+
+ Additional customer reference data.
+
+
+
+
+ Name of the International Expert that completed the Commercial Invoice different from Sender.
+
+
+
+
+ Required for dutiable international Express or Ground shipments. This field is not applicable to an international PIB(document) or a non-document which does not require a Commercial Invoice.
+
+
+
+
+
+
+ The instructions indicating how to print the Commercial Invoice( e.g. image type) Specifies characteristics of a shipping document to be produced.
+
+
+
+
+
+ Specifies the usage and identification of a customer supplied image to be used on this document.
+
+
+
+
+
+
+
+
+
+ Value used to identify a commodity description; must be unique within the containing shipment.
+
+
+
+
+ FedEx internal commodity identifier
+
+
+
+
+
+ A free-form description of the commodity, which could be used for customs clearance documentation.
+
+
+
+
+
+
+
+
+
+
+ Contains only additional quantitative information other than weight and quantity to calculate duties and taxes.
+
+
+
+
+
+ The value of the commodity for customs purposes. The field should be the unit price multiplied by the quantity.
+
+
+
+
+ Defines additional characteristic of commodity used to calculate duties and taxes
+
+
+
+
+
+
+
+
+ All data required for this commodity in NAFTA Certificate of Origin.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the results of processing for the COD special service.
+
+
+
+
+
+
+
+
+
+
+ The identifier for all clearance documents associated with this shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Completed package-level hazardous commodity information for a single package.
+
+
+
+
+ A unique reference id that matches the package to a package configuration. This is populated if the client provided a package configuration for several packages that have the exact same dangerous goods content.
+
+
+
+
+
+ When true indicates that the package can be transported only on a cargo aircraft.
+
+
+
+
+
+ Specifies the maximum radiation level from the package (measured in microSieverts per hour at a distance of one meter from the external surface of the package, divided by 10).
+
+
+
+
+ Specifies the label that is to be put on a package containing radioactive material. The label type is determined in accordance with the Transportation of Dangerous Goods Act and indicates the type of radioactive material being handled as well as the relative risk.
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current package.
+
+
+
+
+
+
+ Computed shipment level hazardous commodity information.
+
+
+
+
+
+
+ This contains the ADR License information, which identifies the license number and ADR category under which the customer is allowed to ship.
+
+
+
+
+
+
+
+
+ Specifies the total number of packages containing hazardous commodities in small exceptions.
+
+
+
+
+
+
+
+
+ Identifies the branded location name, the hold at location phone number and the address of the location.
+
+
+
+
+ Identifies the type of FedEx location.
+
+
+
+
+
+
+
+
+
+
+
+ An identifier of each group of identical packages.
+
+
+
+
+
+ All package-level rating data for this package, which may include data for multiple rate types.
+
+
+
+
+
+
+
+ All package-level shipping documents (other than labels and barcodes). For use in loads after January, 2008.
+
+
+
+
+ Specifies the information associated with this package that has COD special service in a ground shipment.
+
+
+
+
+ Actual signature option applied, to allow for cases in which the original value conflicted with other service features in the shipment.
+
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current package, using updated hazardous commodity description data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Only used with pending shipments.
+
+
+
+
+ Only used in the reply to tag requests.
+
+
+
+
+
+ Computed shipment level information about hazarous commodities.
+
+
+
+
+ All shipment-level rating data for this shipment, which may include data for multiple rate types.
+
+
+
+
+ Returns the default holding location information when HOLD_AT_LOCATION special service is requested and the client does not specify the hold location address.
+
+
+
+
+ Returns any defaults or updates applied to RequestedShipment.exportDetail.exportComplianceStatement.
+
+
+
+
+ This specifies what rules or requirements for documents are applicable for this shipment. This may identify required or prohibited documents.
+
+
+
+
+
+ All shipment-level shipping documents (other than labels and barcodes).
+
+
+
+
+
+
+
+
+
+ Provides reply information specific to SmartPost shipments.
+
+
+
+
+ Identifies the carrier that will pick up the SmartPost shipment.
+
+
+
+
+ Indicates whether the shipment is deemed to be machineable, based on dimensions, weight, and packaging.
+
+
+
+
+
+
+ Provides reply information specific to a tag request.
+
+
+
+
+
+ As of June 2007, returned only for FedEx Express services.
+
+
+
+
+ As of June 2007, returned only for FedEx Express services.
+
+
+
+
+ As of June 2007, returned only for FedEx Express services.
+
+
+
+
+ As of June 2007, returned only for FedEx Express services.
+
+
+
+
+ FEDEX INTERNAL USE ONLY: for use by INET.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The descriptive data for a point-of-contact person.
+
+
+
+
+ Client provided identifier corresponding to this contact information.
+
+
+
+
+ Identifies the contact person's name.
+
+
+
+
+ Identifies the contact person's title.
+
+
+
+
+ Identifies the company this contact is associated with.
+
+
+
+
+ Identifies the phone number associated with this contact.
+
+
+
+
+ Identifies the phone extension associated with this contact.
+
+
+
+
+ Identifies a toll free number, if any, associated with this contact.
+
+
+
+
+ Identifies the pager number associated with this contact.
+
+
+
+
+ Identifies the fax number associated with this contact.
+
+
+
+
+ Identifies the email address associated with this contact.
+
+
+
+
+
+
+
+
+
+
+
+
+ Details the contents of the package.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Must be in one of the following formats: YYMM, YYYYMM, or YYYYMMDD.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies details about the credit card transaction that drive decisions about credit card processing.
+
+
+
+
+
+
+
+ This class represents data tied to the use of a credit card in a specific transaction.
+
+
+
+
+
+
+
+ Specifies details about the credit card transaction that drive decisions about credit card processing.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This class is a rename of the previous VerifyCreditFraudDetail; the name change reflects the fact that it is no longer tied to a "verify" usage.
+
+
+
+
+
+
+
+
+
+
+ The currency code for the original (converted FROM) currency.
+
+
+
+
+ The currency code for the final (converted INTO) currency.
+
+
+
+
+ Multiplier used to convert fromCurrency units to intoCurrency units.
+
+
+
+
+
+
+
+
+ Indicates the type of custom delivery being requested.
+
+
+
+
+ Time by which delivery is requested.
+
+
+
+
+ Range of dates for custom delivery request; only used if type is BETWEEN.
+
+
+
+
+ Date for custom delivery request; only used for types of ON, BETWEEN, or AFTER.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Types of discounts that are excluded.
+
+
+
+
+
+
+ Data required to produce a custom-specified document, either at shipment or package level.
+
+
+
+
+ Common information controlling document production.
+
+
+
+
+ Applicable only to documents produced on thermal printers with roll stock.
+
+
+
+
+ Applicable only to documents produced on thermal printers with roll stock.
+
+
+
+
+ Identifies the formatting specification used to construct this custom document.
+
+
+
+
+ Identifies the individual document specified by the client.
+
+
+
+
+ If provided, thermal documents will include specified doc tab content. If omitted, document will be produced without doc tab content.
+
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified barcode symbology.
+
+
+
+
+
+
+
+
+ Width of thinnest bar/space element in the barcode.
+
+
+
+
+
+
+
+ Solid (filled) rectangular area on label.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Image to be included from printer's memory, or from a local file for offline clients.
+
+
+
+
+
+ Printer-specific index of graphic image to be printed.
+
+
+
+
+ Fully-qualified path and file name for graphic image to be printed.
+
+
+
+
+
+
+
+
+ Horizontal position, relative to left edge of custom area.
+
+
+
+
+ Vertical position, relative to top edge of custom area.
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
+
+
+
+
+
+
+
+
+
+ Printer-specific font name for use with thermal printer labels.
+
+
+
+
+ Generic font name for use with plain paper labels.
+
+
+
+
+ Generic font size for use with plain paper labels.
+
+
+
+
+
+
+
+ Constructed string, based on format and zero or more data fields, printed in specified printer font (for thermal labels) or generic font/size (for plain paper labels).
+
+
+
+
+
+
+
+ Printer-specific font name for use with thermal printer labels.
+
+
+
+
+ Generic font name for use with plain paper labels.
+
+
+
+
+ Generic font size for use with plain paper labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies custom transit time to be applied to the shipment.
+
+
+
+
+ Identifies options to be applied.
+
+
+
+
+
+
+
+
+
+
+ Internal Id used by INET to identify customer provided images during documents generation. Ex COO etc ...
+
+
+
+
+ Internal image type used by INET to identify customer provided images during documents generation. Ex COO etc ..
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Allows customer-specified control of label content.
+
+
+
+
+ If omitted, no doc tab will be produced (i.e. default is former NONE type).
+
+
+
+
+ Controls the position of the customer specified content relative to the FedEx portion.
+
+
+
+
+
+
+ Controls which data/sections will be suppressed.
+
+
+
+
+ For customers producing their own Ground labels, this field specifies which secondary barcode will be printed on the label; so that the primary barcode produced by FedEx has the correct SCNC.
+
+
+
+
+
+
+ Controls the number of additional copies of supplemental labels.
+
+
+
+
+ This value reduces the default quantity of destination/consignee air waybill labels. A value of zero indicates no change to default. A minimum of one copy will always be produced.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interacts both with properties of the shipment and contractual relationship with the shipper.
+
+
+
+
+
+
+ Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
+
+
+
+
+
+
+ This represents the total commodity value of the shipment plus the charges required by the destination country.
+
+
+
+
+ Identifies responsibilities with respect to loss, damage, etc.
+
+
+
+
+ Documents amount paid to third party for coverage of shipment content.
+
+
+
+
+
+
+
+
+
+
+
+
+ This provides the information necessary to identify the different statements, declarations, acts, and/or certifications that apply to this shipment.
+
+
+
+
+ This indicates the different statements, declarations, acts, and/or certifications that apply to this shipment.
+
+
+
+
+ Specifies the NAFTA low value statement information.
+
+
+
+
+
+
+ This indicates the different statements, declarations, acts, and certifications that may apply to a shipment.
+
+
+
+
+
+
+
+
+
+
+ Specifies additional description about customs options. This is a required field when the customs options type is "OTHER".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Describes an approved container used to package dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container.
+
+
+
+
+ Indicates whether there are additional inner receptacles within this container.
+
+
+
+
+ Indicates the type of this dangerous goods container, as specified by the IATA packing instructions. For example, steel cylinder, fiberboard box, plastic jerrican and steel drum.
+
+
+
+
+ Indicates the packaging type of the container used to package the radioactive materials.
+
+
+
+
+ Indicates the number of occurrences of this container with identical dangerous goods configuration.
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current container.
+
+
+
+
+
+
+
+
+ This field is used to identify an instance of an uploaded dangerous goods handling unit.
+
+
+
+
+
+
+ Shipment is packaged/documented for movement ONLY on cargo aircraft.
+
+
+
+
+ Indicates which kinds of hazardous content are in the current package.
+
+
+
+
+ Indicates whether there is additional customer provided packaging enclosing the approved dangerous goods containers.
+
+
+
+
+ Identifies the configuration of this dangerous goods package. The common configuration is represented at the shipment level.
+
+
+
+
+ Indicates one or more containers used to pack dangerous goods commodities.
+
+
+
+
+ Description of the packaging of this commodity, suitable for use on OP-900 and OP-950 forms.
+
+
+
+
+ Name, title and place of the signatory for this shipment.
+
+
+
+
+ Telephone number to use for contact in the event of an emergency.
+
+
+
+
+ Offeror's name or contract number, per DOT regulation.
+
+
+
+
+ Specifies the contact of the party responsible for handling the infectious substances, if any, in the dangerous goods shipment.
+
+
+
+
+ Specifies additional handling information for the current package.
+
+
+
+
+ Specifies the radioactivity detail for the current package, if the package contains radioactive materials.
+
+
+
+
+
+
+
+
+
+
+
+ The instructions indicating how to print the 1421c form for dangerous goods shipment.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+ Specifies that name, title and place of the signatory responsible for the dangerous goods shipment.
+
+
+
+
+
+
+ Indicates the place where the form is signed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+ Only used for tags which had FedEx Express services.
+
+
+
+
+ Only used for tags which had FedEx Express services.
+
+
+
+
+ If the original ProcessTagRequest specified third-party payment, then the delete request must contain the same pay type and payor account number for security purposes.
+
+
+
+
+
+
+
+ Specifies the type of deletion to be performed on a shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking id for the return, if preassigned.
+
+
+
+
+
+
+ Data required to complete the Destionation Control Statement for US exports.
+
+
+
+
+
+ Comma-separated list of up to four country codes, required for DEPARTMENT_OF_STATE statement.
+
+
+
+
+ Name of end user, required for DEPARTMENT_OF_STATE statement.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifications for pup/set or vehicle delayed for loading or unloading.
+
+
+
+
+ Amount of time involved in the detention.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Lists the documents that are not accepted by FedEx for this shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the name associated with the email address.
+
+
+
+
+
+
+
+
+ Content of the email message.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Information describing the address of of the email recipient, role of the email recipient and languages that are requested to be supported.
+
+
+
+
+ EMail address of the recipient.
+
+
+
+
+ The relationship that the customer has to the pending shipment.
+
+
+
+
+ Specifies how the email notification for the pending shipment need to be processed.
+
+
+
+
+ Localization and language details specified by the recipient of the EMail.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Customer-declared value, with data type and legal values depending on excise condition, used in defining the taxable value of the item.
+
+
+
+
+
+
+ Specifies the types of Estimated Duties and Taxes to be included in a rate quotation for an international shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to apply the localization detail to the current context.
+
+
+
+
+
+
+
+ This identifies some of the document types recognized by Enterprise Document Management Service.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies whether to confirm documents prior to processing a shipment with the ELECTRONIC_TRADE_DOCUMENTS special service.
+
+
+
+
+
+
+
+
+ Electronic Trade document references used with the ETD special service.
+
+
+
+
+ Specifies client's intent for whether all documents must be confirmed before shipment processing.
+
+
+
+
+
+ Indicates the types of shipping documents produced for the shipper by FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in the shipment result data.
+
+
+
+
+
+
+
+ The instructions indicating how to print the Export Declaration.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+
+
+
+
+
+ General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates a FedEx Express operating region.
+
+
+
+
+
+
+
+
+
+
+
+ Specification for labor time spent handling shipment.
+
+
+
+
+ Total labor time.
+
+
+
+
+
+
+ Identifies a kind of FedEx facility.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the optional features/characteristics requested for a Freight shipment utilizing a flatbed trailer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce the Freight handling-unit-level address labels. Note that the number of UNIQUE labels (the N as in 1 of N, 2 of N, etc.) is determined by total handling units.
+
+
+
+
+
+ Indicates the number of copies to be produced for each unique label.
+
+
+
+
+ Specifies the quadrant of the page on which the label printing will start.
+
+
+
+
+ If omitted, no doc tab will be produced (i.e. default = former NONE type).
+
+
+
+
+ Controls the position of the customer specified content relative to the FedEx portion.
+
+
+
+
+
+
+
+ Individual charge which contributes to the total base charge for the shipment.
+
+
+
+
+ Freight class for this line item.
+
+
+
+
+ Effective freight class used for rating this line item.
+
+
+
+
+ NMFC Code for commodity.
+
+
+
+
+ Customer-provided description for this commodity or class line.
+
+
+
+
+ Weight for this commodity or class line.
+
+
+
+
+ Rate or factor applied to this line item.
+
+
+
+
+ Identifies the manner in which the chargeRate for this line item was applied.
+
+
+
+
+ The net or extended charge for this line item.
+
+
+
+
+
+
+ Specifies the way in which base charges for a Freight shipment or shipment leg are calculated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values represent the industry-standard freight classes used for FedEx Freight and FedEx National Freight shipment description. (Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Date for all Freight guarantee types.
+
+
+
+
+ Time for GUARANTEED_TIME only.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies responsibilities with respect to loss, damage, etc.
+
+
+
+
+
+
+
+
+ Rate data specific to FedEx Freight or FedEx National Freight services.
+
+
+
+
+ A unique identifier for a specific rate quotation.
+
+
+
+
+ Specifies whether the rate quote was automated or manual.
+
+
+
+
+ Specifies how total base charge is determined.
+
+
+
+
+ Freight charges which accumulate to the total base charge for the shipment.
+
+
+
+
+ Human-readable descriptions of additional information on this shipment rating.
+
+
+
+
+
+
+ Additional non-monetary data returned with Freight rates.
+
+
+
+
+ Unique identifier for notation.
+
+
+
+
+ Human-readable explanation of notation.
+
+
+
+
+
+
+ Specifies the type of rate quote
+
+
+
+
+
+
+
+
+ Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
+
+
+
+
+ Account number used with FEDEX_FREIGHT service.
+
+
+
+
+ Used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.
+
+
+
+
+ Used in connection with "Send Bill To" (SBT) identification of customer's account used for billing.
+
+
+
+
+ Identification values to be printed during creation of a Freight bill of lading.
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+ Designates the terms of the "collect" payment for a Freight Shipment.
+
+
+
+
+ Identifies the declared value for the shipment
+
+
+
+
+ Identifies the declared value units corresponding to the above defined declared value
+
+
+
+
+
+ Identifiers for promotional discounts offered to customers.
+
+
+
+
+ Total number of individual handling units in the entire shipment (for unit pricing).
+
+
+
+
+ Estimated discount rate provided by client for unsecured rate quote.
+
+
+
+
+ Total weight of pallets used in shipment.
+
+
+
+
+ Overall shipment dimensions.
+
+
+
+
+ Description for the shipment.
+
+
+
+
+ Specifies which party will pay surcharges for any special services which support split billing.
+
+
+
+
+ Must be populated if any line items contain hazardous materials.
+
+
+
+
+
+ Details of the commodities in the shipment.
+
+
+
+
+
+
+ Description of an individual commodity or class of content in a shipment.
+
+
+
+
+ A unique identifier assigned to this line item.
+
+
+
+
+ Freight class for this line item.
+
+
+
+
+ FEDEX INTERNAL USE ONLY: for FedEx system that estimate freight class from customer-provided dimensions and weight.
+
+
+
+
+ Identifies billing mask, if used to populate this line item.
+
+
+
+
+ Specifies line item level liability coverage.
+
+
+
+
+ Number of individual handling units to which this line applies. (NOTE: Total of line-item-level handling units may not balance to shipment-level total handling units.)
+
+
+
+
+ Specification of handling-unit packaging for this commodity or class line.
+
+
+
+
+ Number of pieces for this commodity or class line.
+
+
+
+
+ NMFC Code for commodity.
+
+
+
+
+ Indicates the kind of hazardous material content in this line item.
+
+
+
+
+ For printed reference per line item.
+
+
+
+
+ Customer-provided description for this commodity or class line.
+
+
+
+
+ Weight for this commodity or class line.
+
+
+
+
+
+ Volume (cubic measure) for this commodity or class line.
+
+
+
+
+
+
+ Indicates the role of the party submitting the transaction.
+
+
+
+
+
+
+
+
+ Specifies which party will be responsible for payment of any surcharges for Freight special services for which split billing is allowed.
+
+
+
+
+ Identifies the special service.
+
+
+
+
+ Indicates who will pay for the special service.
+
+
+
+
+
+
+ Data required to produce a General Agency Agreement document. Remaining content (business data) to be defined once requirements have been completed.
+
+
+
+
+
+
+
+ Represents features of FedEx Ground delivery for which the shipment is eligible.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Documents the kind and quantity of an individual hazardous commodity in a package.
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Specifies the amount of the commodity in alternate units.
+
+
+
+
+ This describes the inner receptacle details for a hazardous commodity within the dangerous goods container.
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ Specifies the details of any radio active materials within the commodity.
+
+
+
+
+ The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
+
+
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Regulatory identifier for a commodity (e.g. "UN ID" value).
+
+
+
+
+ In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates any special processing options to be applied to the description of the dangerous goods commodity.
+
+
+
+
+ Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity.
+
+
+
+
+
+
+ Specifies any special processing to be applied to the dangerous goods commodity description validation.
+
+
+
+
+
+
+
+ This describes information about the inner receptacles for the hazardous commodity in a particular dangerous goods container.
+
+
+
+
+ This specifies the quantity contained in the inner receptacle.
+
+
+
+
+
+
+ Specifies how the commodity is to be labeled.
+
+
+
+
+
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ Specifies how the customer wishes the label text to be handled for this commodity in this package.
+
+
+
+
+ Text used in labeling the commodity under control of the labelTextOption field.
+
+
+
+
+
+
+ Indicates which kind of hazardous content is being reported.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies number and type of packaging units for hazardous commodities.
+
+
+
+
+ Number of units of the type below.
+
+
+
+
+ Units in which the hazardous commodity is packaged.
+
+
+
+
+
+
+ Specifies documentation and limits for validation of an individual packing group/category.
+
+
+
+
+
+ Coded specification for how commodity is to be packed.
+
+
+
+
+
+
+ Identifies DOT packing group for a hazardous commodity.
+
+
+
+
+
+
+
+
+
+
+ Identifies amount and units for quantity of hazardous commodities.
+
+
+
+
+ Number of units of the type below.
+
+
+
+
+ Units by which the hazardous commodity is measured. For IATA commodity, the units values are restricted based on regulation type.
+
+
+
+
+ Specifies which measure of quantity is to be validated.
+
+
+
+
+
+
+ Specifies the measure of quantity to be validated against a prescribed limit.
+
+
+
+
+
+
+
+
+ Identifies the source of regulation for hazardous commodity data.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contact phone number for recipient of shipment.
+
+
+
+
+ Contact and address of FedEx facility at which shipment is to be held.
+
+
+
+
+ Type of facility at which package/shipment is to be held.
+
+
+
+
+ Location identification (for facilities identified by an alphanumeric location code).
+
+
+
+
+ Location identification (for facilities identified by an numeric location code).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Names for data elements / areas which may be suppressed from printing on labels.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the order in which the labels will be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Relative to normal orientation for the printer.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to create, organize, and return the document.
+
+
+
+
+
+
+
+
+
+ Specifies the order in which the labels are requested to be returned
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the Liability Coverage Amount. For Jan 2010 this value represents coverage amount per pound
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ License or Permit Number.
+
+
+
+
+ Specifies the effective date of the license.
+
+
+
+
+ Specifies the expiration date of the license.
+
+
+
+
+
+
+ Represents a one-dimensional measurement in small units (e.g. suitable for measuring a package or document), contrasted with Distance, which represents a large one-dimensional measurement (e.g. distance between cities).
+
+
+
+
+ The numerical quantity of this measurement.
+
+
+
+
+ The units for this measurement.
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ Specification for marking or tagging of pieces in shipment.
+
+
+
+
+ Number of pieces to be marked or tagged by FedEx.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required to produce a Certificate of Origin document. Remaining content (business data) to be defined once requirements have been completed.
+
+
+
+
+
+
+ Indicates which Party (if any) from the shipment is to be used as the source of importer data on the NAFTA COO form.
+
+
+
+
+ Contact information for "Authorized Signature" area of form.
+
+
+
+
+
+
+
+
+
+
+
+ Defined by NAFTA regulations.
+
+
+
+
+ Defined by NAFTA regulations.
+
+
+
+
+ Identification of which producer is associated with this commodity (if multiple producers are used in a single shipment).
+
+
+
+
+
+ Date range over which RVC net cost was calculated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the information necessary for printing the NAFTA Low Value statement on customs documentation.
+
+
+
+
+ Specifies the NAFTA statement role.
+
+
+
+
+
+
+
+
+
+
+
+
+ See instructions for NAFTA Certificate of Origin for code definitions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ See instructions for NAFTA Certificate of Origin for code definitions.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for services performed during non-business hours and/or days.
+
+
+
+
+ Total number of person days for full non-business days.
+
+
+
+
+ Total number of person hours (whole or partial hours) for non-business hours.
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Indicates the type of notification that will be sent.
+
+
+
+
+ Specifies the email notification details.
+
+
+
+
+ Specifies the localization for this notification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Unique identifier for this offering.
+
+
+
+
+ Specifies values like PRIORITY_OVERNIGHT, FEDEX_ENVELOPE, PRIORITY_ALERT, and other values typically used to identify various offerings in transactions.
+
+
+
+
+ Specifies the two character code used for operationalization of this offering.
+
+
+
+
+
+
+ The instructions indicating how to print the OP-900 form for hazardous materials packages.
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Identifies which reference type (from the package's customer references) is to be used as the source for the reference on this OP-900.
+
+
+
+
+ Specifies the usage and identification of customer supplied images to be used on this document.
+
+
+
+
+ Data field to be used when a name is to be printed in the document instead of (or in addition to) a signature image.
+
+
+
+
+
+
+
+
+ Position of operational instruction element.
+
+
+
+
+ Content corresponding to the operational instruction.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Each instance of this data type represents the set of barcodes (of all types) which are associated with a specific package.
+
+
+
+
+ Binary-style barcodes for this package.
+
+
+
+
+ String-style barcodes for this package.
+
+
+
+
+
+
+ Package-level data required for labeling and/or movement.
+
+
+
+
+ Human-readable text for pre-January 2011 clients.
+
+
+
+
+ Human-readable content for use on a label.
+
+
+
+
+ The operational barcodes pertaining to the current package.
+
+
+
+
+ The FedEx internal code that represents the service and/or features of service for the current package moving under a FedEx Ground service.
+
+
+
+
+
+
+ Data for a package's rates, as calculated per a specific rate type.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+
+ The dimensional weight of this package (if greater than actual).
+
+
+
+
+ The oversize weight of this package (if the package is oversize).
+
+
+
+
+ The transportation charge only (prior to any discounts applied) for this package.
+
+
+
+
+ The sum of all discounts on this package.
+
+
+
+
+ This package's baseCharge - totalFreightDiscounts.
+
+
+
+
+ The sum of all surcharges on this package.
+
+
+
+
+ This package's netFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ The sum of all taxes on this package.
+
+
+
+
+ This package's netFreight + totalSurcharges + totalTaxes.
+
+
+
+
+
+ All rate discounts that apply to this package.
+
+
+
+
+ All rebates that apply to this package.
+
+
+
+
+ All surcharges that apply to this package (either because of characteristics of the package itself, or because it is carrying per-shipment surcharges for the shipment of which it is a part).
+
+
+
+
+ All taxes applicable (or distributed to) this package.
+
+
+
+
+
+
+
+ This class groups together for a single package all package-level rate data (across all rate types) as part of the response to a shipping request, which groups shipment-level data together and groups package-level data by package.
+
+
+
+
+ This rate type identifies which entry in the following array is considered as presenting the "actual" rates for the package.
+
+
+
+
+ The "list" net charge minus "actual" net charge.
+
+
+
+
+ Each element of this field provides package-level rate data for a specific rate type.
+
+
+
+
+
+
+ These special services are available at the package level for some or all service types. If the shipper is requesting a special service which requires additional data, the package special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ Indicates the package special service types that are requested on this shipment. For a list of the valid package special service types, please consult your integration documentation or get the list of the available special services from the getAllSpecialServices method of the Validation Availability and Commitment service.
+
+
+
+
+ For use with FedEx Ground services only; COD must be present in shipment's special services.
+
+
+
+
+
+ Provides details about the batteries or cells that are contained within this specific package.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Branded, translated, and/or localized names for this packaging.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifications for pallets to be shrinkwrapped as part of a Freight shipment.
+
+
+
+
+ Number of pallets to be shrinkwrapped.
+
+
+
+
+
+
+ Specifications for pallets to be provided on Freight shipment.
+
+
+
+
+ Number of pallets to be provided.
+
+
+
+
+
+
+ This type contains equivalent data to Contact, but uses a form of person name with separate first and last names.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This type contains equivalent data to ContactAndAddress, but uses a form of person name with separate first, middle and last names.
+
+
+
+
+
+
+
+
+ The descriptive data for a person's name broken out into individual name elements such as first name, last name.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This information describes how and when a pending shipment may be accessed for completion.
+
+
+
+
+
+
+
+ Specifies the details to be used by the user of the pending shipment
+
+
+
+
+ Specifies the role of the user who is trying to access the pending shipment.
+
+
+
+
+
+
+
+
+
+ This information describes the kind of pending shipment being requested.
+
+
+
+
+
+ Date after which the pending shipment will no longer be available for completion.
+
+
+
+
+ Only used with type of EMAIL.
+
+
+
+
+
+ These are documents that are recommended to be included with the shipment.
+
+
+
+
+ Upload document details provided by the initator of the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This class describes the pickup characteristics of a shipment (e.g. for use in a tag request).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Represents a reference identifier printed on Freight bills of lading
+
+
+
+
+
+
+
+
+ Identifies a particular reference identifier printed on a Freight bill of lading.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Empty unless error label behavior is PACKAGE_ERROR_LABELS and one or more errors occured during transaction processing.
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The type of name (long, medium, short, etc.) to which this value refers.
+
+
+
+
+ The character encoding used to represent this product name. For example, UTF-8.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates the packaging type of the container used to package radioactive hazardous materials.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates whether packaging type "EXCEPTED" or "EXCEPTED_PACKAGE" is for radioactive material in reportable quantity.
+
+
+
+
+
+
+
+
+ Indicates the reason that a dim divisor value was chose.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Selects the value from a set of rate data to which the percentage is applied.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how the recipient is identified for customs purposes; the requirements on this information vary with destination country.
+
+
+
+
+ Specifies the kind of identification being used.
+
+
+
+
+ Contains the actual ID value, of the type specified above.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the details about documents that are recommended to be included with the shipment for ease of shipment processing and transportation.
+
+
+
+
+
+
+
+ Type of documents that are recommended to be included with the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies details needed to generate any label artifacts required due to regulatory requirements.
+
+
+
+
+
+ Specifies how the customer requested the regulatory label to be generated.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This is a 1-based index identifying the commodity in the request that resulted in this COMMODITY or DOCUMENT type prohibition.
+
+
+
+
+
+
+
+
+
+
+
+ FOR FEDEX INTERNAL USE ONLY: The id of the waiver.
+
+
+
+
+ FOR FEDEX INTERNAL USE ONLY: The description of the waiver.
+
+
+
+
+
+
+
+ Describes the vertical position of an item relative to another item.
+
+
+
+
+
+
+
+
+
+
+ A unique identifier of each requested package line item.
+
+
+
+
+ An identifier of each group of identical packages.
+
+
+
+
+ Used as the number or count of identical packages in a group.
+
+
+
+
+ Only used when clients are assigning a tracking number to this package. Should not be used when groupPackageCount is greater than one.
+
+
+
+
+
+ Specifies the declared value for carriage of the package. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the package.
+
+
+
+
+ Represents the gross weight of the package line item.
+
+
+
+
+ FEDEX INTERNAL USE ONLY.
+
+
+
+
+
+ Provides additional detail on how the customer has physically packaged this item. As of June 2009, required for packages moving under international and SmartPost services.
+
+
+
+
+
+ Human-readable text describing the package.
+
+
+
+
+ Human-readable text describing the contents of the package to be used for clearance purposes.
+
+
+
+
+
+
+ Details the contents of the package.
+
+
+
+
+
+
+
+
+
+
+
+ This field contains the service type values, like PRIORITY_OVERNIGHT and FEDEX_GROUND.
+
+
+
+
+ This field contains the packaging type values, like YOUR_PACKAGING and FEDEX_ENVELOPE.
+
+
+
+
+ The client's shipping cycle to which this shipment belongs.
+
+
+
+
+ This specifies information related to the manifest associated with the shipment.
+
+
+
+
+ The shipment variations for the current shipment expressed in key-value pairs.
+
+
+
+
+
+ Specifies the total declared value for carriage of the shipment. The declared value for carriage represents the maximum liability of FedEx in connection with a shipment, including, but not limited to, any loss, damage, delay, mis-delivery, nondelivery, misinformation, any failure to provide information, or mis-delivery of information relating to the shipment.
+
+
+
+
+ This attribute indicates the currency the caller requests to have used in all returned monetary values (when a choice is possible).
+
+
+
+
+ Specifies details about the entity responsible for the shipment.
+
+
+
+
+
+
+
+ Physical starting address for the shipment, if different from shipper's address.
+
+
+
+
+ The sold-to party is used for customs clearance; for example, in support of US import customs rules. The need for this field could vary based on whether a sold-to party was specified on a consolidation.
+
+
+
+
+
+
+ Specifies any custom processing to be applied to this shipment.
+
+
+
+
+
+ Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and FEDEX_FREIGHT_PRIORITY services.
+
+
+
+
+ Used with Ground Home Delivery and Freight.
+
+
+
+
+
+ Customs clearance data, used for both international and intra-country shipping.
+
+
+
+
+ For use in "process tag" transaction.
+
+
+
+
+ Specifies the characteristics of a shipment pertaining to SmartPost services.
+
+
+
+
+ If true, only the shipper/payor will have visibility of this shipment.
+
+
+
+
+ Specifies the client-requested response in the event of errors within shipment.
+
+
+
+
+
+ Contains data used to create additional (non-label) shipping documents.
+
+
+
+
+ Specifies whether and what kind of rates the customer wishes to have quoted on this shipment. The reply will also be constrained by other data on the shipment and customer.
+
+
+
+
+ Specifies the type of rate the customer wishes to have used as the actual rate type.
+
+
+
+
+ Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.
+
+
+
+
+ Specifies the details for the custom rates.
+
+
+
+
+ Only used with multiple-transaction shipments, to identify the master package in a multi-piece shipment.
+
+
+
+
+ The total number of packages in the entire shipment (even when the shipment spans multiple transactions.)
+
+
+
+
+ Specifies data structures that may be re-used multiple times with s single shipment.
+
+
+
+
+ One or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics all packages in the shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This identifies the document types that can be required. This can also indicate when either a COMMERCIAL_INVOICE or a PRO_FORMA_INVOICE is required through the COMMERCIAL_OR_PRO_FORMA_INVOICE option.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the tracking number of the master associated with the return shipment.
+
+
+
+
+
+
+
+ These values are used to control the availability of certain special services at the time when a customer uses the e-mail label link to create a return shipment.
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the allowed (merchant-authorized) special services which may be selected when the subsequent shipment is created. Only services represented in EMailLabelAllowedSpecialServiceType will be controlled by this list.
+
+
+
+
+
+
+ The instructions indicating how to print the return instructions( e.g. image type) Specifies characteristics of a shipping document to be produced.
+
+
+
+
+
+ Specifies additional customer provided text to be inserted into the return document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The "PAYOR..." rates are expressed in the currency identified in the payor's rate table(s). The "RATED..." rates are expressed in the currency of the origin country. Former "...COUNTER..." values have become "...RETAIL..." values, except for PAYOR_COUNTER and RATED_COUNTER, which have been removed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ June 2011 ITG 121203 IR-RMA number has been removed from this structure and added as a new customer reference type. The structure remains because of the reason field below.
+
+
+
+
+
+
+
+ Describes the rotation of an item from its default orientation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Branded, translated, and/or localized names for this service.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for assembly performed on shipment.
+
+
+
+
+ Number of pieces or packages to be assembled
+
+
+
+
+ Total weight of pieces or packages to be assembled
+
+
+
+
+
+
+
+
+
+
+
+ Specifies data structures that may be re-used multiple times with s single shipment.
+
+
+
+
+ Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities.
+
+
+
+
+
+
+ Shipment-level totals of dry ice data across all packages.
+
+
+
+
+ Total number of packages in the shipment that contain dry ice.
+
+
+
+
+ Total shipment dry ice weight for all packages.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type.
+
+
+
+
+ Human-readable text describing the shipment leg.
+
+
+
+
+ Origin for this leg.
+
+
+
+
+ Specifies the location id the origin of shipment leg.
+
+
+
+
+ Destination for this leg.
+
+
+
+
+ Specifies the location id the destination of shipment leg.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates the rate scale used.
+
+
+
+
+ Indicates the rate zone used (based on origin and destination).
+
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+ Specifies the currency exchange performed on financial amounts for this rate.
+
+
+
+
+ Indicates which special rating cases applied to this shipment.
+
+
+
+
+
+ Identifies the type of dim divisor that was applied.
+
+
+
+
+
+
+ Sum of dimensional weights for all packages.
+
+
+
+
+
+
+
+
+ This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ Total of the transportation-based taxes.
+
+
+
+
+
+
+ Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
+
+
+
+
+ This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
+
+
+
+
+ Rate data specific to FedEx Freight and FedEx National Freight services.
+
+
+
+
+ All rate discounts that apply to this shipment.
+
+
+
+
+ All rebates that apply to this shipment.
+
+
+
+
+ All surcharges that apply to this shipment.
+
+
+
+
+ All transportation-based taxes applicable to this shipment.
+
+
+
+
+ All commodity-based duties and taxes applicable to this shipment.
+
+
+
+
+ The "order level" variable handling charges.
+
+
+
+
+ The total of all variable handling charges at both shipment (order) and package level.
+
+
+
+
+
+
+
+
+ This identifies which customer reference field contains the manifest ID.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This is the state of the destination location ID, and is not necessarily the same as the postal state.
+
+
+
+
+ Expected/estimated date of delivery.
+
+
+
+
+ Expected/estimated day of week of delivery.
+
+
+
+
+ Delivery time, as published in Service Guide.
+
+
+
+
+ Committed date of delivery.
+
+
+
+
+ Committed day of week of delivery.
+
+
+
+
+ Standard transit time per origin, destination, and service.
+
+
+
+
+ Maximum expected transit time
+
+
+
+
+ Transit time based on customer eligibility.
+
+
+
+
+ Indicates that this shipment is not eligible for money back guarantee.
+
+
+
+
+ FedEx Ground delivery features for which this shipment may be eligible.
+
+
+
+
+ Text describing planned delivery.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies special or custom features to be applied to a shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies special or custom features to be applied during the processing of the enclosing RequestedShipment.
+
+
+
+
+ Identifies options to be applied.
+
+
+
+
+ Specifies custom transit time to be applied to the shipment.
+
+
+
+
+
+
+ Data for a shipment's total/summary rates, as calculated per a specific rate type. The "total..." fields may differ from the sum of corresponding package data for Multiweight or Express MPS.
+
+
+
+
+ Type used for this specific set of rate data.
+
+
+
+
+ Indicates the rate scale used.
+
+
+
+
+ Indicates the rate zone used (based on origin and destination).
+
+
+
+
+
+ Indicates which weight was used.
+
+
+
+
+ INTERNAL FEDEX USE ONLY.
+
+
+
+
+ FEDEX INTERNAL USE ONLY - the user ID provided when this rate was created
+
+
+
+
+ Specifies the currency exchange performed on financial amounts for this rate.
+
+
+
+
+ Indicates which special rating cases applied to this shipment.
+
+
+
+
+
+ Identifies the type of dim divisor that was applied.
+
+
+
+
+
+
+ Sum of dimensional weights for all packages.
+
+
+
+
+
+
+
+
+ This shipment's totalNetFreight + totalSurcharges (not including totalTaxes).
+
+
+
+
+ Total of the transportation-based taxes.
+
+
+
+
+
+
+ Total of all values under this shipment's dutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment.
+
+
+
+
+ Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
+
+
+
+
+ The total of the totalDutiesAndTaxes plus the totalAncillaryFeesAndTaxes.
+
+
+
+
+ This shipment's totalNetCharge + totalDutiesTaxesAndFees; some duties and taxes are only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
+
+
+
+
+ Identifies the Rate Details per each leg in a Freight Shipment
+
+
+
+
+ Rate data specific to FedEx Freight and FedEx National Freight services.
+
+
+
+
+ All rate discounts that apply to this shipment.
+
+
+
+
+ All rebates that apply to this shipment.
+
+
+
+
+ All surcharges that apply to this shipment.
+
+
+
+
+ All transportation-based taxes applicable to this shipment.
+
+
+
+
+ All commodity-based duties and taxes applicable to this shipment.
+
+
+
+
+ Identifies the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.
+
+
+
+
+ The "order level" variable handling charges.
+
+
+
+
+ The total of all variable handling charges at both shipment (order) and package level.
+
+
+
+
+
+
+ This class groups together all shipment-level rate data (across all rate types) as part of the response to a shipping request, which groups shipment-level data together and groups package-level data by package.
+
+
+
+
+ This rate type identifies which entry in the following array is considered as presenting the "actual" rates for the shipment.
+
+
+
+
+ The "list" total net charge minus "actual" total net charge.
+
+
+
+
+ Each element of this field provides shipment-level rate totals for a specific rate type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These special services are available at the shipment level for some or all service types. If the shipper is requesting a special service which requires additional data (such as the COD amount), the shipment special service type must be present in the specialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object below.
+
+
+
+
+ Indicates the shipment special service types that are requested on this shipment. For a list of the valid shipment special service types, please consult your integration documentation or get the list of the available special services from the getAllSpecialServices method of the Validation Availability and Commitment service.
+
+
+
+
+
+
+
+ This replaces eMailNotificationDetail
+
+
+
+
+
+ This field should be populated for pending shipments (e.g. e-mail label) It is required by a PENDING_SHIPMENT special service type.
+
+
+
+
+
+
+
+
+
+
+ Electronic Trade document references.
+
+
+
+
+ Specification for labor to be performed with the shipment.
+
+
+
+
+ Specifications for pallets to be shrinkwrapped as part of a Freight shipment.
+
+
+
+
+ Specifications for pallets to be provided on Freight shipment.
+
+
+
+
+ Specifications for pup/set or vehicle delayed for loading or unloading.
+
+
+
+
+ Specification for marking or tagging of pieces in shipment.
+
+
+
+
+ Specification for services performed during non-business hours and/or days.
+
+
+
+
+ Specification for assembly performed on shipment.
+
+
+
+
+ Specification for sorting and/or segregating performed on shipment.
+
+
+
+
+ Specification for special equipment used in loading/unloading shipment.
+
+
+
+
+ Specification for storage provided for shipment.
+
+
+
+
+ Specification for weighing services provided for shipment.
+
+
+
+
+ Specification for date or range of dates on which delivery is to be attempted.
+
+
+
+
+
+
+
+
+ Specifies the name or the key for the shipment variation.
+
+
+
+
+ The values that are valid for the specified shipment variation in the context of the current shipment.
+
+
+
+
+
+
+
+
+ This indicates the identifier of a conveyance, such as a trailer ID.
+
+
+
+
+
+
+
+
+
+ The localizations are populated if multiple language versions of a shipping document are returned.
+
+
+
+
+ Specifies how this document image/file is organized.
+
+
+
+
+
+ The name under which a STORED, DEFERRED or EMAILED document is written.
+
+
+
+
+ Specifies the image type of this shipping document.
+
+
+
+
+ Specifies the image resolution in DPI (dots per inch).
+
+
+
+
+ Can be zero for documents whose disposition implies that no content is included.
+
+
+
+
+ One or more document parts which make up a single logical document, such as multiple pages of a single form.
+
+
+
+
+
+
+ Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided.
+
+
+
+
+ Values in this field specify how to create and return the document.
+
+
+
+
+ Specifies how to organize all documents of this type.
+
+
+
+
+ Specifies how to store document images.
+
+
+
+
+ Specifies how to e-mail document images.
+
+
+
+
+ Specifies how a queued document is to be printed.
+
+
+
+
+
+
+ Specifies how to return a shipping document to the caller.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to e-mail shipping documents.
+
+
+
+
+ Provides the roles and email addresses for e-mail recipients.
+
+
+
+
+ Identifies the convention by which documents are to be grouped as e-mail attachments.
+
+
+
+
+ Specifies the language in which the email containing the document is requested to be composed.
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies an individual recipient of e-mailed shipping document(s).
+
+
+
+
+ Identifies the relationship of this recipient in the shipment.
+
+
+
+
+ Address to which the document is to be sent.
+
+
+
+
+
+
+ Specifies characteristics of a shipping document to be produced.
+
+
+
+
+ Specifies how to create, organize, and return the document.
+
+
+
+
+ Specifies how far down the page to move the beginning of the image; allows for printing on letterhead and other pre-printed stock.
+
+
+
+
+
+
+ For those shipping document types which have both a "form" and "instructions" component (e.g. NAFTA Certificate of Origin and General Agency Agreement), this field indicates whether to provide the instructions.
+
+
+
+
+
+ Governs the language to be used for this individual document, independently from other content returned for the same shipment.
+
+
+
+
+ Identifies the individual document specified by the client.
+
+
+
+
+
+
+ Specifies how to organize all shipping documents of the same type.
+
+
+
+
+
+
+
+
+ Specifies the image format used for a shipping document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the convention by which file names are constructed for STORED or DEFERRED documents.
+
+
+
+
+
+
+
+
+ A single part of a shipping document, such as one page of a multiple-page document whose format requires a separate image per page.
+
+
+
+
+ The one-origin position of this part within a document.
+
+
+
+
+ Graphic or printer commands for this image within a document.
+
+
+
+
+
+
+ Specifies printing options for a shipping document.
+
+
+
+
+ Provides environment-specific printer identification.
+
+
+
+
+
+
+ Contains all data required for additional (non-label) shipping documents to be produced in conjunction with a specific shipment.
+
+
+
+
+ Indicates the types of shipping documents requested by the shipper.
+
+
+
+
+
+
+ Specifies the production of each package-level custom document (the same specification is used for all packages).
+
+
+
+
+ Specifies the production of a shipment-level custom document.
+
+
+
+
+
+
+
+ Specifies the production of the OP-900 document for hazardous materials packages.
+
+
+
+
+ Specifies the production of the 1421c document for dangerous goods shipment.
+
+
+
+
+ Specifies the production of the OP-900 document for hazardous materials.
+
+
+
+
+
+ Specifies the production of the return instructions document.
+
+
+
+
+
+
+ Specifies the type of paper (stock) on which a document will be printed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies how to store shipping documents.
+
+
+
+
+ Indicates the mechanism by which a shipping document will be stored for later retrieval.
+
+
+
+
+ Provides the path to be used for STORED or DEFERRED documents.
+
+
+
+
+ Identifies the convention by which file names are constructed for STORED or DEFERRED documents.
+
+
+
+
+ Suffix to be placed at the end of the file name; required on some platforms to determine file type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These values are mutually exclusive; at most one of them can be attached to a SmartPost shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Data required for shipments handled under the SMART_POST and GROUND_SMART_POST service types.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for sorting and/or segregating performed on shipment.
+
+
+
+
+ Number of pieces or packages to be sorted/segregated
+
+
+
+
+ Total weight of pieces or packages to be sorted/segregated
+
+
+
+
+
+
+ Specification for special equipment used in loading/unloading shipment.
+
+
+
+
+ Contains an entry for each type of special equipment used with shipment
+
+
+
+
+
+
+ Specifies the usage of a single type of special equipment while loading/unloading a shipment
+
+
+
+
+ Type of equipment used
+
+
+
+
+ Total amount of time the equipment was used
+
+
+
+
+
+
+ Identifies types of special equipment used in loading/unloading Freight shipments
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specification for storage provided for shipment.
+
+
+
+
+ Total time shipment is held by carrier.
+
+
+
+
+
+
+ Each instance of this data type represents a barcode whose content must be represented as ASCII text (i.e. not binary data).
+
+
+
+
+ The kind of barcode data in this instance.
+
+
+
+
+ The data content of this instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifice the kind of tax or miscellaneous charge being reported on a Commercial Invoice.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the usage of Tax Identification Number in Shipment processing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ For use with SmartPost tracking IDs only
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+ Unique identifier assigned/forwarded by internal FAST services only, to associate service transactions comprising a single business work unit.
+
+
+
+
+ Each FAST service should log request/reply pairs for any transaction in which this attribute is true. This is for internal use only (capturing transaction data for diagnostic purposes).
+
+
+
+
+ Indicates the format in which the transaction was presented to FedEx, used to help identify error-translation context.
+
+
+
+
+ Identifies the environment (level) in which the current transaction should be processed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the application that is responsible for managing the document id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Description of the uploaded document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+ Documents the kind and quantity of an individual hazardous commodity in a package.
+
+
+
+
+ Identifies and describes an individual hazardous commodity.
+
+
+
+
+ Specifies the amount of the commodity in alternate units.
+
+
+
+
+ The mass points are a calculation used by ADR regulations for measuring the risk of a particular hazardous commodity.
+
+
+
+
+ Customer-provided specifications for handling individual commodities.
+
+
+
+
+ The total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc.
+
+
+
+
+
+
+ Identifies and describes an individual hazardous commodity. For 201001 load, this is based on data from the FedEx Ground Hazardous Materials Shipping Guide.
+
+
+
+
+ Regulatory identifier for a commodity (e.g. "UN ID" value).
+
+
+
+
+ In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.
+
+
+
+
+
+
+
+ Fully-expanded descriptive text for a hazardous commodity.
+
+
+
+
+
+
+
+ Coded indications for special requirements or constraints.
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the concept of a container used to package dangerous goods commodities.
+
+
+
+
+ Indicates that the quantity of the dangerous goods packaged is permissible for shipping. This is used to ensure that the dangerous goods commodities do not exceed the net quantity per package restrictions.
+
+
+
+
+ Documents the kinds and quantities of all hazardous commodities in the current package.
+
+
+
+
+
+
+ This definition of variable handling charge detail is intended for use in Jan 2011 corp load.
+
+
+
+
+
+ Actual percentage (10 means 10%, which is a mutiplier of 0.1)
+
+
+
+
+ Select the value from a set of rate data to which the percentage is applied.
+
+
+
+
+ Select the type of rate from which the element is to be selected.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Three-dimensional volume/cubic measurement.
+
+
+
+
+
+
+
+
+ Units of three-dimensional volume/cubic measure.
+
+
+
+
+
+
+
+
+ Identifies the environment (level) for which an AuthenticationCredential is valid, and within which transactions are received.
+
+
+
+
+
+
+
+
+ Specifies a single type of weighing performed on a shipment
+
+
+
+
+ Type of scale used
+
+
+
+
+
+
+ Identifies types of scales used in weighing Freight shipments
+
+
+
+
+
+
+
+
+ The descriptive data for the heaviness of an object.
+
+
+
+
+ Identifies the unit of measure associated with a weight value.
+
+
+
+
+ Identifies the weight value of a package/shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/test_server_wsdl/TrackService_v10.wsdl b/fedex/wsdl/test_server_wsdl/TrackService_v16.wsdl
similarity index 83%
rename from fedex/wsdl/test_server_wsdl/TrackService_v10.wsdl
rename to fedex/wsdl/test_server_wsdl/TrackService_v16.wsdl
index 2a1cb4e..04a383f 100755
--- a/fedex/wsdl/test_server_wsdl/TrackService_v10.wsdl
+++ b/fedex/wsdl/test_server_wsdl/TrackService_v16.wsdl
@@ -1,12 +1,10 @@
-
+
-
+
+
+
-
-
-
-
@@ -54,6 +52,11 @@
Indicates whether this address residential (as opposed to commercial).
+
+
+ The geographic coordinates cooresponding to this address.
+
+
@@ -132,6 +135,12 @@
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
@@ -179,17 +188,22 @@
Value used to identify a commodity description; must be unique within the containing shipment.
-
+
+
+ FedEx internal commodity identifier
+
+
-
-
-
-
-
+
- This field is used for enterprise transactions.
+ A free-form description of the commodity, which could be used for customs clearance documentation.
+
+
+
+
+
@@ -214,6 +228,12 @@
+
+
+
+
+
+
@@ -382,9 +402,6 @@
-
- The dimensions of this package and the unit type used for the measurements.
-
@@ -410,86 +427,38 @@
-
- Identifies the collection of units of measure that can be associated with a distance value.
-
-
+
- Information describing email notifications that will be sent in relation to events that occur during package movement
+ Successive parts of the document (only one, for PDF documents).
-
+
- A message that will be included in the email notifications
+ The one-origin position of this part within a document.
-
+
- Information describing the destination of the email, format of the email and events to be notified on
+ Graphic or printer commands for this image within a document.
-
-
-
-
-
-
-
-
-
-
- The format of the email
-
-
-
-
-
-
-
-
+
-
+
+
- Identifies the relationship this email recipient has to the shipment.
-
-
-
-
- The email address to send the notification to
-
-
-
-
- The types of email notifications being requested for this recipient.
-
-
-
-
- The format of the email notification.
-
-
-
-
- The language/locale to be used in this email notification.
+ Specifies the name associated with the email address.
-
-
-
-
-
-
-
-
@@ -510,6 +479,11 @@
+
+
+
+
+ Identifies a kind of FedEx facility.
@@ -522,15 +496,43 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
- CM = centimeters, IN = inches
-
@@ -661,11 +663,45 @@
- A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) witout having to parse the message string.
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Indicates the type of notification that will be sent.
+
+
+
+
+ Specifies the email notification details.
+
+
+
+
+ Specifies the localization for this notification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -681,9 +717,6 @@
-
- Identifies the set of severity values for a Notification.
-
@@ -692,6 +725,11 @@
+
+
+
+
+
@@ -720,9 +758,6 @@
-
- The enumerated packaging type used for this package.
-
@@ -751,6 +786,44 @@
+
+
+ This enumeration rationalizes the former FedEx Express international "admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The values represented are those common to both carriers.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -764,38 +837,6 @@
-
-
- Tracking number and additional shipment data used to identify a unique shipment for proof of delivery.
-
-
-
-
- FedEx assigned identifier for a package/shipment.
-
-
-
-
- The date the package was shipped.
-
-
-
-
- If the account number used to ship the package is provided in the request the shipper and recipient information is included on the letter or fax.
-
-
-
-
- FedEx operating company that delivered the package.
-
-
-
-
- Only country is used for elimination of duplicate tracking numbers.
-
-
-
-
@@ -898,17 +939,14 @@
Included in the email notification identifying the requester of this notification.
-
+
- Who to send the email notifications to and for which events. The notificationRecipientType and NotifyOnShipment fields are not used in this request.
+ This replaces eMailNotificationDetail
-
- The service type of the package/shipment.
-
@@ -953,6 +991,7 @@
+
@@ -962,177 +1001,45 @@
-
+
-
-
+
+
+
-
-
- FedEx Signature Proof Of Delivery Fax reply.
-
+
-
-
- This contains the severity type of the most severe Notification in the Notifications array.
-
-
-
-
- Information about the request/reply such was the transaction successful or not, and any additional information relevant to the request and/or reply. There may be multiple Notifications in a reply.
-
-
-
-
- Contains the CustomerTransactionDetail that is echoed back to the caller for matching requests and replies and a Localization element for defining the language/translation used in the reply data.
-
-
-
-
- Contains the version of the reply being used.
-
-
-
-
- Confirmation of fax transmission.
-
-
-
-
-
-
- FedEx Signature Proof Of Delivery Fax request.
-
-
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Contains a free form field that is echoed back in the reply to match requests with replies and data that governs the data payload language/translations.
-
-
-
-
- The version of the request being used.
-
-
-
-
- Tracking number and additional shipment data used to identify a unique shipment for proof of delivery.
-
-
-
-
- Additional customer-supplied text to be added to the body of the letter.
-
-
-
-
- Contact and address information about the person requesting the fax to be sent.
-
-
-
-
- Contact and address information, including the fax number, about the person to receive the fax.
-
-
+
+
+
+
-
-
- Identifies the set of SPOD image types.
-
+
-
-
+
+
-
-
- FedEx Signature Proof Of Delivery Letter reply.
-
+
-
-
- This contains the severity type of the most severe Notification in the Notifications array.
-
-
-
-
- Information about the request/reply such was the transaction successful or not, and any additional information relevant to the request and/or reply. There may be multiple Notifications in a reply.
-
-
-
-
- Contains the CustomerTransactionDetail that is echoed back to the caller for matching requests and replies and a Localization element for defining the language/translation used in the reply data.
-
-
-
-
- Image of letter encoded in Base64 format.
-
-
-
-
- Image of letter encoded in Base64 format.
-
-
+
-
-
- FedEx Signature Proof Of Delivery Letter request.
-
+
+
+
+
+
+
+
+
+
+
-
-
- Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
-
-
-
-
- Descriptive data identifying the client submitting the transaction.
-
-
-
-
- Contains a free form field that is echoed back in the reply to match requests with replies and data that governs the data payload language/translations.
-
-
-
-
- The version of the request being used.
-
-
-
-
- Tracking number and additional shipment data used to identify a unique shipment for proof of delivery.
-
-
-
-
- Additional customer-supplied text to be added to the body of the letter.
-
-
-
-
- Identifies the set of SPOD image types.
-
-
-
-
- If provided this information will be print on the letter.
-
-
+
+
@@ -1214,10 +1121,13 @@
+
+
+
+
+
+
-
- The delivery location at the delivered to address.
-
@@ -1247,9 +1157,6 @@
-
- Detailed tracking information about a particular package.
-
@@ -1272,6 +1179,11 @@
Specifies details about the status of the shipment being tracked.
+
+
+ Notifications to the end user that provide additional information relevant to the tracked shipment. For example, a notification may indicate that a change in behavior has occurred.
+
+
@@ -1310,11 +1222,7 @@
Specifies the FXO production centre contact and address.
-
-
- Other related identifiers for this package such as reference numbers.
-
-
+ (Returned for CSR SL only.)
@@ -1355,6 +1263,7 @@
Strict representation of the Packaging type (e.g. FEDEX_BOX, YOUR_PACKAGING).
+ The sequence number of this package in a shipment. This would be 2 if it was package number 2 of 4.
@@ -1365,6 +1274,11 @@
The number of packages in this shipment.
+
+
+ FOR FEDEX INTERNAL USE ONLY: Specifies the software id of the device that was used to create this tracked shipment.
+
+ Specifies the details about the SPOC details.
@@ -1375,7 +1289,7 @@
-
+
@@ -1386,7 +1300,12 @@
- List of special handlings that applied to this package. (Returned for CSR SL only.)
+ List of special handlings that applied to this package.
+
+
+
+
+ Specifies the details about the payments for the shipment being tracked.
@@ -1399,11 +1318,7 @@
Indicates last-known possession of package (Returned for CSR SL only.)
-
-
- The address information for the shipper.
-
-
+ The address of the FedEx pickup location/facility.
@@ -1414,16 +1329,7 @@
(Returned for CSR SL only.)
-
-
- Estimated package pickup time for shipments that haven't been picked up.
-
-
-
-
- Time package was shipped/tendered over to FedEx. Time portion will be populated if available, otherwise will be set to midnight.
-
-
+ The distance from the origin to the destination. Returned for Custom Critical shipments.
@@ -1472,26 +1378,6 @@
-
-
- Date and time the package should be (or should have been) delivered. (Returned for CSR SL only.)
-
-
-
-
- Date and time the package would be delivered if the package has appointment delivery as a special service.
-
-
-
-
- Projected package delivery time based on ship time stamp, service and destination. Not populated if delivery has already occurred.
-
-
-
-
- The time the package was actually delivered.
-
- Actual address where package was delivered. Differs from destinationAddress, which indicates where the package was to be delivered; This field tells where delivery actually occurred (next door, at station, etc.)
@@ -1532,13 +1418,9 @@
Specifies the total number of unique addresses on the CRNs in a consolidation.
-
+
-
-
- The types of email notifications that are available for the package.
-
-
+ Returned for cargo shipments only when they are currently split across vehicles.
@@ -1609,9 +1491,6 @@
-
- The type of track to be performed.
-
@@ -1640,6 +1519,20 @@
+
+
+
+
+ A code that designates the type of informational message being returned.
+
+
+
+
+ The informational message in human readable form.
+
+
+
+
@@ -1679,11 +1572,7 @@
Options available for a tracking notification recipient.
-
-
- The types of email notifications available for this recipient.
-
-
+
@@ -1710,6 +1599,17 @@
+
+
+
+
+ Indicates the classification of the charges being paid.
+
+
+
+
+
+
@@ -1751,9 +1651,6 @@
-
- The descriptive data returned from a FedEx package tracking request.
-
@@ -1783,9 +1680,6 @@
-
- The descriptive data sent by a client to track a FedEx package.
-
@@ -1931,6 +1825,7 @@
+
@@ -1956,7 +1851,9 @@
+
+
@@ -1997,6 +1894,7 @@
+
@@ -2104,10 +2002,131 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the information used to fax the document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the recipients of the email.
+
+
+
+
+ Identifies the person initiating the email.
+
+
+
+
+ This is the localization of the email content.
+
+
+
+
+ A message included in the body of the email.
+
+
+
+
+
+
+
+
+
+
+
+ The localization for the generated document.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
- Descriptive data that governs data payload language/translations. The TransactionDetail from the request is echoed back to the caller in the corresponding reply.
-
@@ -2139,9 +2158,6 @@
-
- Identifies the collection of units of measure that can be associated with a weight value.
-
@@ -2191,7 +2207,7 @@
Identifies a system or sub-system which performs an operation.
-
+ Identifies the service business level.
@@ -2213,17 +2229,11 @@
-
-
-
-
-
-
-
-
+
+
@@ -2231,21 +2241,17 @@
-
-
+
+
-
-
-
-
-
-
-
+
+
+
@@ -2254,17 +2260,8 @@
-
-
-
-
-
-
-
-
+
@@ -2272,8 +2269,8 @@
-
-
+
+
@@ -2282,7 +2279,7 @@
-
+
diff --git a/fedex/wsdl/test_server_wsdl/UploadDocumentService_v11.wsdl b/fedex/wsdl/test_server_wsdl/UploadDocumentService_v11.wsdl
new file mode 100755
index 0000000..678edb5
--- /dev/null
+++ b/fedex/wsdl/test_server_wsdl/UploadDocumentService_v11.wsdl
@@ -0,0 +1,506 @@
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+ Only used in transactions which require identification of the FedEx Office integrator.
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Lists the documents that are not accepted by FedEx for this shipment.
+
+
+
+
+
+
+ Specifies the usage or intent of the document in the current context.
+
+
+
+
+
+
+
+
+ This identifies some of the document types recognized by Enterprise Document Management Service.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The tracking number field should be provided when uploading documents after the shipment has been processed or confirmed. This is only applicable if the shipment has been processed with the POST_SHIPMENT_UPLOAD_REQUESTED ETD attribute.
+
+
+
+
+
+
+ This identifies the document types that can be required. This can also indicate when either a COMMERCIAL_INVOICE or a PRO_FORMA_INVOICE is required through the COMMERCIAL_OR_PRO_FORMA_INVOICE option.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the date until which the document is available
+
+
+
+
+
+
+ Specifies the application that is responsible for managing the document id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Distinct value for reason status was assigned.
+
+
+
+
+ Human-readable explanation of document status.
+
+
+
+
+
+
+
+
+ Each of these values identifies a specific reason why a document or reference could not be uploaded or associated with a shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ For an upload making use of the POST_SHIPMENT_UPLOAD option, this will indicate information about the required documents necessary for package movement.
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the intent or the usage of the documents being uploaded. This provides details about how the documents are relevant to the current transaction.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/fedex/wsdl/test_server_wsdl/ValidationAvailabilityAndCommitmentService_v8.wsdl b/fedex/wsdl/test_server_wsdl/ValidationAvailabilityAndCommitmentService_v8.wsdl
new file mode 100755
index 0000000..d4b3313
--- /dev/null
+++ b/fedex/wsdl/test_server_wsdl/ValidationAvailabilityAndCommitmentService_v8.wsdl
@@ -0,0 +1,377 @@
+
+
+
+
+
+
+
+ Descriptive data for a physical location. May be used as an actual physical address (place to which one could go), or as a container of "address parts" which should be handled as a unit (such as a city-state-ZIP combination within the US).
+
+
+
+
+ Identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.
+
+
+
+
+ The two-letter code used to identify a country.
+
+
+
+
+ The geographic coordinates cooresponding to this address.
+
+
+
+
+
+
+ Identification of a FedEx operating company (transportation).
+
+
+
+
+
+
+
+
+
+ Descriptive data for the client submitting a transaction.
+
+
+
+
+ The FedEx account number associated with this transaction.
+
+
+
+
+ This number is assigned by FedEx and identifies the unique device from which the request is originating
+
+
+
+
+ The language to be used for human-readable Notification.localizedMessages in responses to the request containing this ClientDetail object. Different requests from the same client may contain different Localization data. (Contrast with TransactionDetail.localization, which governs data payload language/translation.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Identifies the representation of human-readable text.
+
+
+
+
+ Two-letter code for language (e.g. EN, FR, etc.)
+
+
+
+
+ Two-letter code for the region (e.g. us, ca, etc..).
+
+
+
+
+
+
+ The descriptive data regarding the result of the submitted transaction.
+
+
+
+
+ The severity of this notification. This can indicate success or failure or some other information about the request. The values that can be returned are SUCCESS - Your transaction succeeded with no other applicable information. NOTE - Additional information that may be of interest to you about your transaction. WARNING - Additional information that you need to know about your transaction that you may need to take action on. ERROR - Information about an error that occurred while processing your transaction. FAILURE - FedEx was unable to process your transaction at this time due to a system failure. Please try again later
+
+
+
+
+ Indicates the source of this notification. Combined with the Code it uniquely identifies this notification
+
+
+
+
+ A code that represents this notification. Combined with the Source it uniquely identifies this notification.
+
+
+
+
+ Human-readable text that explains this notification.
+
+
+
+
+ The translated message. The language and locale specified in the ClientDetail. Localization are used to determine the representation. Currently only supported in a TrackReply.
+
+
+
+
+ A collection of name/value pairs that provide specific data to help the client determine the nature of an error (or warning, etc.) without having to parse the message string.
+
+
+
+
+
+
+
+
+ Identifies the type of data contained in Value (e.g. SERVICE_TYPE, PACKAGE_SEQUENCE, etc..).
+
+
+
+
+ The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Specifies the commit time for a FedEx Ground shipment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Descriptive data to be used in authentication of the sender's identity (and right to use FedEx web services).
+
+
+
+
+
+
+
+
+
+
+ Optionally supplied instead of service to restrict reply to services for a specific carrier.
+
+
+
+
+ Restricts reply to single service, if supplied.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Free form text to be echoed back in the reply. Used to match requests and replies.
+
+
+
+
+ Governs data payload language/translations (contrasted with ClientDetail.localization, which governs Notification.localizedMessage language selection).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Used in authentication of the sender's identity.
+
+
+
+
+ This was renamed from cspCredential.
+
+
+
+
+ Credential used to authenticate a specific software application. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Two part authentication string used for the sender's identity
+
+
+
+
+ Identifying part of authentication credential. This value is provided by FedEx after registration
+
+
+
+
+ Secret part of authentication key. This value is provided by FedEx after registration.
+
+
+
+
+
+
+ Identifies the version/level of a service operation expected by a caller (in each request) and performed by the callee (in each reply).
+
+
+
+
+ Identifies a system or sub-system which performs an operation.
+
+
+
+
+ Identifies the service business level.
+
+
+
+
+ Identifies the service interface level.
+
+
+
+
+ Identifies the service code level.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/label_certification/cert_config.py b/label_certification/cert_config.py
index 277e296..44e2991 100644
--- a/label_certification/cert_config.py
+++ b/label_certification/cert_config.py
@@ -4,6 +4,7 @@
"""
import os
import sys
+
# Use the fedex directory included in the downloaded package instead of
# any globally installed versions.
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
@@ -12,11 +13,11 @@
# Change these values to match your testing account/meter number.
CONFIG_OBJ = FedexConfig(
- key='xxxxxxxxxxxxxxxx',
- password='xxxxxxxxxxxxxxxxxxxxxxxxx',
- account_number='#########',
- meter_number='#########',
- use_test_server=True)
+ key='xxxxxxxxxxxxxxxx',
+ password='xxxxxxxxxxxxxxxxxxxxxxxxx',
+ account_number='#########',
+ meter_number='#########',
+ use_test_server=True)
# Change this to whoever should be the contact person for shipments.
SHIPPER_CONTACT_INFO = {
diff --git a/label_certification/express.py b/label_certification/express.py
index 9a3040d..dac3528 100755
--- a/label_certification/express.py
+++ b/label_certification/express.py
@@ -17,14 +17,13 @@
shipment.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
shipment.RequestedShipment.ServiceType = 'PRIORITY_OVERNIGHT'
shipment.RequestedShipment.PackagingType = 'YOUR_PACKAGING'
-shipment.RequestedShipment.PackageDetail = 'INDIVIDUAL_PACKAGES'
# Shipper contact info.
-transfer_config_dict(shipment.RequestedShipment.Shipper.Contact,
+transfer_config_dict(shipment.RequestedShipment.Shipper.Contact,
SHIPPER_CONTACT_INFO)
# Shipper address.
-transfer_config_dict(shipment.RequestedShipment.Shipper.Address,
+transfer_config_dict(shipment.RequestedShipment.Shipper.Address,
SHIPPER_ADDRESS)
# Recipient contact info.
@@ -39,10 +38,13 @@
shipment.RequestedShipment.Recipient.Address.PostalCode = '20171'
shipment.RequestedShipment.Recipient.Address.CountryCode = 'US'
-shipment.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
+shipment.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
+
+# Senders account information
+shipment.RequestedShipment.ShippingChargesPayment.Payor.ResponsibleParty.AccountNumber = CONFIG_OBJ.account_number
# Label config.
-transfer_config_dict(shipment.RequestedShipment.LabelSpecification,
+transfer_config_dict(shipment.RequestedShipment.LabelSpecification,
LABEL_SPECIFICATION)
package1_weight = shipment.create_wsdl_object_of_type('Weight')
@@ -56,23 +58,23 @@
shipment.send_request()
device = LabelPrinterClass(shipment)
device.print_label()
-
+
shipment.RequestedShipment.Recipient.Address.StreetLines = ['456 Peach St']
shipment.RequestedShipment.Recipient.Address.City = 'Atlanta'
shipment.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'GA'
shipment.RequestedShipment.Recipient.Address.PostalCode = '30303'
shipment.RequestedShipment.Recipient.Address.CountryCode = 'US'
-
+
shipment.send_request()
device = LabelPrinterClass(shipment)
device.print_label()
-
+
shipment.RequestedShipment.Recipient.Address.StreetLines = ['987 Main St']
shipment.RequestedShipment.Recipient.Address.City = 'Boston'
shipment.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'MA'
shipment.RequestedShipment.Recipient.Address.PostalCode = '02115'
shipment.RequestedShipment.Recipient.Address.CountryCode = 'US'
-
+
shipment.send_request()
device = LabelPrinterClass(shipment)
device.print_label()
diff --git a/label_certification/ground.py b/label_certification/ground.py
index b563cc5..4b518d1 100755
--- a/label_certification/ground.py
+++ b/label_certification/ground.py
@@ -16,14 +16,13 @@
shipment.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
shipment.RequestedShipment.ServiceType = 'FEDEX_GROUND'
shipment.RequestedShipment.PackagingType = 'YOUR_PACKAGING'
-shipment.RequestedShipment.PackageDetail = 'INDIVIDUAL_PACKAGES'
# Shipper contact info.
-transfer_config_dict(shipment.RequestedShipment.Shipper.Contact,
+transfer_config_dict(shipment.RequestedShipment.Shipper.Contact,
SHIPPER_CONTACT_INFO)
# Shipper address.
-transfer_config_dict(shipment.RequestedShipment.Shipper.Address,
+transfer_config_dict(shipment.RequestedShipment.Shipper.Address,
SHIPPER_ADDRESS)
# Recipient contact info.
@@ -38,10 +37,13 @@
shipment.RequestedShipment.Recipient.Address.PostalCode = '20171'
shipment.RequestedShipment.Recipient.Address.CountryCode = 'US'
-shipment.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
+shipment.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
+
+# Senders account information
+shipment.RequestedShipment.ShippingChargesPayment.Payor.ResponsibleParty.AccountNumber = CONFIG_OBJ.account_number
# Label config.
-transfer_config_dict(shipment.RequestedShipment.LabelSpecification,
+transfer_config_dict(shipment.RequestedShipment.LabelSpecification,
LABEL_SPECIFICATION)
package1_weight = shipment.create_wsdl_object_of_type('Weight')
@@ -55,23 +57,23 @@
shipment.send_request()
device = LabelPrinterClass(shipment)
device.print_label()
-
+
shipment.RequestedShipment.Recipient.Address.StreetLines = ['456 Peach St']
shipment.RequestedShipment.Recipient.Address.City = 'Atlanta'
shipment.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'GA'
shipment.RequestedShipment.Recipient.Address.PostalCode = '30303'
shipment.RequestedShipment.Recipient.Address.CountryCode = 'US'
-
+
shipment.send_request()
device = LabelPrinterClass(shipment)
device.print_label()
-
+
shipment.RequestedShipment.Recipient.Address.StreetLines = ['987 Main St']
shipment.RequestedShipment.Recipient.Address.City = 'Boston'
shipment.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'MA'
shipment.RequestedShipment.Recipient.Address.PostalCode = '02115'
shipment.RequestedShipment.Recipient.Address.CountryCode = 'US'
-
+
shipment.send_request()
device = LabelPrinterClass(shipment)
- device.print_label()
\ No newline at end of file
+ device.print_label()
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..40c287e
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1 @@
+suds-community==1.0.0
diff --git a/setup.py b/setup.py
index f3e1aa9..c6b9360 100755
--- a/setup.py
+++ b/setup.py
@@ -14,23 +14,25 @@
'Topic :: Software Development :: Libraries :: Python Modules'
]
-KEYWORDS = 'fedex soap suds wrapper'
+KEYWORDS = 'fedex soap suds wrapper rate track avs location ship pickup country availability commitment package service'
setup(name='fedex',
version=fedex.VERSION,
description='Fedex Web Services API wrapper.',
long_description=LONG_DESCRIPTION,
- author='Gregory Taylor',
+ long_description_content_type='text/x-rst',
+ author='Greg Taylor, Rad Wojcik',
author_email='gtaylor@gc-taylor.com',
- url='https://github.com/gtaylor/python-fedex',
+ maintainer='Python Fedex Developers',
+ url='https://github.com/python-fedex-devs/python-fedex',
download_url='http://pypi.python.org/pypi/fedex/',
packages=['fedex', 'fedex.services', 'fedex.printers'],
package_dir={'fedex': 'fedex'},
- package_data={'fedex': ['wsdl/*.wsdl', 'wsdl/test_server_wsdl/*.wsdl']},
+ package_data={'fedex': ['wsdl/*.wsdl', 'wsdl/test_server_wsdl/*.wsdl', 'tools/*']},
platforms=['Platform Independent'],
license='BSD',
classifiers=CLASSIFIERS,
keywords=KEYWORDS,
requires=['suds'],
- install_requires=['suds-jurko'],
-)
+ install_requires=['suds-community'],
+ )
diff --git a/tests/common.py b/tests/common.py
index 4be13f9..3bb3f2e 100644
--- a/tests/common.py
+++ b/tests/common.py
@@ -4,13 +4,15 @@
"""
from fedex.config import FedexConfig
-def get_test_config():
+
+def get_fedex_config():
"""
Returns a basic FedexConfig to test with.
"""
# Test server (Enter your credentials here)
- return FedexConfig(key='xxxxxxxxxxxxxxxxx',
- password='xxxxxxxxxxxxxxxxxxxxxxxxx',
- account_number='xxxxxxxxx',
- meter_number='xxxxxxxxxx',
- use_test_server=True)
\ No newline at end of file
+ return FedexConfig(key='',
+ password='',
+ account_number='',
+ meter_number='',
+ use_test_server=True,
+ proxy = None)
diff --git a/tests/test_address_validation_service.py b/tests/test_address_validation_service.py
index 2320fe6..93432af 100644
--- a/tests/test_address_validation_service.py
+++ b/tests/test_address_validation_service.py
@@ -3,22 +3,28 @@
"""
import unittest
-
+import logging
import sys
+
sys.path.insert(0, '..')
from fedex.services.address_validation_service import FedexAddressValidationRequest
# Common global config object for testing.
-from common import get_test_config
-CONFIG_OBJ = get_test_config()
+from tests.common import get_fedex_config
+
+CONFIG_OBJ = get_fedex_config()
+
+logging.getLogger('suds').setLevel(logging.ERROR)
+logging.getLogger('fedex').setLevel(logging.INFO)
+@unittest.skipIf(not CONFIG_OBJ.account_number, "No credentials provided.")
class AddressValidationServiceTests(unittest.TestCase):
"""
These tests verify that the address validation service WSDL is in good shape.
"""
- def test_avs(self):
+ def test_avs(self):
avs_request = FedexAddressValidationRequest(CONFIG_OBJ)
address1 = avs_request.create_wsdl_object_of_type('AddressToValidate')
@@ -35,7 +41,6 @@ def test_avs(self):
assert avs_request.response
-
if __name__ == "__main__":
-
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
unittest.main()
diff --git a/tests/test_availability_commitment_service.py b/tests/test_availability_commitment_service.py
new file mode 100644
index 0000000..94955c6
--- /dev/null
+++ b/tests/test_availability_commitment_service.py
@@ -0,0 +1,45 @@
+"""
+Test module for the Fedex ShipService WSDL.
+"""
+
+import unittest
+import logging
+import sys
+
+sys.path.insert(0, '..')
+from fedex.services.availability_commitment_service import FedexAvailabilityCommitmentRequest
+
+# Common global config object for testing.
+from tests.common import get_fedex_config
+
+CONFIG_OBJ = get_fedex_config()
+
+logging.getLogger('suds').setLevel(logging.ERROR)
+logging.getLogger('fedex').setLevel(logging.INFO)
+
+
+@unittest.skipIf(not CONFIG_OBJ.account_number, "No credentials provided.")
+class AvailabilityCommitmentServiceTests(unittest.TestCase):
+ """
+ These tests verify that the shipping service WSDL is in good shape.
+ """
+
+ def test_track(self):
+ # Test shipment tracking. Query for a tracking number and make sure the
+ # first (and hopefully only) result matches up.
+
+ avc_request = FedexAvailabilityCommitmentRequest(CONFIG_OBJ)
+
+ avc_request.Origin.PostalCode = 'M5V 3A4'
+ avc_request.Origin.CountryCode = 'CA'
+
+ avc_request.Destination.PostalCode = '27577' # 29631
+ avc_request.Destination.CountryCode = 'US'
+
+ avc_request.send_request()
+ assert avc_request.response
+
+
+if __name__ == "__main__":
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+ unittest.main()
diff --git a/tests/test_config_object.py b/tests/test_config_object.py
new file mode 100644
index 0000000..d255b52
--- /dev/null
+++ b/tests/test_config_object.py
@@ -0,0 +1,39 @@
+"""
+Test module for the Fedex Config Object.
+"""
+
+import unittest
+import logging
+import sys
+
+sys.path.insert(0, '..')
+from fedex.config import FedexConfig
+
+
+class FedexConfigObjectTests(unittest.TestCase):
+ """
+ These tests verify that the fedex config object is working properly.
+ """
+
+ def test_fedex_config(self):
+ # Need to pass at least key and password
+ with self.assertRaises(TypeError):
+ FedexConfig()
+
+ # Test minimum set of credentials, key and password
+ config = FedexConfig('key', 'password')
+ assert config.key
+ assert config.password
+
+ # Test with all parameters, including overwrite wsdl path
+ config = FedexConfig(key='', password='', account_number='', meter_number='',
+ freight_account_number='',
+ integrator_id='', wsdl_path='/wsdls',
+ express_region_code=None, use_test_server=False)
+
+ assert config.wsdl_path
+
+
+if __name__ == "__main__":
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+ unittest.main()
diff --git a/tests/test_country_service.py b/tests/test_country_service.py
new file mode 100644
index 0000000..2761603
--- /dev/null
+++ b/tests/test_country_service.py
@@ -0,0 +1,40 @@
+"""
+Test module for the Fedex CountryService WSDL.
+"""
+
+import unittest
+import logging
+import sys
+
+sys.path.insert(0, '..')
+from fedex.services.country_service import FedexValidatePostalRequest
+
+# Common global config object for testing.
+from tests.common import get_fedex_config
+
+CONFIG_OBJ = get_fedex_config()
+
+logging.getLogger('suds').setLevel(logging.ERROR)
+logging.getLogger('fedex').setLevel(logging.INFO)
+
+
+@unittest.skipIf(not CONFIG_OBJ.account_number, "No credentials provided.")
+class PackageMovementServiceTests(unittest.TestCase):
+ """
+ These tests verify that the country service WSDL is in good shape.
+ """
+
+ def test_postal_inquiry(self):
+ inquiry = FedexValidatePostalRequest(CONFIG_OBJ)
+ inquiry.Address.PostalCode = '29631'
+ inquiry.Address.CountryCode = 'US'
+
+ inquiry.send_request()
+
+ assert inquiry.response
+ assert inquiry.response.HighestSeverity == 'SUCCESS'
+
+
+if __name__ == "__main__":
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+ unittest.main()
diff --git a/tests/test_location_service.py b/tests/test_location_service.py
new file mode 100644
index 0000000..26054a3
--- /dev/null
+++ b/tests/test_location_service.py
@@ -0,0 +1,65 @@
+"""
+Test module for the Fedex LocationService WSDL.
+"""
+
+import unittest
+import logging
+import sys
+
+sys.path.insert(0, '..')
+from fedex.services.location_service import FedexSearchLocationRequest
+
+# Common global config object for testing.
+from tests.common import get_fedex_config
+
+CONFIG_OBJ = get_fedex_config()
+
+logging.getLogger('suds').setLevel(logging.ERROR)
+
+
+@unittest.skipIf(not CONFIG_OBJ.account_number, "No credentials provided.")
+class SearchLocationServiceTests(unittest.TestCase):
+ """
+ These tests verify that the shipping service WSDL is in good shape.
+ """
+
+ def test_location_phone_search(self):
+ # Test location service phone query
+
+ location_request = FedexSearchLocationRequest(CONFIG_OBJ)
+
+ location_request.LocationsSearchCriterion = 'PHONE_NUMBER'
+ location_request.PhoneNumber = '4169297819'
+ location_request.MultipleMatchesAction = 'RETURN_ALL'
+
+ location_request.Constraints.LocationTypesToInclude = ['FEDEX_AUTHORIZED_SHIP_CENTER']
+
+ location_request.Address.PostalCode = 'M5V 1Z0'
+ location_request.Address.CountryCode = 'CA'
+
+ location_request.send_request()
+
+ assert location_request.response
+
+ def test_location_address_search(self):
+ # Test search by address, using minimum parameters
+
+ location_request = FedexSearchLocationRequest(CONFIG_OBJ)
+ location_request.Address.PostalCode = '38119'
+ location_request.Address.CountryCode = 'US'
+
+ def test_location_coordinates_search(self):
+ # Test search by geo coordinates
+ # https://www.fedex.com/us/developer/webhelp/ws/2020/US/FedEx_WebServices_2020_Developer_Guide.htm#t=wsdvg%2FLocation_Request_Coding_Details.htm
+
+ location_request = FedexSearchLocationRequest(CONFIG_OBJ)
+ location_request.LocationsSearchCriterion = 'GEOGRAPHIC_COORDINATES'
+ location_request.Address.CountryCode = 'US'
+ location_request.GeographicCoordinates = '34.074866096127096-118.40365442768258/'
+
+ location_request.send_request()
+ assert location_request.response.HighestSeverity == 'SUCCESS'
+
+if __name__ == "__main__":
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+ unittest.main()
diff --git a/tests/test_package_movement_service.py b/tests/test_package_movement_service.py
index 41bb0a0..2f53d13 100644
--- a/tests/test_package_movement_service.py
+++ b/tests/test_package_movement_service.py
@@ -3,23 +3,38 @@
"""
import unittest
-
+import logging
import sys
-sys.path.insert(0, '..')
+import warnings
+
+warnings.simplefilter('always', DeprecationWarning) # Show deprecation on this module in py2.7.
+
+sys.path.insert(0, '../')
from fedex.services.package_movement import PostalCodeInquiryRequest
# Common global config object for testing.
-from common import get_test_config
-CONFIG_OBJ = get_test_config()
+from tests.common import get_fedex_config
+CONFIG_OBJ = get_fedex_config()
+logging.getLogger('suds').setLevel(logging.ERROR)
+logging.getLogger('fedex').setLevel(logging.INFO)
+
+
+@unittest.skipIf(not CONFIG_OBJ.account_number, "No credentials provided.")
class PackageMovementServiceTests(unittest.TestCase):
"""
These tests verify that the package movement service WSDL is in good shape.
"""
- def test_postal_inquiry(self):
- inquiry = PostalCodeInquiryRequest(CONFIG_OBJ)
+ def setUp(self):
+ self.config_obj = get_fedex_config()
+
+ def tearDown(self):
+ pass
+
+ def test_postal_inquiry(self):
+ inquiry = PostalCodeInquiryRequest(self.config_obj)
inquiry.PostalCode = '29631'
inquiry.CountryCode = 'US'
@@ -29,7 +44,6 @@ def test_postal_inquiry(self):
assert inquiry.response.HighestSeverity == 'SUCCESS'
-
if __name__ == "__main__":
-
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
unittest.main()
diff --git a/tests/test_pickup_service.py b/tests/test_pickup_service.py
new file mode 100644
index 0000000..a30208e
--- /dev/null
+++ b/tests/test_pickup_service.py
@@ -0,0 +1,120 @@
+"""
+Test module for the Fedex Pickup Service WSDL.
+"""
+
+import unittest
+import logging
+import sys
+import datetime
+
+sys.path.insert(0, '..')
+from fedex.services.pickup_service import FedexCreatePickupRequest, FedexPickupAvailabilityRequest
+
+# Common global config object for testing.
+from tests.common import get_fedex_config
+
+CONFIG_OBJ = get_fedex_config()
+
+logging.getLogger('suds').setLevel(logging.ERROR)
+logging.getLogger('fedex').setLevel(logging.INFO)
+
+
+@unittest.skipIf(not CONFIG_OBJ.account_number, "No credentials provided.")
+class FedexCreatePickupRequestTests(unittest.TestCase):
+ """
+ These tests verify that the pickup service WSDL is in good shape.
+ """
+
+ def setUp(self):
+ self.config_obj = get_fedex_config()
+
+ def tearDown(self):
+ pass
+
+ def test_pickup_request(self):
+ pickup_service = FedexCreatePickupRequest(self.config_obj)
+
+ pickup_service.OriginDetail.PickupLocation.Contact.PersonName = 'Sender Name'
+ pickup_service.OriginDetail.PickupLocation.Contact.EMailAddress = 'test@user.com'
+ pickup_service.OriginDetail.PickupLocation.Contact.CompanyName = 'Acme Inc.'
+ pickup_service.OriginDetail.PickupLocation.Contact.PhoneNumber = '9012638716'
+ pickup_service.OriginDetail.PickupLocation.Address.StateOrProvinceCode = 'SC'
+ pickup_service.OriginDetail.PickupLocation.Address.PostalCode = '29631'
+ pickup_service.OriginDetail.PickupLocation.Address.CountryCode = 'US'
+ pickup_service.OriginDetail.PickupLocation.Address.StreetLines = ['155 Old Greenville Hwy', 'Suite 103']
+ pickup_service.OriginDetail.PickupLocation.Address.City = 'Clemson'
+ # pickup_service.OriginDetail.PickupLocation.Address.UrbanizationCode = '' # For Puerto Rico only
+ pickup_service.OriginDetail.PickupLocation.Address.Residential = False
+
+ # FRONT, NONE, REAR, SIDE
+ # pickup_service.OriginDetail.PackageLocation = 'NONE'
+
+ # APARTMENT, BUILDING, DEPARTMENT, FLOOR, ROOM, SUITE
+ # pickup_service.OriginDetail.BuildingPart = 'SUITE'
+
+ # Identifies the date and time the package will be ready for pickup by FedEx.
+ pickup_service.OriginDetail.ReadyTimestamp = datetime.datetime.now().replace(microsecond=0).isoformat()
+
+ # Identifies the latest time at which the driver can gain access to pick up the package(s)
+ pickup_service.OriginDetail.CompanyCloseTime = '23:00:00'
+
+ pickup_service.CarrierCode = 'FDXE'
+
+ pickup_service.TotalWeight.Units = 'LB'
+ pickup_service.TotalWeight.Value = '1'
+ pickup_service.PackageCount = '1'
+ # pickup_service.OversizePackageCount = '1'
+
+ # pickup_service.CommodityDescription = ''
+
+ # DOMESTIC or INTERNATIONAL
+ # pickup_service.CountryRelationship = 'DOMESTIC'
+
+ # See PickupServiceCategoryType
+ # pickup_service.PickupServiceCategory = 'FEDEX_DISTANCE_DEFERRED'
+
+ pickup_service.send_request()
+
+ assert pickup_service.response.HighestSeverity == 'SUCCESS', pickup_service.response.Notifications[0].Message
+
+ def test_pickup_availability(self):
+ availability = FedexPickupAvailabilityRequest(self.config_obj)
+
+ availability.PickupType = 'ON_CALL'
+
+ availability.AccountNumber.Type = 'FEDEX_EXPRESS'
+ availability.AccountNumber.AccountNumber = self._get_config().account_number
+
+ availability.DispatchDate = datetime.datetime.now().strftime('%Y-%m-%d')
+ availability.PackageReadyTime = datetime.datetime.now().strftime('%H:%M:%S')
+ availability.CustomerCloseTime = '17:00:00'
+
+ availability.NumberOfBusinessDays = 2
+
+ availability.PickupAddress.PostalCode = 'M5V 3A4'
+ availability.PickupAddress.CountryCode = 'CA'
+ availability.PickupAddress.CountryName = 'Canada'
+
+ availability.PickupRequestType = 'SAME_DAY'
+
+ availability.ShipmentAttributes.ServiceType = 'PRIORITY_OVERNIGHT'
+ availability.ShipmentAttributes.PackagingType = 'YOUR_PACKAGING'
+
+ availability.ShipmentAttributes.Dimensions.Length = 12
+ availability.ShipmentAttributes.Dimensions.Width = 9
+ availability.ShipmentAttributes.Dimensions.Height = 1
+ availability.ShipmentAttributes.Dimensions.Units = 'IN'
+
+ availability.ShipmentAttributes.Weight.Units = 'KG'
+ availability.ShipmentAttributes.Weight.Value = 0.25
+
+ availability.send_request()
+
+ availability.send_request()
+
+ assert availability.response.HighestSeverity == 'SUCCESS', availability.response.Notifications[0].Message
+
+
+if __name__ == "__main__":
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+ unittest.main()
diff --git a/tests/test_rate_service.py b/tests/test_rate_service.py
index 215ab35..2af0896 100644
--- a/tests/test_rate_service.py
+++ b/tests/test_rate_service.py
@@ -3,22 +3,28 @@
"""
import unittest
-
+import logging
import sys
+
sys.path.insert(0, '..')
from fedex.services.rate_service import FedexRateServiceRequest
# Common global config object for testing.
-from common import get_test_config
-CONFIG_OBJ = get_test_config()
+from tests.common import get_fedex_config
+
+CONFIG_OBJ = get_fedex_config()
+
+logging.getLogger('suds').setLevel(logging.ERROR)
+logging.getLogger('fedex').setLevel(logging.INFO)
+@unittest.skipIf(not CONFIG_OBJ.account_number, "No credentials provided.")
class RateServiceTests(unittest.TestCase):
"""
These tests verify that the rate service WSDL is in good shape.
"""
- def test_rate(self):
+ def test_rate(self):
rate = FedexRateServiceRequest(CONFIG_OBJ)
rate.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
@@ -47,8 +53,9 @@ def test_rate(self):
rate.send_request()
- assert rate.response.HighestSeverity == 'SUCCESS'
+ assert rate.response.HighestSeverity == 'SUCCESS', rate.response.Notifications[0].Message
-if __name__ == "__main__":
+if __name__ == "__main__":
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
unittest.main()
diff --git a/tests/test_ship_service.py b/tests/test_ship_service.py
index a9ce48f..ac93dd2 100644
--- a/tests/test_ship_service.py
+++ b/tests/test_ship_service.py
@@ -3,23 +3,29 @@
"""
import unittest
-
+import logging
import sys
+
sys.path.insert(0, '..')
from fedex.services.ship_service import FedexProcessShipmentRequest
from fedex.services.ship_service import FedexDeleteShipmentRequest
# Common global config object for testing.
-from common import get_test_config
-CONFIG_OBJ = get_test_config()
+from tests.common import get_fedex_config
+
+CONFIG_OBJ = get_fedex_config()
+
+logging.getLogger('suds').setLevel(logging.ERROR)
+logging.getLogger('fedex').setLevel(logging.INFO)
+@unittest.skipIf(not CONFIG_OBJ.account_number, "No credentials provided.")
class ShipServiceTests(unittest.TestCase):
"""
These tests verify that the ship service WSDL is in good shape.
"""
- def test_create_delete_shipment(self):
+ def test_create_delete_shipment(self):
shipment = FedexProcessShipmentRequest(CONFIG_OBJ)
shipment.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
@@ -66,10 +72,11 @@ def test_create_delete_shipment(self):
package1.Weight = package1_weight
shipment.add_package(package1)
+ shipment.send_validation_request()
shipment.send_request()
assert shipment.response
- assert shipment.response.HighestSeverity == 'SUCCESS'
+ assert shipment.response.HighestSeverity in ['SUCCESS', 'WARNING']
track_id = shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].TrackingIds[0].TrackingNumber
assert track_id
@@ -84,5 +91,5 @@ def test_create_delete_shipment(self):
if __name__ == "__main__":
-
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
unittest.main()
diff --git a/tests/test_tools.py b/tests/test_tools.py
new file mode 100644
index 0000000..781cb9b
--- /dev/null
+++ b/tests/test_tools.py
@@ -0,0 +1,49 @@
+"""
+Test module for the Fedex Tools.
+"""
+
+import unittest
+import logging
+import sys
+
+sys.path.insert(0, '..')
+
+import fedex.config
+import fedex.services.ship_service as service # Any request object will do.
+import fedex.tools.conversion
+
+logging.getLogger('suds').setLevel(logging.ERROR)
+logging.getLogger('fedex').setLevel(logging.INFO)
+
+
+class FedexToolsTests(unittest.TestCase):
+ """
+ These tests verify that the fedex tools are working properly.
+ """
+
+ def test_conversion_tools(self):
+ # Empty config, since we are not actually sending anything
+ config = fedex.config.FedexConfig(key='', password='',
+ account_number='', meter_number='',
+ use_test_server=True)
+
+ # We need a mock suds object, a request object or sub-object will do.
+ waybill_request = service.FedexProcessShipmentRequest(config)
+ obj = waybill_request.create_wsdl_object_of_type('ProcessShipmentRequest')
+
+ # Test basic sobject to dict.
+ dict_obj = fedex.tools.conversion.basic_sobject_to_dict(obj)
+ assert type(dict_obj) == dict
+
+ # Test with serialization and case conversion.
+ dict_obj = fedex.tools.conversion.sobject_to_dict(obj, key_to_lower=True, json_serialize=True)
+ assert type(dict_obj) == dict
+
+ # JSON string object test
+ dict_obj = fedex.tools.conversion.sobject_to_json(obj)
+ assert dict_obj, "Expecting a JSON string object."
+
+
+if __name__ == "__main__":
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+ unittest.main()
diff --git a/tests/test_track_service.py b/tests/test_track_service.py
index 5cfd67d..9b9e69f 100644
--- a/tests/test_track_service.py
+++ b/tests/test_track_service.py
@@ -1,22 +1,29 @@
"""
-Test module for the Fedex ShipService WSDL.
+Test module for the Fedex TrackService WSDL.
"""
import unittest
-
+import logging
import sys
+
sys.path.insert(0, '..')
from fedex.services.track_service import FedexTrackRequest
# Common global config object for testing.
-from common import get_test_config
-CONFIG_OBJ = get_test_config()
+from tests.common import get_fedex_config
+
+CONFIG_OBJ = get_fedex_config()
+logging.getLogger('suds').setLevel(logging.ERROR)
+logging.getLogger('fedex').setLevel(logging.INFO)
+
+@unittest.skipIf(not CONFIG_OBJ.account_number, "No credentials provided.")
class TrackServiceTests(unittest.TestCase):
"""
These tests verify that the shipping service WSDL is in good shape.
"""
+
def test_track(self):
# Test shipment tracking. Query for a tracking number and make sure the
# first (and hopefully only) result matches up.
@@ -38,11 +45,11 @@ def test_track(self):
# Uncomment below if testing in production with a valid tracking number
# for match in track.response.CompletedTrackDetails[0].TrackDetails:
- # # This should be the same tracking number on the response that we
- # # asked for in the request.
- # assert match.TrackingNumber == tracking_num
+ # This should be the same tracking number on the response that we
+ # asked for in the request.
+ # assert match.TrackingNumber == tracking_num
if __name__ == "__main__":
-
+ logging.basicConfig(stream=sys.stdout, level=logging.INFO)
unittest.main()